Export and Import Rules in 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 and view any rules created for that study.
Users must have the Study Configure privilege to create, manage, run, export, and import rules for a study.

Orchestrator supports rule export and import using JSON files. Users can export selected rules, or all rules if none are selected, and import them into another study or into a study on a different URL. During import, the system validates rule structure and field values to ensure compatibility with the target study or URL before allowing the import. All export and import actions are recorded in the audit log to support traceability.

Orchestrator Window

Export Rules

Export configured rules to a JSON file to reuse in another study or on another URL.

  1. Navigate to Orchestrator for the study that contains the rules.
  2. Select all rules by selecting the checkbox in the header, or select specific rules by checking the box to the left of each row. If no rules are selected, all rules are exported when the Export Rule(s) icon is clicked.
  3. Click the Export Rule(s) icon in the toolbar.

The JSON file downloads automatically and includes the rule configuration details required for re-import.

Import Rules

Import rules from a JSON file to reuse rule configurations in another study or on another URL.

  1. Navigate to Orchestrator for the target study. 
  2. Click the Import Rule(s) icon in the toolbar. The Import Rule window opens. 
  3. Drag and drop the JSON file into the upload area, or browse to select the file.
    Import Rule Window
  4. Once the file uploads, the total number of rules selected for import and the number of skipped rules display.
    Import Rule window with total and skipped rules
  5. Select Skip Discrepancies if applicable.
    1. Click the Show All link to view all discrepancies. The discrepancy list displays the Name, Field, Value, and Discrepancy Type. Click Close to close the window.
  6. Click Import.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request