UC_CLIENT_SETTINGS - Various Client Settings

The indication of specific characters that are allowed to be used in the alias names of workflow tasks.

Default value: -#

Blanks are ignored.

The alias name of workflow tasks which can be set in the properties ( General tab) is limited to specific characters. To allow characters in the alias names that are usually not available (such as "-"), you can make use of this setting.

All the characters that should be allowed must be entered in a row, blanks will be ignored. The order of the individual characters is irrelevant.

For example: To allow the characters "-", ":" and "+", you must specify the value in the format -:+.

The Queue object that is used to execute CallAPI scripts.

Default value: "CLIENT_QUEUE"

Full URL (including protocol and port) of an Application Release Automation instance.

AUTO_FORECAST_DAYS

The number of days that are included in the AutoForecast calculation.

Default value: "1"

No

AUTO_FORECAST_PREFIX

The beginning of the names of 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 value: "14"

No

CALE_WARN_NOTIFICATION

The notification that is activated if the advance expiration warning occurs.

Server

When the Automation Engine starts and when a new day begins, the validity dates of all calendars are checked whether they expire within the defined number of days. The specified notification starts for each calendar whose validity date expires. The name of the calendar can be read in the script using the READ buffer as shown below:

:READ &UC_CAUSE_NAME,,

No alert is sent for Calendar objects of the system client 0000 because you cannot activate objects in this client.

CALE_WARN_LEVEL

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

Server

CLIENT_PRIORITY

The priority of the client.

Allowed values: "200" - "255"

No

CLIENT_STATUS

"GO" - Automatic processing is active.
"STOP" - Automatic processing is stopped.

UserInterface

"N[o]": The jobs with status FAULT_OTHER shall be kept in the Activity Window.

If the status FAULT_OTHER in the UserInterface is selected in the dropdown box of the job, this means, the radio-button 'After error-free execution' is also selected. Therefore the job will be removed from the Activity Window, even if the value is set to "N".

"Y[es]": Remove jobs with status FAULT_OTHER from Activity Window.

Allowed values: Integers only.

Valid value range: [0,999999]

Deactivation time in minutes
(This value corresponds with the one in the "Time delay" field in the Attributes tab of the respective objects.)

If the following applies, no client-wide delay time will be considered:

• Key is not set or
• key has no value or
• key has no valid value.

For certain executable objects, deactivation options can be set in two ways: By using this key or setting the corresponding value in the UserInterface field of the relevant object. This applies to Workflow, Event (Console, Time, Database, File, Time), Notification (Alarm, Mail, Standard), Group, Script, Job and FileTransfer. Please refer to the respective object's parameter descriptions for detailed information.

This activates the client's deployment functionality.

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

"Y" - This activates the deployment functionalities.
"N" - This deactivates the deployment functionalities.

Note that you cannot use the system client 0000 as a deployment client.

When you activate this setting (Y), the Deployment tab becomes available in workflows and the General tab, which is available in the properties of workflow tasks, includes the option "Run per Patch" .

EH_KICK_INTERVAL

The refresh interval that can be specified for the task view in the Activity Window and monitors.

Default value: 3 seconds

No

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

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

Activation/deactivation of adaptive ERT calculation for the entire client.

Permitted values: "Y" (default value) or "N"

"Y" - Adaptive ERT calculation is active.
"N" - Deactivation of adaptive ERT calculation.

Settings for the adaptive calculation of the expected runtime (ERT).

The adaptive calculation can be activated/deactivated for the entire client using the ERT_ADAPTIVE setting. If the adaptive calculation is deactivated, the tasks that the dynamic ERT method "Adaptive" was defined for ( "Runtime" tab) use the alternative method (ERT_ADAPTIVE_FALLBACK_METHOD).

The setting ERT_ADAPTIVE_FALLBACK_METHOD defines the alternative ERT method to be used if either the JWP is not available (Java-based work process, takes over the adaptive ERT calculation), or if the overall calculation has been deactivated (ERT_ADAPTIVE="N").

With ERT_ADAPTIVE_DEFAULT_CONTEXT, you can define factors to be taken into account in the adaptive ERT calculation. You can also specify any object attributes; these must be separated by semicolons. The following factors are taken into account by default:

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

Information which should be taken into account in the adaptive ERT calculation.

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

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

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

Permitted values: "FIXED," "MAXIMUM," "AVERAGE," "LINEAR_REGRESSION" (default value)

"FIXED" - Static predefined value
"AVERAGE" - Dynamically determined average
"LINEAR_REGRESSION" - Dynamically based linear regression
"MAXIMUM" - Dynamically longest actual runtime.

ERT_METHOD

The method to evaluate the estimated runtime (ERT).

Allowed values: FIXED, MAXIMUM, AVERAGE, LINEAR_REGRESSION

"FIXED" - Static predefined value.
"AVERAGE" - Dynamically determined average.
"LINEAR_REGRESSION" - Dynamically based linear regression.
"MAXIMUM" - Dynamically longest actual runtime.
"ADAPTIVE" - Intelligent calculation of the ERT taking into account various factors and runtime parameters.

Default value: "LINEAR_REGRESSION"

No

By deactivating the estimated runtime (ERT) calculation, you can improve the performance of the Automation Engine. If it is deactivated (ERT_CALCULATION/BATCH), you can determine it subsequently for all objects in the databaseA database is an organized collection of data including relevant data structures.. Use the utility AE DB Load in order to load the file UC_UPD_ESTIMATE_ERT.TXT. The duration for calculating the expected runtime depends on the number of objects that is involved.

The file UC_UPD_ESTIMATE_ERT.TXT contains a line at its end that calls the ERT calculation function. If you specify a client, ERT calculation takes place in this client, otherwise the whole system is included in the calculation.

For example:

ESTIMATE_ERT 1000

All other validity keys that start with "ERT_" form the default values for calculating the expected runtime (ERT). You can adjust them in the Runtime tab of each object if needed.

ERT_FRT

The fixed value for the estimated runtime in seconds.

Three-digit value, default: "0"

No

ERT_CHECK_COUNT

The number of calculated runs.

Two-digit value between "1" and "25", default: "20"

No

ERT_CORR_PERCENT

The positive correction value in percent.

Three-digit value, default: "0"

No

ERT_IGNORE_PERCENT

The deviation in percent.

Three-digit value, default: "0"

No

ERT_MINIMUM_COUNT

The minimum number of runs that should be counted for deviation.

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

No

ERT_CALCULATION

The determination of the estimated runtime (ERT) by the Automation Engine.

Allowed value: BATCH, IMMEDIATE
Default: "IMMEDIATE"
"BATCH" = Determination of the estimated runtime (ERT) is inactive
"IMMEDIATE" = Determination of the estimated runtime is active

No

EXT_REPORTS

Creates extended task reports.

Allowed values: SCRIPT, JCL, HOST_JCL, OBJECT_ACCESS separated by commas.
"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.

No

FIRST_DAY_OF_WEEK

The starting day of the week.

Allowed values: 1 - 7
Default value: "2"

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

No

The key FIRST_WEEK_METHOD can be used to define the first calendar week of a new year. By default, the week that includes at least 4 days of a new year is used as the first calendar week. You can also determine the starting day of a week using the entry  FIRST_DAY_OF_WEEK (default: Monday).

Note that the definitions that are made for the first calendar week influence the results of the script function WEEK_NR which retrieves the calendar week.

FIRST_WEEK_METHOD

The definition of the week that is regarded the first calendar week of a year.

Allowed values: 1, 4, 7
Default value: "4"

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

CP and WP processes

JOBP_SAVE_INCOMPLETE

This is the setting for saving workflows.

Allowed values: YES, NO or ASK (default)

"YES" - The workflow will always be saved.
"NO" - The workflow cannot be saved because there are still tasks that have no predecessors and/or successors.
"ASK" - A query displays and asks whether the workflow should be saved.

UserInterface

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 have not to be changed one by one.

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

MAX_USER_INTERFACE

The maximum number of UserInterfaces that can be logged on at the same time.

Allowed values: "1" to max. license count

No

NOW_MINUS

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

Allowed values: "1" to "5"
Default value: "1"

No

NOW_PLUS

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

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

No

OBJECT_AUDIT

The logging for the revision report.

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

"Y" - Logging for the revision report is made.
"N" - There is no logging.

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 task aborts if this time is exceeded. 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 task aborts if this time is exceeded.
  The PromptSet dialog is called if the user logs on again within this time period.
  

The task aborts if the graphical interface is closed although 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:

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 passwordA secret combination of characters for a Automation Engine user. 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 value), 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 defined without a password. You might want to use this setting to specify a default password that complies with your configured password policy. If you specify a default password here, you must let new users know what it is so they can use it the first time they log into this client. When a password is specified here, users will use this password when logging into the client for the first time. They will then be prompted to change their password. If nothing is specified here, the default password for new users defined without a password will be "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 and this key 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

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

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

No

PWD_CONTAINS_NUMBER

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

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

No

PWD_CONTAINS_SPECIAL_CHARACTER

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

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

No

PWD_CONTAINS_UPPER_CASE

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

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

No

PWD_FORBID_LOGIN

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

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

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

The maximum length of user passwords.

Allowed values: "0" - "32"
Default value: "32"

No

PWD_LENGTH_MIN

The minimum length of user passwords.

Allowed values: "0" - "32"
Default value: "0"

No

SEARCH_SCRIPT_FOR_USAGE

The search for object use in script.

Allowed values: "Y", "L" and "N" (default value)

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

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

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.

The access trace function can be reviewed in the System Overview (provided that the required privileges are assigned). 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 UserInterface. 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 provided that 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>

(optional) This key sets the default values for the agent to be used to send emails and the Login object containing the desired login data for sending emails and attachments.

If the parameters Agent and Login are specified in individual SEND_MAIL script functions anywhere throughout the client, those script statement values will be overridden by this setting.

Using the Automation Engine's Email connection 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.

The maximum size (in bytes) for the report file that is sent via email.

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

In the Notification tab of the Notification object, you can enter the RunID of a task whose reports should be included in the message. The setting SMTP_MAX_ATTACHMENT_SIZE limits the report-file sizes.

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".

This limitation does not affect files that are sent via email.

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

Allowed values: "0" - "999"
Default value: "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

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 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 stands for the highest, 255 for the lowest priority. If 0 is selected for executable objects in the Attributes tab, the priority that is defined for the client in this entry is used. If no default priority is specified, or the variable is not available in the local client, the priority is 200

Note that 0 is the highest possible task priority. It can only be specified here.

TEMPLATE_SHOW_ALL

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

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

"Y" - The selection dialog shows all object types.
"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 configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. of the variable UC_OBJECT_TEMPLATE.
• The specification that has been made in TEMPLATE_SHOW_ALL.
  

If value "N" has been specified, only the object types that can be created by the particular user (for example, the user has a "write" privilege) are listed.

If you specify "Y", the users can see all the 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.  

Here you can specify the required behavior if Variable objects cannot be found whose value should be used to replace placeholders in attributes at runtime.

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

In AE, you can insert values of Variable objects in the attributes of executable objects at runtime. As a placeholder, specify the variable name enclosed in { } brackets as 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. The value of the result column (in dynamic variables) or the first Value column (in static variables) of the first entry (Key) is used if neither a column nor a key have been specified.

The setting VARA_ERROR_ON_REPLACEMENTcan be used in order to determine whether the task should be canceled if the specified variable cannot be found. If "N" is used (system settings) and the Variable object is not available, the attribute value including the invalid placeholder are assumed.

VERSION_MANAGEMENT

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

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 value: "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.

This option is deactivated when you specify a different value or no value (=default 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.

XRO_REPORTS

External report analysis.

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

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

No