This article provides a technique to better integrate transfers initiated by Orchestrator and monitored in Console.
Note: this concerns mainly transfers that are not part of Aspera applications such as Faspex and Shares, as these applications already use the cookie mechanism.
Console displays various pieces of information for past and current transfers. Some pieces are related to the transfer, such as size, speed. Other pieces can be used to identify the transfer by looking at parameters such as: "Transfer Name", "Started via" and "Contact". These fields can also be used for sorting and filtering.
Transfers initiated by Orchestrator, using the "FASP transfer" plugin, appear like any transfer initiated by simple clients, and servers, such as an Aspera Client to an Enterprise Server, or a Connect Plugin to a Connect Server.
By default, these transfer will be named according to the first file transferred and destination directory, and the contact will be the transfer user (identified by ssh). In most cases, this will not be sufficient, and a more specific transfer identifier should be used, allowing users to quickly identify transfers.
Console provides a feature, called "Custom Cookie Rule", that allows setting arbitrary values to the transfer fields: "Transfer Name", "Started via" and "Contact", by using the FASP "cookie" mechanism. Please refer to Console Administration manual for more information.
This Article shows how to customize console and a workflow so that Orchestrator initiated transfers can more easily be identified in Console.
The procedure consists in two parts:
1- configuring Console to detect special cookie, and set transfer values
2- configuring the "FASP transfer" in Orchestrator so that it fills the cookie accordingly.
This is described in Console Administrator Manual, in section: General Console Configuration > Cookie Configuration.
Let's create a Cookie rule:
We set here the Regular Expression to require the cookie to start with a unique identifying string: "setcustomfields:", and then separate three arbitrary values with a colon (:). These three free form values are then used to set transfer fields, with \1, \2 and \3. \1 refer to the value matched by the first: ":(.*):", i.e. any string between two colon, etc...
Orchestrator sample transfer workflow
Let's create a very simple workflow:
Let's just provision the necessary fields:
The plugin uses the "fasp_generic.xml.erb" payload. (The payload specifies the parameters for the Aspera Central SOAP API.).
Let's start the transfer, and see in Console:
We get the expected generic display.
Orchestrator setting cookie
Let's take the previous workflow, and let's add a custom action to build the custom cookie:
We define three input parameters and one output parameter, and we link them with the following code:
i.e. we implement the format expected by Console.
Then, just map the "Cookie" input of the transfer to the "Cookie" output parameter of the previous step.
Now we get, in Console:
Note the contact, sent via and name fields are now customized !