Skip to main content

System Properties

Properties for your Universal Controller system are set (in the Controller database) during Controller installation. These properties let you define Controller system information and performance.

Universal Controller system properties do not reside in a properties file; they are available only via the user interface.

Although you can reset these properties any time after the Controller is in operation without having to stop and restart the Controller, you should click the Reload current page icon in your browser taskbar after resetting a property.

info

You must be assigned the ops_admin role in order to reset these properties.

Step 1

From the Available Services, select Administration > Properties. The Properties list displays.

Step 2

If you want to change the value of a property, click a its Value field and select/enter a new value.

Step 3

To filter the list of displayed properties, enter appropriate characters (not case-sensitive) in the empty fields above the Name and/or Value columns.

For example, to display only properties elated to promotion, enter promotion (or PROMOTION, promo, etc.) in the empty field above the Name column.

All System Properties​

The Universal Controller system properties are as follows:

Action URL Base​

uc.action_url.base​

Specifies the Base URL of the Universal Controller web application used for automatic generation of Action URLs.

It is recommended you configure this explicitly; however, if you leave it unspecified, Universal Controller will capture the Base URL automatically using an incoming request.

In an HA configuration, this would typically be specified as the load balancer Base URL; however, if you have an HA configuration where you access the Universal Controller web application by a cluster node’s specific hostname, then you may need to use the advanced configuration shown in the examples below.

scheme://hostname[:port]/contextpath

  • Example: https://uc-server:8080/uc

cluster_node_id_1@scheme://hostname[:port]/contextpath|cluster_node_id_2@scheme://hostname[:port]/contextpath

  • Example: ha1:8080-uc@https://ha1:8080/uc|ha2:8080-uc@https://ha2:8080/uc

Default: (none)

Administrator Email Address​

uc.admin.email_addr​

System administrator email address(es) specified as the recipient(s) for System Notifications. Addresses for multiple administrators should be specified in a comma-separated list.

Default: (none)

Agent Address Information Restricted​

uc.agent.address_info_restricted​

Specification (true or false) for whether or not to hide the IP address of an Agent from non-Administrator (ops_admin) users.

If the property is set to true and the user is a non-Administrator, the IP Address field of Agents will display ***** instead of the actual value for that user.

Default: true

Agent Cache Retention Period in Days​

uc.agent.cache.retention​

Number of days that cache files (stdout, stderr) are retained by the system.

Default: 7

Agent Cluster Network Alias Cache Retention In Minutes​

uc.agent_cluster.network_alias.cache_retention_in_minutes​

Amount of time (in minutes) that a resolved Network Alias will be used before attempting to resolve it again.

Default: 30

Agent Cluster Network Alias Retry Interval In Minutes​

uc.agent_cluster.network_alias.retry_interval_in_minutes​

Amount of time (in minutes) before automatically retrying the Network Alias resolution upon failure.

Default: 5

Agent Cluster Network Alias Uquery Port​

uc.agent_cluster.network_alias.uquery_port​

Default port for an Agent Cluster with a Distribution method of Network Alias if no Agent Port is specified.

Default: 7887

Agent Credentials Required​

uc.agent.credentials.required​

Specification (true or false) for whether or not Credentials are required for agent-based tasks and Application Resources.

Default: false

Agent Credentials Required On Registration​

uc.agent.credentials.required.registration​

Specification (Windows, Linux/Unix, z/OS) for whether the agent has to use the credentials or not.

Default: (none)

Agent Heartbeat Grace Period in Seconds​

uc.agent.heartbeat.grace_period_in_seconds​

Grace period in seconds (minimum 30, maximum 600) that the Controller will allow for a delayed heartbeat message.

Default: 60

Agent Heartbeat Interval in Seconds​

uc.agent.heartbeat.interval.in.seconds​

Number of seconds between each heartbeat message sent by the agent to the Controller.

Default: 120

Agent Notification Disabled If Suspended​

uc.agent.notification.disable_if_suspended​

Specification (true or false) for whether or not Agent notifications will not be processed (true) when a suspended Agent goes active/offline.

Default: false

Agent Prefix​

uc.agent.prefix​

Prefix appended to the Queue name for newly registered agents. A 4-digit number is appended to this prefix.

Default: AGNT

Allow In Doubt Re-run​

uc.task_instance.rerun.allow_in_doubt​

Specification (true or false) for whether or not the Controller will allow the re-run of a task instance if it is in the In Doubt status.

Default: true

Audit Owner Read Permitted​

uc.audit.owner.read.permitted​

Specifies if users without the ops_admin role or the ops_audit_view role can view their own audits, specifically, any audit indicating it was Created By their User Id (Username).

Default: true

Autofit Plain Large Text Fields​

uc.universal_template.text_field.large.plain.auto_fit​

Specification (true or false) for whether or not the Controller will auto-fit Universal Task Large Text Fields when Text Type is Plain.

Default: true

Automatically Create Versions​

uc.version.automatically​

Specification (true or false) for whether or not the Controller will retain copies of previous versions. Affects system behavior when you make updates to records in your Controller database, such as changing a task definition.

Default: true

Automatically Skip Conflicting Multi-Origin Paths​

uc.workflow.skip_conflicting_multi_origin_paths​

Specification (true or false) for whether or not the Controller will automatically skip a task (within a workflow) that is connected to multiple predecessor tasks, where one or more of the predecessor tasks would cause the task to be run and one or more would cause the task to be skipped.

Default: false

uc.banner.background_color​

Hexadecimal color code for the color of the Universal Controller user interface page banner. Valid values are #[0-9, a-f, A-F] (six characters) or transparent.

Default: transparent

For transparent, color will be based on Theme.

Name of the Banner Logo file to use in the Universal Controller user interface page banner (next to the Stonebranch logo). Enter the name of the logo file, excluding the path, from directory ../tomcat/uc_images/. Valid logo files end in extension .png, .jpg, or .gif.

info

The banner logo is allocated a maximum width of 298px and a maximum height of 32px. The image will be scaled, preserving its ratio, to fit within its designated area.

Default: (none)

uc.banner.logo_url​

URL of a web resource that you want the Banner Logo to link to. The URL must begin with http://, https://, or ftp:// and contain no spaces. (Banner Logo URL is not a valid URL.)

Default: (none)

Broadcast On Hold If Cluster Suspended​

uc.cluster_broadcast.hold_on_suspended​

Specification (true or false) for whether or not cluster broadcast tasks will be run if the agent cluster selected for the broadcast has been suspended.

Default: true

Broadcast On Hold If Cluster Unresolved​

uc.cluster_broadcast.hold_on_unresolved​

Specification (true or false), for a task instance defined within a worfklow, if a broadcast cluster is specified, and Universal Controller is unable to find the broadcast cluster by id, or unable to resolve the broadcast cluster variable, or the Execution User cannot read the cluster due to security constraints, that the task instance should be Held, with an appropriate Hold Reason, rather than the instance becoming Undeliverable only when eligible to run.

Default: true

Bulk Export Activity Permitted​

uc.bulk_export.activity.permitted​

Specification (true or false) for whether or not to permit the Bulk Export Activity server operation to be run.

Default: false

Bundle Exclude On Existence Picker Default​

uc.bundle.exclude_on_existence.picker.default​

Default selection for the Exclude on Existence field in both the Bundle Details for a new Bundle and the Promote dialog when promoting one or more individual records, which identifies record types in the promotion payload that will not be updated if they exist on the target server.

Use the Shift and/or Ctrl keys to select multiple record types.

Default: (none)

Bundleless Promotion With Execute Permission Permitted​

uc.promotion.bundleless.execute_permission.permitted​

Specifies whether or not a bundleless promotion should be limited to users with the ops_promotion_admin role, or if users with promotion target Execute permission should be permitted to perform a bundleless promotion.

Default: false

Business Service Visibility Restricted​

uc.bsrvc.visibility_restricted​

Specifies (true or false) if drop-down menus for selecting a Business Service, such as Member of Business Services, should be restricted to displaying only those Business Services for which a user has an assigned or inherited Permission or relevant Roles.

If a user has any Permission, directly assigned or inherited, with Member of Any Business Service or Unassigned selected, the user will have no Business Service visibility restrictions.

If user is assigned a Permission, directly assigned or inherited, with Not Member of Specific Business Services or Unassigned or Not Member of Specific Business Services selected, then visibility will be granted for every Specific Business Service not specified.

For any Permission that the user has, directly assigned or inherited, with an explicit Business Service specified for Member of Business Services, visibility for that specific Business Service will not be restricted.

The following Roles, directly assigned or inherited, provide a user with unrestricted Business Service visibility.

  • ops_admin
  • ops_agent_cluster_admin
  • ops_bundle_admin
  • ops_dba
  • ops_email_admin
  • ops_oms_admin
  • ops_peoplesoft_admin
  • ops_promotion_admin
  • ops_sap_admin
  • ops_service
  • ops_snmp_admin
  • ops_user_admin
info

In cases where the user can Read a record that is a member of one or more Business Services, and visibility for one or more of those Business Services is restricted for that user, the user will be able to see the display name of those Business Services in the Member of Business Services field; however, the drop-down will not contain those Business Services for selection.

Any attempt to modify the selection of the Member of Business Services field will result in the removal of restricted Business Services from the selection.

Default: false

Calendar Preview Past Period In Months​

uc.calendar.preview.past.months​

Number of months (going backwards) to show all Custom Days defined for a calendar in a Calendar Preview.

Default: 3

Calendar Preview Future Period In Years​

uc.calendar.preview.years​

Number of years (starting from the end of the current year) to show all Custom Days defined for a calendar in a Calendar Preview.

Default: 2

Change History Description CLI Required​

uc.change_history.description.cli.required​

Specifies (true or false) if the change-description parameter is required or optional when modifying records via the Command Line.

Only applicable when the Change History Enabled property is true.

Default: false

Change History Description Required​

uc.change_history.description.required​

Specifies (true or false) if users are prompted with a mandatory or optional Change Description field when modifying records via the User Interface.

Only applicable when the Change History Enabled property is true.

info

If you change this property, you must log out and log back in for the change to take effect.

Default: false

Change History Description Web Service Required Required​

uc.change_history.description.web_service.required​

Specifies (true or false) if the X-Change-Description header is required or optional when modifying records via the Web Services API.

Only applicable when the Change History Enabled property is true.

Default: false

Change History Enabled​

uc.change_history.enabled​

Specifies (true or false) if users are prompted with a Change Description field when modifying records. The specified Change Description will be added as a new entry to the Change History list of the record. Change history will be added to the Metadata section.

Change History is supported by:

  • Agent Cluster
  • Application
  • Calendar
  • Credentials
  • Custom Day (Global)
  • Database Connection
  • Email Connection
  • Email Template
  • Business Services
  • OAuth Client
  • Peoplesoft Connection
  • Sap Connection
  • Script
  • SNMP Manager
  • Task
  • Task Instance
  • Trigger
  • Variable (Global)
  • Virtual Resource

Users will also be prompted for a Change Description when modifying any related data from a tab of the above record types. The specified Change Description will be propagated to the Change History of the parent record.

info

If you change this property, you must log out and log back in for the change to take effect.

Default: false

Change History Retention​

uc.change_history.retention​

Specifies the maximum number of Change Descriptions to retain before Change Descriptions start getting pruned (minimum = 10, maximum = 1000).

Default: 100

CLI/Web Service Result Limit​

uc.cli.result_limit​

Maximum number of records that can be retrieved (or matched) for the following:

  • CLI List APIs excluding List Predecessors / Successors of a Task Instance in a Workflow CLI
  • CLI APIs for limiting matches:
    • Launch a Task
    • Export Trigger
    • Disable a Trigger
    • Enable a Trigger
    • Launch Trigger Tasks Now
  • Web Service List APIs:
    • List Task Instances
    • List Task Instances - Advanced
    • List Tasks
    • List Tasks - Advanced
    • List Triggers
    • List Triggers - Advanced
    • List Virtual Resources
    • List Virtual Resources - Advanced
    • List Variables
    • List Variables - Advanced

Default: 1000

Client Export Fetch Limit​

uc.export.client.fetch_limit​

Number of records to pre-fetch before performing an export to CSV, PDF, XLS (Excel), or XLSX. Before performing an export, the client will attempt to pre-fetch all list grid data. If after the pre-fetch, the list grid does not contain all matching rows, a warning displays, before continuing with the export, indicating that the export doesn't contain everything.

Default: 1000

Compress Bundle Promotion Payload​

uc.bundle.payload_compression​

Specification (true or false) for whether or not the Controller will compress record bundles during a promotion.

Default: false

Confirm Enable/Disable Trigger Command​

uc.user.confirm.enable.disable.trigger.default​

Specification (yes or no) for whether or not a confirmation pop-up displays if a user selects to enable or disable a trigger.

Default: yes

Confirm Exit​

uc.browser.confirm_exit​

Specification (true or false) for whether or not a confirmation pop-up displays if a user navigates away from the Universal Controller user interface (or closes the browser without logging out).

Default: true

Confirm Update For Tasks In Workflows​

uc.task.confirm.workflow_update​

Specification (true or false) for whether or not a user, when updating a task, is prompted with a Confirmation dialog listing all Workflows containing that task, since those Workflows could be impacted by the task update.

Default: false

Continue Monitoring Completed Workflows in Workflow Monitor​

uc.workflow_monitor.monitor_completed​

Specification (true or false) for whether or not the Controller will continue monitoring completed Workflows in the Workflow Monitor.

Default: false

uc.version.on.related.list.change​

Specification (true or false) for whether or not a record version will be created if the user changes a record associated with the current record. For example, if true, the Controller will create a version of the task when the user changes a task variable.

Default: true

Critical Path Calculations Permitted​

uc.cp.calculations.permitted​

Specification (true or false) for whether or not a user can use the Critical Path feature of the Controller.

Default: false

Critical Path Color​

uc.cp.color​

Hexadecimal color code for the color of the vertices and edges along the Critical Path displayed within the Workflow Monitor while in Critical Path view. Valid values are #[0-9, a-f, A-F] (six characters).

Default: #FF0000 (red)

Critical Path Dynamic Calculation Threshold In Seconds​

uc.cp.calculations.dynamic.threshold_in_seconds​

When a task instance completes, if the difference between its end time and its projected end time is greater than or equal to the threshold specified in seconds, a critical path recalculation event will be dispatched. Valid values are 0-600.

Default: 0

Critical Path Monitor Polling Interval In Seconds​

uc.cp.monitor.polling.interval_in_seconds​

Interval (in seconds) in which that Universal Controller queries for task instances with a status greater than WAITING, and less than SKIPPED, and have elapsed their projected end time. Valid values are 60+.

Default: 300

Critical Path Monitor Polling Threshold In Seconds​

uc.cp.monitor.polling.threshold_in_seconds​

Threshold (in seconds) that Universal Controller uses to determine if a task instance has elapsed its projected end time when polling. Valid values are 60+.

Default: 60

Critical Path Projected Late Action Maximum​

uc.cp.projected_late.action.maximum​

Number of times that a task instance can invoke Actions On Projected Late before being muted.

As a task instance Projected End Time changes, the Projected Late flag can be set and cleared multiple times. In such situations, this property limits the number of Actions being performed On Projected Late, such as Email Notifications, for a particular instance.

Default: 5

Critical Path Projected Late Threshold In Minutes​

uc.cp.projected_late.threshold_in_minutes​

Threshold beyond the Late Start Time, Late Start Duration, or Late Finish Time that the projected time must exceed in order for the task instance to be flagged as Projected Late.

Default: 5

Custom Day Global Permitted​

uc.custom_day.global.permitted​

Specification (true or false) for whether to enable (true) or disable (false) global Custom Days.

info

You cannot set Custom Day Global Permitted to false if there are any existing global Custom Days.

Default: true

Custom Day Local Indicator Enabled​

uc.custom_day.local_indicator.enabled​

Specification (true or false) for whether to enable (true) or disable (false) the Local Custom Day indicator ({L}) for Trigger and Composite Trigger components, Task Run Criteria, and Calendar Preview.

Default: true

Custom Day Strict Mode​

uc.custom_day.strict.mode​

Specification (true or false) for whether or not a Custom Day referenced in the Complex section of Task Run Criteria for a task in a workflow must belong to the Calendar in use at run time.

Default: false

Data Backup/Purge Export Path​

uc.backup.path​

Export path to use instead of the default export path (uc_backups under the Tomcat directory) for Data Backup/Purge operations.

Default: (none)

Deployment Wait For Running Instances Timeout In Seconds​

uc.extension.deployment.wait_timeout_in_seconds​

Specifies the number of seconds to wait before failing the tasks waiting for the deployment.

Default: 600

Disable Tab Indicators​

uc.disable.tab.indicators​

Specification (true or false) for whether or not to disable the tab icons that indicate if tabs contain (green icon) or do not contain (gray icon) records.

Default: false

Email Body Default Begin Marker​

uc.email.body_begin_marker​

Default Begin Marker for Email Monitor Body Variables field.

Default: -- BEGIN --

Email Body Default End Marker​

uc.email.body_end_marker​

Default End Marker for Email Monitor Body Variables field.

Default: -- END --

Email Credentials Permitted​

uc.credentials.email.permitted​

Specification (true or false) for whether or not to enable the use of Email Credentials.

Default: true

Email Monitor Polling Interval In Seconds​

uc.email.monitor.polling.interval_in_seconds​

Number of seconds between each poll of a Mailbox Folder by an Email Monitor task.

Default: 120

Email Notification Audit​

uc.email.notification.audit​

Specification (Success/Failed or Failed) for how to identify an Email Notification audit.

Default: (none)

Enable Force Rerun For z/OS Job Steps​

uc.zos.jobstep_force_rerun​

Specification (true or false) for whether or not the Select for Re-run (Force) action is available when selecting z/OS Restartable Job Steps. Force re-run skips the dependency check and forces the selected job step to re-run.

Default: false

Exclude Holidays for Business Days​

uc.calendar.exclude_holidays​

Specification (true or false) for whether or not the Controller will consider a Business Day on which a holiday falls as a non-Business Day.

  • If true, holidays that fall on Business Days are considered non-Business Days.
  • If false (the default), holidays that fall on Business Days are considered Business Days.

For example, if the default value (false) is used, and a job is defined to run on Business Days, the job will run on Christmas Day, even though it is a holiday.

This behavior applies to Triggers, Task Run Criteria, and JavaScript functions that operate on Business Days, and provides a means to avoid having to specify a restriction or skip criteria for holidays.

Default: false

Expand Lists Automatically​

uc.lists.expand_automatically.default​

Specification (Yes or No) for whether or not to Expand Lists by Default in the List / Details views.

Default: No

Export Agent References​

uc.export.agent_references​

Specification (true or false) for whether or not the Controller will export referenced Agents when exporting definition XMLs with the Export References feature.

Default: false

Export Path​

uc.export.path​

Pathname where exported XML files are written.

All cluster nodes use their own local system default export path. You should set a value for Export Path only if the path is writable by all cluster nodes.

info

Any bulk import or list import of an Export Path property (from version 6.1.1.0 or earlier) will result in the server resetting the database back to the default "unset" Export Path value.

Both bulk export and list export will first look for a configured Export Path property. If a value has not been set, they will use the local system default path of <tomcat>/uc_export.

Default: (none)

Expose UDM Script​

uc.infitran.expose_script​

For debugging use only. Specification (true or false) for whether or not the Controller prepares a script when it launches a file transfer on a UDM installation. If troubleshooting is necessary, enabling this property allows you to view the script in the Output tab on the task instance.

Default: false

Expose Resolved Script​

uc.script_library.expose_resolved_script​

Specification (true or false) for whether or not to generate a SCRIPT output type capturing the resolved contents of the Scripts script for each task instance run attempt that utilizes a script from the Scripts. This property only applies to Scripts defined with the Resolve UAC Variables option checked. Any user with the task instance Read permission for a specific task instance will be able to view the SCRIPT output type content for that specific instance.

To avoid generating unnecessary output, we recommend enabling this property only for debugging purposes. The unresolved script content can always be viewed from Scripts.

For Enhanced View SAP Tasks, Specification (true or false) for whether or not to generate a SCRIPT output type capturing the resolved content of the generated SAP Definition Script for each task instance run attempt of an Enhanced View SAP task.

To avoid generating unnecessary output, we recommend enabling this property only for debugging purposes.

Default: false

File Transfer Task Exclude Protocols​

uc.task.file_transfer.exclude_protocols​

Specification for which protocols will be excluded from the Transfer Protocol field in the File Transfer Task Details:

  • FTP
  • SFTP
  • UDM
  • FTPS
  • FTPES

You can select multiple, but not all, protocols. Also, you cannot exclude a protocol if it is specified in the Transfer Protocol field for any exisitng File Transfer Task or Task Instance.

Flatten Reference List Fields In Chart Reports​

uc.report.flatten_references​

Specification (true or false) for whether or not to flatten Business Services in Chart reports when grouping by Member of Business Services.

Default: false

Forecast Period in Days​

uc.forecast.days​

Number of days to be included in a trigger forecast. See Displaying Trigger Forecast Information.

Default: 31

Inherit Actions On Defined For Insert Task​

uc.inherit_actions.on_defined.insert_task​

Specification (true or false) for whether or not a task inserted into a Workflow, whose initial inserted status will be Defined, will perform inherited Workflow Actions for the Defined status.

Default: false

LDAP Synchronization Enabled​

uc.security.ldap.enabled​

Specification (true or false) for whether or not LDAP synchronization is enabled. This allows you to retain your LDAP Settings while using or not using LDAP authentication, as desired.

Default: false

License Key​

uc.license​

License key for your installation; provided to you by your Universal Controller representative.

By default, the controller automatically refreshes the uc.properties file every 5 minutes to accommodate changes to this property without requiring a restart. To change the property refresh interval, see uc.property.refresh_interval_in_seconds.

Default: (none)

List Qualifying Times Format​

uc.trigger.date.format.display​

Format that you want the Controller to use when listing qualifying times for Time and Cron Triggers. See List Qualifying Times.

Default: EEEEE, MMMMMMM dd, yyyy HH:mm:ss z Z

Log File Retention Period in Days​

uc.log.retention​

Number of days that the Controller and Agent retain their log files.

Default: 5

Log Level​

uc.log.level​

Level of logging for the Controller:

  • ALL
  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR

Default: INFO

Login Disclaimer​

(uc.login.disclaimer}

Allows for the specification of free-form text to be displayed at the bottom of the Universal Automation Center Login page.

Default: (none)

Login Notification​

(uc.login.notification}

Allows for the addition of a pop-up to be displayed on the Universal Automation Center Login page.

Default: (none)

Maximum Extension Deployment Threads​

uc.extension.deployment.max_threads​

Maximum number of concurrent threads to handle extension deployments; minimum =1, maximum = 20.

Default: 5

Maximum Nested Variable Depth​

uc.variable.maximum_depth​

Maximum number of nested variables allowed.

Default: 25

Maximum Nested Variable Expansion​

uc.variable.maximum_expansion​

Maximum number of nested variable characters allowed.

Default: 250000

Maximum Processing Threads​

uc.threads.max​

Maximum number of processing threads used.

Default: 1000

Maximum Timer Threads​

uc.timer.threads.max​

Maximum number of timer threads used.

Default: 300

uc.navigation.auto_collapse.default​

Specification (Yes or No) for whether or not the side Navigation Menu on the Home Dashboard collapses by default.

Default: Yes

uc.navigation.bar.auto_collapse.default​

Specification (Yes or No) for whether or not the side Navigation Bar collapses by default.

Default: No

Node Time Display​

uc.node_time.display.default​

Specification (Yes or No) for whether or not the User Task Bar will display the Cluster Node time by default.

Default: Yes

Node Time Display Background Color​

uc.node_time.display.background_color.default​

Default color to use for the Cluster Node time field background in the User Task Bar.

Default: White

Node Time Display Color​

uc.node_time.display.color.default​

Default color to use for the Cluster Node time field in the User Task Bar.

Default: Black

Node Time Display Time Zone​

uc.node_time.display.tz.default​

Specification (true or false) for whether to display the time zone of the Server or the User in the Cluster Node time field in the User Task Bar.

Default: Server

OMS Log Level​

uc.oms.log.level​

Default: INFO

Open Telemetry Visualization In IFrame​

uc.otel.visualization_url.iframe​

Specification (true or false) for whether the Open Telemetry Visualization URL will open in an iframe embedded within a controller application tab (default) or open in a new browser tab.

Default: true

Open Telemetry Visualization URL​

uc.otel.visualization_url​

When an Open Telemetry Visualization URL is specified, the Details > Show Trace right-click menu action for a task instance will open the trace visualization URL in an iframe and or new browser tab, depending on the configuration of Open Telemetry Visualization In IFrame.

The following tokens are supported within the trace visualization URL.

  • ${traceId}
  • ${spanId}

The URL will be resolved using the specific trace id and span id associated with the task instance.

For example,

https://hostname:port/trace/${traceId}?uiFind=${spanId}&uiEmbed=v0 → https://hostname:port/trace/a629c8a23114d1a6fafc03291c672f68?uiFind=eb17913c4fa001f9&uiEmbed=v0

info

This is only applicable if you have configured an Open Telemetry Trace exporter.

Default: (none)

Operational Memo Reset On Re-run​

uc.task_instance.operational_memo.reset_on_rerun

Specification (true or false) for whether or not to reset the Operational Memo field on a task instance re-run.

Default: true

Perform Actions On Defined For Tasks Within Skipped Workflow​

uc.perform_actions.on_defined.tasks_within_skipped_wf​

Specification (true or false) for whether or not tasks within a workflow that is being skipped due to trigger-time run criteria should perform Actions on Defined status and evaluate their own run criteria.

Default: false

Perform Actions On Defined Workflow First​

uc.perform_actions.on_defined.wf_first​

Specification (true or false) for whether or not to allow a workflow, on Defined status, to process its own Actions prior to processing any Actions for its children task instances on Defined status.

This might be leveraged if, on Defined status, a workflow initializes a variable using the Set Variable Action, and a child task instance, also on Defined status, leverages that same variable in its own Set Variable Action.

Default: false

Perform Actions On Halt​

uc.perform_actions.on_halt​

Specification (true or false) for whether or not to allow the triggering of notifications for a task instance status change to Finished when issuing a Force Finish (Halt) or Force Finish/Cancel (Halt) command.

Default: true

Perform Set Variable Actions Before Workflow Dependency Evaluation​

uc.perform_actions.before_wf_dependency_evaluation​

Specification (true or false) for whether or not the Set Variable Action of a task in a workflow will occur before downstream path conditions of that task are evaluated.

Default: true

Picker Fetch Limit​

uc.picker.fetch_limit​

Fetch limit for all picker windows; minimum =200, maximum = 1000.

For example, the value of this property determines how many tasks can be fetched at any one time for stonebranchbundle-01.

Default: 200

Platform Log Level​

uc.platform.log.level​

Level of logging for the user interface framework:

  • ALL
  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR
  • OFF

Default: WARN

Promote By Business Service Membership Permitted​

uc.bundle.promote_by_bsrvc_membership.permitted​

Specification (true or false) for whether or not you can promote a Bundle by Business Service Membership.

You cannot set this property to false if the Promote Members of Business Services or Visible To field in any Bundle records has a non-empty value.

Also, if the proparty is set to false:

  • If the Promote Members of Business Services or Visible To field in a Bundle record has a non-empty value, Bundle promotion (including schedule Bundle promotion) is prohibited for that record.
  • If the Promote Members of Business Services and Visible To field in a Bundle reocrd has an empty/blank value, the Promote By Business Service Membership section will be hidden for this record.

Default: true

Promotion Follow References Permitted​

uc.promotion.follow_references.permitted​

Specification (true or false) for whether or not to permit utilizing follow reference option for Promotion.

Default: true

Promotion Follow Report References​

uc.promotion.report.follow_references​

Specification (true or false) for whether or not to promote referenced reports in an email task or email notification when Follow References is true for the promotion.

Default: true

Promotion History Retention Period in Days​

uc.promotion_history.retention​

Number of days that the Controller retains Promotion History.

Default: 60

Promotion Schedule Retention Period In Days​

uc.promotion_schedule.retention​

Number of days that a Promotion Schedule will remain available after the promotion has completed successfully.

Default: 7

Promotion Validate Report References​

uc.promotion.report.validate_references​

Specification (true or false) for whether or not to implement report-related promotion validation.

info

This property applies to the target system to which a promotion payload is being promoted.

Default: true

Purge Activity By Primary Key Limit​

uc.backup.purge_by_primary_key.limit​

Number of task instances to purge per transaction while performing the Activity purge (by primary key).

Default: 500

Purge Activity By Primary Key Maximum Per Backup​

uc.backup.purge_by_primary_key.maximum_per_backup​

Specifies the maximum number of records to back up per file (minimum = 1000, maximum = 10000).

Default: 2500

Purge All Non-Default Users And Groups Permitted​

uc.purge.non_default_users_and_groups.permitted​

Specification (true or false) for whether or not to allow the Purge All Non-Default Users And Groups Server Operation to be run.

Default: false

Purge Dates From Custom Day List Older Than​

uc.custom_day.purge_dates_older_than​

Number of days old (1-999) that a date in a Custom Day List of Dates will cause it to be purged automatically.

Default: (none)

Purge Replication Required​

uc.backup.purge.replication.required​

When true, specifies that the Data Backup/Purge cannot proceed with purging records that have not been replicated yet.

Only applicable if a Reporting Server is configured and enabled for replicating the type of record being purged.

Default: true

Re-run (Suppress Intermediate Failures) Permitted​

uc.task_instance.rerun.suppress_intermediate_failures.permitted​

Specification (true or false) for whether or not you can manually Re-run a task instance specifying that intermediate failures be suppressed.

Default: true

Reconcile Built-In Universal Template Changes On Promotion​

uc.promotion.universal_template.system_template.reconcile_changes​

Controls the promotion behavior when promoting a Universal Task based on a built-in Universal Template that has changed.

Default: false

Record New In Tab​

uc.record.new_in_tab.default​

Specification (Yes or No) for whether or not to display the new record editor under a new tab when clicking on the following icons:

  • for non-related record list

  • from the Services menu

  • New Task... in workflow editor

Click here to see list of affected record types...
  • Agent Cluster
  • Task
  • Trigger
  • Application
  • Back up & Purge
  • Bundle
  • Bundle Target
  • Calendar
  • Credentials
  • Custom Day
  • Database/Email/Peoplesoft/SAP Connection
  • Email Template
  • Business Services
  • Filter
  • OAuth Client
  • Oms Server
  • Report
  • Script
  • Simulation
  • Universal Event Template
  • Universal Template
  • User
  • Group
  • Global Variable
  • Virtual Resource
  • Webhook
  • Task Instance
  • Audit
  • Agent
  • Promotion History Item
  • Trigger Forecast
  • History
  • Widget
  • Color
  • Promo History
  • Promo Schedule
  • Cluster Node
  • Version (of the above types)

Default: No

Record Open In Tab​

uc.record.open_in_tab.default​

Specification (Yes or No) for whether or not to display the record Details under a new tab when double clicking (or clicking on the icon) for a record in the following cases:

  • Any non-related record list
  • Workflow tree
  • Workflow timeline
Click here to see list of affected record types...
  • Agent Cluster
  • Task
  • Trigger
  • Application
  • Back up & Purge
  • Bundle
  • Bundle Target
  • Calendar
  • Credentials
  • Custom Day
  • Database/Email/Peoplesoft/SAP Connection
  • Email Template
  • Business Services
  • Filter
  • OAuth Client
  • Oms Server
  • Report
  • Script
  • Simulation
  • Universal Event Template
  • Universal Template
  • User
  • Group
  • Global Variable
  • Virtual Resource
  • Webhook
  • Task Instance
  • Audit
  • Agent
  • Promotion History Item
  • Trigger Forecast
  • History
  • Widget
  • Color
  • Promo History
  • Promo Schedule
  • Cluster Node
  • Version (of the above types)

Default: No

Recurring Task Launch Skip Condition Default​

uc.recurring.task.skip_condition.default​

Default value of the Task Launch Skip Condition field for a Recurring Task:

  • None
  • Active
  • Active By Recurring Task Instance

Default: None

Recurring Task Minimum Frequency In Seconds​

uc.recurring.task.minimum_frequency_in_seconds​

Minimum duration, in seconds, that a Recurring Task can have for a Recurrence Interval.

The minimum value is 0.

Default: 5

Reference New In Tab​

uc.reference.new_in_tab.default​

Specifies whether to use the currently defined system default, or to select Yes or No, for whether or not to display the record Details under a new tab when creating a reference record.

Default: No

Reference Open In Tab​

uc.reference.open_in_tab.default​

Specification (Yes or No) for whether or not to display the record Details under a new tab when viewing a reference field.

Default: No

Remote File Monitor Task Exclude Protocols​

uc.task.ftp_file_monitor.exclude_protocols​

Specification for which protocols will be excluded from the Server Type field in the Remote File Monitor Task Details:

  • FTP
  • SFTP
  • FTPS
  • FTPES

You can select multiple, but not all, protocols. Also, you cannot exclude a protocol if it is specified in the Server Type field for any exisitng Remote File Monitor Task or Task Instance.

Report Average Color​

uc.report.average_color.default​

Specification of the default hexadecimal color of the average line when using the Show Average option on Bar Chart/Horizontal and Bar Chart/Vertical reports.

Default: #000000

Report Group Threshold​

uc.report.group_threshold.default​

If the Group Threshold field on the Report is - - System Default - -; Maximum number of groups to display on a Chart report. All groups above the threshold will be displayed in one group named Other.

info

This option formerly was named System Default Report Group Threshold.

Default: 10

Report Threshold Color​

uc.report.threshold_color.default​

Specification of the default hexadecimal color of the threshold line when using the Show Threshold option on Bar Chart/Horizontal and Bar Chart/Vertical reports.

Default: #000000

Resolvable Credentials Permitted​

uc.credentials.resolvable.permitted​

Specification (true or false) for whether or not the use of Resolvable Credentials is enabled.

Default: false

Retain Overridden Step Codes On z/OS Task Re-run​

uc.task_instance.rerun.zos.retain_step_codes​

Specification (true or false) for whether or not a changed return code of a previously executed step in a z/OS task is retained when the task is re-run.

Default: false

Retrieve Output Default Number Of Lines​

uc.retrieve_output.maximum_lines​

Specifies the default value for the Number of Lines field on the Retrieve Output dialog. Additionally, if the Number of Lines field is blank, it specifies the limit for the number of lines retrieved when Automatic Output Retrieval is enabled on a task.

Default: 100

Retrieve Output Maximum Lines​

uc.retrieve_output.maximum_lines.limit​

Specifies the maximum number of lines that can be requested when retrieving output.

Default: (none)

Run Command On Filtered Task Launch Limit​

uc.command.filtered.task.launch.limit​

Specifies the maximum number of tasks that can be launched at once using the Run Command On Filtered > Launch operation. By default, there is no limit.

Default: (none)

SAP Credential Type Required​

uc.task.sap.credential_type.required​

Specification (true or false) for whether or not an SAP task will only accept SAP Credentials (as opposed to other Credential Types).

Default: false

SAP Task ABAP Program Name Fetch Limit​

uc.task.sap.abap_program.fetch_limit​

Specifies the maximum number of results (10-5000) that can be retrieved from the SAP system for ABAP Program Name dynamic choice select item.

Default: 500

SAP User Name Restricted​

uc.task.sap.username.restricted​

Specification (true or false) for whether or not the SAP User Name for an SAP Job Step can only be specified by SAP User Credentials.

Default: false

Scheduled Report 3D Pie Chart​

uc.report.scheduled.3d_pie_chart.default​

Specification (Yes or No) for whether Pie Chart reports are rendered in 2D (No) or 3D (Yes).

Default: No

Scheduled Report Fetch Limit​

uc.report.scheduled.fetch_limit​

Maximum number of records to fetch for inclusion in a List report (minimum is 1; no maximum). The report will indicate if the specified maximum has been reached.

Default: 1,000

Scheduled Report Image Height​

uc.report.scheduled.image_height.default​

Specification for the height (in pixels) of PNG chart report images.

Default: 500

Scheduled Report Image Width​

uc.report.scheduled.image_width.default​

Specification for the height (in pixels) of PNG chart report images.

Default: 750

Scheduled Report Inline Image​

uc.report.scheduled.inline_image.default​

Specification (Yes or No) for whether to inline chart report images within the email (Yes) or include them as attachments (No). If any other attachments, such as standard error and standard output, are included, this property does not apply; the chart report image will be delivered as an attachment.

Default: Yes

Scheduled Report PDF Orientation​

uc.report.scheduled.pdf.orientation.default​

Specification (Landscape or Portrait) for the page layout of the PDF.

Default: Landscape

Scheduled Report PDF Size​

uc.report.scheduled.pdf.size.default​

Specification (Letter, Legal, or A4) for the page size of the PDF.

Default: Letter

Scheduled Report Time Zone​

uc.report.scheduled.tz.default​

Specification for whether to obtain the time zone from the Server (Server) or from the User record of the Execution User (User).

This property applies to all report types (List, Bar Chart/Horizontal, Bar Chart/Vertical, and Pie Chart).

Default: Server

Script Resolve Variables Default​

uc.script.variables.resolve.default​

Specification (true or false) for whether or not the Resolve UAC Variables option in scripts is enabled by default.

Default: false

Script Upload Accept List​

uc.script.upload.accept_list​

Specification for a list of allowed extensions and/or mime types. An administrator can add/remove extensions or mime types to/from the list or clear the list completely to remove restrictions altogether.

Default: .bat, .cmd, .js, .ps1, .py, .uapy, .vbs, .wsf, .sh, .usp, .udm, .yml, application/xml, application/json, text/html, text/plain

Script Upload Maximum Size​

uc.script.upload.maximum_size​

Specification for the maximum size (in bytes) of an uploaded script (minimum = 0, maximum = 2147483647)

Default: 1048576

Show Last Login​

uc.login.show_last_login​

Specification (true or false) for whether or not the last login time is shown in the console when logging into the user interface.

For more information and examples, see Show Last Login.

Default: true

Show Metadata​

uc.form.show_metadata.default​

Specification (Yes or No) for whether or not the Metadata section displays automatically in the the Details of all Controller records.

You can override this system default configuration by customizing the Show Metadata user preference.

Default: No

Show Variables Fetch Global Automatically​

uc.show_variables.fetch_global.default​

Specification (Yes or No) for whether or not to fetch and display Global Variables automatically for the Show Variables action.

If No, the visibility of Global Variables in Show Variables can still be toggled, on demand, by the Show Global and Hide Global buttons.

You can override this system default configuration by customizing the Show Variables Fetch Global Automatically user preference.

Default: No

SMTP Debug​

uc.smtp.debug​

Specification (true or false) for whether or not additional debug information about any Email Connection issues (for example, Email Connection Test fails or errors while sending emails) will be included in the log.

Default: false

SQL/Stored Procedure Close Additional Results Sets​

uc.sql_handler.close_additional_result_sets​

Specification (true or false) for whether or not to close any additional Result Sets if multiple Result Sets have been returned by SQL or Stored Procedure tasks.

info

You should not change this property to false unless there is a backwards compatibility issue.

Default: true

SQL/Stored Procedure Ignore Update Count If No Results​

uc.sql_handler.update_count.ignore_if_no_results​

Specification (true or false) for whether or not to create a SQL Results record for rows affected when no results (result sets or update counts) are returned by SQL or Stored Procedure tasks.

Default: false

SQL/Stored Procedure Maximum Rows​

uc.sql_handler.maximum_rows​

Specifies the maximum number of rows that can be returned from an SQL task or Stored Procedure task.

Default: (none)

Start Server Paused​

uc.startup.paused​

Specification (true or false) for whether or not a Universal Controller cluster node should become paused when starting up.

info

This property is applicable only for a Universal Controller cluster node that is starting up. Any cluster node that has already started will not be impacted. Once a cluster node is in paused mode, it will remain in paused mode until running the Resume Cluster Node server operation for that specific cluster node.

Default: false

Stop Unknown Application Monitors​

uc.application.stop_unknown_monitors​

Specification (true or false) for whether or not to stop any application monitors currently running on an Agent if the Controller is no longer managing those monitors (Windows and Linux/Unix only).

Default: false

Strict Dashboard Create Constraints​

uc.dashboard.create_constraints.strict​

Specification (true or false) for whether or not to restrict dashboard creation only to users with the ops_admin, ops_report_admin, ops_dashboard_group, or ops_dashboard_global role.

Default: false

Strict Report Create Constraints​

uc.report.create_constraints.strict​

Specification (true or false) for whether or not to restrict report creation only to users with the ops_admin, ops_report_admin, ops_report_group, or ops_report_global role.

Default: false

System Default Activity Quick Filters​

uc.activity.quick_filters.default​

Task instance status types to include in the Active, Blocked, Completed, and Problem Quick Filters. You can add statuses to or delete statuses from any of these Quick Filter. You also can delete any of these Quick Filters and create you own Quick Filters.

Default: Active=!180,!190,!200; Blocked=10,20,23,30,33,60; Completed=180,190,200; Problem=35,81,99,110,120,125,130,140

System Default CLI Bulk Import Path​

uc.bulk_import.path.default​

Pathname from where imported XML files are written.

Default: <tomcat-home>/uc_import or <tomcat-home>\uc_import

(<tomcat-home> is the base tomcat installation directory.)

System Default Command Line Access​

uc.user.command_line.default​

Specification (Yes or No) for all users whose Command Line access field in their User Details is set to -- System Default --, for whether or not to control a user's ability to access the Controller through the Command Line Interface (CLI).

Default: Yes

System Default Confirm Launch Command​

uc.user.confirm.launch.default​

Specification (Yes or No) for whether or not a user is prompted with a Confirmation dialog when issuing the Launch command.

info

If a task is launched that has been modified but not saved, a Confirmation dialog displays even if the System Default Confirm Launch Command is set to No.

Default: Yes

System Default Confirm Task Instance Commands​

uc.user.confirm.task_instance.commands.default​

Specification (Yes or No) for whether or not to enable command confirmations when issuing commands against task instances.

Default: No

System Default Maximum Versions​

uc.version.maximum.default​

Maximum number of version records (1 to 255) to maintain per definition.

Default: 100

System Default Trigger Simulate Forecast​

uc.trigger.simulation​

Specification (true or false) for whether or not to simulate the launching of tasks when triggers are eligible to fire. If simulation is enabled, only the scheduled launch of the task by the trigger is inhibited. All other aspects of the trigger execution, including generation of forecast data, are enabled.

You can still force a trigger by using the Trigger Now command or launch a task by using the Launch command.

Default: false

System Default Update Virtual Resource Limit On Promotion​

uc.promotion.virtual_resource.update_limit.default​

Specification (Yes or No) for whether or not virtual resource limits are updated as part of a promotion.

Default: Yes

System Default Wait/Delay Workflow Only​

uc.timewait.workflow.only.default​

Specification (Yes or No) for whether or not to apply Wait/Delay Options to a task only if it runs within a workflow.

Default: Yes

System Default Web Browser Access​

uc.user.browser.default​

Specification (Yes or No), for all users whose Web Browser access field in their User Details is set to -- System Default --, for whether or not to control a user's ability to access the Controller through the user interface.

Default: Yes

System Default Web Service Access​

uc.user.web_service.default​

Specification (Yes or No), for all users whose Web Service access field in their User Details is set to -- System Default --, for whether or not to control a user's ability to access the Controller through the RESTful Web Services API.

Default: Yes

System Details Database Information Restricted​

uc.widget.system_details.db_info_restricted​

Specification (true or false) for whether or not the following database information on the System Details widget is visible only to users assigned the ops_admin role or ops_server_operation_admin role:

  • Database Type
  • Database Name
  • Database URL
  • Database Connections

These restrictions apply no matter where the System Details widget is accessed from:

  • Home Dashboard
  • Custom Dashboard
  • Widget List Preview
  • System Identifier on User Task Bar
  • System Clock on User Task Bar

System Details Expanded Categories​

uc.widget.system_details.expanded.default​

Specification for which System Details widget categories to expand by default:

  • Cluster Node
  • Release
  • Memory
  • License
  • Database

Default: Cluster Node

System Identifier​

uc.system_identifier​

User-selected name displayed in the System Identifier field on the User Task Bar.

Default: (none)

System Identifier Background Color​

uc.system_identifier.background_color​

Background color for the System Identifier field on the User Task Bar.

Default: black

System Identifier Color​

uc.system_identifier.color​

Text color for the System Identifier field on the User Task Bar.

Default: white

Task Automatic Output Retrieval Default​

uc.task.output_return_type.default​

Default Automatic Output Retrieval field value for Windows and Linux/Unix tasks and for Universal Templates.

Default: None

Task Field Resolution Required​

uc.task.field.resolution.required​

Specification (true or false) for whether or not a task instance transitions to Start Failure if qualifying fields - such as Command, Script, Parameters (including z/OS Parameters), and Environment Variables - remain unresolved at runtime.

Default: false

Task Instance Normalize Business Service Membership​

uc.task_instance.normalize_bsrvc​

Indicates if the Universal Controller is normalizing Business Service membership for Task Instance and History records:

  • Disabled
    Business Service normalization is not enabled.
  • Enabled/Normalizing
    Business Service normalization is enabled. New Task Instance and History records are being normalized; however, existing Task Instance and History record normalization has not completed.
  • Enabled/Normalized
    Business Service normalization is enabled. New Task Instance and History records are being normalized, and normalization of existing Task Instance and History records has completed.
info

This property is read-only. It can be updated only by running the Enable Task Instance Business Service Normalization and Disable Task Instance Business Service Normalization server operations.

Default: Disabled

Task Instance Number Cache Only​

uc.task.instance_number.cache_only​

Specifies if the Universal Controller should switch to a cache only strategy for managing the Instance Number of a particular task record.

When a task is launched, it is assigned an Instance Number, starting at 1 and incremented for each instance of the specific task.

By default, the counter is persisted on the task record, requiring a database update to increment the counter.

If the cache only strategy is enabled, all management of the Instance Number is managed in memory.

On a restart, the maximum Instance Number currently in the Activity table is populated into the cache. If there are no instances, the Instance Number will restart from 1.

info

This is an advanced configuration. Please consult with support prior to enabling this option.

If instances of a particular task are all deleted or purged, the counter will reset to 0 for that particular task. As uniqueness of a task instance is determined by its UUID, this will not impact anything feature-wise. Even features like Previous Instance Wait with a Wait For Last / Wait For All configuration are not impacted as the Instance Number of the latest instance will always be greater than any prior instances. We do expose the Instance Number via the ${ops_instance_number} and alias ${ops_task_ref_count} built-in variables, so customers need to be aware how this may impact their use of those built-in variables.

To restore the legacy strategy, you must stop the Universal Controller and add the following property to the uc.properties.

uc.task.instance_number.cache_only=false

It cannot be restored from the user interface.

Default: false

Task Launch Permission Required For Insert Task​

uc.task.insert.launch.permission.required​

Specification (true or false) for whether or not users must have Launch Command permission for a task in order to insert the task into a Workflow.

By default, users with Read access for a task can insert that task into a Workflow. This property can be used to prevent a user from inserting a task into a Workflow if the user does not have both Read and Launch Command permissions on that task.

Default: false

Task Launch Reason Required​

uc.task.launch_reason.required​

Specification (true or false) for whether or not a new field, launch reason, will be added to the manual launch command of a task or trigger and these details will be added to the Notes section of the task instance details.

Default: false

Task Output Path Functions Permitted​

uc.task.output_path.functions.permitted​

Specification (true or false) for whether or not Output Path tokens generated by Task Instance Output Path and Sibling Task Instance Output Path functions are permitted.

Default: true

Task Retry Maximum​

uc.task.retry_maximum​

Specification for whether or not to enforce a maximum number of task instance retries. Valid values:

  1. blank: No limit on Maximum Retries; Retry Indefinitely is permitted.
  2. >=1: Limit on Maximum Retries; Retry Indefinitely is not permitted.
info

If any current tasks are in violation of the selected >=1 Task Retry Maximum, an error message will occur. To see which tasks have a Maximum Retries value specified, or have Retry Indefinitely selected, run a Report on all tasks or display the Maximum Retries and Retry Indefinitely columns on the All Tasks list.

Default: blank

Task Retry Re-run Permission Required​

uc.task.retry.rerun_permission_required​

Specification (true or false) for whether or not the Execution User of a task must have Re-run permission for the automatic retry to engage.

If true, the automatic retry will not engage if the Execution User does not have Re-run permission, and an error will be logged and appear in the Status Description accordingly.

If false, the Re-run permission check for automatic retries is disabled.

Default: true

Task Simulation Permitted​

uc.task.simulation.permitted​

Specification (true or false) for whether or not the simulation feature is enabled. When disabled:

  • Simulation service no longer available from Services menu.
  • Auto open for Simulation tab ignored.
  • Simulate option no longer available from Task, Task Instance and Trigger forms.
  • Simulate option no longer available from Launch with Variables… and Trigger Now… commands.

Default: true

Task Time Zone Preference​

uc.task.time_zone_preference.default​

Specification (Server or Inherited) for whether the time zone for a task is evaluated on the time zone of the server or the time zone of the Parent Workflow or Trigger / Launch specification.

Default: Server

Task Variable Path Function Permitted​

uc.task.variable_path.function.permitted​

Specification (true or false) for whether or not task variable path function is permitted.

Default: true

Task Wait For Output Timeout In Seconds​

uc.task.wait_for_output.timeout_in_seconds​

If Wait For Output is enabled for a task where automatic output retrieval is selected (potentially, to be used by a successor task); Length of time (in seconds) that the task will wait (that is, remain Running) until the output is returned by the Agent so that the successor task does not run before the output is available.

Default: 60

Time Trigger Minimum Frequency In Seconds​

uc.trigger.time.minimum_frequency_in_seconds​

Minimum frequency - in seconds - of the Time Interval for a Time Trigger.

Default: 5

Track Counts For Unlimited Execution Limit​

uc.execution_limit.unlimited.counts​

Specification (true or false) for enabling the tracking of task instances running concurrently if the Task Execution Limit field for an Agent or Agent Cluster is set to Unlimited.

The following restrictions apply to this property:

  • If you change this property, all UI behavior based on this property will require logging out/logging in to take effect.
  • You cannot change this property from false to true while there are one or more task instances running against an Agent and/or Agent Cluster.
  • If you change this property from false to true, all Agents and Agent Clusters will begin tracking task counts.
  • If you change this property true to false, all Agents and Agent Clusters that are not Limited will have their Current Count column set to 0.
  • If this property is false, and an Agent or Agent Cluster is Unlimited, the Current Count column will display as blank in the list and will be hidden in the Agent / Agent Cluster Details.
  • If this property is true, and an Agent or Agent Cluster is Unlimited, the Current Count column will display the current count and the current count will be visible in the Agent / Agent Cluster Details.
  • If this property is false, and you change an Agent / Agent Cluster from Limited to Unlimited, the current count will be reset back to 0.
  • If this property is true or false, and you change an Agent / Agent Cluster from Unlimited to Limited, the current count will be reset back to 0.
info

For optimal performance, we recommend that you leave this property set to false.

Default: false

Trigger Launch Task Asynchronously​

uc.trigger.launch_task_async​

Specification (true or false) for whether or not a Task will launch asynchronously when a Trigger launches only a single Task.

Default: true

Trigger Task Launch Skip Condition Default​

uc.trigger.skip_condition.default​

Default value of the Task Launch Skip Condition field for all trigger types:

  • None
  • Active
  • Active By Trigger

Default: None

Universal Event Extension Publish Audit​

uc.universal_event.publish.extension.audit​

Specification (true or false) for whether or not an audit record is generated for each Universal Event published through an Extension-based Universal Task Instance.

info

Enabling this property can cause a large amount of audit to be generated.

Default: false

Universal Event Web Service Publish Audit​

uc.universal_event.publish.web_service.audit​

Specification (True or false) for whether or not an audit record is generated for each Universal Event published through the Web Service API.

info

Enabling this property can cause a large amount of audit to be generated.

Default: false

Universal Task Interact with Desktop Permitted​

uc.task.universal.interact_with_desktop.permitted​

Specification (true or false) for whether or not to permit utilizing Interact with Desktop option for Universal Task.

Default: false

Universal Template Extension Maximum Bytes​

uc.universal_template.extension.maximum_bytes​

Maximum number of bytes (6000000 - 1000000000) for a Universal Template Extension Archive.

warning

If you are deploying large extensions, it is important that you configure the Java heap size adequately.Things to consider.

  • # of agents configured to accept the extension(s).
  • # of agents configured to deploy on-registration and how many would be registering simultaneously.
  • # of parallel, on-demand deployments, where deployment happens the first time the extension needs to execute on a specific agent.

Default: 6000000

URL Action Parameter Enabled​

uc.url.action_parameter.enabled​

Specification (true or false) for whether or not to enable the URL Action parameter, which lets you automatically perform an action in the user interface.

Default: true

Use Checksum Validation​

uc.use.checksums​

Specification (true or false) for whether or not to implement checksum validation in order to prevent tampering of Controller data outside of the Controller system.

Default: false

Use Dashboard Visibility Icons​

uc.dashboard.use_visibility_icons.default​

Specification (Yes or No) of the system default for the Use Dashboard Visibility Icons user preference.

Default: Yes

Use Task Time Zone Preference For Date Functions​

uc.functions.date.use_task_time_zone_preference​

Specification (true or false) for whether or not to use the Task Time Zone Preference for Date functions.

info

This only applies when resolving Date functions for Task Instances. This includes Forecasts, which simulate task instances.

Default: false

User Defined Task Choice Field 1 Label​

uc.task.custom_choice_field1.label​

Label for this user-defined choice field that will display in the General Information section of the Details for all existing and new tasks and task instances.

Default: (none)

User Defined Task Choice Field 1 Options​

uc.task.custom_choice_field1.options​

Specifies a comma-delimited list of available options for User Defined Task Choice Field 1.

Default: (none)

User Defined Task Choice Field 1 Required​

uc.task.custom_choice_field1.required​

Specifies the task type(s) for which User Defined Task Choice Field 1 is required.

Default: (none)

User Defined Task Field 1 Label​

uc.task.custom_field1.label​

Label for this user-defined text field that will display in the General Information section of the Details for all existing and new tasks and task instances.

Default: (none)

User Defined Task Field 1 Required​

uc.task.custom_field1.required​

Specification (true or false) for whether or not User Defined Task Field 1 is required.

Default: false

User Defined Task Field 2 Label​

uc.task.custom_field2.label​

Label for this user-defined field that will display in the General Information section of the Details for all existing and new tasks and task instances.

Default: (none)

User Defined Task Field 2 Required​

uc.task.custom_field2.required​

Specification (true or false) for whether or not User Defined Task Field 2 is required.

Default: false

User Defined Trigger Field 1 Label​

uc.trigger.custom_field1.label​

Label for this user-defined field that will display in the General Information section of the Details for all existing and new triggers.

Default: (none)

User Defined Trigger Field 1 Required​

uc.trigger.custom_field1.required​

Specification (true or false) for whether or not User Defined Trigger Field 1 is required.

Default: false

User Defined Trigger Field 2 Label​

uc.trigger.custom_field2.label​

Label for this user-defined field that will display in the General Information section of the Details for all existing and new triggers.

Default: (none)

User Defined Trigger Field 2 Required​

uc.trigger.custom_field2.required​

Specification (true or false) for whether or not User Defined Trigger Field 2 is required.

Default: false

User Interface Desnity​

uc.user_interface.density.default​

Default density setting (font and control size offset) for the user interface:

  • Dense (-2)
  • Compact (-1)
  • Standard ( 0)
  • Expanded (+1)
  • Spacious (+2)

When the User Interface Density user preference is -- System Default --, this property specifies the density to be used.

Default: Standard

User Interface Theme​

uc.user_interface.theme.default​

Default display theme to use for the user interface:

  • Light
  • Dark

When the User Interface Theme user preference is -- System Default --, this property specifies the theme to be used.

Default: Light

Virtual Page Fetch Limit​

uc.virtual_page.fetch_limit​

Virtual page size to be used when scrolling in a list.

Default: 100

Virtual Page Pick List Fetch Limit​

uc.virtual_page.pick_list.fetch_limit​

Virtual page size to be used when scrolling the options in a drop-down list that are bound by another data source (for example, the Task To Monitor drop-down list options in the Task Monitor Task Details).

Default: 100

Wait For Running Extensions To Complete Before New Deployment​

uc.extension.deployment.wait_for_running_tasks​

Specification (true or false) for whether or not an extension deployment to an Agent will wait for any currently running Task Instances of that Template on that same Agent.

Default: true

Web Service Application Concurrent Request Limit​

uc.web_service.application.concurrent_request.limit​

Controls the number of concurrent requests for the application (that is, the Universal Controller server).

The application-level concurrent request limit cannot be less than 1 or less than the user-level concurrent request limit (if specified).

Default: (none; that is, no limit)

Web Service Basic Auth Permitted​

uc.web_service.basic_auth.permitted​

Specification (true or false) for whether or not Basic Authentication is permitted for the controller Web service APIs.

Default: true

Web Service Credentials Permitted​

uc.credentials.web_service.permitted​

Allows enabling/disabling the use of Web Service credentials.

  • If false:
    • Creation of new Web Service credentials will be prohibited.
    • All Web Service Task Instances using authentication will transition into the Start Failure status.
  • If false on a target Controller to which you are promoting, the promotion will fail.

Default: true

Web Service Default Response Content​

uc.web_service.response.content.default​

Default type of content, XML or JSON, for web service responses.

Default: JSON

Web Service Memory Utilization Threshold​

uc.web_service.memory.utilization.threshold​

Percentage of allocated memory in use that defines a threshold for prohibiting access to the RESTful Web Service API.

The threshold must be a whole number (integer) and cannot be less than 1 or more than 99.

Default: (none; that is, no threshold)

Web Service Personal Access Token Auth Headers​

uc.web_service.personal_access_token_auth.headers​

Specifies a comma-delimited list of alternative authorization headers where a Personal Access Token can be specified for Web Service authentication.See Web Service authentication examples.

Default: (none)

Web Service Personal Access Token Auth Permitted​

uc.web_service.personal_access_token_auth.permitted​

Specification (true or false) for whether or not Personal Access Token Authentication is permitted for the controller Web Service APIs.

Default: true

Web Service Personal Access Token Maximum Expiration In Days​

uc.web_service.personal_access_token.maximum_expiration_in_days​

Controls the maximum expiration day for a web service personal access token.

If specified, expiration for any newly generated Personal Access Token must be within the maximum.

Default: (none; that is, no limit)

Web Service Task Insecure Permitted (HTTP)​

uc.task.web_service.http.insecure.permitted​

Specification (true or false) for whether or not an Insecure field is added to Web Service tasks. which can allow the Web Service task to proceed with a TLS/SSL connection that is considered insecure.

info

This property cannot be set to false if there are existing Web Service tasks with Insecure enabled.

Default: false

Web Service Task Output MIME Type Exclusion List (HTTP)​

uc.task.web_service.output.mime_type.exclusion_list​

List of content-types, such as binary, that are discarded to avoid being stored as Web Service Task output, which are not supported and can lead to task instance run failure.

Default: image/*,audio/*,video/*,application/pdf

Web Service Task Resolvable Credentials Functions Permitted​

uc.task.web_service.credentials.resolvable.functions.permitted​

Specification (true or false) for whether or not to permit Resolvable Credential functions support in Web Service tasks.

info

In order to enable Resolvable Credential functions support for Web Service Task, this property and the Resolvable Credentials Permitted system property must set to true.

Default: false

Web Service Task System Proxy Property Inheritance (HTTP)​

uc.task.web_service.http.proxy_property_inheritance​

Specification (true or false) for whether or not to use the Java proxy system properties for HTTP Web Service tasks.

Default: false

Web Service Task Timeout​

uc.task.web_service.timeout​

Number of seconds to wait for the request to complete, if a Timeout value is not specified for a Web Service task.

Default: 60

Web Service Task URL Whitelist Regular Expression​

uc.task.web_service.url.whitelist​

Regular Expression that specifies the URLs supported by the Web Service task. (The default value specifies that all URLs are supported.)

If you have a specific regex that you want to be case-insensitive, pre-pend the following option to the regex: (?i)"."(?i)

Default: ^https?://.+$

Web Service User Concurrent Request Limit​

uc.web_service.user.concurrent_request.limit​

Controls the number of concurrent requests per unique user ID.

The user-level concurrent request limit cannot be less than 1 or greater than the application-level concurrent request limit (if specified).

Default: (none; that is, no limit)

Windows/Linux Scripts Permitted​

uc.script.distributed.permitted​

Specification (true or false) for whether to enable (true) or disable (false) the use of the Script type.

info

You can set Windows/Linux Scripts Permitted to false only if currently there are no Script types defined in the database.

Default: true

Windows Task Interact with Desktop Permitted​

uc.task.windows.interact_with_desktop.permitted​

Specification (true or false) for whether or not to permit utilizing Interact with Desktop option for Windows Task.

Default: false

Workflow Monitor Task Description Enabled​

uc.workflow.monitor.task.description.enabled​

Specification (true or false) for whether to enable (true) or disable (false) the display of a Task Description field in the Task Instance Details for a task instance in a Workflow Monitor.

Default: true

Workflow Search Result Limit​

uc.workflow.search_result_limit​

Results limit when querying for task records from the Task Find or Open Workflow pop-up.

Default: 200

z/OS Task Increment Number Of Override Instances On Force Finish​

uc.task.zos.override_run_count.increment_on_force_finish​

Specifies (true or false) if the Number Of Override Instances should be incremented when a z/OS task instance is force finished, like it does when completed successfully.

Once incremented, if the Number Of Override Instances is greater than or equal to the z/OS task instance Override Instance Count for Deletion, the controller will automatically request the agent delete the override JCL.

Default: true

Overriding Universal Controller System Properties​

You can override any Universal Controller system property by adding it to the Universal Controller Start-up Properties (uc.properties) file and restarting the Controller.

Any Universal Controller system property added to uc.properties must be in the same format as the uc.properties properties: <Property Name>=<value>. For example: uc.startup.paused=true

When the restarted Controller reads the uc.properties file, it updates the database with the value of any Universal Controller system property included in the file. It then removes that property from the file.

Deprecated System Properties​

The following system properties have been deprecated and hidden in Universal Controller. However, if you have upgraded Universal Controller from a release earlier than 7.1.0.0, you may still see them in your System Properties list.

Name
(Property Name)

Description

Default

Release
Deprecated

Promotion Accept Bundle Create/Update Permission Required
(opswise.promotion.accept_bundle.create_update_permission.required)

Specification (true or false) for whether or not the ops_promotion_admin role additionally requires Create (or Update) permission, on the target Universal Controller, for any record type being promoted.

Any user without the ops_promotion_admin role always will require Create (or Update) permission, regardless of this property.

true

6.9.0.0

Promotion Read Permission Required
(opswise.promotion.read_permission.required)

Specification (true or false) for whether or not the ops_promotion_admin role additionally requires Read permission, on the source Universal Controller, for any record type being promoted.

Any user without the ops_promotion_admin role always will require Read permission, regardless of this property.

info

If false, any user with the ops_promotion_admin role automatically is granted Read permission for any record that can be promoted.

true

6.9.0.0

Promotion Strict Mode
(uc.promotion.strict_mode)

Specification for whether or not to fail a promotion if a record being promoted matches both of the following target records conditions simultaneously:

  • Record with same name / different sysid
  • Record with different name / same sysid

If the record being promoted matches a target record by only one of the above conditions, the Controller will allow the promotion to continue. Depending on which condition you match, you will see the following result.

  • If the record being promoted matches a target record with same name / different sysid, the id mismatch will be logged in this format:
    Promoted {<type>} with name "<name>" and id 3c7a1b3c422049cab796e98fb5420ff3 has a different id than the original "<name>" with id 7b91616ff0dc431b9ae011f6e795806e.
  • If the record being promoted matches a target record with different name / same sysid, it is considered a name update and the name mismatch will not be logged.

Valid values are 0 (allow) and 1 (fail).

1

7.4.0.0

Strict Business Service Membership Read Constraints
(opswise.read_constraints.bsrvc_membership.strict)

Specification (true or false) for whether the Controller will enforce explicit Read permission for the following record types:

  • Agent
  • Agent Cluster
  • Calendar
  • Credential
  • Database Connection
  • Email Connection
  • Email Template
  • OMS Server
  • PeopleSoft Connection
  • SAP Connection
  • SNMP Manager
  • Trigger Forecasts
  • Virtual Resource

If the property is false, users have implicit Read permission for these record types.

If the property is true, users can view these record types only if they are granted Read permission explicitly via an appropriate role or permission.

info

For those record types, above, that have a corresponding permission type, when you create a permission, the Read operation checkbox automatically will be checked if the property is false.

true

6.9.0.0

Strict Connection Execute Constraints
(opswise.connection.execute_constraints.strict)

Specification (true or false) for whether Universal Controller will enforce Execute constraints for connections (Database Connections, Email Connections, SAP Connections, and SNMP Managers) during task instance execution.

If Strict Connection Execute Constraints is false, only Read constraints for connections are enforced based on the configuration of the Strict Business Service Membership Read Constraints Universal Controller system property.

If Strict Connection Execute Constraints is true, the Execution User for any task instance executing with a connection must have Execute permission for that connection; otherwise, the task instance will transition into a Start Failure status.

true

6.9.0.0

Variable Security Enabled
(opswise.security.variable.enabled)

Specification (true or false) for enabling enhanced Global Variable security.

true

6.9.0.0

Virtual Resource Security Enabled
(opswise.security.virtual_resource.enabled)

Specification (true or false) for enabling enhanced Virtual Resource security.

true

6.9.0.0