You must enable javascript in order to view this page or you can go
here
to view the webhelp.
Orchestrator Admin Guide 3.1.1
for Windows
Content
Search Results
Loading, please wait ...
Introduction
Single Node Installation
Requirements
Installing Orchestrator
Product Configuration
Upgrading Orchestrator
Upgrading: Overview
Upgrading Orchestrator: Requirements
Upgrading a Single Node to the Current Release of Orchestrator
Upgrading Plugins and Portlets After an Upgrade of Orchestrator
Rolling Back an Upgrade
Uninstalling Orchestrator
Working with SAML
SAML and
Orchestrator
Configuring Your Identity Provider (IdP)
Configuring SAML in Orchestrator
High Availability Installation
Overview of High Availability for Orchestrator
General Requirements
Architecture of the High Availability Cluster
Overview of High Availability Architecture
Installing Orchestrator in High Availability Environments
Overview of Installation Process
Configuring orchestrator.yml for High Availability
Configuring MySQL and Aspera Services
Setting up Database Connectivity
Configuring MySQL and Aspera Services: Overview
Configuring the Aspera Services
Authorizing Orchestrator Database Access for Cluster IP Addresses
Completing the High Availability Installation Process
Configuring the Nodes
Upgrading a High Availability Setup
Upgrading High Availability: Requirements
Upgrading Orchestrator in a High Availability Environment
Alternative Configurations
Getting Started with Orchestrator
The Orchestrator Help Page
Starting and Stopping Orchestrator
Starting Orchestrator from the Services Panel
Starting Orchestrator from the Command Line
Stopping Orchestrator from the Services Panel
Stopping Orchestrator from the Command Line
Restarting Orchestrator from the Services Panel
Restarting Orchestrator from the Command Line
Troubleshooting Orchestrator Startup Operations
Connecting to the Orchestrator UI
Administering User Accounts
Creating a User
Assigning a User to a Group
Creating Strong Passwords in Orchestrator
Updating User Information
Resetting Passwords
Configuring LDAP Access
Active Directory Operations
Viewing and Granting User Permissions
Defining a New Permission
Remote Nodes
Overview: Remote Nodes
Creating a Remote Node
Editing a Remote Node
Testing a Remote Node
Removing a Remote Node
Remote Node Status Notifications
Generating a Certificate for a Node in a Workflow
Plugins
Searching for a Plugin
Enabling a Plugin
Disabling a Plugin
Importing a Plugin
Reloading a Plugin
Exporting a Plugin
Archiving a Plugin
Viewing the Archive List
Revision History Options for Plugins
Asset Management Plugins
Code Sample Plugins
File Operations Plugins
File Transfer Plugins
File Transformation Plugins
FIMS Plugins
Integration Plugins
Quality Control Plugins
Resource Plugins
System Plugins
Transcoding Plugins
Triggers Plugins
User Interactions Plugins
Virus Scan Plugins
Other Utilities Plugins
Plugin Templates for Workflows
Creating Workflow Action Templates and Global Templates
Editing a Workflow Action Template
Duplicating a Template
Exporting and Importing Workflow Templates
Workflows
Creating a Workflow
Editing a Workflow
Copying Work Step Inputs and Outputs
Setting Milestones for Work Steps
Setting Pre-processing and Post-processing for Work Steps
Copying and Deleting Work Steps
Launching a Workflow
Importing a Workflow
Exporting a Workflow
Deploying a Workflow to an External Orchestrator Instance
Duplicating a Workflow
Changing the Workflow Description
Printing a Workflow
Deleting a Workflow
Creating a Workflow Folder
Changing the Folder Location for a New or Existing Workflow
Moving a Workflow Folder
Deleting a Workflow Folder
Managing Workflow Revisions
Setting Workflow Permissions
Setting Batch Permissions for Workflows
Generating a Workflow Call URL
Creating Test Cases with the Workflow Testing Utility
Creating and Comparing Workflow Snapshots
Viewing a Workflow as a Dependency Tree
Work Orders
Creating a Work Order
Copying Work Step Inputs and Outputs
Configuring Work Order Filters
Deleting a Work Order
Resetting a Work Order
Relaunching a Work Order
Bulk Restart for Work Orders
Journals
Overview: Journals and Journal Books
Working with Journal Books
Working with Journals
Resource Manager
Creating a New Resource Pool
Viewing Resource History for Workflows
Monitors
Creating a Workflow Monitor
Bulk Activation and Deactivation for Workflow Monitors
Creating a Folder Monitor
Creating a Script Monitor
Creating a Monitor Group
Adding Monitors to a Monitor Group
Ungroup a Monitor from a Monitor Group
Creating a Remote Node Monitor
Exporting a Remote Node Monitor
Importing a Remote Node Monitor
Creating a Work Order Monitor
Exporting a Work Order Monitor
Importing a Work Order Monitor
Managing System
Connections
The Dashboard and Portlets
Introduction
Installing a Portlet
Importing a Portlet
Modifying an Existing Portlet
Creating a Custom Portlet
Editing a Custom Portlet
Creating a Portal Page
Configuring a Portal Page
Selecting a Custom Portlet for a Portal Page
Selecting an Installed Portlet for a Portal Page
Assigning a Portal Page to Other Users
Reordering the List of Portal Pages in the Dashboards List
Queues
Viewing and Managing Queues
Execution Queue Display
System Administration
Orchestrator Configuration File (orchestrator.yml)
Synchronous and Asynchronous Workers
Editing the Global Configuration Parameters
Adding Mongrel Processes for a New Apache Port
Creating Snapshots
Capsule Management
Importing a Capsule
Customizing the Orchestrator Logo
Migrating from Disk Persistence to Database Persistence
Rollback from Database Persistence to Disk Persistence
Adding Mongrel Processes for a New Apache Port
Increasing Apache Proxy Timeout
Inline Validation with Orchestrator
Overview of Inline File Validation
Requirements for Inline Validation
Performing Inline File Validation with Orchestrator (Validation with URI)
Inline File Validation with URI
Inline File Validation with Lua Script
Application Status and Management
Orchestrator Background Processes Status
Control Process
Orchestrator Monitor
Ping a Remote Orchestrator Instance
External Integration API
Introduction
Authentication
General API Calls
Persist Custom Data
Dashboard
Get Alerts for a User
API Calls for Monitors
Activate Monitors
Deactivate Monitors
List Monitors
API Calls for Plugins and Portlets
Plugin Version
Portlet Version
API Calls for Queues
Queue Item
Fetch Queued Items From a Queue
Look Up an Item in a Queue
List All Queues
Reorder a Queued Item
Bulk Reorder a Queued Item
Check Current Status of Execution Statistics
API Calls for Tasks
List User Tasks
Fetch Task Details
Submit a Task
API Calls for Work Orders
List Work Orders for a Workflow
Initiate a Work Order
Check the Status of a Specific Work Order
Fetch the Output of a Work Order
Reset a Work Order
Cancel a Work Order
Get Work Order Statistics
Check the Status of a Specific Step
Reset a Work Step
Cancel a Work Step
Get Work Step Statistics
API Calls for Workflows
List Available Workflows on the System
Export a Workflow
Import a Workflow
Fetch Inputs Specification for a Workflow
Fetch the Output Specification of a Workflow
Check the Running Status for all Workflows
Check the Running Status for a Specific Workflow
Check the Detailed Running Status for a Specific Workflow
Run Test Cases for Workflow Steps
Get the Status of Executed Test Cases for Workflow Steps
API Calls to Manage Resources
Manage Resources
Appendix
Orchestrator Directory Locations
Error Codes in Orchestrator
Remote Node Status Notifications
Firewall Rules
Creating a Basic Token for Transfers to Cloud Storage
TCP and UDP Ports Used in Orchestrator High Availability Environments
Technical Support
Legal Notice
Your browser does not support iframes.