UC_STATISTIC_OPTIONS - Controlling the Statistics Functions

Settings in Variables

UC_USER_LOGON - Single Logon

---

UC_SYSTEM_SETTINGS - System-Wide Settings

This variable contains settings that apply throughout an entire AE system.

Description

This variable is supplied in client 0000. Its settings apply for the whole AE system and can only be changed in client 0000.

AE monitors all the values that this variable includes. The administrator receives a message if an attempt is made to store an invalid value in this variable. This message is also written to the Automation Engine's log file. The default value is used instead of the invalid value. If the invalid value is a value range, the system uses the maximum value if the specified maximum value is exceeded. The minimum value is used if a value that lies below the minimum value has been found. The variable's contents remain unchanged.

AGENT_COUNT_PER_IP

An agent's license will be checked when it logs on to the Automation Engine system. By default, the system also verifies whether an agent that is already logged in uses the same IP address. If so, the agent that has newly logged on does not require a separate license.

Checking numerous agents (approx. 1,000) can increase the time that it takes to log on to the system. For this reason, you can also deactivate the IP address check by using the setting AGENT_COUNT_PER_IP.

Every agent that logs on requires its own license when you deactivate this check. Whether or not the IP address has already been used is irrelevant in this case.

 AGENT_LOG_CHANGE_PER_MINUTE
The more agents an AE system contains, the higher the chance is that log-file changes are required for a large number of agents at the same time. Use the setting AGENT_LOG_CHANGE_PER_MINUTE to improve system performance by limiting the number of log files to be changed per minute. 

AGENTGROUP_CHECK_INTERVAL
Tasks such as jobs or file transfers can run within an agent group. The task's status changes to "Waiting for Host" if no agent is available that is part of this agent group. The setting AGENTGROUP_CHECK_INTERVAL defines the interval at which the system checks whether a particular agent is active, and if so, it initiates the start for the waiting tasks.

The value for this setting should not lie below the interval at which the agent attempts to establish a connection to the AE system. This value can be specified with the option RECONNECT_TIME in the variable UC_HOSTCHAR_DEFAULT.

BACKENDVAR_MAX_ROWS

This setting determines the maximum number of lines that BACKEND-type VARA objects can return.

Note that selecting a high value can result in a longer time taken to resolve backend-type variables. 

CHANGE_LOGGING_DAYS and CHANGE_LOGGING_MB
These files can be changed on a time- and size-dependent basis in order to ensure that the log files can be handled smoothly during high workload times for Automation Engines and agents. You can also archive and reorganize this data in the AE database, although the Automation Engine and the agents are active for several months without interruption in the best case.

You can also specify temporary log-file changes in the Properties tab in the System Overview. Here, you can directly specify server settings for the log-file change of work processes. These modifications are valid until the system reboots. Use the script element CHANGE_LOGGING in order to trigger a forced log-file change.

To avoid endless reports for events, RemoteTaskManagers, Sync objects, and Schedule objects, their reports are also changed and a new statistical record begins. In this case, only the setting of CHANGE_LOGGING_DAYS is relevant.

CHANGE_LOGGING_MB only works if the setting LOG_TO_DATABASE is set to the value Y. For the Automation Engine, define this setting in the variable UC_SYSTEM_SETTINGS, and for agents, use UC_HOSTCHAR_DEFAULT. CHANGE_LOGGING_DAYS does not depend on this option.

The log files of all work processes are automatically changed if the logging of a work process (WP, DWP, PWP) changes.

The logging of tasks that start on a recurring basis is changed on a daily basis or if the period settings are modified.

CONDITION_CHECK_INTERVAL
The Preconditions tab, which is available in the properties of workflows, can be used to define conditions and statements. These are regularly checked and executed before the tasks start. This process (evaluation cycle) is repeated until the last start time or a final statement has been reached. Use this key to change the time interval. By default, an evaluation takes place every 60 seconds.

DEFAULT_REPORT_SCAN_MEMORY and MAX_REPORT_SCAN_MEMORY
Use DEFAULT_REPORT_SCAN_MEMORY to define the memory size to be requested in order to read reports using a Filter object. The Automation Engine doubles this size if the report to be read is larger. For complex reports, the memory is doubled until the value specified in MAX_REPORT_SCAN_MEMORY has been reached. The task ends with the status FAULT_OTHER if this value is exceeded.

Example:

A report has a size of 10 MB, the default memory is 3 MB, the maximum is 30 MB.

The Automation Engine recognizes that 3 MB is not sufficient to read the report and increases the memory: 3 MB -> 6 MB -> 12 MB. The maximum value for memory has not been exceeded and the report can now be read.

DELETE_CHECKBACK_LIMIT
When you delete an object, the system automatically checks back if this object is also used in other objects. The process as a whole can take a little longer than usual when many objects are deleted simultaneously. Use the key DELETE_CHECKBCK_LIMIT in order to have a query displayed starting with the specified object number, letting you determine whether the usage in other objects should be checked.

DISABLE_USER_HEADER
Job runs also consider Headers and Trailers. These special objects are available in system client 0000 and can be used to call user-defined Include objects. More detailed information is available in the documentation about job includes. If user-defined Include objects should not be used, you can either specify particular platforms or *ALL. Resultantly, these Include objects are not searched, which avoids unnecessary database accesses and improves performance.

Example:

ERT_ADAPTIVE_JWP_TIMEOUT

A Java-based work process (JWP) calculates the adaptive expected runtime. If there is no JWP, the ERP cannot be calculated by using this adaptive method.

Use the setting ERT_ADAPTIVE_JWP in order to determine the time in seconds after a system start that the system spends waiting for the adaptive ERT calculations until a JWP is active. After this period of time and when there still is no JWP, the system uses the alternative ERT calculation method which is specified with the setting ERT_ADAPTIVE_FALLBACK_METHOD (UC_CLIENT_SETTINGS).

If the JWP becomes available at a later point, the system will apply the adaptive ERT calculation again.

Note that this setting is only relevant when you intend to calculate the ERT by using the "adaptive" calculation method.

At least one active JWP is needed for the adaptive ERT calculation method.

EXECUTE_ON_EXCEPTION
By default, invalid messages which cause a server process to crash are put into quarantine. Use this key to define that an object should start if such a message is sent. Enter its name as the relevant value.

Note that the object is searched and activated in all clients. System client 0000 is exempted because no objects can be activated in it.

EXTERNAL_CHECK_INTERVAL
This setting determines the frequency at which the status of external dependencies is checked in workflows. The workflow first checks its external dependencies when it starts. The task automatically reports its status when it has ended.

GENERIC_ACTIVITIES_LIMIT
Depending on the specified filter settings, the Activity Window displays the corresponding tasks. If it contains numerous active tasks, performance is affected negatively because refreshing the Activity Window at short intervals is very CPU-intensive. Therefore, you can limit the maximum number of activities to be displayed using the entry GENERIC_ACTIVITIES_LIMIT. A message in the Activity Window's status line indicates that there are more active tasks than displayed. Limit the Activity Window filter so that non-displayed tasks can also be viewed.

GENERIC_AUTO_FORECAST_LIMIT
Auto Forecast filter criteria are very complex. The entry GENERIC_AUTO_FORECAST_LIMIT can be used to limit the maximum number of search results.

GENERIC_SEARCH_LIMIT
In the Explorer, you can search for objects or particular folders. Include the various options in your search. Complex selection criteria can result in a large amount of results and cause long searching times. Therefore, Automic recommends limiting the number of results to be displayed with the entry GENERIC_SEARCH_LIMIT. If the search result is above the value defined here, a message is displayed and only the specified maximum number of results is output.

GENERIC_STATISTICS_LIMIT
Statistical records are automatically created when objects are processed. Selective statistics can be used to search for objects using various options. Complex selection criteria can result in a large amount of results and cause long searching times. To specify a maximum number of records to be displayed, use the entry GENERIC_STATISTICS_LIMIT. A message is displayed if the search result exceeds the value defined here.

GET_PROCESS_LINE_RTRIM
The script functionGET_PROCESS_LINE reads a line of a data sequence (such as a report). Use the entry GET_PROCESS_LINE_RTRIM to determine whether blanks used at the end of the line should be truncated.

LAST_USE
The Header tab of each object contains information about the object's creation and last modification time. It is also possible to display the date of its last use and the total number of executions. The entry in LAST_USE indicates the time in minutes since the last refresh. Executions are not counted if no value or 0 has been specified.

LDAP
LDAP can be used to query information from a directory service such as the Microsoft Active Directory. Users logging in to the AE system can authenticate themselves using this directory service.

LOG_TO_DATABASE
This setting can be used to determine whether the Automation Engine also writes log-file messages to the AE database. Value Y indicates that log messages are saved in the Server object's report. Value N indicates that logging is only performed in the log file. This setting improves the performance of your AE system.

The variable UC_HOSTCHAR_DEFAULT contains a setting of the same name which can be used to specify the agent's log behavior.

MAX_EXPORT_COUNT
During the exporting process, information about the objects highlighted in the Explorer (name, attributes, etc...) is written to a common XML file. To limit the maximum number of objects that can be exported at the same time, use the entry MAX_EXPORT_COUNT. Exceeding this value means that the process has failed. A corresponding error message indicates this.

MAX_IMPORT_SIZE
Use this entry to limit the maximum size of an XML file which should be imported. The import does not take place if the file exceeds the specified value.

MIN_EVENT_INTERVAL
For each event, you can specify a minimum interval (minutes) for its execution in the corresponding Event tab. To define a lower limit, use the entry MIN_EVENT_INTERVAL. The interval specified here is applied if an event contains a value below this limit. AE uses the value specified in the variable UC_JOB_CHECKINTERVAL if 0 is entered here.

MQA_COUNT_BACK 

Use this key to define the maximum number of server messages to be buffered for further analysis. Only messages which have been sent or received by work processes (PWP, DWP, WP) are affected. These messages are saved in the random access memory (RAM) of the computer on which the Automation Engine is running.

Open the latest messages that have been buffered via the System Overview -> Automation Engine section. Here, select the Workload menu item in a WP's context menu.

MQ_BLOCK_COUNT and MQ_CHECK_TIME
In Oracle databases, the Automation Engine checks the block size of the message queues MQPWP, MQWP, MQDWP, MWRWP, MQOWP and MQCPnnn at the interval specified in MQ_CHECK_TIME . If the block size exceeds the value specified in MQ_BLOCK_COUNT, the Automation Engine reorganizes the message queue, improving the performance of your AE system.

PASSWORD_EXIT
This entry facilitates a password exit. The value to be specified is the name and path of the generated program library.
Example: PASSWORD_EXIT c:\AUTOMIC\pwexit\bin\xuc4pass.dll

PASSWORD_EXIT_PARAM
If parameters need to be assigned, do so using the PASSWORD_EXIT_PARAM key.

PASSWORD_CHANGE
Use this key to define whether the password can be changed.
Example: PASSWORD_CHANGE NO

RECONNECT_TIME

This entry specifies a time interval during which the server processes try to establish a connection. This affects the connection attempts for a restart or after a lost connection.

REPORT_BLKSIZE and REPORT_TIME

Use these entries to determine the report size in bytes. You can also specify the interval (seconds) at which the report will be refreshed.

RESERVED_API_USERS
Every user who uses the CallAPI needs a free dialog license. These dialog licenses are shared with the users who log in to AE via the UserInterface. The number of dialog licenses specified here is reserved for CallAPI users. In doing so, the CallAPI cannot be blocked due to a lack of free dialog licenses.

Example: "5" is entered in the variable and there are 20 licenses available for the dialog. No further logins would be allowed after the fifteenth login via the UserInterface. It is possible for five additional users to log in to the Automation Engine via the CallAPI. If there are enough available dialog licenses, more users than defined here can use the CallAPI at the same time.

Logging in to system client 0000 is possible even if all dialog licenses are in use. The administrator can always log in to the AE system.

SCR_LOOPCHK_TIME
This setting affects scripts whose generation takes longer than specified here. In such cases, script generation repeatedly pauses for in order to avoid unnecessary Automation Engine loads. Use this method to avoid endless loops.

Use SCR_LOOPCHK_TIME to define the frequency at which the script is interrupted. The subsequent waiting time is always 1 second at the start. This time is doubled after every interruption. The longest waiting time is 128 seconds. After this value has been reached, the waiting time is always 128. It is no longer doubled.

Example for SCR_LOOPCHK_TIME 3:

Script generation always stops every 5 seconds, regardless of the value specified in SCR_LOOPCHK_TIME. Doing so ensures that the script can be canceled without blocking other tasks. A higher value for SCR_LOOPCH_TIME affects the waiting time interval (see above).

SERVER_OPTIONS
This key can be used to handle server settings regarding performance improvements and trace outputs. Its value is composed of a 15-digit string with each digit representing a particular server setting. These values can be read using the script function GET_UC_SETTING.

Activate the particular settings by inserting the respective letters in the relevant positions. The character N is used to deactivate a server option. By default, all Server options are deactivated (NNNNNNNNNNNNNNN).

In the example shown below, options 1, 2, 6 and 8 are activated:

 SMGR_PORT_RANGE

If a ServiceManager is used, you can execute its actions directly via the AE system. The relevant commands can either be called directly from the System Overview (Agents / AutomationEngine) or via the script element MODIFY_SYSTEM.

This key can be used to specify the port number or a port area for the automatic search for ServiceManager instances. Doing so is only required if the ServiceManager does not run on the default port 8871.

The system automatically searches for a ServiceManager when the server processes start for the first time. Subsequently, this search must be executed manually using the "Refresh ServiceManager Scan" command in the System Overview. You can also specify the connection settings for the ServiceManager manually in the agent or Server object.

You can specify a port area by separating the start and end port by a comma. This area must not exceed 10 port numbers. Enclose the value in parentheses ( ) in this case.

For example: (8871, 8873)

SNMP_REFRESH

Use this setting to define the interval at which the display for the blocked workflows for SNMP is refreshed. The default value is 10 seconds.

SQLVAR_INTERNAL

By default, the creation of Variable objects of the type "SQL - internal" / "SQL - internal SECURE" is deactivated. This is due to security reasons, as the execution of SQL statements on the AE database enables system-wide access to objects and other data. Important data records can also be modified or deleted.

Set SQLVAR_INTERNAL to the value YES in order to create, edit, and use internal SQL variables on a system-wide basis. To do so, a user must have the "Create and modify SQL-Internal variables" privilege.

NO has the effect that the objects cannot be created anymore. The variable type SQLI is no longer listed in the Templates dialog (new object).

The internal SQL variables that are supplied by default in client 0 are not affected by this setting and can always be used.

SQLVAR_MAX_ROWS

Databases often supply huge amounts of data. Therefore, you can limit the number of lines to be retrieved by Variable objects with the source SQL and SQLI. Specifying a very high value has the effect that it takes correspondingly longer to resolve Variable objects.

This setting does not have any effect on variables of the types Filelist and Multi.

SYNC_BLOCK_COUNT

For performance reasons, log-file changes of Sync objects are performed by block. This means that the log files of a specified number of Sync objects are changed. The log files of the remaining Sync objects are changed in the next blocks.

This setting can be used to determine the number of Sync objects whose logs are to be changed per block. The lower the value, the longer the process will take as a whole. However, a value that is too high can negatively affect the performance of the AutomationEngine.

TRASHBIN_SHOW_MAX
The value that is specified here determines the maximum number of objects to be shown in the Recycle Bin. The current date serves as the basis for this, i.e., the last n objects are visible.

UNREAD_MESSAGES and UNREAD_MESSAGES_BUFFER
The setting here determines the further handling of administrator messages which occur during operation without a user being logged in with the privilege to view them. "N" means that the messages are written to the database without being displayed again. In this case, use the category messages in the System Overview to view these messages at a later point. "Y" indicates that messages are kept and displayed in the Message Window for the next user with a suitable privilege.

Use the UNREAD_MESSAGE_BUFFER to determine the number of unread messages to be kept. The oldest entry will be overwritten once the number of messages is exceeded.

When the Message Window has displayed its unread entries to a user, these are marked as read and removed from the input buffer.

Note that unread messages are lost when:

• the AE system reboots
• the primary work process is changed
• messages are re-organized with the utility AE DB Reorg.

Messages are always written to the database. Activating this function causes unread entries to be highlighted so that they can be displayed in the Message Window at a later point in time.

VAR_SECURITY_LEVEL

You can use this key to determine whether variables can be used in VARA objects, and which ones. 

This affects the replacement procedure of variables that are used within SQL statements (VARA types: SQL and SQLI) and OS commands (VARA type: Backend).

The documentation about the dynamic PromptSet dialogs describes the positions where PromptSet variables can be replaced (security level 3).

The following table lists the variables and the security levels at which they are replaced:

Security level	Variables
	Predefined variables (User cannot directly change the value)	Predefined variables (User can change the value)	Placeholder for VARA objects	PromptSet variables
0
1
2
3

The security levels of all predefined variables are provided here.

Note for security level 3: You can execute all SQL statements and OS commands that are included in the value to be inserted in the specified Variable object.

A script is used to change the content of the variable VARA2 whose value will be inserted in the SQL statement:
:PUT_VAR VARA2, '*', 'Value; DELETE * FROM x;'

An additional SQL command has been inserted in the SQL variable VARA1 (value replacement) because the content of the Variable object VARA2 has been changed. This was possible although VARA1 has not directly been changed (for example by a user without the corresponding rights) and can also lead to unintended database accesses (in this case: the deletion of data).

The setting VAR_SECURITY_LEVEL has no effect if you access Variable objects of client 0. In this case, they can always be used.

VARIABLE_SERVICE_CHECK_INTERVAL
Dynamic variables can either be used as predefined variables or via script elements in objects. Their values are dynamically retrieved from the data source (database, Variable object or file-system directory) at runtime. If the database variable (source: SQL) runs into an error while resolving the variable because the database is not available or due to incorrect connection or login data, the task switches to a waiting condition ("Waiting for continuation of variable resolving").

Variable resolving can be repeated as soon as the particular error has been cleared (for example, the database name in the connection object has been corrected). The interval at which this attempt is to be repeated is specified by the setting VARIABLE_SERVICE_CHECK_INTERVAL.

Note that you cannot cancel tasks that are in the condition "Waiting for continuation of variable resolving".

VERSIONS_SHOW_MAX
The value that is specified here determines the maximum number of objects to be shown in Version Management. The current date serves as the basis for this, i.e., the last n objects are visible.

WORKLOAD_DEFAULT_FT and WORKLOAD_DEFAULT_JOB
These two settings determine the resources a file transfer or job uses by default. This value can be individually specified in the corresponding objects and overrides the default value specified in the variable.

WP_MIN_NUMBER
Extra server processes (DWPs) are available for messages sent to the database by UserInterfaces. These are special types of work processes (WP). Specify the number of server processes to act as work processes using the entry WP_MIN_NUMBER. The remaining processes can be used as dialog processes (DWP).

Note that the primary work process (PWP) is not included.

Define a node name in the Automation Engines' INI files, as server processes can be distributed among several computers. The minimum number of work processes is valid per "node name". If you use the same "node name" on different computers, this setting is valid for the network.

Your AE system can also run without dialog processes.

XML_ENCODING and XML_ENCODING_CHECK
The XML encoding influences the display of characters in the UserInterface. Use the key XML_ENCODING to specify the encoding to be used for your AE system. The second key affects the verification of imported XML files.

ISO-8859-15 (Latin 9) contains the Euro (€) character and Western-European country-specific special characters. The table below lists additional differences:

OBJECT_ACCESS_CLIENT_ZERO
Setting this key's flag to Y allows users to access system client objects in READ ONLY mode. By using the context menu in a Script object or the UserInterface you can open those objects in READ ONLY mode to check their reports or statistics.

Also see:

UC_CLIENT_SETTINGS
Overview of all the variables in table format
Variable