Setting Up the XML File

CA ArcotID OTP Client Installation Guide › Using Advanced Features › Managing External Programs › Configuring External Programs › Setting Up the XML File

Setting Up the XML File

The External Programs, which are available to the users through their ArcotID OTP Desktop Client must be defined in the ExternalPrograms.xml file. This file contains the declaration of External Programs and the configuration settings that must be applied to the External Programs.

The ArcotID OTP Desktop Client provides a default ExternalProgramsSample.xml file located in the directory that contains the shared files listed in the "Default Location for Shared Files" section. You can use this default file as a template to define the External Programs that you plan to implement.

Important! After you change or modify the ExternalPrograms.xml file, you must restart the browser for the changes to take effect.

For the ArcotID OTP Desktop Client to read the External Programs, the elements of the External Program must be defined in the specific sections of the ExternalPrograms.xml file. For example, the name of the External Program must be defined using the <name> XML tag, and it must be within a <program> section. The following table lists the sections that you must use to define the External Programs:

XML Tags	Parent Tag	Required?	Description
<programs>	NA	Mandatory	Specifies the root element and contains zero or more External Programs (<program>).
<program>	<programs>	Mandatory	Contains the definition of an External Program.
<name>	<program>	Mandatory	Specifies the name by which the External Program is identified. This name appears on the OTP Generator screen.
<file>	<program>	Mandatory	Specifies the name of the script file. See "Creating the Script File" for more information. Note: Do not include the path of the file.
<hidden>	<program>	Optional	Controls whether the window is visible or hidden. By default, this value is set to FALSE, which means the script is rendered using the UI. Note: This command is always run from a terminal window.
<confirm>	<program>	Optional	Controls whether the user is prompted to accept the External Program before running it. By default, this value is set to TRUE, which means the user is prompted to accept the External Program before running it.
<domains>	<program>	Mandatory	Contains a list of <domain> tags.
<domain>	<domains>	Mandatory	Specifies a domain from where the program can be run. You can provide HTTPS and FILE schemes. If the scheme is omitted then the value is considered as HTTPS. Note: The URL of the ArcotID OTP Generator page must match the <domain> tag, else the External Programs cannot be executed.