You must enable javascript in order to view this page or you can go
here
to view the webhelp.
Aspera Orchestrator User Guide 3.0.1
for Linux
C Content
Search
Keywords:
Loading, please wait ...
Introduction
The Orchestrator Help Page
Startup Operations
Starting Orchestrator
Stopping Orchestrator
Restarting Orchestrator
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
Reviewing User Preferences
Resetting Passwords
Configuring LDAP Access
Viewing and Granting User Permissions
Defining a New Permission
Workflow Designer
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
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
Generating a Workflow Call URL
Workflow Templates
Creating a Template
Editing a Template
Duplicating a Template
Exporting a Template
Importing a Template
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
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
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
List of Orchestrator Plugins
Plugin Help Content
ADI 3 Parser and Validator Action Plugin
ADI Parser and Validator Action Plugin
ADI Transformation Plugin
Amberfin transcoding Action Plug-in
Array Fan-out Action Plugin
Ascp Client Action Plugin
Aspera Central Watcher Action Plugin
Aspera Node API Plugin
Aspera Node API Transfer Plugin
Aspera Node File Watcher Action Plugin
Aspera Node Search Plugin
Baton File Correction Action Plugin
Console Notification Action Plugin
Console Smart Transfer Operation Action Plugin
Custom Trigger Action Plugin
Database Trigger Action Plugin
Email Notification Action Plugin
FASP Controller Plugin
FASP Transfer Plugin
Faspex Delivery Plugin
Faspex Inbox Watcher Action Plugin
Funnel-in Action Plugin
Local Execution Action Plugin
Local File Operation
Local File Permission Action Plugin
Local File Watcher Action Plugin
Local Folder Watcher Action Plugin
Media Info Action Plugin
Merge Point Action Plugin
Queue Stager Action Plugin
Remote Execution Action Plugin
Remote File Operation Action Plugin
Remote File Watcher Action Plugin
Resource Manager Action Plugin
REST Request Action Plugin
SOAP Request Action Plugin
SOAP Request Listener
Sub-workflow Action Plugin
User Input Action Plugin
Vantage Transcoding Action Plugin
Workflow Launcher Action Plugin
XSLT Transformation Action Plug-in
Journals
Overview: Journals and Journal Books
Working with Journal Books
Working with Journals
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 Mounts
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
Synchronous and Asynchronous Workers
Orchestrator Configuration File (orchestrator.yml)
Editing the Global Configuration Parameters
Adding Mongrel Processes for a New Apache Port
Taking Snapshots
Capsule Management
Importing a Capsule
Customize 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
ASCTL and Orchestrator
Overview
Orchestrator Setup
Start Orchestrator
Check Orchestrator Status
Stop Orchestrator
Admin User Configuration
Stop All Mongrels
Start All Mongrels
Asynchronous Worker Count
Synchronous Worker Count
Backup Database
Base Port
Create Setup File
Create Snapshot
Disable Orchestrator
Generate Config
Help
Info
List Configuration
List Workflows
Migrate Database
Mongrel Count
Rake Commands
Restart Orchestrator
Restore From Database File
Restore From Snapshot File
Setup Orchestrator from File
Orchestrator Webroot (URI Namespace)
Orchestrator Version
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
aspera.conf - Transfer
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 Workflows
List Available Workflows on the System
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
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 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
Appendix
Orchestrator Directory Locations
Error Codes in Orchestrator
Remote Node Status Notifications
Firewall Rules
Technical Support
Legal Notice
Your browser does not support iframes.