Versions Compared

Key

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

...

Script

Description and Links

Anchor
Bulk Export
Bulk Export
Bulk Export

Exports all current record definitions, without versions, when migrating data to a new Universal Controller deployment.

Anchor
Bulk Export Activity
Bulk Export Activity
Bulk Export Activity

Exports all current Activity data from multiple Universal Controller database tables.
 

Note
titleNote

In order to run this server operation, the Bulk Export Activity Permitted Universal Controller system property must be set to true.

 
If you choose to run this server operation, the following confirmation pop-up displays:
 

Anchor
Bulk Export Audit
Bulk Export Audit
Bulk Export Audit

Exports all current Audit records when migrating data to a new Universal Controller deployment.

Anchor
Bulk Export History
Bulk Export History
Bulk Export History

Exports all current History records when migrating data to a new Universal Controller deployment.
 
If you choose to run this server operation, the following confirmation pop-up displays:
 

Anchor
Bulk Export with Versions
Bulk Export with Versions
Bulk Export with Versions

Exports all current records along with older (non-current) versions of record definitions when migrating data to updated software.

Anchor
Bulk Import
Bulk Import
Bulk Import

Imports all data from an exported file when migrating data to updated software.

Anchor
Clear Server Cache
Clear Server Cache
Clear Server Cache

Clears the internal server cache. You can use this operation if you are experiencing unexpected behavior with the Controller system. For example, Technical Support may ask you to first run this operation to clear the server cache, then clear your browser cache.

Anchor
Database Information
Database Information
Database Information

Displays the following information for the Controller database:

  • Type: MYSQL
  • Database Name: db_name
  • Database Product Name: MySQL
  • Database Product Version: 8.0.11
  • Driver Name: MySQL Connector/J
  • Driver Version: mysql-connector-java-8.0.12 (Revision: 24766725dc6e017025532146d94c6e6c488fb8f1)
  • Configured JDBC URL: jdbc:mysql://hostname:port/
  • Adjusted JDBC URL: jdbc:mysql://hostname:port/db_name?useUnicode=true&serverTimezone=US/Eastern&socketTimeout=1800000
  • Connection Pool: Server (0/3)
  • Connection Pool: Reserved (0/3)
  • Connection Pool: Client (0/5)

Anchor
Database Table Counts
Database Table Counts
Database Table Counts

Displays the following information for Universal Controller database tables:

  • Largest table
  • Number of tables
  • Number of rows
  • Number of rows in each table

See Universal Controller Database Tables 206427854, below, for a description of all tables.

Anchor
Disable Task Instance Business Service Normalization
Disable Task Instance Business Service Normalization
Disable Task Instance Business Service Normalization

Disables normalization of Business Service membership for all:

  • New Task Instance and History records.
  • Existing Task Instance and History records if it is still in progress.

All previously normalized Business Service membership records will not be removed until they qualify for Activity or History purge.

Also, the Task Instance Normalize Business Service Membership property will be set to Disabled.

Anchor
Enable Task Instance Business Service Normalization
Enable Task Instance Business Service Normalization
Enable Task Instance Business Service Normalization

Commence normalization of Business Service membership for all existing Task Instance and History records, and begin normalizing Business Service membership for all new Task Instance and History records.

Note
titleNote

When deciding on enabling Business Service normalization, it should be noted that there is trade-off between the query performance on Task Instance/History Lists and the added insertion of normalization data at Task Instance/History record creation time.

If the Controller is restarted and the Task Instance Normalize Business Service Membership property is Enabled/Normalizing, the Controller will resume normalization of Business Service membership for all existing Task Instance and History records.


Anchor
Generate Server UUIDs Cache
Generate Server UUIDs Cache
Generate Server UUIDs Cache

For use only by Technical Support personnel or when you are requested to run it by Technical Support.

Anchor
Health Check
Health Check
Health Check

Displays information about the current instance of the Controller.

Anchor
Inspect Events
Inspect Events
Inspect Events

For use only by Technical Support personnel or when you are requested to run it by Technical Support.

Anchor
Inspect Universal Events
Inspect Universal Events
Inspect Universal Events

Limits the number of events displayed by the Inspect Events server operation.

The events will display with the latest events first; that is, ordered by created time descending.

Default is 1000.

Anchor
Inspect Output Message Queue
Inspect Output Message Queue
Inspect Output Message Queue

For use only by Technical Support personnel or when you are requested to run it by Technical Support.

Anchor
Inspect Subscriptions
Inspect Subscriptions
Inspect Subscriptions

For use only by Technical Support personnel or when you are requested to run it by Technical Support.

Anchor
Inspect Timers
Inspect Timers
Inspect Timers

For use only by Technical Support personnel or when you are requested to run it by Technical Support.

Anchor
LDAP Refresh
LDAP Refresh
LDAP Refresh

If LDAP is configured for this installation, it refreshes every 24 hours. This server operation forces a refresh. The refresh writes all Controller log entries to the user interface as well as to the Controller log, and the response will not be returned until the process completes. If you estimate the refresh could take a considerable amount of time, we recommend you use LDAP Refresh (Asynchronous) 206427854.

Anchor
LDAP Refresh (Asynchronous)
LDAP Refresh (Asynchronous)
LDAP Refresh (Asynchronous)

If LDAP is configured for this installation, it refreshes every 24 hours. This server operation forces a refresh. The refresh is performed in the background and sends Controller log entries to the Controller log.

Anchor
List/Download Logs
List/Download Logs
List/Download Logs

Lists (and optionally lets you download) any existing UC log files for the Controller node that this operation is executed on.
 
The list identifies the name, last modification date, size of each log file, and - when you hover over the log file entry on the list - an icon that lets you download that file.
 

 
The icons at the bottom of the list let you perform the following:

  • Download selected log files.
  • Select all log files.
  • Deselect all log files.

(You also can select / deselect all log files by clicking the Name checkbox at the top of the list.)

Anchor
Load Demonstration Definitions
Load Demonstration Definitions
Load Demonstration Definitions

Loads base demonstration data into your database (for example: workflows, tasks, triggers).

Anchor
Memory Usage
Memory Usage
Memory Usage

Displays a summary of Controller memory usage.

Anchor
Overdue Timers Delete
Overdue Timers Delete
Overdue Timers Delete

Deletes any overdue timers, as listed by the Overdue Timers List 206427854 operation.

Anchor
Overdue Timers List
Overdue Timers List
Overdue Timers List

Lists any timers that are overdue (normally, no timers should be overdue).

Anchor
Pause Cluster Node
Pause Cluster Node
Pause Cluster Node

Pauses the Controller, which prevents it from processing tasks and events. If an event or task is already running when you run this operation, the event or task will complete. The Controller remains in a paused state until you run the Resume Cluster Node 206427854 operation.

Anchor
Purge All Non-Default Users And Groups
Purge All Non-Default Users And Groups
Purge All Non-Default Users And Groups

Purges all non-default Users and Groups and their associated data. There is one default User: Administrator (ops.admin). There are two default Groups: Administrator Group and Everything Group.
 
This server operation will also clear the following fields:

  • Manager field for the Administrator user if it references a non-default user.
  • Manager field for the Administrator Group and/or Everything Group if it references a non-default user.
  • Parent field for the Administrator Group and/or Everything Group if it references a non-default group.

The following is recommended before running this server operation:

  • Disable any triggers that are currently enabled by a non-default user.
  • Unassign the Execution User for any triggers that are currently assigned a non-default user as the Execution User.
  • Complete any active task instances that are currently assigned a non-default user as the Execution User.
Note
titleNote

To run this server operation, the Purge All Non-Default Users And Groups Permitted Universal Controller System Property must be set to true.

 
If you choose to run this server operation, the following confirmation pop-up displays:
 

Anchor
Purge History
Purge History
Purge History

Purges all records from the History table (ops_history).
 
Any time a task instance goes into an end status (Cancelled, Failed, Skipped, Finished, Success), a copy of it is written to the History table. You can view your History table by selecting Automation Center > Task Instances > History from the navigation pane.
 

Note
titleNote

If you do not need to keep or back up your task instance history, we recommend that you run this operation periodically; otherwise, make sure you schedule a routine Data Backup/Purge for history by selecting Administration > Data Backup/Purge from the navigation pane. Executing a Data Backup/Purge of an extremely large History table can seriously degrade Controller system performance.


Anchor
Purge Instances
Purge Instances
Purge Instances

Purges everything in the All Task Instances table (ops_exec), which contains all system activity, including task instances in any status (including end statuses). Records in the All Task Instances table (ops_exec) remain there until they are purged.
 

Warning
titleWarning

Running this operation will purge any live data; that is, task instances that have not completed.


Anchor
Purge Logs and Cache
Purge Logs and Cache
Purge Logs and Cache

Sends a request to all active Agents to purge their logs and cache.

Anchor
Purge Versions
Purge Versions
Purge Versions

Purges versions of records in excess of the maximum specified by the System Default Maximum Versions Universal Controller system property.

Anchor
Refresh System Default List Layouts
Refresh System Default List Layouts
Refresh System Default List Layouts

For Controller upgrades only; resets system defaults list layouts.
 
You may be asked to run this server operation by Technical Support.

Anchor
Reset All Agent Cluster Task Counts
Reset All Agent Cluster Task Counts
Reset All Agent Cluster Task Counts

Resets the current number of tasks currently being run by all Agent clusters to 0 (see Resetting the Current Task Count).

Anchor
Reset All Agent Task Counts
Reset All Agent Task Counts
Reset All Agent Task Counts

Resets the current number of tasks currently being run by all Agents to 0 (see Resetting the Current Task Count).

Anchor
Restart Cluster Node
Restart Cluster Node
Restart Cluster Node

Stops and restarts the Controller within the running Tomcat server. The Controller is effectively shut down and started up without stopping and starting Tomcat.
 

Note
titleNote:

Restart Cluster Node will cause a failover to occur if it is executed on the Active node while another node is running as Passive.


Anchor
Restore System Default List Layouts
Restore System Default List Layouts
Restore System Default List Layouts

Restores all lists to their default layouts.

Anchor
Resume Cluster Node
Resume Cluster Node
Resume Cluster Node

Resumes the Controller after it has been paused using the Pause Cluster Node 206427854 operation, or paused by the Start Server Paused Universal Controller property on startup.

Anchor
Roll Log
Roll Log
Roll Log

Renames the existing log to a timestamped log and opens a new log file.

Anchor
Run Garbage Collection
Run Garbage Collection
Run Garbage Collection

Runs the "garbage collector." The gc method suggests that the Java Virtual Machine expend effort toward recycling unused objects in order to make the memory they currently occupy available for quick re-use. When control returns from the method call, the Java Virtual Machine has made a best effort to reclaim space from all discarded objects.

Anchor
Server Information
Server Information
Server Information

Displays the following categories of information about the Universal Controller server:

  • Node
  • License
  • Server Deployment
  • Database Information
  • Memory Information

Anchor
System Properties
System Properties
System Properties

Displays all properties of the operating system on which the Controller is running.
 
You may be asked to run this server operation by Technical Support.

Anchor
Temporary Property Change
Temporary Property Change
Temporary Property Change

Allows for the temporary setting of specific Universal Controller properties to be used for diagnosing problems. This operation and setting of properties should be performed only under the guidance of Stonebranch support.

Anchor
Thread List
Thread List
Thread List

Captures information about internal Controller system processes.
 
You may be asked to run this server operation by Technical Support.

Anchor
Thread List by CPU
Thread List by CPU
Thread List by CPU

Captures information about internal Controller system processes.
 
You may be asked to run this server operation by Technical Support.

Anchor
Thread Stack Trace
Thread Stack Trace
Thread Stack Trace

Captures information about internal Controller system processes.
 
You may be asked to run this server operation by Technical Support.

...

The following table identifies and describes all Universal Controller database tables, which are listed if you run the Database Table Counts 206427854 server operation, above.

The tables are in alphabetical order according to Table Name.

...