Release Notes: IBM Aspera Orchestrator 3.0.2

Product Release: August 31, 2017
Release Notes Updated: August 31, 2017

This release of IBM Aspera Orchestrator provides the new features, fixes, and other changes listed below. The Breaking Changes section provides important information about modifications to the product that may require you to adjust your workflow, configuration, or usage. Additional sections cover system requirements and known problems.


Work Orders
  • The following are improvements to the display of work order information:
    • When reviewing information for a particular step, the work order header (work order name) remains fixed at the top of the page while the user scrolls though the work order status information.
    • Information under the header can be collapsed and expanded.
    • Work order numbers can be copied to the clipboard.
  • Improved graphs to track and display Orchestrator performance, including data for work orders and work steps, have been added..
Dashboards and Portlets
  • All portlets are updated to conform to the current UI design.
  • Users can now destroy a work order by submitting its ID in a new API call.
  • A new capability has been added to the XSLT plugin: Nokogiri can now be used to transform XMLs.
  • New capabilities have been added to the Amazon Glacier Operation and Amazon S3 Operation plugins, including the ability to restore a file from the Amazon Glacier archive and send it to Amazon S3 (after which the user can trigger a Node API call to download the file from Amazon S3 to an on-premise server).
  • The Aspera Node API plugin has added a number of new options:

    The following options are available for the "Submit Transfer Using Parameters" operation:

    • A new option to select the authentication method—using a dropdown menu—has been added. Two new authentication methods are now available in Orchestrator: Login Password Authentication and Login Key Authentication; Token Authentication continues to be available. Of particular note, Login Key Authentication offers a new parameter: "Remote key path" (used with SSH).
    • The transfer direction (send or receive) can now be selected in a dropdown menu.
    • A new "Have token?" checkbox has been added; if selected, it allows the user to edit token parameters. If not selected, the user can use the default remote access key and remote secret (password), or edit those values as needed.

    A new operation, "Monitor Transfer" is now available.

    A new "Use SSL" checkbox has been added. If selected, the default port (for the Node API to connect with) is HTTPS 9092. If not selected, the default port is HTTP 9091.

  • The File Info plugin now supports a list of multiple files.
  • The Amberfin Transcoder plugin is now asynchronous, which facilitates the tracking of long transcodes.
  • The Fasp Control plugin has been improved, with the following added capabilities:
    • Increased logging and reporting capabilities
    • Increased accuracy for the central address given at runtime
    • Improved timeouts for sessions that contain a large file count
    • Ability to provide the count or records returned in the response
    • An additional returned data set that includes only failed files
  • Users can now collapse and expand the display of available plugins in the workflow designer by category.
  • In the Email Notification and User Input plugins, users can now select a default mail server. This feature can be used for system notifications (for password reset and other events).
  • The data for items in a managed queue can now be exported as a CSV file.


If you are upgrading from a previous release, the following changes in this release may require you to adjust your workflow, configuration, or usage.

  • The following plugins must be upgraded after an Orchestrator upgrade in order to function properly:
    • Amazon Glacier Operation
    • Amazon S3 Operation
    • Aspera Files Package Delivery
    • Aspera Files Package Watcher
    • Console Smart Transfer Operation
    • Episode Transcoding
    • Load Manager
    • Resource Manager
    • Soap Request
    • The Platform
    • Vantage Transcoding



  • ORC-1688 - When the user installs Orchestrator with the "detailed" setup option and enters "/" (none) for the web root value, Apache fails to start.
  • ORC-1635 - The remote node SSH connection fails when it takes longer than 10 seconds to authenticate.
  • ORC-1615 - An attempt to revert a snapshot from the command line with Orchestrator that was installed with Ruby 2.3.0 does not work.
  • ORC-1453 - Resizing the browser window causes the Orchestrator icon and bell icon (for tasks and alerts) to display incorrectly.
  • ORC-1067 - The default values for cleanup_cutoff (number of days before work order data cleanup for errored/failed workflows) and purge_cutoff (number of days before work order data purging for complete workflows) in orchestrator.yml are incorrect.
Engine and Workers
  • ORC-1656 - The display of polling data on the Execution Statistics and Execution Queue pages is inconsistent.
Dashboards and Portlets
  • ORC-1647 - The custom portlet can't be enabled.
  • ORC-1643 - After configuring the csv_editor portlet using a CSV file path, then going to the dashboard, the user sees the error message, Error displaying portlet: csv_editor.
  • ORC-809 - The Journal View Portlet does not retain the selected Journal Book; after the option is saved, the Journal Book field returns to the default value.
  • ORC-392 - When the default Resource Manager template is used with a workflow persistence scope, the resource management portlet sometimes fails to render and displays the error: Error displaying portlet: resource_management.
Workflows and Workflow Designer
  • ORC-1663 - The folder deletion feature is not working.
  • ORC-1648 - Users cannot delete a previous version of a workflow from the revision history page.
  • ORC-1638 - When the user tries to delete a workflow revision, the revision is not deleted and the user is redirected to the workflow designer page instead of the revision history page for the workflow.
  • ORC-1626 - Users cannot import default workflows.
  • ORC-1620 - In the workflow designer, if the user switches the layout back to version 2 or 3 (using the tab at the bottom of the page), the designer no longer renders all steps in the workflow.
  • ORC-1569 - If the file value field under the Journals tab in the work step configuration template has a Ruby variable (such as <%= custom %>), the template can't be saved.
  • ORC-1562 - A step based on the plugin Aspera Node Search fails with the error, TypeError: wrong argument type.
  • ORC-1462 - Saving a step in a workflow without entering all the required inputs causes the step background to turn red (as expected). When the user subsequently fixes the issue by entering the missed step inputs and clicking Save, the workflow does not clear the red background from the step.


  • ORC-1619 - When monitoring an inbox using the Faspex Inbox Watcher plugin with Faspex 4.1, the plugin triggers before the upload of the package is complete.
  • ORC-1614 - The Federated plugin does not pull the inputs specification from the portable ID.
  • ORC-1597 - The Load Balancer plugin fails because the File class is missing the movemethod.
  • ORC-1524 - There is no comment section for the Shared State Operation and Simple Parameter Lookup plugins.
  • ORC-1501 - In the Email Notification plugin, the HTML body is missing the rich text editor.
  • ORC-1209 - No search result is returned for lower-case strings such as "user input", "media", and "logic operator" using plugin search in the workflow designer.
  • ORC-1587 - In order to get the percentage complete, the Journals page must be refreshed manually.
  • ORC-1586 - The blue progress bar for Journals does not appear.
  • ORC-1447 - The Journals page crashes intermittently.
  • ORC-1596 - A POST Request with a customized JSON payload to initiate a work order generates a 404 error.
  • ORC-1505 - JSON format support is not available for the processes_status API call.
  • ORC-1069 - When checking the status of a particular work order, neither thework_order_status API nor the work_step_status API returns information for percent_complete at the step level.


Windows 64-bit: 2008 R2, 2012, 2012 R2, 2016
Microsoft Visual C++ 2015 Redistributable Package, 64-bit
Browsers: Firefox 45–55, Google Chrome 50–60
Linux 64-bit: RHEL 6.0-6.7, 7.0-7.2; CentOS 6.0-6.7, 7.0-7 (1511), SLES 12
Aspera Common Components 1.2.20 
Browsers: Firefox 45–55, Google Chrome 50–60


Linux 64-bit (rpm): aspera-orchestrator-3.0.2.ff01700.x86_64.rpm
md5: cca13b2fd4c1e46b1ed6620e04877366
sha1: 55d3055d9cd841f99fc0a8312dcd7eaa6e89e279


ORC-1673 - If you are upgrading a version of Orchestrator prior to v. 3.0.1 that is configured with an external database, and during detailed setup you enter a new database IP address, Orchestrator does not update the database file or the database configuration file.

Workaround: Before running the setup, do the following:
  1. Update /opt/aspera/var/config/orchestrator/database.yml with the new IP address.
  2. Confirm that /opt/aspera/var/config/orchestrator/database.yml has a reference to adapter: mysql2 (not adapter: mysql).
  3. In /opt/aspera/orchestrator/config/database.yml, delete the entry for wait_timeout, and in its place, add an entry for checkout_timeout.
  4. Confirm that the name-value pairs in /opt/aspera/orchestrator/config/database.ymlmatch the name-value pairs already in/opt/aspera/var/config/orchestrator/database.yml.
    Note: This last step is required for Orchestrator 3.0.1 and 3.0.2.

ORC-1595 - When the user creates a workflow with two steps—where the outputs of the first step are mapped as inputs of the second step—and adds a step between the original two, the input mapping is not carried through to the last step automatically.

ORC-1530 - Importing a workflow made in Orchestrator 3.0.1 or 3.0.2 back into v. 2.7.1, some elements do not display properly. For example:
  • Payload type fields (text area or edit area) have a "/" inserted.
  • Parameter of type password is unusable.


For online support resources for Aspera products, including raising new support tickets, please visit the Aspera Support Portal. Note that you may have an existing account if you contacted the Aspera support team in the past. Before creating a new account, first try setting a password for the email that you use to interact with us. You may also call one of our regional support centers.

Powered by Zendesk