Automic Workload Automation

AWI v12.3 URLs 

22 days ago

Note: This document pertains to AWI v12.3. For information on earlier versions, see AWI v12.2 URLs.

AWI URL parameters

The v12.3 documentation for the AWI configuration.properties file contains instructions for enabling parameterized login:

parameter_login.enabled

Specifies whether the AWI login window opens, the parameters for Connection, Client, Name, Department, Logintype and Language are already filled in. Users need to enter only their password.

Possible values:

  • true
    Login parameters except password are filled in

  • false (default)


    No login parameters are filled in

If this is enabled, then the AWI startup will recognize login parameters that are added to the start URL in the following format:

https://<AWI >/?system=ConnectionName&client=9999&name=MyUserName&department=Dept&logintype=AE(default)|KERBEROS|SAML&language=MyLanguage&autologin=true



Notes:

  • If your browser is not accessing AWI over an SSL protocol, your URL will start with http://.
  • The logintype parameter is optional and it is only relevant when the related SSO parameter is enabled in the configuration.properties file.
  • The autologin parameter is optional and can be used together with the KERBEROS or SAML login types. If the autologin parameter is provided, the login dialog is submitted automatically.

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

Parameter Description (default)
Example Documented
system AE system name AE_EXP
client AE client number 0001
name User name JSMITH
department Department name CORP
password Password¹ myPas$w0rd
language Language (en/de/fr)² en
logintype Use username and password, or Kerberos/SAML single sign-on? (AE/KERBEROS/SAML) KERBEROS
autologin Enable 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.
  4. There is also a debug parameter that can be used to display a debugging window. This is mostly useful to the AWI developers.

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 identifier, specified after the AWI host name and prefixed by a hash (#) character.

Perspective URL
Administration https://awi-hostname/#administration 
Process Assembly https://awi-hostname/#pa 
Process Monitoring https://awi-hostname/#pm 
Service Catalog https://awi-hostname/#sc 
Dashboards https://awi-hostname/#home 


AWI auto-login
By combining URL parameters and the path identifier of a perspective, it’s possible to construct a URL that will automatically log the user in and take her to a particular perspective. For instance, the following URL would log in automatically using Kerberos to the system AE_EXP, client 1, and then navigate to the Process Assembly perspective.
https://awi-exp.mycompany.com/?system=AE_EXP&client=0001&logintype=KERBEROS&autologin=true#pa

AWI URL examples

AWI view URL
Explorer https://awi-hostname/#pa/pa&navigation=explorer 
Explorer (specific folder) https://awi-hostname/#pa/pa&navigation=explorer&folder=folder-OH_Idnr 
Explorer (specific object) https://awi-hostname/#pa/view/object-name 
Favorites https://awi-hostname/#pa/pa&navigation=favoritesNavigation 
Search https://awi-hostname/#pa/pa&navigation=searchNavigation 
Processes & Usage https://awi-hostname/#pm/system/usage 
Agents https://awi-hostname/#pm/system/agents 
Activities (all queues) https://awi-hostname/#pm/overview&view=tree
(I found no straightforward way to build a URL that displays a specific queue.)
Users https://awi-hostname/#administration/users 
Connections https://awi-hostname/#administration/connections

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-tab navigation-location
Default tab for object type default
General sheet.simpleoverview
General Sync sheet.sync
General Runtime sheet.runtime
General Object Authorizations sheet.object.authorizations
Attributes sheet.attributes
Process sheet.script
Process Pre-Process sheet.script_pre
Process Post-Process sheet.script_post
Output Output-Scan sheet.output_scan
Variables & Prompts Variables sheet.variables
Variables & Prompts Prompt Sets sheet.prompts
Rollback sheet.rollback
Version Management sheet.version
Documentation Docu sheet.documentation.Docu
Rapid Automation sheet.ra
Console Event Event Process sheet.event.console.script
DB Event Event Process sheet.event.db.script
File Event Event Process sheet.event.file.script
Time Event Event Process sheet.event.time.script

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

 

System

Client

Perspective

URL

EXP2

0001

Process Assembly

https://awi-exp.mycompany.com/#pa&system=UC4_EXP2&client=0001&logintype=KERBEROS&autologin=yes  

EXP2

0001

Process Monitoring

https://awi-exp.mycompany.com/#pm&system=UC4_EXP2&client=0001&logintype=KERBEROS&autologin=yes  

EXP2

0001

Administration

https://awi-exp.mycompany.com/#administration&system=UC4_EXP2&client=0001&logintype=KERBEROS&autologin=yes

 

System

Client

Object

URL

EXP2

0001

UC0.EXP2.TEST#1_1.JOBP

https://awi-exp.mycompany.com/#pa/view/UC0.EXP2.TEST%231_1.JOBP&system=UC4_EXP2&client=0001&logintype=KERBEROS&autologin=yes  

EXP2

0001

UC0.EXP2.TEST#1_1.JOBS_UNIX

https://awi-exp.mycompany.com/#pa/view/UC0.EXP2.TEST%231_1.JOBS_UNIX&system=UC4_EXP2&client=0001&logintype=KERBEROS&autologin=yes  

EXP2

0001

UC0.EXP2.TEST#1_1.VARA_STATIC

https://awi-exp.mycompany.com/#pa/view/UC0.EXP2.TEST%231_1.VARA_STATIC&system=UC4_EXP2&client=0001&logintype=KERBEROS&autologin=yes  

EXP2

0000

UC_SYSTEM_SETTINGS

https://awi-exp.mycompany.com/#pa/view/UC_SYSTEM_SETTINGS&system=UC4_EXP2&client=0000&logintype=KERBEROS&autologin=yes  

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.)

   

Statistics
0 Favorited
28 Views
2 Files
0 Shares
5 Downloads
Attachment(s)
zip file
AWI_Icons.zip   199K   1 version
Uploaded - 10-22-2019
zip file
JUI_Icons.zip   94K   1 version
Uploaded - 10-22-2019

Tags and Keywords

Related Entries and Links

No Related Resource entered.