Administrator

Configuring Agentry Settings

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

Context

If you change settings in a section marked "Affects All Agentry Applications", keep in mind that all Agentry applications are affected.

Procedure

  1. In Management Cockpit, select Start of the navigation path Applications Next navigation step  Next navigation step Configure Next navigation step Application-Specific Settings End of the navigation path.
  2. Under Time Zone Aliases, 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-value pairs, 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, enter Central Standard Time=America/Chicago or UTC+2:00=E. Europe.
  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.
    Property Default Description
    Face Path facePath=sql\custom;sql

    facepath=sql\custom;sql

    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.
    Property Default Description
    Application Globals File Globals.ini Name and location of the globals localization file. You can change this setting if the name of the file is different from the default.
    Application Strings File ApplicationText.ini Name and location of the application strings localization file. You can change this setting if the name of the file is different from the default..
    Client String Names File ClientStringNames.ini Name and location of the client string names localization file. You can change this setting if the name of the file is different from the default. Changes to this property require an application restart.
    Client Strings File ClientText.ini Name of the client strings localization file. You can change this setting if the name of the file is different from the default.
    Development Server N/A Read-only. Whether the application is development or production.
    Enable Failed Transaction Logging True 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.
    Enable Override File Enables.ini 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 False 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 FailedTransactionsQueue Location of the failed transaction queue files. This path is relative to the installation folder of the server.
    Images Path \Application\<Development_or_Production>\Images Location of image files in either the development or production environment.
    Localization Path localizations 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.
    Localizations None 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 semicolons to separate names.
    Scripts Path Application\Development\Scripts 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 None If this value is specified, then the [SpinDoc] configuration is loaded from the named .ini file instead of from Agentry.ini.
    Transmit Configuration File TransmitConfigurations.ini Name and location of the transmit configurations override file. Change this setting if the file name is different from the default.
    Trusted Certificate Store None Location of the trusted certificate store for the server. This store is used only when clients are required to provide authentication certificates during synchronization.
    URL Path 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 Logging (Affects All Agentry Applications), set these logging values:
    Definition Values Description
    Event Log File Valid file name, or path and file name; the default is events.log. The file to which event log items are written. You can change the default to specify a different file name or location. The path can be relative to the server installation folder; or a full path that includes the drive letter. Requires server restart.
    Maximum Log Size Numeric value, in bytes; the default is 0. The maximum size of the log file in bytes. A value of 0 indicates no maximum size. Any other value results in the log file rolling over when the file exceeds the value set here.
    Log Roll Time Time of day in 24-hour clock format (HH:MM); the default is 1:00am. The time at which to roll log files. The server must be running for the files to roll over at the specified time. Requires server restart.
    Log Rolls At Time Enabled or disabled; the default is enabled. Whether to roll the log files based on the time defined in Log Roll Time. Requires server restart.
    Message Log File Valid file name, or path and file name; the default is messages.log. The file to which message log items are written. You can change the default to specify a different file name or location. The path can be relative to the server installation folder; or a full path that includes the drive letter. Requires server restart.
  6. 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.
  7. Under Server (Affects All Agentry Applications), edit administrator contact information and client timeout and notification settings.
    Properties Defaults Descriptions
    Administrator Email admin@yourcompany.com Administrator e-mail address.
    Administrator Name Your Name Here Administrator name.
    Administrator Phone ???-???-???? Telephone number for contacting the administrator.
    Allow Relogin Enabled Whether to allow users to relogin.
    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 Disabled Whether to notify the user on log out.
    Notify User on Shutdown Disabled Whether to notify the user on shut down.
  8. Restart the application if you modified any values that require it.