AWI URLs

Document created by Michael_Lowry on May 2, 2018Last modified by Luu Le on Sep 1, 2018
Version 5Show Document
  • View in full screen mode

This document describes the URL schema of the Automic Web Interface. If you are interested in contributing to this document, please contact one of the authors.

 

AWI URL parameters

The AWA documentation contains instructions for Enabling parameterized login in AWI:

  1. In your AWI instance, set the parameter_login.enabled property to "true" in the configuration.properties file.

  2. In your AWI startup URL append the login information that you want to have already entered in the login window, so that the URL looks like this:
    https://<AWI>/#&system=ConnectionName&client=9999&name=MyUserName&department=Dept

By examining an AWI trace, I was able to discover several undocumented URL parameters.

ParameterDescriptionExampleDocumented
systemAE system nameUC4_EXP2
clientAE client number0001
nameUser nameJSMITH
departmentDepartment nameCORP
passwordPassword¹myPas$w0rd
languageLanguage (en/de/fr)²en
ssoEnable single sign-on (Kerberos)? (yes/no)yes
autologinEnable automatic login? (yes/no)³yes

Notes:

  1. To use the password parameter, you must add the line parameter_login.with_password=true to the configuration.properties file and restart the AWI server. (See AWI configuration settings.)
  2. If the language parameter is specified, it must be specified first, before other parameters.
  3. To use autologin=yes, you must also specify sso=yes.

 

Using these parameters, it is possible to construct URLs that log in automatically with SSO to a particular AE system and client.

 

AWI URL perspectives

Each of the main AEI perspectives has its own parameter, specified after the AWI host name and prefixed by a hash (#) character.

PerspectiveURL
Administrationhttps://awi-hostname/#administration 
Process Assemblyhttps://awi-hostname/#pa 
Process Monitoringhttps://awi-hostname/#pm 
Service Cataloghttps://awi-hostname/#sc 
Dashboardshttps://awi-hostname/#home 

 

AWI URL examples

 

AWI URL navigation locations

The navigation parameter specifies a particular properties sheet of an object. It is thus possible to construct a URL that will navigate directly to a particular properties sheet of a particular object.

https://awi-hostname/#pa/view/object-name&navigation=navigation-location

There are many different navigation locations:

 

AWI tab

AWI sub-tabnavigation-location
Default tab for object typedefault
Generalsheet.simpleoverview
GeneralSyncsheet.sync
GeneralRuntimesheet.runtime
GeneralObject Authorizationssheet.object.authorizations
Attributessheet.attributes
Processsheet.script
ProcessPre-Processsheet.script_pre
ProcessPost-Processsheet.script_post
OutputOutput-Scansheet.output_scan
Variables & PromptsVariablessheet.variables
Variables & PromptsPrompt Setssheet.prompts
Rollbacksheet.rollback
Version Managementsheet.version
DocumentationDocusheet.documentation.Docu
Rapid Automationsheet.ra
Console EventEvent Processsheet.event.console.script
DB EventEvent Processsheet.event.db.script
File EventEvent Processsheet.event.file.script
Time EventEvent Processsheet.event.time.script


Knowing this URL format, it is possible to include AWI links in emails, web pages, etc. Here are some examples.

 

 

Note that hash characters (#) in object names must be replaced with %23 in AWI URLs.

 

AWI deep links

By combining these parameters, you can create deep links to specific AWI perspectives or specific AE objects. Here’s an example from a wiki page, with icons added to improve readability.

(A ZIP file containing all the AWI icons is attached to this document.)

 

This document originates in a couple of discussions (1, 2).

    
5 people found this helpful

Attachments

Outcomes