This document pertains to AWI v12.2. URL parameters have changed in later versions; see also AWI v12.3 URLs.
AWI URL parameters
The AWA documentation contains instructions for Enabling parameterized login in AWI:
-
In your AWI instance, set the parameter_login.enabled property to "true" in the configuration.properties file.
- 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.
| Parameter |
Description |
Example |
Documented |
| system |
AE system name |
UC4_EXP2 |
✔ |
| client |
AE client number |
0001 |
✔ |
| name |
User name |
JSMITH |
✔ |
| department |
Department name |
CORP |
✔ |
| password |
Password¹ |
myPas$w0rd |
✘ |
| language |
Language (en/de/fr)² |
en |
✘ |
| sso |
Enable single sign-on (Kerberos)? (yes/no) |
yes |
✘ |
| autologin |
Enable automatic login? (yes/no)³ |
yes |
✘ |
|
Notes:
- 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.)
- If the language parameter is specified, it must be specified first, before other parameters.
- To use autologin=yes, you must also specify sso=yes.
|
Note: 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 parameter, specified after the AWI host name and prefixed by a hash (#) character.
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-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 |
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).