Overview of Orchestrator

This article is currently being updated. Please come back later for updates.

Permissions: All users with study access can open Orchestrator from the module drop-down in the Study Details page and view rules created for that study.
Users must have the Study Configure privilege to create, manage, run, export, and import rules.

Orchestrator manages rules that run against imported study data. Rules can be created using the Rule Condition Builder or SQL Editor and configured to generate issues and / or queries when bidirectional queries are enabled for the study.

Rules can be exported as JSON files and imported into other studies or URLs to support reuse of validated rule configurations across environments.

Any issues or queries created through Orchestrator are accessible in the Data Central Issues and Queries panels for a study. Issues are also available in the Issues module. Issues and queries generated by Orchestrator are managed the same as other issues and queries in the system.

Issues and queries created by Orchestrator that are resolved by a user are not automatically generated again. When Orchestrator reruns the rules, issues and queries that have been fixed since the previous run are automatically resolved as follows:

  • Open, In Progress, and Answered issues are closed.
  • Answered queries and non-Rave Open queries are closed.
  • Open Rave queries are canceled. Rave requires queries to be answered before they can be closed, so Orchestrator cancels eligible Open queries instead.

All actions performed in Orchestrator are captured in the Audit Log.

Access Orchestrator

Access Orchestrator from the module drop-down in the Study Details page.

  1. Access a study.
  2. Click the module drop-down and select Orchestrator.

    Access Orchestrator from the module drop-down in study details

The Orchestrator page opens with a badge showing the total number of rules for the study. All existing rules are displayed in the listing, and the badge count updates automatically when filters are applied.

Orchestrator rule listing and master header toolbar

Toolbar and Rule Listing Actions

The toolbar includes actions for running, activating, deactivating, importing, exporting, creating, editing, viewing, and deleting rules, as well as paging, filtering, study configuration, and system help.

Depending on user permissions, some actions may appear disabled.

The rule listing includes the following columns: Open Issues, Open Queries, Rule Name, Active Status, Data Store, Domain, Field, Tag, Priority, Updated, Issue Run Status, Query Run Status, and Last Run. 

  • When a rule runs, the Issue Run Status and Query Run Status columns display a real-time processing indicator. After the run completes, the status updates to display success (green checkmark) or error (red X) indicators, along with the total number of records flagged during the most recent run.

    Rule listing showing Issue Run Status and Query Run Status processing indicator

  • After a rule run completes, users can click counts displayed in the Open Issues and Open Queries columns. These counts display as hyperlinks that open the corresponding Issues or Queries panel in Data Central, with filters automatically applied for Status = Open and Opened By = [Rule Name]. This provides direct access to rule-specific output.

    Open Issues and Open Queries columns displaying hyperlink counts

    Note: Hyperlinks are active only when open items exist and are disabled for users without access to Data Central.

Sort and Filter Rules

All columns support standard elluminate sorting and filtering functionality, including the Open Issues and Open Queries columns.

Use the left navigation filters and sorting options to refine the rule listing.

Sort Rules

Under Quick Sort, click Recent Run to display the most recent run at the top of the list. Click Recent Run again to return to the default view.

The date of the most recent run displays next to Recent Run.

Filter Rules

Under View Rules, click a filter to apply it. Click the filter again to remove it.

  • Active: Displays only rules marked as Active. A badge displays the number of active rules.
  • Errors: Displays only rules with errors. A badge displays the number of rules with errors.
  • Priorities: Displays rules by priority. Select Minor or Moderate if available. Available priorities depend on the rules configured for the study. Badges display the number of rules in each priority.
  • Tags: Displays rules associated with the selected tag. Badges display the number of rules associated with each tag.
  • Data Store (for example, Clinical): Displays rules associated with the selected data store domain. Badges display the number of rules in each domain.

Reset or Clear Filters

  1. Click the Filters icon in the toolbar.
  2. Select Reset Filters or Clear Filters.

Alternatively, remove individual filters by clicking the red circle next to the filter name.

View Rule Details

Rule Details Panel

To open the Rule Details panel, double-click a rule row, or select the rule row and click the Details icon. 

Rule Details panel displaying rule configuration information

The Rule Details panel displays key information about the rule, including Rule Name, Active Status, Description, Primary Field, Rule Fields, Related Fields, Tag, Priority, Last Updated, Issue Run Status, Query Run Status, Last Run, Open Issues, and Open Queries.

The Open Issues and Open Queries rows contain hyperlinks that open the corresponding panel listings in Data Central with filters automatically applied for Status = Open and Opened By = [Rule Name]. Only results associated with the selected rule display.

Read-Only Rule Builder

Only users with the Study Configure privilege can create or manage rules. All other users have read-only access and can view the rule parameters.

To view rule parameters:

  1. Click the Edit icon in the toolbar, or select the rule name hyperlink.
  2. The Rule Builder window opens to the Step 1: Build tab by default.
  3. Select the Step 2: Action tab to review the associated actions.
  4. Click Close to exit the Rule Builder window.

Rule Builder window in read-only mode

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request