Automic Workload Automation

Expand all | Collapse all

AWI — parameterized URLs with autologin SSO

  • 1.  AWI — parameterized URLs with autologin SSO

    Posted 02-17-2017 04:49 AM
    Note: An updated version of the information below can be found here: AWI URLs 

     

    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 the parameter_login.enabled property to "true" in the configuration.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 nameCORP
    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.

    It’s even possible to construct deep links that navigate directly to a specific object. Here are a few examples.

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



  • 2.  AWI — parameterized URLs with autologin SSO

    Posted 03-27-2017 04:32 AM
    Philipp Elmer wrote:
    you mentioned something about the order of the parameters, that gave me the missing clue about the language parameter. It DOES work, but has to be specified as the FIRST parameter.
    Thanks for the information,PhilippElmer. I updated the list of parameters with a note to this effect.


  • 3.  AWI — parameterized URLs with autologin SSO

    Posted 03-24-2017 04:03 PM
          Hi

    Michael A. Lowry


    I'm afraid the language parameter doesn't exists.
    I tried a few variations on my 12.0.1 system and couldn't get it to work *sigh*
    Cheers, Philipp
    languageLanguage (en/de/fr)
    en


  • 4.  Re: AWI — parameterized URLs with autologin SSO

    Posted 06-07-2018 07:53 AM

    I copied much of the above information to the document AWI URLs.



  • 5.  AWI — parameterized URLs with autologin SSO

    Posted 02-21-2017 08:25 AM

    There are actually a few more parameters. This list should be complete.

    ParameterDescriptionExample
    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


    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.



  • 6.  AWI — parameterized URLs with autologin SSO

    Posted 10-12-2017 03:44 AM
    Currently, there is no color parameter that can be used in this way. I have updated the original post with the complete list of parameters that can be used.


  • 7.  AWI — parameterized URLs with autologin SSO

    Posted 03-24-2017 04:23 PM
    Hi

    Michael A. Lowry

    ,
    you mentioned something about the order of the parameters, that gave me the missing clue about the language parameter.
    It DOES work, but has to be specified as the FIRST parameter.
    e.g. https://<AWI >/#&language=de&system=ConnectionName&client=9999&name=MyUserName&department=Dept
    Thanks! This is very helpful, indeed!
    Cheers, Philipp


  • 8.  AWI — parameterized URLs with autologin SSO

    Posted 10-12-2017 01:56 AM
    Has someone tried this for color too? I tried color=blue (or color=4063FF) but it did not work. 

    Regards,
    Jessica


  • 9.  AWI — parameterized URLs with autologin SSO

    Posted 02-17-2017 05:48 AM
    I discovered two undocumented parameters that can be specified in the URL in addition to system and client: sso and autologin.

    ParameterDescriptionExample
    systemAE system name
    UC4_EXP2
    clientAE client number0001
    ssoEnable single sign-on (Kerberos)? (yes/no)
    yes
    autologinEnable automatic login? (yes/no)
    Requires sso=yes*
    yes
    Here is an example:
    https://awi-exp2.mycompany.com/#pa&system=UC4_EXP2&client=0001&sso=yes&autologin=yes
    Adding these two parameters appears to help with the aforementioned problems, and forces the AWI to try automatic SSO even if the specified system and/or client differs from the last one used.  (I gather cookies are used to store session information, and that information in these cookies is used by default.)

    Based on this knowledge I updated the direct object URLs from my original post:
     

    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  
    These work more reliably.

    I did notice that if I simultaneously open several different URLs to different combinations of system and client, the AWI gets confused and has trouble keeping the sessions distinct. This results in errors (session expired, invalid session). The work-around is to give the first session enough time to open completely, and only then open additional sessions.

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

    * Using autologin=yes without sso=yes results in a NullPointerException.


  • 10.  AWI — parameterized URLs with autologin SSO

    Posted 01-08-2018 10:10 AM
      |   view attached
    Thanks to parameterized AWI URLs, I can now include links to a particular perspective, object, or view in the AWI. I have begun to include such links in emails & web pages on our internal wiki. Here’s an example.
    smv8etfdskmm.pnghttps://us.v-cdn.net/5019921/uploads/editor/a4/smv8etfdskmm.png" width="280">
    (The icons are just PNG files extracted from awi.war, and attached to the wiki page. I have attached a ZIP of the icons I use most.)

    This will make it much simpler for our administrators to provide user-friendly documentation, and for AWI users to exchange information during development, testing, and troubleshooting of their automation batches.

    Attachment(s)

    zip
    AWI_Icons.zip   199 KB 1 version