Installation of Password Exit with AE

You need to install Password Exit to use OAuth as login method for your Automation Engine (AE) or Integrated Windows Authentication for ARA version 5.

For installation and configuration basics see also: AE documentation - Application Integration Guide - Program Exits - Password Exit.

Steps:

  1. Install scriptable command line tool to send HTTP post requests (e.g., curl) on the AE host.

    Remember to install a version with SSL support for HTTPS communication.

  2. Copy the library (.so or .dll) and the ini file to the bin directory of the AE

  3. Login to AE client 0

  4. Set the paths to the library and ini file (e.g., xuc4pass.dll and xuc4pass.ini) in UC_SYSTEM_SETTINGS: parameters PASSWORD_EXIT and PASSWORD_EXIT_PARAM

    ParameterDescriptionExample
    PASSWORD_EXITPath to Password Exit libraryc:\automic\AE\bin\xuc4pass.dll
    PASSWORD_EXIT_PARAMPath to configuration file

    c:\automic\AE\bin\xuc4pass.ini

    Variable object UC_SYSTEM_SETTINGS with configured password exit library and ini file (example: xuc4pass).

  5. Adapt the ini file (e.g., xuc4pass.ini) where PASSWORD_EXIT_PARAM is pointing to: Set Url to your OAuth validation end-point URL you want to use:

    Parameter

    Type

    Default Value

    Description

    Url

    String

    -

    OAuth validation endpoint URL

    Example: http://oauthsrv/oauth2/validate

    Protocol indication (http/https) is required.

    Needs to be the same as specified in sapiConfig.xml.

    OutputFile

    String

    -

    Output file to store run-time information

    Logging

    Number

    -

    Logging level:

    • 0 ... disable logging
    • 1 ... writing to target AE WP log-file
    tokenPrefixStringBearer

    Prefix for the access-token

    If the received prefix matches this value, the string is regarded as token, otherwise as password.

    cmd

    String

    -

    cURL command used to call the service method to verify login user

    Search

    String

    "access_token"

    String to be found in messages, if validation is successful (only then "access_token" appears)

    Example content of the ini file (e.g., xuc4pass.ini) using cURL:

    [Settings]
    Url=http://oauthsrv/oauth2/validate
    outputFile=C:\Automic\AE\Temp\xuc4pass_log.txt
    Logging=1
    tokenPrefix=Bearer
    cmd=C:/curl/curl --user User1:PWord %0 –data "access_token=%1"
    Search="access_token":
  6. Restart the AE

  7. Now, Password Exit is active