Predefined server variables

TotalAgility provides some predefined server variables.

To view the list of predefined server variables, do the following:

On the main menu, select System data > Server variables. The Server variables page appears.
On the Category list, select System Category. The list of predefined server variables is displayed.

The following table describes the system server variables.

Name	Type	Description
AD_CHASE_REFERRAL	Bool	If this variable is set to True, then even a resource existing elsewhere in the AD structure but is a member of the group you are syncing, is imported. (Default: False) The import only works if Chase Referral is also enabled within AD itself. The AD_CHASE_REFERRAL is useful when importing cross-domain resources.
AD_DEACTIVATE_USER	Bool	Active Directory synchronization tries to delete users from TotalAgility when corresponding users are deleted from the active directory. If the deletion of the user fails for any reason, such as the user is currently logged in or assigned to a live activity, the AD_DEACTIVATE_USER setting controls what happens next. If False (default), the Active Directory synchronization process logs an error attempting to delete the user. The process is then routed to a review activity (along with any other synchronization errors) for an administrator to review. The administrator may re-process any failures by taking corrective action such as forcibly logging out the target user. If True, the user that could not be deleted is deactivated with no further access to the TotalAgility platform. In this case, the Active Directory synchronization process does not record an error or route it for review.
AD_EMAIL_ADMINISTRATOR	String	Email address of the user or group who is notified of critical errors, such as "Admin@sampleemail.com".
AD_EMAIL_CONTENT_CRITICAL	String	Content of the critical error in the email, such as "There has been a critical error syncing with Active Directory. Error returned was:".
AD_EMAIL_CONTENT_ERRORS	String	Content of the soft errors (not critical) in the email, such as, "Some Errors have occurred while syncing with Active Directory, please visit the link below to view these:"
AD_EMAIL_SUBJECT_CRITICAL	String	Subject of the critical error in the email, such as "Critical Error Syncing Active Directory".
AD_EMAIL_SUBJECT_ERRORS	String	Subject of the soft errors in the email, such as, "There were errors during the sync with Active Directory."
AD_LAST_USNCHANGED	String	Every change within Active Directory gets a unique incrementing change number (USN). This number is stored in TotalAgility in the AD_LAST_USNCHANGED server variable. This variable is used by the Active Directory Synchronization activity and a value of 0 ensures that full synchronization of all data is complete. The latest USN is then updated to the AD_LAST_USNCHANGED server variable. Subsequent synchronization only checks for changes since the last USN number. This is the routine synchronization for the system. For full synchronization, you can manually reset the AD_LAST_USNCHANGED server variable to 0 and execute a new job on the SYSTEM Active Directory Synchronization map.
AD_PASSWORD	String	Password for the account to connect to your Active Directory server.
AD_PORT	Long	The port used for LDAP or LDAPS protocol. If the port is not specified, the default port 389 or 636 is used for the respective LDAP or LDAPS.
AD_SECURITY_LEVEL	Short	The TotalAgility security level of the TotalAgility defined resource required to complete the activity. If the security level is 10 (default), TotalAgility resources with any security level can complete the activity. If the security level is one, only TotalAgility resources with the highest level of security can complete the activity.
AD_SERVERNAME	String	Machine name of your Active Directory server. TotalAgility only uses Server Name and OU combinations in the AD_SERVERNAME variable.
AD_SERVERNAME_CN	String	A specific group level where the AD is synchronized. This means that only those resources which are members of this group are synchronized. These variable names are case sensitive; if you do not enter the values the same as they are created within Active Directory, the job suspends and reports an error such as "Parameter is Incorrect" or "Parameter is not Found".
AD_USE_SECURED_CONNECTION	Bool	Indicates whether SSL can be used over LDAP when synchronizing TotalAgility with the Active Directory server. (Default: False)
AD_USERNAME	String	A valid Active Directory account to connect to your Active Directory server. ad_username must have appropriate user rights on the items being synchronized in Active Directory to extract the relevant information from Active Directory. The username with more than 56 characters is truncated.
LIMITED_USER_SESSION_ID	System	LIMITED_USER_SESSION_ID is like the System session ID but just for limited users. You set this at runtime as you do for the System session ID system server variable.
SKILL_LEVEL_SETTINGS	Short	The skill level of the TotalAgility-defined resource required to take and complete the activity.
SPP_SMTP_SERVER	String	Email server (SMTP) name used to send emails. (Default: localhost)
SPP_SYSTEM_SESSION_ID	System	A unique system session ID for each installation of TotalAgility that allows execution of any secure SDK call. It is used by all system processes to make a call to SDK API.
SYSTEM_EMAIL_FROM	String	Holds a valid email address for the system account sending the mail to the administrator.
USE_DESIGNTIME_RESOURCES	Bool	Indicates whether to use the design time resources. It is used by the SYSTEM Perform Auto Work Allocation system map to perform work allocation.