The script file defines an External Program that can be executed by using ArcotID OTP Desktop Client. You must include these files in the directory where the ExternalPrograms.xml file is located.
The script file is defined with the .bat extension on Microsoft Windows and as a shell script on Apple Macintosh and Ubuntu Linux. The ArcotID OTP Desktop Client provides a sample script (ExternalProgramsSample), and it is available in the directory that contains the shared files.
When you invoke the script file, it is passed as the environment variables, as discussed in the following table:
|
Environment Variable |
Dependent XML tag in the externalprogram.xml file |
Description |
|---|---|---|
|
CA_AUTH_CONFIRM |
<confirm> |
Prompts the user to accept the External Programs before they run them. If CA_AUTH_CONFIRM is defined, then CA_AUTH_PROP_confirm is used to define the confirmation string.
The CA_AUTH_CONFIRM variable is set if the <confirm> value in the externalprograms.xml file is set to TRUE. |
|
CA_AUTH_HIDDEN |
<hidden> |
Used if the script is executed in the hidden mode without the GUI or a display window. |
|
CA_AUTH_PROGRAM |
<file> |
Defines the file name of the script that contains the External Program to be invoked. |
|
CA_AUTH_PROP_account |
NA |
Defines the name of the ArcotID OTP account that must be used to invoke External Programs. |
|
CA_AUTH_PROP_cmdname |
<name> |
Defines the name of the External Program to be invoked. |
|
CA_AUTH_PROP_confirm |
NA |
Defines the confirmation message that is displayed to the user if CA_AUTH_CONFIRM variable is TRUE. |
|
CA_AUTH_PROP_password |
NA |
Defines the generated ArcotID OTP that has to be used by the External Program. |
The result of the script file is returned to ArcotID OTP Desktop Client, and then displayed to the user through a pop-up dialog box.
|
Copyright © 2013 CA Technologies.
All rights reserved.
|
|