The Orchestrator Help Page

The Help page provides access to a number of key information resources for Orchestrator like template workflows, descriptions of the plugins, and a test environment for API endpoints.

At the top-right corner of the page, click Admin > Help Center.

Plugins and Workflows

Click Plugins or Workflows to see a complete list with descriptions. You can filter the display be entering a search string in the Search box. This returns a list all plugins or workflows that have a name matching the search string or have tags that match the provided search string.

  • Workflows displays a list of preconfigured Workflows for various purposes. Each workflow displays search term buttons that link to the associated plugins. To the right of each workflow is a view icon and a download icon. The View icon shows the image of the workflow as it appears in the workflow designer. Clicking the Download icon downloads the workflow to your system so that you can import it (see Importing a Workflow).
    Note: These workflows do not run "as is", because there will be dependencies (for example, a remote node), but they will run after proper configuration.
  • Plugins displays complete a list of plugin in the system. Click the "Example" icon at the right to view all preconfigured workflows that use that particular plugin.

Admin Guide

Click Admin Guide in the far-left navigation pane for guidance in installing, configuring, and upgrading Orchestrator. You can also view the latest Admin Guide on the Aspera website.

API Test Environment

Click API in the far-left navigation pane to open a list of commonly used API calls in Orchestrator. In the left pane, enter inputs and outputs, select JSON or XML, and choose various function calls such as Initiate or Check status to test the response on the local system. The URL and response body displays in the right pane.