UC_CLIENT_SETTINGS - Various Client Settings

The predefined client VARA object UC_CLIENT_SETTINGS stores client-specific settings. Settings that are specific to clients may control the behavior of the system when the AE starts. They may handle the access control of the authorization system, define maximum life-spans of user passwords, or log the system status. The same settings are shown in the Client object and can be edited there. . For more information, see Clients (CLNT).

• ALIAS_SPECIAL_CHARACTERS

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

  • Default value: -#
  • Restart required: No

• API_QUEUE

  Indicates the Queue object that is used to execute CallAPI scripts.

  • Default value: CLIENT_QUEUE
  • Restart required: No

• AUTO_FORECAST Parameters

  Contains the following parameters relevant for the Autoforecast function:

  • AUTO_FORECAST_DAYS

    • Default value: 1
    • Restart required: No

  • AUTO_FORECAST_PREFIX

    • Default value: Name prefix for forecasts that are created by the Autoforecast function
    • Restart required: No

• CALENDAR Parameters

  Contains the following parameters relevant for the Calendar.

  • CALE_LOOK_AHEAD_MAX

    • Default value: 14
    • Allowed values: 0-9999
    • Restart required: No

  • CALE_WARN_LEVEL

    • Value: Number of days prior to a calendar's expiration date that triggers an advance warning
    • Restart required: Server, see Starting and Ending Server Processes

  • CALE_WARN_NOTIFICATION

    • Value: notification that is activated in order to warn in advance that a calendar will expire
    • Restart required: Server, see Starting and Ending Server Processes

• CLIENT Parameters

  Parameters relevant for Clients

  • CLIENT_PRIORITY

    Determines the priority of the Client

    • Allowed values: 200 - 255

    • Restart required: No

  • CLIENT_STATUS

    Stops and releases automatic processing within a client

    • Allowed values: GO / STOP

    • Restart required: No

• DEACTIVATION Parameters

  Contains the following deactivation parameters:

  • DEACTIVATION_DELAY_TIME

    Deactivation time in minutes

    • Allowed values:

      Integers only

      Valid value range: [0,999999]

    • Restart required:

      No

  • DEACT_FAULT_OTHER

    Determines what should happen with the tasks that en with FAULT_OTHER status

    • Allowed values:

      • Y (Yes)

        The deactivation options are not considered. The task itself is deactivated.

      • N (No)

        The deactivation options are considered.

    • Restart required:

      No

• DEFAULT_TASKLIST_TIMESPAN

  Default number of hours in integer form to check for Process Monitoring filters in the Automic Web Interface

  • Default values

    12 hours

  • Restart required:

    No

• EH_KICK_INTERVAL

  Refresh interval for viewing tasks in the in the Tasks list and in the monitors (Process Monitoring perspective).

  • Default value:

    3 seconds

  • Restart required:

    No

• ERT Parameters

  Client-wide variable object that contains the following parameters relevant for the Estimated Runtime (ERT) calculation

  • ERT_ADAPTIVE

    • Allowed values:

      • Y

        Activates adaptive ERT calculation

      • N

        Deactivates adaptive ERT calculation

    • Restart required:

      No

  • ERT_ADAPTIVE_DEFAULT_CONTEXT

    • Allowed values:

      • FIXED

        Static predefined value

      • AVERAGE

        Dynamically retrieved average value

      • LINEAR REGRESSION

        Dynamic value, based on linear regression

      • MAXIMUM

        Dynamic value, based on the longest actual runtime

    • Default value:

      LINEAR REGRESSION

    • Restart required:

      No

  • ERT_ADAPTIVE_FALLBACK_METHOD

    • Allowed values:

      • FIXED

        Static predefined value

      • AVERAGE

        Dynamically retrieved average value

      • LINEAR REGRESSION

        Dynamic value, based on linear regression

      • MAXIMUM

        Dynamic value, based on the longest actual runtime

    • Default value:

      LINEAR REGRESSION

    • Restart required:

      No

  • ERT_CALCULATION

    • Allowed values:

      • BATCH

        Deactivates ERT calculation

      • IMMEDIATE

        Activates ERT calculation

    • Default value:

      IMMEDIATE

    • Restart required:

      No

  • ERT_CHECK_COUNT

    • Allowed values:

      Two-digit value between 1 and 25

    • Default value:

      20

    • Restart required:

      No

  • ERT_CORR_PERCENT

    • Allowed values:

      Up to three-digit values

    • Default value:

      0

    • Restart required:

      No

  • ERT_FRT

    • Allowed values:

      Up to three-digit values

    • Default value:

      0

    • Restart required:

      No

  • ERT_IGNORE_PERCENT

    • Allowed values:

      Up to three-digit values

    • Default value:

      0

    • Restart required:

      No

  • ERT_METHOD

    • Allowed values:

      • FIXED

        Static predefined value

      • AVERAGE

        Dynamically determined average

      • LINEAR REGRESSION

        Dynamic value based on linear regression

      • MAXIMUM

        Dynamic value based on the longest actual runtime

      • ADAPTIVE

        Intelligent ERT calculation that considers various factors and runtime parameters

    • Default value:

      LINEAR_REGRESSION

    • Restart required:

      No

  • ERT_MINIMUM_COUNT

    • Allowed values:

      Two-figure value between 1 and ERT_CHECK_COUNT

    • Default value:

      0

    • Restart required:

      No

• EXT_REPORTS

  Controls the creation of extended reports, see Extended 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 Agent, which is platform-specific

    • OBJECT_ACCESS

      Log of access to objects

    • SQL_VAR

      Log for access to SQL variables including SQL statement and parameters

    Note: Use commas to separate values.

  • Restart required:

    No

• FIRST_DAY_OF_WEEK

  Defines the first day of the week

  • Allowed values:

    • 1 - Sunday

    • 2 - Monday

    • 3 - Tuesday

    • 4 - Wednesday

    • 5 - Thursday

    • 6 - Friday

    • 7 - Saturday

  • Restart required:

    No

• FIRST_WEEK_METHOD

  Specifies which is 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

    • 7 - The first week that includes 7 days of the new year

  • Default value:

    4 - The first week that includes at least 4 days of the new year

  • Restart required:

    CP and WP Processes, see Starting and Ending Server Processes

• GENERIC_ACTIVITIES_LIMIT

  Sets the maximum number of tasks that the Automic Web Interface should be displayed in the Process Monitoring perspective

  • Allowed values:

    0 - 20000

  • Default value:

    5000

  • Restart required:

    No

• KDC_LOGIN_FORCED

  Determines whether authentication via Kerberos Distribution Center is optional or not

  • Description:

    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.

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

  • Allowed values:

    • Y
    • N

• MAX_SEARCH_RESULTS

  Maximum number of results that are returned by the global search, see Global Search

  • Allowed values:

    Integers only.

  • Valid value range:

    [1,50]

  • Default value:

    5 rows

  • Restart required:

    No

• Validity Period of Calendar Events Parameters

  Client-wide variable object that specifies the number of years considered in dynamic Calendar calculations.

  • NOW_MINUS

    • Allowed values:

      1 - 5

    • Default value:

      1

    • Restart required:

      No

  • NOW_PLUS

    • Allowed values:

      1 - 10

    • Default value:

      6

    • Restart required:

      No

• OBJECT_AUDIT

  Activates or deactivates object logging and that store the results in the utility AE DB revision report, see AE DB Revision Report

  • Allowed values:

    • Y

      Logging for the revision report is activated

    • N

      Logging for the revision report is not activated

  • Default value:

    N

  • Restart required:

    No

• PASSWORD Parameters

  Settings for User passwords

  • PWD_AGE_MAX

    • Allowed values:

      Integer

    • Default value:

      Empty

    • Restart required:

      No

  • PWD_ATTEMPTS_MAX

    • Allowed values:

      Integer

    • Default value:

      Unlimited

    • Restart required:

      No

  • PWD_CONTAINS_LOWER_CASE

    • Allowed values:

      • Y
      • N

    • Default value:

      N

    • Restart required:

      No

  • PWD_CONTAINS_NUMBER

    • Allowed values:

      • Y
      • N

    • Default value:

      N

    • Restart required:

      No

  • PWD_CONTAINS_SPECIAL_CHARACTER

    • Allowed values:

      • Y
      • N

    • Default value:

      N

    • Restart required:

      No

  • PWD_CONTAINS_UPPER_CASE

    • Allowed values:

      • Y
      • N

    • Default value:

      N

    • Restart required:

      No

  • PWD_DEFAULT

    Default password for new Users that have been created and configured without a password

  • PWD_FORBID_LOGIN

    • Allowed values:

      • Y
      • N

    • Default value:

      N

    • Restart required:

      No

  • PWD_GENERATION

    • Allowed values:

      1 - 99

    • Default value:

      0 (the new password is not compared to any older passwords)

    • Restart required:

      No

  • PWD_LENGTH_MAX

    • Allowed values:

      0 - 32

    • Default value:

      32

    • Restart required:

      No

  • PWD_LENGTH_MIN

    • Allowed values:

      0 - 32

    • Default value:

      0

    • Restart required:

      No

• PROMPT Parameters

  Maximum waiting time for a task that includes PromptSets

  • PROMPT_RESPONSETIME

    • Default value:

      0 (= unlimited)

    • Restart required:

      No

  • PROMPT_TIMEOUT

    • Default value:

      0 (= unlimited)

    • Restart required:

      No

• REMOTE REPOSITORY Parameters

  Establishes the connection to the remote repository you want to use the Version Control functionality

  • REMOTE_REPOSITORY_URL

    SSH URL needed to establish the connection

  • REPOSITORY_SSH_DIR

    SSH directory you wish to use when connecting to a remote repository

• SEARCH_SCRIPT_FOR_USAGE

  Controls the search for object use in scripts

  • Allowed values:

    • Y
    • L
    • N

  • Default value:

    N

  • Restart required:

    No

• SECURITY Parameters

  Client-wide variable object that contains security parameters relevant for the access trace function of the authorization system

  • SECURITY_AUDIT_FAILURE

    • Allowed values:

      • HOST_ACCESS

        All the denied attempts to access a host are logged.

      • LOGON

        All the denied login attempts are logged.

      • OBJECT_ACCESS

        The denied attempts to access an object are logged.

      • USER_PRIVILEGES

        All denied user privileges are logged.

    • Restart required:

      No

  • SECURITY_AUDIT_SUCCESS

    • Allowed values:

      • HOST_ACCESS

        Authorized host accesses are logged

      • LOGON

        Authorized logins are logged

      • OBJECT_ACCESS

        Authorized object accesses are logged

      • USER_PRIVILEGES

        Authorized user privilege uses are logged

    • Restart required:

      No

• SEND_MAIL_DEFAULT

  Sets the Agent and the Login object that should be used in SEND_MAIL script functions

  • Format:

    SEND_MAIL_DEFAULT = <agent object>,<login object>

  • Restart required:

    No

• SMTP Parameters

  Settings for the email connection to the Automation Engine.

  • SMTP_FROM_ADDR

    • Description:

      Email address of the sender

    • Restart required:

      No

  • SMTP_LOGIN

    • Description:

      Name of the Login object that is used to log on to the SMTP server

    • Restart required:

      No

  • SMTP_MAX_ATTACHMENT_SIZE

    • Allowed values:

      400 - 50000

    • Default value:

      8000

    • Restart required:

      No

  • SMTP_REPLY_TO

    • Description:

      Email address for the response

    • Restart required:

      No

  • SMTP_SERVER

    • Description:

      Name of the SMTP server

    • Restart required:

      No

  • SMTP_TIMEOUT

    • Allowed values:

      0 - 999

    • Default value:

      20

    • Restart required:

      No

• STARTUP_ACTION

  Influences the behavior of the system after the Automation Engine has started

  • Allowed values:

    • STOP

      The Client stops automatic processing after the Automation Engine has been started

    • WAIT x (seconds)

      The Client suspends automatic processing after the Automation Engine has been started and waits for the specified period of time

  • Default:

    Automatic processing is immediately active when the Automation Engine has started

  • Restart required:

    Server, see Starting and Ending Server Processes

• TASK_PRIORITY

  Priority of the task processed by the Client. This priority is overruled by the value entered on the Attributes page by developers and object designers when defining an executable object. For more information, see Attributes Page.

  • Allowed values:

    1 - 255, where

    • 1 = highest priority
    • 255 = lowest priority

    If no default priority is specified, or if the variable is not available in the Client, the priority of an object is 200.

  • Restart required:

    No

• TEMPLATE_SHOW_ALL

  In combination with the UC_OBJECT_TEMPLATE variable, this parameter determines which templates are provided as basis for the creation of objects.

  • Allowed values:

    • Y

      Users in this Client 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, it is compared with the name of the template when a new object is created. For more information, see Users (USER), User Groups (USRG).

    • N

      Only the object types that can be created by the particular User are listed in the Add Object dialog.

  • Restart required:

    No

• VARA_ERROR_ON_REPLACEMENT

  Specifies what should happen if the values of VARA objects cannot be resolved at runtime when they are used in the attributes of executable objects

  • Allowed values:

    • Y

      An error occurs and processing aborts

    • N

      Processing continues. The value is assigned as specified and no replacement takes place (default)

  • Default value:

    N

  • Restart required:

    No

• VERSION_MANAGEMENT Parameters

  Controls the object Version Management functionality

  • VERSION_MANAGEMENT

    Determines whether object Version Management is activated or not

    • Allowed values:

      • Y

        Version Management is activated

      • N

        Version Management is not activated

    • Default value:

      N

    • Restart required:

      No

  • VERSION_MANAGEMENT_SUFFIX

    With Version Management activated, it determines the name of the duplicated (old) object

    • Allowed values:

      Up to 8 characters. Entries that include more characters are truncated.

    • Default value:

      OLD

    • Restart required:

      No

• WAIT_STATE_RECORDING

  Stores specific information about tasks that are in a waiting status caused by a queue (queue stop or queue limit) in the Automation Engine database

  • Allowed value:

    QUEUE

    This option is deactivated if you specify a different value or no value at all.

  • Restart required:

    No

• WF_COMPLETION_ACCELERATION

  Activates an additional parameter to accelerate the execution of certain Workflows based on their task completion rate

  • Allowed values:

    • NO

      No extra parameter is taken into account

    • ABSOLUTE

      The task completion rate is taken into account

  • Default value:

    No

  • Restart required:

    No

• XRO_REPORTS

  Activates the logging of Job and File Transfer data to facilitate external report analysis

  • Allowed values:

    • Y

      Report data of jobs and file transfers are logged

    • N

      Report data of jobs and file transfers are not logged

  • Default value:

    N

  • Restart required:

    No

See also:

• UC_SYSTEM_SETTINGS - Systemwide Settings
• VARA Objects
• List of VARA Objects for System and Client Values