Applications

Access: Home > Applications

Only WAE administrators have the ability to add and manage WAE applications or custom client menus to the WAE UI. These applications can then be launched directly from the Home > Applications window or the Applications page.

Installing the Application

Step 1blank.gif If a WAE application is available as an <application-name>.zip file, download the file to your server. You can search WAN Automation Engine (WAE) from the Cisco download site, and navigate to the WAE application.

Step 2blank.gif From the WAE UI, select Home > Applications.

Step 3blank.gif Click Apps Management or the gear (Settings) icon located on the upper-right corner of the window. The Apps Management window appears.

Step 4blank.gif Click the upload icon and upload the <application-name>.zip file that you downloaded.

After the upload is complete, the following options for each application are available:

  • Enable—Adds the application to the Applications window or page so that it can be easily launched. A user will only see the Applications window if a WAE administrator has enabled the application.
note.gif

Noteblank.gif The application cannot be enabled if the application is not compatible with your license type or your WAE software version.

  • Delete—Uninstalls the application software and no longer appears in the Apps Management window. This option appears only during initial upload or after disabling the application.

Step 5blank.gif Click Enable to add the application to the Applications window.

Once enabled, only the Disable option is available. The Disable option removes the application without uninstalling it from WAE. To uninstall the application, click Disable, then click Delete.

Step 6blank.gif Close the window and confirm that the application is listed in the Applications window.

 

Application File Contents

This section provides a high-level description of what WAE requires in order to add an application to the WAE UI. For more information, contact your support representative.

The.zip file must contain the following:

  • application.json—Application configuration file
  • application.war—Entire backend package of the application
  • ROOT/services/<application.json>/<UI_files>—All UI files required by the application contained in this directory structure

Contents of an application.json file:

{
"name": "<app-name>”,
"caption": "<app-caption>”,
"description": “<app-description>",
"icon": "fa fa-fw fa-wrench”,
"redirectPage": "<app-redirect>”,
"version": “<app-version>”
"dependencies": {
"wae-version": “<wae-version>”,
"wae-exclude-versions": [ “<wae-exclude-versions>”],
"licenses": ["license-type"]
}
}

 

Variable
Description

<app-name>

The name of the application. This has to match the ROOT/services/<app-name>

<app-caption>

The caption for the application that will be displayed in the UI.

<app-description>

Description of the application.

<icon>

Icon to be used for the application. WAE supports font-awesome 4.3.0 icons.

<app-redirect>

The URL of the redirect page.

<app-version>

Application version.

<wae-version>

Minimum WAE software version supported. All versions above will work except any versions listed in <wae-exclude-versions>.

<wae-exclude-versions>

All WAE software versions that are not supported.

<license-type>

License feature.

Example:

{
"name": "MyNewApp”,
"caption": "My New Application”,
"description": “Sends statistics reports to a specified e-mail address",
"icon": "fa fa-fw fa-wrench”,
"redirectPage": "rd_mynewapp”,
"version": “1.0”
"dependencies": {
"wae-version": “6.1”,
"wae-exclude-versions": [
"6.3",
"6.2.1"
],
"lic enses": [
"ML_Map",
"MC_VPN",
"MD_Sim" ]
}
}