Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
Table of Contents
maxLevel2
maxlevel2

...

Step 1

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

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.

...

Name
(Property Name)

Description

Default

Anchor
Administrator Email Address
Administrator Email Address
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.

(none)

Anchor
Agent Address Information Restricted
Agent Address Information Restricted
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.

true

Anchor
Agent Cache Retention Period in Days
Agent Cache Retention Period in Days
Agent Cache Retention Period in Days
(uc.agent.cache.retention)

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

7

Anchor
Agent Cluster Network Alias Cache Retention In Minutes
Agent Cluster Network Alias Cache Retention In Minutes
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.

30

Anchor
Agent Cluster Network Alias Retry Interval In Minutes
Agent Cluster Network Alias Retry Interval In Minutes
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.

5

Anchor
Agent Cluster Network Alias Uquery Port
Agent Cluster Network Alias Uquery Port
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.

7887

Anchor
Agent Credentials Required
Agent Credentials Required
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.

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.

(none)

Anchor
Agent Heartbeat Grace Period In Seconds
Agent Heartbeat Grace Period In Seconds
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.

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.

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.

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.

AGNT

Anchor
Allow In Doubt Re-run
Allow In Doubt Re-run
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.

true

Anchor
Audit Owner Read Permitted
Audit Owner Read Permitted
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).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.true

Anchor
Automatically Create Versions
Automatically Create Versions
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.

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.

false

Anchor
Banner Color
Banner Color
Banner Background Color
(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.

transparent
For transparent, color will be based on Theme

Anchor
Banner Logo
Banner Logo
Banner Logo
(uc.banner.logo)

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.
 

Note
titleNote

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.


(none)

Anchor
Banner Logo URL
Banner Logo URL
Banner Logo URL
(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.)

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

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.

true

Anchor
Bulk Export Activity Permitted
Bulk Export Activity Permitted
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.

false

Anchor
Bundle Exclude On Existence Picker Default
Bundle Exclude On Existence Picker Default
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.

(none)

Anchor
Bundleless Promotion With Execute Permission Permitted
Bundleless Promotion With Execute Permission Permitted
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.

false

Anchor
Business Service Visibility Restricted
Business Service Visibility Restricted
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
Note
titleNote

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.


false

Anchor
Calendar Preview Past Period In Months
Calendar Preview Past Period In Months
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.3

Anchor
Calendar Preview Period In Years
Calendar Preview Period In Years
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.

2

Anchor
CLI/Web Service Result Limit
CLI/Web Service Result Limit
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

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.

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.

false

Anchor
Confirm Enable Disable Trigger Command
Confirm Enable Disable Trigger Command
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.

yes

Anchor
Confirm Exit
Confirm Exit
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).

true

Anchor
Confirm Update For Tasks In Workflows
Confirm Update For Tasks In Workflows
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.

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.

false

Anchor
Create Version On Related List Change
Create Version On Related List Change
Create Version On Related List Change
(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.

true

Anchor
Critical Path Calculations Permitted
Critical Path Calculations Permitted
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.

false

Anchor
Critical Path Color
Critical Path Color
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).

#FF0000 (red)

Anchor
Critical Path Dynamic Calculation Threshold In Seconds
Critical Path Dynamic Calculation Threshold In Seconds
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.

0

Anchor
Critical Path Monitor Polling Interval In Seconds
Critical Path Monitor Polling Interval In Seconds
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+.

300

Anchor
Critical Path Monitor Polling Threshold In Seconds
Critical Path Monitor Polling Threshold In Seconds
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+.

60

Anchor
Critical Path Projected Late Action Maximum
Critical Path Projected Late Action Maximum
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.

5

Anchor
Critical Path Projected Late Threshold In Minutes
Critical Path Projected Late Threshold In Minutes
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.

5

Anchor
Custom Day Global Permitted
Custom Day Global Permitted
Custom Day Global Permitted
(uc.custom_day.global.permitted)

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

Note
titleNote

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


true

Anchor
Custom Day Local Indicator Enabled
Custom Day Local Indicator Enabled
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.

true

Anchor
Custom Day Strict Mode
Custom Day Strict Mode
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.

false

Anchor
Data Backup/Purge Export Path
Data Backup/Purge Export Path
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.

(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.600

Anchor
Disable Tab Indicators
Disable Tab Indicators
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.

false

Anchor
Email Body Default Begin Marker
Email Body Default Begin Marker
Email Body Default Begin Marker
(uc.email.body_begin_marker)

Default Begin Marker for Email Monitor Body Variables field.

- - BEGIN - -

Anchor
Email Body Default End Marker
Email Body Default End Marker
Email Body Default End Marker
(uc.email.body_end_marker)

Default End Marker for Email Monitor Body Variables field.

- - END - -

Anchor
Email Credentials Permitted
Email Credentials Permitted
Email Credentials Permitted
(uc.credentials.email.permitted)

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

true

Anchor
Email Monitor Polling Interval In Seconds
Email Monitor Polling Interval In Seconds
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.

120

Anchor
Email Notification Audit
Email Notification Audit
Email Notification Audit
(uc.email.notification.audit)

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

(none)

Anchor
Exclude Holidays for Business Days
Exclude Holidays for Business Days
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.

false

Anchor
Expand List Automatically
Expand List Automatically
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.No

Anchor
Export Agent References
Export Agent References
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.

false

Anchor
Export Path
Export Path
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.
 

Note
titleNote

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.


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

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 TasksSpecification (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.

false

Anchor
File Transfer Task Exclude Protocols
File Transfer Task Exclude Protocols
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.


Anchor
Flatten Reference List Fields In Chart Reports
Flatten Reference List Fields In Chart Reports
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.

false

Anchor
Forecast Period in Days
Forecast Period in Days
Forecast Period in Days
(uc.forecast.days)

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

31

Anchor
Inherit Actions On Defined For Insert Task
Inherit Actions On Defined For Insert Task
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.

false

Anchor
LDAP Synchronization Enabled
LDAP Synchronization Enabled
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.

false

License Key
(uc.license)

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

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

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

Anchor
Log File Retention Period in Days
Log File Retention Period in Days
Log File Retention Period in Days
(uc.log.retention)

Number of days that the Controller retains its log files.

5

Anchor
Log Level
Log Level
Log Level
(uc.log.level)

Level of logging for the Controller:

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

INFO

Anchor
Login Disclaimer
Login Disclaimer
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.

(none)

Anchor
Login Notification
Login Notification
Login Notification
(uc.login.notification}

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

(none)

Maximum Extension Deployment Threads
(uc.extension.deployment.max_threads)

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

Anchor
Maximum Nested Variable Depth
Maximum Nested Variable Depth
Maximum Nested Variable Depth
(uc.variable.maximum_depth)

Maximum number of nested variables allowed.

25

Anchor
Maximum Nested Variable Expansion
Maximum Nested Variable Expansion
Maximum Nested Variable Expansion
(uc.variable.maximum_expansion)

Maximum number of nested variable characters allowed.

250000

Anchor
Maximum Processing Threads
Maximum Processing Threads
Maximum Processing Threads
(uc.threads.max)

Maximum number of processing threads used.

1000

Anchor
Maximum Timer Threads
Maximum Timer Threads
Maximum Timer Threads
(uc.timer.threads.max)

Maximum number of timer threads used.

300

Navigation Auto Collapse
(uc.navigation.auto_collapse.default)

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

Yes

Anchor
Node Time Display
Node Time Display
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.

Yes

Anchor
Node Time Display Background Color
Node Time Display Background Color
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.

White

Anchor
Node Time Display Color
Node Time Display Color
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.

Black

Anchor
Node Time Display Time Zone
Node Time Display Time Zone
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.

Server

Anchor
OMS Log Level
OMS Log Level
OMS Log Level
(uc.oms.log.level)


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

Note

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


(none)

Anchor
Operational Memo Reset On Re-run
Operational Memo Reset On Re-run
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.true

Anchor
Perform Actions On Defined For Tasks Within Skipped Workflow
Perform Actions On Defined For Tasks Within Skipped Workflow
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.

false

Anchor
Perform Actions On Defined Workflow First
Perform Actions On Defined Workflow First
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.

false

Anchor
Perform Actions On Halt
Perform Actions On Halt
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.

true

Anchor
Picker Fetch Limit
Picker Fetch Limit
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.

200

Anchor
Platform Log Level
Platform Log Level
Platform Log Level
(uc.platform.log.level)

Level of logging for the user interface framework:

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

WARN

Anchor
Promote By Business Service Membership Permitted
Promote By Business Service Membership Permitted
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.
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.

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

Anchor
Promotion History Retention Period in Days
Promotion History Retention Period in Days
Promotion History Retention Period in Days
(uc.promotion_history.retention)

Number of days that the Controller retains Promotion History.

60

Anchor
Promotion Schedule Retention Period In Days
Promotion Schedule Retention Period In Days
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.

7

Anchor
Validate Report References On Promotion
Validate Report References On Promotion
Promotion Validate Report References
(uc.promotion.report.validate_references)

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

Note

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


true

Anchor
Purge Activity By Primary Key Limit
Purge Activity By Primary Key Limit
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).

500

Anchor
Purge All Non-Default Users And Groups Permitted
Purge All Non-Default Users And Groups Permitted
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.

false

Anchor
Purge Dates From Custom Day List Older Than
Purge Dates From Custom Day List Older Than
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.

(none)

Anchor
Re-run (Suppress Intermediate Failures) Permitted
Re-run (Suppress Intermediate Failures) Permitted
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.

true

Anchor
Reconcile Built-In Universal Template Changes On Promotion
Reconcile Built-In Universal Template Changes On Promotion
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.false
Anchor
Record New
Record New
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


Expand
titleClick 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)


No

Anchor
Record Open
Record Open
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


Expand
titleClick 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)


No

Anchor
Recurring Task Launch Skip Condition Default
Recurring Task Launch Skip Condition Default
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
None

Anchor
Recurring Task Launch Skip Condition Default
Recurring Task Launch Skip Condition Default
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.

5
Anchor
Reference New
Reference New
Reference New In Tab
(uc.reference.new_in_tab)

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.

No
Anchor
Reference Open
Reference Open
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.

No

Anchor
Remote File Monitor Task Exclude Protocols
Remote File Monitor Task Exclude Protocols

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.


Anchor
Report Average Color
Report Average Color
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.#000000

Anchor
Report Group Threshold
Report Group Threshold
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.
 

Note
titleNote

This option formerly was named System Default Report Group Threshold.


10

Anchor
Report Threshold Color
Report Threshold Color
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.#000000

Anchor
Resolvable Credentials Permitted
Resolvable Credentials Permitted
Resolvable Credentials Permitted
(uc.credentials.resolvable.permitted)

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

false

Anchor
Retain Overridden Step Codes On z/OS Task Re-run
Retain Overridden Step Codes On z/OS Task Re-run
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.

false

Anchor
Retrieve Output Default Number Of Lines
Retrieve Output Default Number Of Lines
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.

100

Anchor
Retrieve Output Maximum Lines
Retrieve Output Maximum Lines
Retrieve Output Maximum Lines
(uc.retrieve_output.maximum_lines.limit)

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

(none)

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

Anchor
Scheduled Report 3D Pie Chart
Scheduled Report 3D Pie Chart
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).

No

Anchor
Scheduled Report Fetch Limit
Scheduled Report Fetch Limit
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.

1,000

Anchor
Scheduled Report Image Height
Scheduled Report Image Height
Scheduled Report Image Height
(uc.report.scheduled.image_height.default)

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

500

Anchor
Scheduled Report Image Width
Scheduled Report Image Width
Scheduled Report Image Width
(uc.report.scheduled.image_width.default)

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

750

Anchor
Scheduled Report Inline Image
Scheduled Report Inline Image
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.

Yes

Anchor
Scheduled Report PDF Orientation
Scheduled Report PDF Orientation
Scheduled Report PDF Orientation
(uc.report.scheduled.pdf.orientation.default)

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

Landscape

Anchor
Scheduled Report PDF Size
Scheduled Report PDF Size
Scheduled Report PDF Size
(uc.report.scheduled.pdf.size.default)

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

Letter

Anchor
Scheduled Report Time Zone
Scheduled Report Time Zone
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).

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.false
Anchor
Show Last Login
Show Last Login
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.

true

Anchor
Show Metadata
Show Metadata
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.

No

Anchor
Show Variables Fetch Global Automatically
Show Variables Fetch Global Automatically
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.

No

Anchor
SMTP Debug
SMTP Debug
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.

false

Anchor
SQL/Stored Procedure Close Additional Results Sets
SQL/Stored Procedure Close Additional Results Sets
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.
 

Note
titleNote

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


true

Anchor
SQL/Stored Procedure Ignore Update Count If No Results
SQL/Stored Procedure Ignore Update Count If No Results
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.

false

Anchor
SQL/Stored Procedure Maximum Rows
SQL/Stored Procedure Maximum Rows
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.

(none)

Anchor
Start Server Paused
Start Server Paused
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.
 

Note
titleNote

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.


false

Anchor
Stop Unknown Application Monitors
Stop Unknown Application Monitors
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).

false

Anchor
Strict Dashboard Create Constraints
Strict Dashboard Create Constraints
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.

false

Anchor
Strict Report Create Constraints
Strict Report Create Constraints
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.

false

Anchor
System Default Activity Quick Filters
System Default Activity Quick Filters
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.

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

Anchor
System Default CLI Bulk Import Path
System Default CLI Bulk Import Path
System Default CLI Bulk Import Path
(uc.bulk_import.path.default)

Pathname from where imported XML files are written.

<tomcat-home>/uc_import
or
<tomcat-home>\uc_import
 
(<tomcat-home> is the base tomcat installation directory.)

Anchor
System Default Command Line Access
System Default Command Line Access
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).

Yes

Anchor
System Default Confirm Launch Command
System Default Confirm Launch Command
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.

Note
titleNote

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.


Yes

Anchor
System Default Confirm Task Instance Commands
System Default Confirm Task Instance Commands
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.

No

Anchor
System Default Maximum Versions
System Default Maximum Versions
System Default Maximum Versions
(uc.version.maximum.default)

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

100

Anchor
System Default Trigger Simulate
System Default Trigger Simulate
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.

false

Anchor
System Default Update Virtual Resource Limit On Promotion
System Default Update Virtual Resource Limit On Promotion
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.

Yes

Anchor
System Default Wait/Delay Workflow Only
System Default Wait/Delay Workflow Only
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.

Yes

Anchor
System Default Web Browser Access
System Default Web Browser Access
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.

Yes

Anchor
System Default Web Service Access
System Default Web Service Access
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.

Yes

Anchor
System Details Database Information Restricted
System Details Database Information Restricted
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

Anchor
System Details Expanded Categories
System Details Expanded Categories
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
Cluster Node

Anchor
System Identifier
System Identifier
System Identifier
(uc.system_identifier)

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

(none)

Anchor
System Identifier Background Color
System Identifier Background Color
System Identifier Background Color
(uc.system_identifier.background_color)

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

black

Anchor
System Identifier Color
System Identifier Color
System Identifier Color
(uc.system_identifier.color)

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

white

Anchor
Task Automatic Output Retrieval Default
Task Automatic Output Retrieval Default
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.None

Anchor
Task Field Resolution Required
Task Field Resolution Required
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.false

Anchor
Task Instance Normalize Business Service Membership
Task Instance Normalize Business Service Membership
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.
Note
titleNote

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.


Disabled

Anchor
Task Launch Reason Required
Task Launch Reason Required
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.false

Anchor
Task Output Path Functions Permitted
Task Output Path Functions Permitted
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.true

Anchor
Task Retry Maximum
Task Retry Maximum
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.
Note
titleNote

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.


blank

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 and Task Instance forms.

  • Simulate option no longer available from Launch with Variables… and Trigger Now… commands.

true

Anchor
Task-Time-Zone-Preference
Task-Time-Zone-Preference
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.

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

Anchor
Task Wait For Output Timeout In Seconds
Task Wait For Output Timeout In Seconds
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.

60

Anchor
Time Trigger Minimum Frequency In Seconds
Time Trigger Minimum Frequency In Seconds
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.

5

Anchor
Track Counts For Unlimited Execution Limit
Track Counts For Unlimited Execution Limit
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.
Note
titleNote

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


false

Anchor
Trigger Task Launch Skip Condition Default
Trigger Task Launch Skip Condition Default
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
None

Anchor
Universal Event Extension Publish Audit
Universal Event Extension Publish Audit
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.

Note
titleNote

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


false

Anchor
Universal Event Web Service Publish Audit
Universal Event Web Service Publish Audit
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.

Note
titleNote

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


false
Anchor
Universal Task Interact with Desktop Permitted 
Universal Task Interact with Desktop Permitted 
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.

false

Anchor
Universal Template Extension Maximum Bytes
Universal Template Extension Maximum Bytes
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.



6000000

Anchor
URL Action Parameter Enabled
URL Action Parameter Enabled
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.

true

Anchor
Use Checksum Validation
Use Checksum Validation
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.

false

Anchor
Use Dashboard Visibility Icons
Use Dashboard Visibility Icons
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.

Yes

Anchor
User Defined Task Field 1 Label
User Defined Task Field 1 Label
User Defined Task Field 1 Label
(uc.task.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 tasks and task instances.

(none)

Anchor
User Defined Task Field 1 Required
User Defined Task Field 1 Required
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.


false

Anchor
User Defined Task Field 2 Label
User Defined Task Field 2 Label
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.

(none)

Anchor
User Defined Task Field 2 Required
User Defined Task Field 2 Required
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.

false

Anchor
User Defined Trigger Field 1 Label
User Defined Trigger Field 1 Label
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.

(none)

Anchor
User Defined Trigger Field 1 Required
User Defined Trigger Field 1 Required
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.


false

Anchor
User Defined Trigger Field 2 Label
User Defined Trigger Field 2 Label
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.

(none)

Anchor
User Defined Trigger Field 2 Required
User Defined Trigger Field 2 Required
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.

false

Anchor
User Interface Density
User Interface Density
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.

Standard

Anchor
User Interface Theme
User Interface Theme
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.

Light

Anchor
Virtual Page Fetch Limit
Virtual Page Fetch Limit
Virtual Page Fetch Limit
(uc.virtual_page.fetch_limit)

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

100

Anchor
Virtual Page Pick List Fetch Limit
Virtual Page Pick List Fetch Limit
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).

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

Anchor
Web Service Application Concurrent Request Limit
Web Service Application Concurrent Request Limit
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).

(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. true

Anchor
Web Service Credentials Permitted
Web Service Credentials Permitted
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.

true

Anchor
Web Service Default Response Content
Web Service Default Response Content
Web Service Default Response Content
(uc.web_service.response.content.default)

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

XML

Anchor
Web Service Memory Utilization Threshold
Web Service Memory Utilization Threshold
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.

(none; that is, no threshold))
Anchor
Web Service Personal Access Token Auth Headers
Web Service Personal Access Token Auth Headers
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.
(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.true

Anchor
Web Service Personal Access Token Maximum Expiration
Web Service Personal Access Token Maximum Expiration
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.

(none; that is, no limit)

Anchor
Web Service Task Insecure Permitted (HTTP)
Web Service Task Insecure Permitted (HTTP)
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.

Note
titleNote

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


false

Anchor
Web Service Task Output MIME Type Exclusion List (HTTP)
Web Service Task Output MIME Type Exclusion List (HTTP)
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.

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

Anchor
Web Service Task Resolvable Credentials Functions Permitted
Web Service Task Resolvable Credentials Functions Permitted
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.

Note
titleNote

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


false

Anchor
Web Service Task System Proxy Property Inheritance (HTTP)
Web Service Task System Proxy Property Inheritance (HTTP)
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.

false

Anchor
Web Service Task Timeout
Web Service Task Timeout
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.

60

Anchor
Web Service Task URL Whitelist Regular Expression
Web Service Task URL Whitelist Regular Expression
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)

^https?://.+$

Anchor
Web Service User Concurrent Request Limit
Web Service User Concurrent Request Limit
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).

(none; that is, no limit)

Anchor
Windows Linux Scripts Permitted
Windows Linux Scripts Permitted
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 Script type.
 

Note
titleNote

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


true

Anchor
Windows Task Interact with Desktop Permitted
Windows Task Interact with Desktop Permitted
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.false

Anchor
Workflow Monitor Task Description Enabled
Workflow Monitor Task Description Enabled
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.

true

Anchor
Workflow Search Result Limit
Workflow Search Result Limit
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.

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.

true

...