Show TOC

Configuring Agentry SettingsLocate this document in the navigation structure

Once you upload the Agentry application, you can change the Agentry production definition settings made by the developer, and configure additional Agentry settings. Some settings apply to the current application, and others apply to all applications.


Some of the Agentry settings apply only to the selected application, and other settings apply to all Agentry applications. When you change settings in a section marked "Affects All Agentry Applications", keep in mind that all Agentry applications are affected.
Note The sections that appear and their order vary, depending on how the Agentry application has been developed. The settings that affect all applications are grouped at the end. The Publish and Logging sections are documented separately.


  1. In Management Cockpit, select Start of the navigation path Applications Next navigation step Configure Next navigation step App Specific Settings End of the navigation path.
  2. Under Time Zone Alias, map time zone names on remote systems (client devices and back-end systems) to time zone names on this server. Create a list of key-values, one key-value per line, in the format: "key=value". The keys are the time zone names on the remote systems; the values are the equivalent time zone names for the server's host operating system. For example: Central Standard Time=America/Chicago, or UTC+2:00=E. Europe.
    Note The UTC notation (such as UTC+4:00=Moscow Standard Time) is recommended, especially outside of the United States.
  3. Under SPINDOC, edit the values that are exposed to the Agentry application as variables [Server Data Markup Language (SDML)], and the “Face Path” setting.
    Properties Defaults Descriptions
    Face Path



    The Face Path setting defines the search path used by the SQL back end to locate the query files, which are used for database initialization, authentication, password changes, and so forth; and the SQL script files, which are used for SQL back-end processing. If this setting is missing, there is no default to use, so processing may fail.
  4. Under Configuration, edit settings for the Agentry directory and path location for configuration-related files.
    Properties Defaults Descriptions
    Application Globals File


    Name and location of the globals localization file. This setting can be changed when the name of the file is different than the default.

    Application Strings File


    Name and location of the application strings localization file. This setting can be changed when the name of the file is different than the default.

    Client String Names File


    Name and location of the client string names localization file. This setting can be changed when the name of the file is different than the default. Changes to this property require an application restart.

    Client Strings File


    Name of the client strings localization file. This setting can be changed when the name of this file is different from the default.

    developmentServer N/A Read-only. Whether the application is development or production.
    Enable Failed Transaction Logging


    Whether to enable the failed transaction queue, which is a part of the transaction failure handling functionality. By default, when transaction failure handling is enabled, transactions that fail with a fatal error code result in the creation of a failed transaction file on the server containing the data from that transaction. If this option is set to false, the file is not generated.

    All remaining transaction failure handling behaviors are carried out, including the removal of the failed transaction from the client.
    Note Setting this option to false might result in lost data for fatal errors that are related to transaction processing. This option has no affect if transaction failure handling is disabled (that is, enableTransactionFailureHandling is false.
    Enable Override File


    Name and location of the enables localization file. Change this setting only if the file name is different from the default.

    Enable Transaction Failure Handling


    Whether to enable the transaction failure handling functionality within the Agentry platform. This option must be true for all aspects of this functionality to be enabled.

    Failed Transaction Filename Format

    Server-generated XML file name

    Format of the file name for each failed transaction queue file generated by the server. The format strings %{userid}, %{transaction_name}, %{date}, %{time}, and %{count} may be used. The file generated is always be in XML format, and the file extension provided (.xml) should reflect this content type.

    Failed Transaction Queue


    Location of the failed transaction queue files. This path is relative to the installation folder of the server.

    Images Path


    Location of image files in either the development or production environment.

    Localization Path


    Location of localization files for use in the application. This path is relative to the server’s installation folder. If the default folder “localizations” does not exist, it must be created.



    One or more local names, according to the ISO 639-1 standard. This option lists the supported languages, which also require corresponding override localization files, for an application. Use a semi-colon to separate each name.

    Scripts Path


    If you use an Server Data Markup Language (SDML) tag in the Agentry application that includes content from a file using a relative path, this is the directory under which the file in question needs to be located.

    Spin Doc INI File


    If this value is specified, then the [SpinDoc] configuration is loaded from the named .ini file instead of from Agentry.ini.

    Transmit Configuration File


    Name and location of the transmit configurations override file. Change this setting if the file name is different from the default.

    Trusted CertificateStore


    Location of the trusted certificate store for the server. This store is used only when clients are required to provide authentication certificates during synchronization.

    urlPath None Overrides the path portion of the WebSockets URL (for example, if the URL is https://<server>:8081/<MyApp>, this value overrides <MyApp>, which is the default application name.
  5. Under Agentry (Affects All Agentry Applications), edit Agentry application settings.
    Property Default Description
    Keep Alive Delta 3600 (seconds) Interval during which the server writes something to the various log files, if nothing else has been written during that time period to indicate that the server is not dead. Changes to this property require an application restart.
    Shut Down Wait 15000 (milliseconds) Length of time Agentry waits for all of its threads to exit while shutting down, before it stops them.
    System Name Agentry Name of the Agentry server, which appears in the title bar of the server’s GUI interface on the console. Changes to this property require an application restart.
  6. Under Server (Affects All Agentry Applications), edit administrator contact information and client timeout and notification settings.
    Properties Defaults Descriptions
    Administrator Email Administrator e-mail address.
    Administrator Name Your Name Here Administrator name.
    Administrator Phone ???-???-???? Telephone number for contacting the administrator.
    Allow Region Disabled Whether to allow regions.
    Inactive Timeout 7200 (seconds) Length of time that an idle user can remain connected to the server before the connection is dropped.
    Notify User on Logout Enabled Whether to notify the user on log out.
    Notify User on Shutdown Enabled Whether to notify the user on shut down.
  7. Restart the application if you modified any values that require it.