This variable is used to define the settings of one or more agents.
For file transfer settings, the FT Protocol column indicates whether the settings apply for the old and/or the new protocol.
The variable is supplied with the system client 0000. Its settings are valid for the entire AE system and can only be changed from within system client 0000.
The standard host characteristics variable UC_HOSTCHAR_DEFAULT is supplied in the HOST_VARIABLES folder. It is valid for all agents. If an agent uses a different configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied., you can create individual variables that contain any term except for the term DEFAULT.
Agents are assigned to host characteristics in the variable UC_EX_HOSTCHAR.
Key |
Value |
New start required |
FT protocol | ||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ANONYMOUS_FE |
Influences usage of login data for the execution of jobs, FileSystem Events and file transfers. This setting is only supported for OS/400, z/OS, UNIX and Windows agents. The Key ANONYMOUS_FE is not supported on z/OS systems.
Allowed values: Y and N (default) Regardless of the settings that are defined here, the Automation Engine system always checks at the beginning of a job's execution, whether a Login object is available including an entry for the particular platform. If there is no corresponding entry, the job aborts. This setting can be used to define whether the login data that is stored in the Login object should be used to execute jobs, FileSystem Events and file transfers. The behavior also depends on the settings that are defined in the following INI-file parameters of the agent:
For file transfers, the following privilege setting in the User object is decisive: For FileSystem Events the corresponding privilege is decisive: |
Agent | Old and new | ||||||||||||||||||||||||||||||||||||||
APPLICATION_LOGIN |
The name of a Login object. The login data of the Login object is used for:
Default value: ERP_LOGIN |
Agent |
|||||||||||||||||||||||||||||||||||||||
BACKUP_RETENTION_CHECK |
The time at which the backup folder's lifetime will be checked. All files and directories that have been stored longer than is specified in BACKUP_RETENTION_LIFETIME will be deleted. The backup folder stores the files of the file rollback of jobs and file transfers. You can define the backup folder using the Agent variable UC_EX_PATH_BACKUP in the agent's INI file. In the Rollback tab, you can specify the files that should be copied to the backup folder. They are stored automatically when a Job object or FileTransfer object is processed. Only affects Windows and Unix agents. Allowed values: Valid time in the format HH:MM |
Agent | |||||||||||||||||||||||||||||||||||||||
BACKUP_RETENTION_LIFETIME |
The life time in days for the content of the backup folder. In this key, you can determine how long files and directories will be stored in the backup folder. The system checks this setting daily at the time that is specified in BACKUP_RETENTION_CHECK. All files and directories that have been stored in the backup folder for more than the specified days will be deleted. Only affects Windows and Unix agents. Allowed values: "0" - "99" |
Agent | |||||||||||||||||||||||||||||||||||||||
BLOCK_ON_LOST |
This entry can be used to define the action that a workflow should take if one of its jobs changes its status to ENDED_LOST. Allowed values: YES (default value) and NO YES - The workflow blocks. |
No |
|||||||||||||||||||||||||||||||||||||||
DISCONNECT_AFTER_FT |
This defines whether the connection between the agents ends after a file transfer. YES - The connection ends after the file transfer (default value). This parameter only affects the connection but not the execution of the file transfer. The system always checks whether there is a connection to the destination agent BEFORE the file transfer starts. A connection is established if it is not available. In the 32-bit UNIX agent for SunSolaris, the number of filter descriptors (open connections and files) is limited to 253. Keep this in mind when you execute jobs / file transfers and when you use the setting DISCONNECT_AFTER_FT = "NO". Automic recommends using the value "YES". This setting is only checked if you use the old file transfer protocol. Using the new protocol means that the connection is always automatically terminated. |
Agent |
Old | ||||||||||||||||||||||||||||||||||||||
EVENT_CHECKINTERVAL |
The time interval in seconds during which the agent checks the conditions FILE_CHANGED and FILE_STABLE in its FileSystem events. Allowed values: 60 - 100000 If you select FILE_CHANGED or FILE_STABLE in a FileSystem event, this interval is used for all condition checks. The interval increases automatically if checking a condition takes longer than the specified interval. |
Agent | |||||||||||||||||||||||||||||||||||||||
EXECUTE_ON_ASSIGNMENT |
You can use these keys to start any executable object in the following situations. If the agent starts and ends:
For tasks with undefined ends:
If you change an agent's client rights:
Default value: No object starts. The object is searched and activated in all objects in which the agent is authorized to do so. System client 0000 is exempted, objects must not be activated in it. EXECUTE_ON_ASSIGNMENT searches all clients in which an authorization has been changed. The object starts under the user UC/UC which is available in system client 0000. Therefore, do not assign authorizations at the object level. The object that is defined here for agents should wait the time specified in RECONNECT_TIME using the script statement :WAIT. Afterwards you can use SYS_HOST_ALIVE in order to verify whether the agent has logged on again and react accordingly. Note that EXECUTE_ON_START and EXECUTE_ON_END can be used by the object to read the script variable &uc_ex_host from the read buffer. This variable contains the name of the agent and can be used in the object's script. For example: :READ &uc_ex_host,, EXECUTE_ON_ASSIGNMENT can be used to read the following variables:
|
Agent |
|||||||||||||||||||||||||||||||||||||||
FE_VERSION |
Sets the version of the file event functionality of the AE system, which determines the capabilities of the system's agents. Allowed values: "1" or "2" Default value: "2" In order to execute a FileSystem Event object with a UNIX agent under a different user specified in a Login object, this key has to be set to "2". |
||||||||||||||||||||||||||||||||||||||||
FT_ASYNC_QUIT_MAX, FT_ASYNC_QUIT_MIN, FT_ASYNC_QUIT_NUM |
The settings for synchronous / asynchronous transfers between a sending and a receiving agent of file transfers. Asynchronous transfers are the default setting. Synchronous transfer: Data packages are only sent when the receipt of sent packages has been confirmed. Sender and receiver adjust their transmission speeds. A synchronous behavior is achieved when the setting FT_ASYNC_QUIT_NUM equals FT_ASYNC_QUIT_MAX. Asynchronous transfer: Data packages are sent although confirmations are still missing for sent packages. In doing so, data can be transferred faster because a faster sender or a slower connection are used more efficiently. The agents' TCP/IP buffer (INI-file parameter: SendBufferSize= and RecvBufferSize=) should be increased accordingly.
The higher the value of FT_ASYNC_QUIT_MIN, the more the receiving agent will be unburdened when FT_ASYNC_QUIT_MAX has been reached. These options are only effective in OS/400, NSK, UNIX, Windows and z/OS agents. FT_ASYNC_QUIT_MAX FT_ASYNC_QUIT_MIN FT_ASYNC_QUIT_NUM Note that the value that is specified as the MIN setting must not exceed the MAX setting. For example: FT_ASYNC_QUIT_MIN / MAX / NUM: |
No | New | ||||||||||||||||||||||||||||||||||||||
FT_COMPRESS |
The compression type for file transfers. Allowed values: NO (default value) and NORMAL |
Agent |
Old and new | ||||||||||||||||||||||||||||||||||||||
FT_CONNECTION_TIMEOUT |
The duration in seconds after which an unused file transfer connection between two agents is automatically terminated. Default value: 300 seconds Automic recommends increasing this setting's default value (5 min) if you transfer huge files (> 3,8 GB) from NSK. Otherwise, the connection could end prematurely. |
Agent | New | ||||||||||||||||||||||||||||||||||||||
FT_REPORT_TIME |
Time interval in seconds in which the agent sends report blocks. Minimum value: 1 |
Agent | New | ||||||||||||||||||||||||||||||||||||||
FT_RESTARTINFO_CHECK |
The time in UTC at which the life time of file transfer restart information is checked. It is checked on a daily basis. This restart information is stored locally in the agents temp directory in the form of StatusStore files (ending *.sts). These files are deleted after the life time that has been specified using the key FT_RESTARTINFO_LIFETIME . Default value: 0:00:00 |
Agent | New | ||||||||||||||||||||||||||||||||||||||
FT_RESTARTINFO_LIFETIME |
The number of days the restart information of file transfers is stored (life time). Minimum value: 1 |
Agent | New | ||||||||||||||||||||||||||||||||||||||
FT_RESTARTINFO_INTERVAL |
The time interval in seconds in which the agents store the restart points during a file transfer. Minimum value: 1 |
Agent | New | ||||||||||||||||||||||||||||||||||||||
FT_STATUS_INTERVAL |
The time interval in seconds in which the agents send the status information of file transfers to the Server. The status of file transfers is displayed in the task's detail window. Minimum value: 1
|
Agent | New | ||||||||||||||||||||||||||||||||||||||
FT_USE_MD5 |
MD5 checksum usage that allows for the files that have been transferred in file transfers to be checked. This method ensures that the transferred files comply with the source files if the file transfer is restarted. For performance reasons, the MD5 checksum is not calculated for files that are smaller than 1MB. This behavior is always valid, regardless of the definitions that have been made in this setting. Allowed values: Y (default value) and N |
Agent | New | ||||||||||||||||||||||||||||||||||||||
JOB_CHECKINTERVAL |
Job execution is periodically checked by the agents. You define the time interval for this check in this entry. Minimum value: 1 There is no upper limit for this setting. The default value is used if 0 is defined. You may reduce this interval to less than 60 seconds, in case the check for job statuses shall be executed in shorter intervals. |
Agent |
|||||||||||||||||||||||||||||||||||||||
KEEP_ALIVE |
The time interval for the periodic Automation Engine check. Allowed values: 60 and above The value that is defined here must not be less than 60 seconds. Otherwise, the default value is used. The specified value must also result in complete minutes (such as 60, 120, 180). If you use a different value, it is rounded up to the next minute (for example, a value of 99 seconds results in 120 seconds). A fixed value of 60 seconds is always added to the specified value. Therefore, the actual minimum is 120 seconds. The System Overview always displays the value that has been set by using KEEP_ALIVE. (see also: System Overview) |
Agent |
|||||||||||||||||||||||||||||||||||||||
LOG_TO_DATABASE |
This stores agent logs to the AE databaseA database is an organized collection of data including relevant data structures.. Allowed values: Y (default value) and N Y - The agent sends its log-file messages also to the Automation Engine which stores it in the Agent object's report. |
Agent | |||||||||||||||||||||||||||||||||||||||
MAX_FILE_COUNT |
The maximum number of files that should be retrieved in FileSystem events. Allowed values: 0 - 100000 0 - The number of files to be found is not limited. If wildcard characters are used or sub-directories are included in the search, a file can be found several times. For performance reasons, you can specify a maximum number of files that should be found. For example: 100 files The agent only checks in the first 100 found files whether the specified condition applies and, if applicable, triggers !Process. |
Agent | |||||||||||||||||||||||||||||||||||||||
MAX_REPORT_SIZE |
This entry contains the maximum number of report blocks that should be transferred to the AE database. Allowed values: 1 - 10000 The key REPORT_BLKSIZE can be used to specify the maximum number of bytes used in a block. For example: Block size: 8000 bytes This definition results in a maximum report size of 937 KB. Define whether the agent should store the report in the AE database and/or in a file in the host-specific tabs of jobs. The report is truncated and stored to the database if it exceeds the maximum specified number of blocks. If only the option "Job report" - "Database" has been selected, the file is deleted on the agent computer after it has successfully been transferred. An incomplete report is stored in the database if it exceeds the maximum number of blocks. The specification that has been made in MAX_REPORT_SIZE is not considered when the job report is stored as a file. In this case, the complete report is stored in the file system. (see also: System Overview) |
Agent |
|||||||||||||||||||||||||||||||||||||||
This entry defines the time interval during which the agent tries to establish a connection. This refers to the establishment of a connection in case of a restart or when the connection has been ended. Allowed values: 1 - 3600 This setting has a different impact on the Windows and OS/400 agents. These two platform agents always only after the RECONNECT _TIME will try to reconnect. |
Agent |
||||||||||||||||||||||||||||||||||||||||
REPORT_BLKSIZE |
This entry contains the size of a report block. Allowed values: 1 - 8000 |
Agent |
|||||||||||||||||||||||||||||||||||||||
REPORT_TIME |
You use REPORT_TIME to set the time interval during which the agent sends the logging to the AE system. Allowed values: 1 - 3600 |
Agent |
|||||||||||||||||||||||||||||||||||||||
VAR_TIMEOUT |
The maximum time in seconds for resolving Variables objects with the sources BACKEND and SQL. Backend variables run a command on an OS (such as Windows or UNIX) and supply the result as values. SQL variables process SQLcommand on an external database and return its results. Allowed values: 1 to 600 |
Agent | |||||||||||||||||||||||||||||||||||||||
WORKLOAD_MAX_FT |
The maximum number of resources that the agent provides for file transfers. Allowed values: -1 to 100000 The value -1 corresponds to UNLIMITED which means that the resource settings are ignored when the file transfer is processed. Values above 100000 are read as -1. The value for WORKLOAD_MAX_FT can also temporarily be set in the System Overview. |
No | |||||||||||||||||||||||||||||||||||||||
WORKLOAD_MAX_JOB |
The maximum number of resources that the agent provides for jobs. Allowed values: -1 to 100000 The value -1 corresponds to "UNLIMITED", which means that resource settings are ignored when the job is processed. Values above 100000 are read as -1. The value for WORKLOAD_MAX_JOB can also temporarily be set in the System Overview. |
Agent |
See also:
Overview of all variables in Table Form
Variable