UC_CLIENT_SETTINGS - Various Client Settings

Indicates the specific characters that you can use in the alias names of workflow tasks.

Default: -#

Blanks are ignored.

The alias names of workflow tasks that can be set in the task properties in the General tab is limited to specific characters. Here you can allow characters that are usually not available, for example "-".

The Queue object that is used to execute CallAPI scripts.

Default: "CLIENT_QUEUE"

Full URL (including protocol and port) of a CA Automic Release Automation instance.

AUTO_FORECAST_DAYS

The number of days that should be included in the AutoForecast calculation.

Default: "1"

No

The AutoForecast creates forecast data for activities that run in Schedule and Event objects. Depending on the active Schedule and Event objects in the client, a forecast will be created for these objects for a previously defined number of days.

Important! Setting this value too high can impact performance. Set this value higher than 14 only to meet a specific need and only after having analyzed the impact that it would have on the performance of your system.

AUTO_FORECAST_PREFIX

Name prefix for forecasts that are created by the AutoForecast.

No

CALE_LOOK_AHEAD_MAX

The maximum number of days that is considered for calculating the next valid date based on calendar conditions.

Allowed values: "0 - 9999"
Default: "14"

No

CALE_WARN_LEVEL

The number of days prior to a calendar's expiration date that triggers an advance warning.

Server, see Starting and Ending Server Processes

CALE_WARN_NOTIFICATION

The notification that is activated in order to warn in advance that a calendar will expire.

Server, see Starting and Ending Server Processes

When the Automation Engine starts and a day change takes place, it checks the validity dates of all calendars. The specified notification starts for each calendar whose validity date expires within the defined number of days. You can get the relevant calendar name by using :READ as shown below:

:READ &UC_CAUSE_NAME,,

No alert is sent for Calendar objects that are stored in the system client 0000 because you cannot activate objects here.

CLIENT_PRIORITY

The priority of the client.

Allowed values: "200" - "255"

No

CLIENT_STATUS

"GO" - Activates automatic processing.
"STOP" - Stops automatic processing.

AWI (logout/login)

Deactivation time in minutes.

Allowed values: Integers only
Valid value range: [0,999999]

Client-wide delay time is NOT considered if

• this key is not defined
• this key does not include a value
• the value of this key is not valid

You can also set this value directly in the Deactivate after field in the Automatic Deactivation Section of the Attributes pages of Workflows (JOBP), Notifications (CALL), Events (EVNT), File Transfers (JOBF), Jobs (JOBS) and Scripts (SCRI).

"Y[es]": If tasks end with FAULT_OTHER, the deactivation options are not considered. The task itself is deactivated.

"N[o]": If tasks end with FAULT_OTHER, the deactivation options are considered.

The default number of hours in integer form to check for Process Monitoring filters in the AWI.

Default value: 12 hours

EH_KICK_INTERVAL

Refresh interval for viewing tasks in the Activities pane and monitors.

Default: 3 seconds

No

If the properties of a task have changed (for example, start, status, end), the AWI receives a message from the Server and the Activities pane and monitor view can be refreshed. You can specify the interval in which messages should be sent to the AWI in this key. In doing so, messages are sent in blocks which has positive effects on your system performance.

No message is sent to the AWI if tasks do not change during an interval.

Activation or deactivation of adaptive ERT calculation for the entire client.
Allowed values:

"Y" - Activates (default)
"N" - Deactivates

These are the settings for the adaptive calculation of the expected runtime (ERT).
Deactivating ERT_ADAPTIVE means that the tasks for which the dynamic ERT method Adaptive has been defined in the Estimated Runtime (ERT) Section will use the alternative method ERT_ADAPTIVE_FALLBACK_METHOD.

ERT_ADAPTIVE_FALLBACK_METHOD is also used if the JWP is not available to handle adaptive ERT calculation.

ERT_ADAPTIVE_DEFAULT_CONTEXT defines the information that should be considered for adaptive ERT calculation. You can also specify any object attributes; these must be separated by semicolons. The following factors are considered by default:

• Parent Alias
• Parent Name
• Agent (for file transfers: target and source agent)
• Start time

Information that should be considered for adaptive ERT calculation.

You can also specify object attributes; these must be separated by semicolons (;) .

Default: "PARENT_ALIAS;HOST;FT_DST_HOST;FT_SRC_HOST;START_TIME"

Alternative method for calculating the ERT if adaptive calculation is not possible.

Allowed values:

"FIXED" - Static predefined value
"AVERAGE" - Dynamically retrieved average value
"LINEAR_REGRESSION" - Dynamic value, based on linear regression (default)
"MAXIMUM" - Dynamic value, based on the longest actual runtime.

ERT_CALCULATION

The Automation Engine can calculate the estimated runtime (ERT).

Allowed values:

"BATCH" = Deactivates ERT calculation
"IMMEDIATE" = Activates ERT calculation (default)

No

Deactivating ERT calculation can slightly improve the performance of your Automation Engine. Despite this, you can still calculate the ERT of all objects subsequently in the database. Use the utility AE DB Load for this purpose and load the file UC_UPD_ESTIMATE_ERT.TXT. It depends on the number of objects that are involved how long the ERT calculation process takes.

The file UC_UPD_ESTIMATE_ERT.TXT contains a line at its end that activates the ERT calculation function for the whole AE system. You can specify a client if ERT calculation should only take place in a specific client.

For example:

ESTIMATE_ERT 1000

All keys below that start with "ERT_" form the default values for ERT calculation. You can adjust them in the Runtime tabs of the individual objects if required.

ERT_CHECK_COUNT

Number of runs that should be evaluated.

Two-digit value between "1" and "25"

Default: "20"

No

ERT_CORR_PERCENT

Positive correction value in percent.

Three-digit value, default: "0"

No

ERT_FRT

Fixed value for the ERT in seconds.

Three-digit value, default: "0"

No

ERT_IGNORE_PERCENT

Deviation in percent.

Three-digit value, default: "0"

No

ERT_METHOD

Method that is used to evaluate the ERT.

Allowed values:

"FIXED" - Static predefined value.
"AVERAGE" - Dynamically determined average.
"LINEAR_REGRESSION" - Dynamic value based on linear regression (default).
"MAXIMUM" - Dynamic value based on the longest actual runtime.
"ADAPTIVE" - Intelligent ERT calculation that considers various factors and runtime parameters.

No

ERT_MINIMUM_COUNT

Minimum number of runs that should be considered for deviation.

Two-figure value between "1" and "ERT_CHECK_COUNT", default: "0"

No

EXT_REPORTS

Creates extended task reports.

Allowed values:
"SCRIPT" = Log of the entire script.
"JCL" = Log of all job attributes and the generated JCL.
"HOST_JCL" = JCL is taken from the target host (platform-specific).
"OBJECT_ACCESS" = Log of access to objects.
"SQL_VAR" = Log for access to SQL variables including SQL statement and parameters.

Separate several values with commas.

No

FIRST_DAY_OF_WEEK

Starting day of the week.

Allowed values:

"1" - Sunday
"2" - Monday (default)
"3" - Tuesday
"4" - Wednesday
"5" - Thursday
"6" - Friday
"7" - Saturday

No

FIRST_WEEK_METHOD

Definition of the week that is regarded the first calendar week of a year.

Allowed values:

"1" - The week that includes January 1st.
"4" - The first week that includes at least 4 days of the new year (default).
"7" - The first week that includes 7 days of the new year.

CP and WP, see Starting and Ending Server Processes

Sets the maximum number of records that should be displayed in the AWI Process Monitoring view.

Allowed values: 0 to 20000
Default: 5000

The Process Monitoring perspective displays your activities according to the filter settings that you have defined. Displaying numerous tasks may affect performance negatively because refreshing the view at short intervals is very CPU-intensive. Therefore, you can limit the maximum number of activities to be displayed.

Forces authentication via Kerberos Distribution Center (optional).

Allowed values: "Y[es]" or "N[o]"

The authentication via Kerberos is forced for all users of a client at once.
The advantage of this method is that User objects do not have to be changed one by one.

If this parameter is set to "N" or is not set, KDC_LOGIN_FORCED has no effect.

Allowed values: Integers only.

Valid value range: [1,50]

Default: 5 rows

MAX_USER_INTERFACES

Maximum number of user interfaces that can be logged on at the same time.

Allowed values: "1" to max. license count

No

NOW_MINUS

Number of years that is considered in dynamic calendar calculation.

Allowed values: "1" (default) to "5"

No

NOW_PLUS

The number of years that is considered in dynamic calendar calculation.

Allowed values: "1" to"10"
Default: "6"

No

OBJECT_AUDIT

Logging for the revision report.

Allowed values:

"Y" - Logging for the revision report takes place.
"N" - No logging takes place (default).

No

The time in minutes that the system waits for a task's PromptSet dialog to be confirmed.
The task aborts if this time is exceeded.

Default value: 0 (= unlimited)

These settings define the maximum waiting time for a task that includes PromptSets. Depending on the particular situation, the task aborts if this time is exceeded.

• PROMPT_RESPONSETIME
  Maximum time that the system waits until the user confirms a task's PromptSet input prompt. It is irrelevant whether the dialog includes one or several PromptSet objects. The time is reset when the input dialog is confirmed with "Done". This is relevant for workflows that display the PromptSet dialogs of several tasks in succession.
• PROMPT_TIMEOUT
  If a PromptSet input mask cannot be displayed because the particular user has not logged on, the corresponding task switches to the waiting condition "Waiting for user input". In this case, the maximum waiting time is the time that has been determined in PROMPT_TIMEOUT.
  The PromptSet dialog is called if the user logs on again within this time period.

The task aborts if the graphical user interface is closedalthough the PromptSet dialog is still open.

The time in minutes that the system waits for a user to log on in order to display a PromptSet dialog.
The task aborts if this time is exceeded.

Default value: 0 (= unlimited)

PWD_AGE_MAX

The life span of the user passwords in days.

No

Settings for user passwords, see

PWD_AGE_MAX
MAX_PASSWORD_AGE used in the key "Freely selected" serves to define the maximum life span of user passwords. The value specifies the number of days (as an integer) that a password is valid. If 75% of the value's life span is over, users are informed that the password will soon expire when they log on. If the password has already expired, it must be changed the next time a user logs on. If there is no entry for this key (default), the system does not check the expiration time.

PWD_ATTEMPTS_MAX
Here you can limit the number of invalid login attempts. Users who exceed the specified value will be locked. Authorized persons can unlock affected users in the corresponding User object. By default, the number of invalid login attempts is not limited. The time delay until the message "Access denied" displays increases as of the third invalid attempt.

PWD_DEFAULT
This setting specifies the default password for new users that were created and configured without a password. Use this setting to define a default password that complies with your password policy. The password that you specify here is the password that users need for logging on to the client for the first time. First-time users will then be requested to change the password. If you do not specify a default password here, or if the password you defined does not comply with your current password policy, the default password for new Users that have been configured without a password is pass.

PWD_GENERATION
This setting defines the last n passwords that must not be used again. The new password must differ from these last n passwords. The Automation Engine stores all passwords. This ey only determines the number of passwords that are compared with the new password.

All other keys that start with "PWD" define the criteria that a user password must meet.

If no value is specified for the above settings, the system searches for a default value in the variable UC_SYSTEM_SETTINGS. It uses the fixed default value if it does not include these PWD keys.

PWD_ATTEMPTS_MAX

The number of invalid login attempts.

No

PWD_CONTAINS_LOWER_CASE

Use this key to force the use of lowercase letters in user passwords.

Allowed values: "Y" and "N" (default)

No

PWD_CONTAINS_NUMBER

Use this key to force the use of numbers in user passwords.

Allowed values: "Y" and "N" (default)

No

PWD_CONTAINS_SPECIAL_CHARACTER

Use this key to force the use of special characters in user passwords.

Allowed values: "Y" and "N" (default)

No

PWD_CONTAINS_UPPER_CASE

Use this key to force the use of uppercase letters in user passwords.

Allowed values: "Y" and "N" (default)

No

PWD_FORBID_LOGIN

You can use this key to forbid user names in user passwords.

Allowed values: "Y" and "N" (default)

No

PWD_GENERATION

The number of the last n passwords that must not be used again.

Allowed values: "1" - "99"
Default value: "0"

"0" signals that the password is not checked against older passwords

No

PWD_LENGTH_MAX

Maximum length of user passwords.

Allowed values: "0" - "32" (default)

No

PWD_LENGTH_MIN

Minimum length of user passwords.

Allowed values: "0" (default) - "32"

No

SEARCH_SCRIPT_FOR_USAGE

The search for object use in script.

Allowed values:

"Y" - Search for objects that are used in scripts (with regular expressions).
"L" - Search for objects that are used in scripts (normal search without regular expressions).
"N" -  No search for object usage in scripts (default).

No

When deleting, renaming or manually searching the use of an object, AE checks if this object is used in other objects as well (for example, in Schedule objects). If so, you can have a list of all these objects displayed. With the specification of the key SEARCH_SCRIPT_FOR_USAGE and the values "Y" and "L", objects that are used in scripts (for example,  ACTIVATE_UC_OBJECT) are included in the search. There are different search types:

"Y" - The searched string is handled as a word that is enclosed in delimiters such as blanks, left and right parentheses, equals, commas, single quotations, double quotations, end of lines and script ends.

For example: Searching for MM only lists results in which this term is enclosed in the listed delimiters.

• (MM)
• =MM=
• 'MM'
• (MM,
• =MM at the end of a line

Underscores are not delimiters. Searching for MM is not successful if you search for _MM_.

Note that this search specification is only supported for the MS SQL Server and Oracle version 10g and beyond.

Searching by using the option "Y" is more complex and takes longer.

"L" - The searched string must be somewhere in the script as otherwise, it is not displayed as a search result.

For example: Searching for MM lists results in which this term is included as a whole or partially.

• MM
• MM.CLOSING
• AE.MM.DAY

"L" search result are limited to 1000 entries for performance reasons.

SECURITY_AUDIT_FAILURE

The authorization system's access control management.

"HOST_ACCESS" - All the denied attempts to access a host will be logged.
,"LOGON" - All the denied login attempts will be logged.
"OBJECT_ACCESS" - The denied attempts to access an object will be logged.
"USER_PRIVILEGES" - All denied user privileges will be logged.

No

The authorization system's access trace function can be defined for each individual client. You can log authorized and/or denied accesses in the categories login, privilege, host access and object access. Single assignments to variable values must be separated by commas. Specify the variable values exactly as described (case sensitive). Single assignments to values are not case sensitive.

You can review the access trace function in the Administration perspective provided that you have the required privileges. Each access results in a security message that informs about the access time, user, access category, host and the actual access. Host information is only available if the user is logged on to the AWI. Usually, you cannot retrieve host information for tasks that are activated at runtime.

If an unknown user makes an attempt to log on to the system, the access denial is logged in client 0000 when the access trace function is activated in the variable of client 0000.

SECURITY_AUDIT_SUCCESS

The authorization system's access control management.

"HOST_ACCESS" - Authorized host accesses will be logged.
"LOGON" - Authorized logins will be logged.
"OBJECT_ACCESS" - Authorized object accesses will be logged.
"USER_PRIVILEGES" - Authorized user privilege uses will be logged.

No

Key for setting the parameters Agent and Login used in SEND_MAIL script functions client-wide.

Format: SEND_MAIL_DEFAULT = <agent object>,<login object>

This key sets the default values for the agent that should be used to send emails and the Login object that contains the desired login data for sending emails and attachments.

This setting is overruled if the parameters Agent and Login are specified in individual SEND_MAIL script functions.

Using the Email connection of the Automation Engine requires the keys SMTP_SERVER and SMTP_FROM_ADDR to be specified. All other settings are optional.

The name of the Login object that is used to log on to the SMTP server.

In the Notification page of a Notification object, you can specify the RunID of a task whose reports should be attached to the message. By using the parameter SMTP_MAX_ATTACHMENT_SIZE, you define the maximum size of the report file that is sent by email in bytes.

Default: "8000"
Minimum: "400"
Maximum: "50000"

Notes:

• When the report file exceeds the maximum value, only the allowed size is read and sent. The file end includes the following note: "Truncated through SMTP_MAX_ATTACHMENT_SIZE limit"
• SMTP_MAX_ATTACHMENT_SIZE applies to reports that are sent by email, but not to other types of attachment that are sent by email.

The maximum time in seconds that the system waits for an SMTP Server to respond.

Allowed values: "0" - "999"
Default: "20"

STARTUP_ACTION

"STOP" - The system stops after the Automation Engine has started.
"WAIT x" - The system waits x seconds after the Automation Engine has started.

Server, see Starting and Ending Server Processes

By using the entry STARTUP_ACTION in the scope "Freely selected", you can influence the behavior of the system after the Automation Engine has started. The client can either stop automatic processing when the Automation Engine starts or suspend it for a specified period of time. By default, automatic processing is immediately active when the Automation Engine has started.

Note that the parameter SystemStop=YES in the Automation Engine's INI file overrides the settings that have been made in STARTUP_ACTION.

TASK_PRIORITY

The priority of tasks.

Allowed values: "1" - "255"

No

1 = highest priority

255 = lowest priority

Default (if no default priority is specified, or the variable is not available in the client) = 200

If 0 is selected for executable objects in their Attributes page, the value entered in this key applies for that object. See Attributes Page.

See also Automation Engine Priority.

TEMPLATE_SHOW_ALL

This key affects the list of object types that is shown when objects are created.

Allowed values:

"Y" - The selection dialog shows all object types (default).
"N" - The selection dialog only lists the object types that can be created by the particular user.

No

The content of the selection dialog that is shown while an object is created depends on the following factors:

• The configuration of the variable UC_OBJECT_TEMPLATE.
• The specification that has been made in TEMPLATE_SHOW_ALL.

"N" means that only the object types that can be created by the particular user are listed. For example, the user has a "write" privilege.

"Y" means that users can see all object types but can only create objects for which they have write access. If a filter has been placed in the authorizations, this filter is compared to the name of the template when a new object is created. See also user, user groups

Here you can specify the required behavior if the Variable objects whose value should be replaced at runtime by a placeholder in attributes cannot be found .

Allowed values:
"Y" - An error occurs and processing aborts.
"N" - Processing continues. The value is assigned as specified and no replacement takes place (default)

In AE, you can insert values of Variable objects in the attributes of executable objects at runtime. As a placeholder, you specify the variable name enclosed in { } brackets, and optionally the key and the column.

Notation:
{ Variable object [, Key [, Column number ]] }

The placeholder is replaced by the corresponding value when the task is generated. If neither a column nor a key have been specified, the value of the result column (in dynamic variables) or the first Value column (in static variables) of the first entry (Key) is used

You can also use the setting VARA_ERROR_ON_REPLACEMENTto determine whether the task should be canceled if the specified variable cannot be found. If "N" is used in the system settings, and the Variable object is not available, the attribute value including the invalid placeholder are used.

VERSION_MANAGEMENT

"Y" - Version control of objects is activated
"N" - No version control takes place (default)

No

VERSION_MANAGEMENT_SUFFIX

The part of the name that is inserted in objects that are created in the sequel of a Version Management.

Default: "OLD"
Maximum 8 characters

No

Stores specific information about tasks that are in a waiting status because of a queue in the AE database.

Allowed values:
"QUEUE" - Logs information about the waiting condition of all the queue's tasks in the database.

By default, this option is deactivated when you specify a different value or no value.

This setting is only relevant when you want to monitor the time slot of tasks relating to queues using the Automic product Predictive Analytics and / or Process Analytics.

When you set the value "QUEUE", the details of all tasks that are in a waiting status because of a queue stop or a queue limit will be logged in the AE database.

Setting for completion acceleration of workflows which have the highest amount of already completed tasks.

Allowed values:
"NO" - No acceleration (default). This is the same behavior as in previous versions.

"ABSOLUTE"- Tasks in workflow structures with the highest amount of already completed tasks will be preferred in waiting states.

The execution order of tasks in waiting states such as 'Waiting for SYNC / .. Queue slot/ ...resource / ...end of parallel task /... is determined by two environmental conditions:
1. Automation Engine priority
2. FIFO, a first in first out mechanism.

With this key set to value "ABSOLUTE" an additional measure will be added which prefers tasks in running workflows, depending on the absolute amount of already completed tasks in the parent workflow structure.
The execution order will then be determined by
1. Automation Engine priority
2. Task completion rate
3. FIFO mechanism.

XRO_REPORTS

External report analysis.

Allowed values:

"Y" - Report data of jobs and file transfers are logged.
"N" - Reports are not logged (default).

No