UC_SYSTEM_SETTINGS - Systemwide Settings

This predefined system Variable (VARA) object is supplied in Client 0 and contains settings that apply throughout an entire Automation Engine system. This variable object can only be changed in Client 0.

The Automation Engine monitors all the values that are included in this variable. As a system administrator, you receive a message every time a user attempts to store an invalid value in this variable. This message is also written to the log file of the Automation Engine. If an invalid value is used, the system uses the default value instead. If the invalid value is a range and the specified maximum value is exceeded, the system uses the maximum value. The minimum value is used if a value that lies below the minimum value is found. The variable's contents remain unchanged.

The VARA object UC_SYSTEM_SETTINGS includes the following variables:

  • ACTIVITIES_LIMIT Parameters

    • COMBINED_ACTIVITIES_LIMIT

      Specifies the maximum number of tasks to be displayed on the task list.

      • Default value: 500

      • Restart required: No

    • GENERIC_ACTIVITIES_LIMIT

      Defines the number of tasks returned by the Automation Engine that will be available for requests on the task list.

      • Allowed values: 0 to 20000

      • Default value: 5000

      • Restart required: No

  • AGENT Parameters

    Contains the following parameters relevant for the Agents:

    • AGENT_LIST_LIMIT

      Defines the number of agents to be displayed in the agent list.

      • Allowed values: 1 to 20000

      • Default value: 5000

        The default value is used if no value has been defined and if the value is set to zero (0) or higher than 20000.

      • Restart required: No

    • AGENT_LOG_CHANGE_PER_MINUTE

      Defines the maximum number of log-file changes for agents (per minute).

      • Allowed values: 20 to n

      • Default value: 60

      • Restart required: No

    • AGENTGROUP_CHECK_INTERVAL

      Defines the interval in minutes at which tasks that are waiting for the host of an agent group are checked.

      • Allowed values: 1 to 60

      • Default value: 10

      • Restart required: No

  • BACKENDVAR_MAX_ROWS

    Defines the maximum number of lines that a BACKEND type Variable object returns.

    • Allowed values: 0 to 50000

    • Default value: 200

    • Restart required: No

  • CAU_INCLUDE_SERVER_CERTIFICATES

    Determines whether the Automation Engine sends the server certificates to an Agent during a Centralized Agent Upgrade (CAU) or not.

    • Allowed values: Y and N

    • Default value: Y

    • Restart required: No

  • CAU_PARALLEL_LIMIT

    Determines how many agents can be upgraded in you system at the same time using the Centralized Agent Upgrade (CAU), see Centralized Agent Upgrade (CAU).

    • Allowed values: 0 to 100000

    • Default value: 1000

    • Restart required: No

  • CHANGE_LOGGING Parameters

    • CHANGE_LOGGING_DAYS

      Defines the time period in days after which the log files are changed.

      • Allowed values: 1 to 32767

      • Default value: 14

      • Restart required: No

    • CHANGE_LOGGING_MB

      Defines the size in MB after which the log files are changed.

      • Allowed values: 1 to 32767

      • Default value: 20

      • Restart required: No

  • CONDITION_CHECK_INTERVAL

    Defines the time interval in seconds at which the Preconditions tab of workflows is rechecked.

    • Default value: 60

    • Restart required: No

  • CP_ENDPOINT

    Important! This variable is relevant only if a non-TLS/SSL Agent, such as BS2000, NSK, OS/400, VMS and z/OS, uses a third party load balancer to connect to an Automation Engine instance in a container-based environment.

    Defines where to reach the communication process (CP).

    • Allowed values: Addresses (hostname:port) for communication processes separated by a semicolon, see Communication Processes (CP).

    • Restart required:

      You have to restart the communication processes (CPs) if:

      • the CP_ENDPOINT variable is defined for the first time or is deleted

      • you want to start all communication processes (CPs) with the same port number

      You do not have to restart the communication processes (CPs) if:

      • you have an Automic Automation Kubernetes Edition deployment

      • you are only changing a port number that was already defined or adding additional ports to the variable definition. However, if you change the port definition, make sure that the change is reflected in the configuration (INI) file of the relevant Agent.

  • DEFAULT_TASKLIST_TIMESPAN

    Defines the time frame in hours that is applied to show the executions that have been deactivated during this period of time.

    • Allowed values: Integers

    • Default value: 12 or No Time Frame

      Note: The default value of 12 is only available when the Include deactivated tasks option is selected, otherwise No Time Frame is the default setting.

    • Restart required: No

  • DELETE_CHECKBACK_LIMIT

    Determines the number of objects to be deleted for which the Search for Use function is executed without a check back.

    • Allowed values: 0 to 100

    • Default value: 10

    • Restart required: No

  • DISPLAY_ENCRYPTED_PWD_IN_REPORT

    Allows you to have the password in the report to be displayed as stars (*).

    • Allowed values: YES and NO

    • Default value: YES

    • Restart required: No

  • DISABLE_USER_HEADER

    Allows you to exclude user-defined Include objects from being called in the Headers and Trailers of Job Objects.

    • Allowed values: BS2000, CIT, JMX, MVS, NSK, OS400, PS, SAP, SAPBW, SIEBEL, UNIX, VMS, WINDOWS or *ALL.

      Note: Separate values by using commas.

    • Default: All available Includes are executed.

    • Restart required: No

  • ERT_ADAPTIVE_JWP_TIMEOUT

    Defines the time in minutes after a system start that the system waits for the availability of a JWP to calculate the adaptive ERT.

    Note: 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.

    • Allowed values: 1 to 60

    • Default value: 5

    • Restart required: No

  • EXECUTE_ON_EXCEPTION

    Defines if an object should start if a message is put into quarantine, see Quarantine.

    • Allowed values: Object name

    • Restart required: No

  • EXT_DEP_ENDED_LOST_RUNNING

    Defines the handling of tasks in external dependencies.

    • Allowed values: N[o] and Y[es]

      N[o]: Tasks with status ENDED_LOST are ignored in external dependencies.

      Y[es]: Tasks with status ENDED_LOST are handled like every other task in external dependencies.

    • Default value: N

    • Restart required: No

  • EXTERNAL_CHECK_INTERVAL

    Defines the interval in minutes at which external dependencies in workflows are checked, see External Dependencies in Workflows.

    • Allowed values: 1 to 1440

    • Default value: 10

    • Restart required: No

  • GENERATE_UNDEFINED_SCRIPT_VARS

    Allows you to use the script function GENERATE_SCRIPT_VARS when set to Y.

    • Allowed values: Y and N

    • Default value: N

    • Restart required: No

  • GENERIC_AUTO_FORECAST_LIMIT

    Defines the maximum number of autoforecast results to be displayed, see Autoforecast.

    • Allowed values: 0 to 20000

    • Default value: 5000

    • Restart required: No

  • GENERIC_SEARCH_LIMIT

    Defines the maximum number of search results to be displayed.

    • Allowed values: 0 to 20000

    • Default value: 5000

    • Restart required: No

  • GENERIC_STATISTICS_LIMIT

    Defines the maximum number of statistical records to be displayed.

    • Allowed values: 0 to 20000

    • Default value: 5000

    • Restart required: No

  • GET_PROCESS_LINE_RTRIM

    Defines the handling of blanks in a line that is read by using the script function GET_PROCESS_LINE.

    • Allowed values: 0 and 1

      0: GET_PROCESS_LINE leaves blanks at the end unchanged.

      1: GET_PROCESS_LINE truncates blanks at the end.

    • Default value: 1

    • Restart required: No

  • INDEXSEARCH_INTERVAL

    Defines how often (in seconds) the advanced search index is updated, see Advanced Search.

  • JCP_ENDPOINT

    Important! This variable is relevant only if your Automic Web Interface or your Agents connect to the Automation Engine using a third party load balancer, such as an ingress in container-based installations.

    Defines where to reach the JCP.

    • Default value: https://hostname:8443

    • Restart required: No

  • JWP Parameters

    • JWP_KEYSTORE_PATH

      Defines the alternative keystore path the JWP should use instead of the JRE default keystore location. Paths can be local or network paths and can us UNC format.

    • JWP_KEYSTORE_LOGIN

      Defines the usage of a Login object that provides a password for type JWP_KEYSTORE, see Login (LOGIN). You need this password to access the JWP keystore file defined with the JWP_KEYSTORE_PATH key.

      • Allowed value: <name_of_the_login_object>

      • Restart required: No

  • KDC

    Enables or disables Kerberos Distribution Center (KDC) authentication for a system.

    • Allowed values: Y[es] and N[o]

    • Default value: N[o]

      Note: If the switch is not set, the default value is used.

    • Restart required: No

  • LAST_USE

    Defines the time delay in minutes after which the objects' usage counter is refreshed.

    • Allowed values: 0 to 10

    • Default value: 0 (no refresh)

      Note: Executions are not counted if no value or 0 has been specified.

    • Restart required: No

  • LDAP

    Allows you to connect to LDAP.

    • Allowed values: Y and N

      Y: LDAP is used.

      N: LDAP is not used.

    • Default value: N

    • Restart required: No

  • LOG_TO_DATABASE

    Determines whether the Automation Engine also writes log file messages to the AE database.

    • Allowed values: Y and N

    • Default value: Y

      Y: The log messages of the Automation Engine are saved in Server object's report in the AE database.

      N: The log messages of the Automation Engine are saved only in the log file and not in the AE database.

    • Restart required: Server, see Starting and Ending Server Processes

  • MAX_EXPORT_COUNT

    Determines the maximum number of objects that are exported at the same time.

    • Allowed values: 0 to 1000000

    • Default value: 1000

    • Restart required: No

  • MAX_IMPORT_SIZE

    Determines the maximum size in KB of the XML file that is imported.

    • Allowed values: 0 to 30702

    • Default value: 30702

    • Restart required: Automic Web Interface (logout/login)

  • MAX_NESTING_DEPTH

    Security check to avoid endless loops. Disabling it allows you to start tasks over and over again.

    • Allowed values: 0 to 9999

      Setting the value to 0 disables the security check.

    • Default value: 16

    • Restart required: No

  • MAX_VARIABLE_SIZE

    Determines the maximum size of script variables in bytes.

    • Allowed values: 1024 to 1048576

    • Default value: 1048576

    • Restart required: No

  • MAXIMUM_STORE_RESOURCE_SIZE

    Determines the maximum size of resources attached to the Storage object, in bytes, see Storage (STORE).

    Important! This variable is used only in the script command :ATTACH_RES.

    • Allowed values: 0 to 95 MB (99900000 bytes)

    • Default value: 95 MB (99900000 bytes)

    • Restart required: Automic Web Interface (logout/login)

  • MIN_EVENT_INTERVAL

    Defines the minimum interval in minutes at which events are executed.

    • Allowed values: 0 to 9999

    • Default value: 1

    • Restart required: No

  • MQ Parameters (Oracle)

    • AUTOMATIC_MQ_REORG

      Determines whether the message queue tables are reorganized automatically.

      • Allowed values: Y and N

      • Default value: N

      • Restart required: No

    • MQ_BLOCK_COUNT

      Defines the number of blocks after which the message queue is reorganized.

      • Allowed values: 0 to 100000

      • Default value: 64

      • Restart required: No

    • MQ_CHECK_TIME

      Defines the interval in seconds at which message queues are checked.

      • Allowed values: 0 to 1000000

        No check is made if the value is set to 0.

      • Default value: 600

      • Restart required: No

  • MQA_COUNT_BACK

    Defines the number of server messages to be buffered in the random access memory of the server computer.

    • Allowed values: 0 to 1000

    • Default value: 0

    • Restart required: No

  • OBJECT_ACCESS_CLIENT_ZERO

    Determines user access to objects in the system client 0 from other clients in the Automation Engine system.

    • Allowed values: Y[es] and N[o]

      Y: Users have access to system client objects in write protected mode.

    • Default value: Y[es]

    • Restart required: No

  • PACKS_COMPATIBILITY_MODE

    This key defines which Action Pack structure should be used to export an Action Pack with the Plugin Manager. For more information, see About the Plugin Manager.

    • Allowed values:

      • ALL

        The Pack content is exported in both formats: XML, JSON.

      • JSON

        The Pack content is exported in JSON format.

      • XML

        The Pack content is exported in XML format.

    • Restart required: No
    • Default: JSON

  • PASSWORD Parameters

    • PASSWORD_EXIT

      Facilitates a password exit.

      • Format: Name including the path of the generated server program library for an external password check

        Example

        c:\AUTOMIC\pwexit\bin\xuc4pass.dll

      • Number of characters allowed: Max. 256 characters

      • Restart required: Server, see Starting and Ending Server Processes

    • PASSWORD_EXIT_PARAM

      Allows you to assign parameters for a password check.

  • PERFORMANCE Parameters

    • PERFORMANCE_ACTIVE

      Defines whether this feature is turned on or not.

      • Allowed values: Y and N

      • Default value: Y

      • Restart required: No

    • PERFORMANCE_KEEP_DAYS

      Number of days that the performance data is stored in the database.

      • Allowed values: 1 to N

      • Default value: 30

      • Restart required: No

    • PERFORMANCE_CLEAN_UP_BATCH_SIZE

      Batch size used for deleting metrics.

      • Allowed values: 1 to N

      • Default value: 1000

      • Restart required: No

  • PM_INDEX_URL

    Defines the URL to the public GIT repository containing an updated list of available Packs.

    • Default value: https://github.com/Automic/Index.git
    • Restart required: No

  • PM_PACK_RELEASENOTE_URL

    This variable is used to connect to the repository containing the release notes of the Packs.

    • Default value: https://downloads.automic.com/jart/prj3/depman/interfaces/marketplace/list_packages.jart?to-json=yes

    • Restart required: No

  • PM_PROXY_SERVER

    This variable is used by thePlugin Manager together with the PM_PROXY_PORT variable to access the Internet. For more information, see About the Plugin Manager and PM_PROXY_PORT.

    • Default value: Empty value

    • Restart required: No

    • Default value: Empty value

    • Restart required: No

  • PM_PROXY_PORT

    This variable is used by the About the Plugin Manager together with the PM_PROXY_SERVER variable to access the Internet. For more information, see About the Plugin Manager and PM_PROXY_SERVER.

    • Default value

      Empty value

    • Restart required

      No

  • RECONNECT_TIME

    Defines the time interval in seconds at which the server processes attempt to establish a connection. This affects the connection attempts for a restart or after a lost connection.

  • REPORT Parameters

    • REPORT_BLKSIZE

      Determines the resport size in bytes.

    • REPORT_TIME

      Determines the interval in seconds at which the report is refreshed.

  • REPORT_SCAN Parameters

    • DEFAULT_REPORT_SCAN_MEMORY

      Defines the size in MB which is requested by default for reading an Output Analysis report.

      • Allowed values: 1 to 50

      • Default value: 2

      • Restart required: No

    • MAX_REPORT_SCAN_MEMORY

      Defines the maximum size in MB which is requested for reading an Output Analysis report.

      • Allowed values: 1 to 100

      • Default value: 10

      • Restart required: No

  • REPOSITORY_SSH_DIR

    Determines the SSH directory you wish to use when connecting to a remote repository.

    If this parameter has not been set, the system uses the default SSH directory of the installation's operating system.

  • RESOLVE_GET_VAR

    Determines the behavior of the GET_VAR script function.

    • Allowed values: Y[es] and N[o]

      Y[es]: GET_VAR shows the variable's value. The variable is resolved.

      N[o]: GET_VAR does not resolve the variable, but shows the variable's name, for example: &var#.

    • Default value: Y[es]

    • Restart required: No

  • REST_ENDPOINT

    Important! This variable is relevant only if your Automic Web Interface or your Agents connect to the Automation Engine using a third party load balancer, such as an ingress in container-based installations.

    Defines where the Java API and AWI can reach the REST API.

    Note: The Java API does not return the REST_ENDPOINT set in this variable when you use the GetRestEndpoints API call.

    • Default value: https://hostname:8088

    • Restart required: No

  • SAML

    Enables or disables Security Assertion Markup Language (SAML) authentication for a system.

    • Allowed values: Y and N

    • Default value: N

      Note: If the switch is not set, the default value is used.

    • Restart required: No

  • SCR_LOOPCHK_TIME

    Defines the time period in seconds at which the script is interrupted and an endless loop is assumed. This parameter allows you to avoid endless loops.

    • Allowed values: 1 to 32767

    • Default value: 5

    • Restart required: No

  • SERVER_OPTIONS

    Various server settings for performance improvement and trace outputs.

    • Format: 16 digit strings

      Each digit represent a particular server setting. These values can be read using the script function GET_UC_SETTING.

    • Default: All options are deactivated

    • Restart required: No

  • ServiceManager Parameters

    • SMGR_AUTO_SCAN

      Determines whether new agents are scanned automatically for a ServiceManager connection.

      • Allowed values: YES and NO

      • Default value: YES

      • Restart required: No

    • SMGR_LOOKUP

      Determines whether the coupling between AE processes and the ServiceManager can be disabled.

      • Allowed values: YES and NO

      • Default value: YES

      • Restart required: No

    • SMGR_PORT_RANGE

      Indication of a port number or a port area that is searched for ServiceManager services

      • Default value: 8871

      • Port area: Max. 10 port numbers

      • Restart required: No

      • Syntax format: <port> or (<portFrom>,<portTo>)

    • SMGR_SUPPORT_LEGACY_SECURITY

      Enables compatibility with legacy ServiceManagers for version prior to 12.2.0 (TLS 1.2).

      • Allowed values: Y and N

      • Default value: N

      • Restart required: No

  • SHOW_REPORT_HIERARCHICAL

    Allows you to display reports as subordinate tasks in the Process Monitoring perspective.

    • Allowed values: Y[es] and N[o]

      Y[es]: The Process Monitoring perspective displays the report of a task as its child.

      N[o]: The Process Monitoring perspective displays reports as individual tasks.

    • Default value: Y[es]

    • Restart required: No

  • SNMP_REFRESH

    Defines the interval in seconds at which the display for the blocked workflows for SNMP is refreshed.

    • Allowed values: 0 to 600

      0: always check

    • Default value: 10

    • Restart required: No

  • SQL Variables Parameters

    • SQLVAR_INTERNAL

      Determines who can create and edit SQL - internal and SQL - internal SECURE Variable objects.

      • Allowed values: YES and NO

      • Default value: NO

      • Restart required: No

    • SQLVAR_MAX_ROWS

      Defines the maximum number of lines to be retrieved by Variable objects with the source SQL and SQLI.

      • Allowed values: 0 to 500000

        If you specify a very high value it may take longer to resolve Variable objects.

      • Default value: 200

      • Restart required: No

  • SUPPRESS Message Parameters

    • SUPPRESS_AGENT_MESSAGES

      Determines if messages are suppressed while connecting or disconnecting an agent to avoid performance issues.

      • Allowed values: Y and N

      • Default value: N

      • Restart required: No

    • SUPPRESS_MSG_INTERVAL

      Determines if messages are suppressed when more than 60 equal messages are sent within a specified period of seconds.

      • Allowed values: 0 - 600

      • Default value: 60

      • Restart required: No

  • SYNC Parameters

    • SYNC_BLOCK_COUNT

      Determines the number of Sync objects whose log should be changed per block.

      • Allowed values: 1 to 1000

      • Default value: 10

      • Restart required: No

    • SYNC_CHECK_RESTART

      Determines whether Sync objects are checked when restarting a canceled job without an Abend action.

      • Allowed values: Y and N

        Y: Sync object is checked when restarting a canceled job without an Abend action.

        N: Sync object is not checked, a job is restarted immediately.

      • Default value: Y

      • Restart required: No

  • TLS_GATEWAY_CP

    Defines if the TLS Gateway can be used as a communication process (CP) for non-TLS/SSL Agents or not.

    • Allowed values: YES and NO

    • Default value: NO

    • Restart required: No

  • TRASHBIN_SHOW_MAX

    Determines the maximum number of objects to be shown in the recycle bin, see Recycle Bin. The current date serves as the basis, for example, the last n objects are visible.

    • Allowed values: 0 to 20000

    • Default value: 5000

    • Restart required: No

  • UNREAD_MESSAGES Parameters

    • UNREAD_MESSAGES

      Determines the output of unread administrator and security messages.

      • Allowed values: YES and NO

      • Default value: YES

      • Restart required: No

    • UNREAD_MESSAGES_BUFFER

      Determines the maximum number of unread messages that should be kept.

      • Allowed values: 10 to 5000

      • Default value: 500

      • Restart required: No

  • VAR_SECURITY_LEVEL

    Determines whether variables can be used in VARA objects, and which ones.

    • Allowed values: 0, 1, 2, and 3

    • Default value: 0

    • Restart required: No

  • VARIABLE_SERVICE_CHECK_INTERVAL

    Defines the interval in minutes at which the resolving of SQL variables is repeated if their values are not available due to an error.

    • Allowed values: 1 to 60

    • Default value: 10

    • Restart required: No

  • VERSIONS_SHOW_MAX

    Determines the maximum number of objects that are displayed in the Version Management page, see Version Management Page.

    • Allowed values: 0 to 20000

    • Default value: 5000

    • Restart required: No

  • WEBSOCKET_TIMEOUT

    Determines the keep-alive intervals in seconds for Windows, UNIX, and Java agents.

    • Allowed values: 10 and above

    • Default value: 60

    • Restart required: Agent

  • Workflow Structure Cancellation Parameters

    • CANCEL_ALL_CHECK_ATTEMPTS

      Specifies how often the status of the workflow structure that is to be canceled recursively is checked.

      • Allowed values: 1 to 100

      • Default value: 10

      • Restart required: No

    • CANCEL_ALL_CHECK_TIMEOUT

      Specifies the interval in seconds in which the status of the workflow structure that is to be canceled recursively is checked.

      • Allowed values: 1 to 100

      • Default value: 5

      • Restart required: No

  • WORKLOAD_DEFAULT Parameters

    • WORKLOAD_DEFAULT_FT

      Determines the resources a file transfer uses by default.

      • Allowed values: 1 to 100000

      • Default value: 1

      • Restart required: No

    • WORKLOAD_DEFAULT_JOB

      Determines the resources a job uses by default.

      • Allowed values: 1 to 100000

      • Default value: 1

      • Restart required: No

  • WP_MIN_NUMBER

    Determines the minimum number of server processes per node name to be used as work processes (WP). Any additional processes are used as Dialog Processes (DWP).

    • Format: node name1=number;node name2=number

    • Allowed values for numbers: 2 up to the maximum number of work processes.

    • Default value: 5

    • Restart required: No

  • XML Parameters

    • XML_ENCODING

      Specifies the encoding the Automation Engine uses to encode XML files.

      • Allowed values: ISO-8859-15, ISO-8859-1, and WINDOWS-1252

      • Default value: ISO-8859-15

      • Restart required: No

    • XML_ENCODING_CHECK

      Checks the encoding during the import process. It affects the verification of imported XML files.

      • Allowed values: Y and N

        Y: The import files must have the encoding that is assigned in the XML_ENCODING parameter.

        N: Encoding of the XML files is not checked.

      • Default value: Y

      • Restart required: No

  • ZERO_DOWNTIME_UPGRADE

    Enables or disables a mode, which prepares the system for a version upgrade without system downtime.

    • Allowed values: Y or N

      Y: A database upgrade is allowed while the system is fully up and running. New CPs/WPs can be started for working in a compatibility mode, with their peers of a pre-installed version.

      N: Database upgrade not possible, if the system is running. All CPs/WPs must have the same version.

    • Default value: N

    Important! During the period of time where this parameter is set to Y, the system performance will be reduced because certain system optimizations are not possible in this mode.

See also: