Aspera Orchestrator User Guide 2.6.0

Introduction
Orchestrator Directory Locations
Startup Operations
- 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
- Reviewing User Preferences
- Resetting Passwords
- Configuring LDAP Access
- Active Directory Operations
- 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
- Remote Nodes in Orchestrator
- Creating a Remote Node
- Editing a Remote Node
- Testing a Remote Node
- Removing a Remote Node
Work Orders
- Creating a Work Order and Starting a Workflow
- Copying Work Step Inputs and Outputs
- Configuring Work Order Filters
- Canceling a Work Order
- Deleting a Work Order
- Resetting a Work Order
- Relaunching a Work Order
- Bulk Restart for Work Orders
- Work Orders Statistics View
Plugins
- About Plugins in Orchestrator
- 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
Journals
- Creating Journals In Orchestrator
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
- Queues Page Display
- Execution Queue Display
The Orchestrator Help Page
System Administration
- Synchronous and Asynchronous Workers
- Orchestrator Configuration File (orchestrator.yml)
- Changing Orchestrator Configuration
- Adding Mongrel Processes for a New Apache Port
- Using Snapshot Management
- 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
- Base Port
- Create Setup File
- Create Snapshot
- Disable Orchestrator
- Backup Database
- 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 Using Orchestrator
- Overview of Inline Validation Process
- Requirements for Inline Validation
- Performing Inline Validation
External Integration API
- Application Status and Management
- Introduction
- Authentication
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
- Initiate a Work Order
- Check the Status of a Specific Work Order
- Check the Status of a Specific Step
- Cancel a Work Order
- Cancel a Work Step
- Reset a Work Order
- Fetch the Output of a Work Order
- List Work Orders of a Workflow
General API Calls
- Persist Custom Data
- Dashboard
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
- Reorder a Queued Item
- Bulk Reorder a Queued Item
API Calls for Tasks
- List Tasks of a User
- Fetch Details of a Task
- Submit a Task
Appendix
- Error Codes in Orchestrator
- Remote Node Status Notifications
- Firewall Rules
Legal Notice

Revision: 2.6.0.136026 Generated: 11/22/2016 22:06

Aspera Orchestrator User Guide 2.6.0 for Windows