Michael_Lowry

AWI — parameterized URLs with autologin SSO

Discussion created by Michael_Lowry on Feb 17, 2017
Latest reply on Jan 8, 2018 by Michael_Lowry
On the documentation page Configuring Automic Web Interface, in the section Configure the Login and User Authentication, there is a sub-section with instructions for Enabling parameterized login in AWI. Here is an excerpt:
  1. In your AWI instance, set theparameter_login.enabledproperty to "true" in theconfiguration.properties.

  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
This allows one to construct a URL that will take one directly to a particular system or client.

There are actually a few more parameters that are undocumented. By examining an AWI trace, I was able to assemble what I believe is a complete list of valid URL parameters.
                                         
ParameterDescriptionExampleDocumented
systemAE system nameUC4_EXP2
clientAE client number0001
nameUser nameJSMITH
departmentDepartment name
CORP
passwordPassword¹myPas$w0rd
languageLanguage (en/de/fr)²en
ssoEnable single sign-on (Kerberos)? (yes/no)yes
autologinEnable automatic login? (yes/no)³yes

1. To use the password parameter, parameter_login.with_password=true must be added to configuration.properties.
2. If the language parameter is specified, it must be specified first, before other parameters.
3. To use autologin=yes, it is also necessary to specify sso=yes.

It is also possible to construct deep link AWI URLs that go straight to a particular perspective. These work best when single sign-on (SSO) is enabled, because the login happens transparently.
                               
 

System

 
 

Client

 
 

Perspective

 
 

URL

 
 

EXP2

 
 

0001

 
 

Process Assembly

 
  https://awi-exp2.mycompany.com/#pa&system=UC4_EXP2&client=0001&sso=yes&autologin=yes  
 

EXP2

 
 

0001

 
 

Process Monitoring

 
  https://awi-exp2.mycompany.com/#pm&system=UC4_EXP2&client=0001&sso=yes&autologin=yes  
 

EXP2

 
 

0001

 
 

Administration

 
  https://awi-exp2.mycompany.com/#administration&system=UC4_EXP2&client=0001&sso=yes&autologin=yes  
It’s even possible to construct deep links that navigate directly to a specific object. Here are a few examples.
                                       
 

System

 
 

Client

 
 

Object

 
 

URL

 
 

EXP2

 
 

0001

 
 

UC0.EXP2.TEST#1_1.JOBP

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

EXP2

 
 

0001

 
 

UC0.EXP2.TEST#1_1.JOBS_UNIX

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

EXP2

 
 

0001

 
 

UC0.EXP2.TEST#1_1.VARA_STATIC

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

EXP2

 
 

0000

 
 

UC_SYSTEM_SETTINGS

 
  https://awi-exp2.mycompany.com/#pa/view/UC_SYSTEM_SETTINGS&system=UC4_EXP2&client=0000&sso=yes&autologin=yes  
Note that hash characters (#) in object names must be replaced with %23 in AWI URLs.

Outcomes