Performing Inline File Validation with Orchestrator (Validation with URI)

Inline file validation is a feature available to users of Aspera Enterprise Server suite products. This section describes a procedure to configure the transfer server for inline file validation with URI.

For further information, see Inline File Validation with URI or Inline File Validation with Lua Script (note that validation with Lua script is only available for transfer servers v. 2.7.1 and above). For more detailed information about inline validation parameters, see the General Configuration Reference section (file handling and aspera.conf transfer articles) in the Aspera Enterprise Server Admin Guide.

  1. Publish a workflow.
    Do one of the following:
    • Design and publish a workflow in Orchestrator.
    • Import a workflow and publish it.
    The workflow must contain a run-time parameter with name File and type Hash.
    Orchestrator populates the File parameter with a hash when ascp triggers an API call. For example:
    {"size"=>"1048576", "session_id"=>"12a66e2b-8c4b-4cf3-b220-737712918071", 
    "target_rate_kbps"=>"500", "cipher"=>"aes-128", "file_name_encoding"=>"utf8", 
    "min_rate_kbps"=>"0", "startstop"=>"running", "user_id"=>"0", "host"=>"10.0.136.8", 
    "rate_policy"=>"fair", "file"=>"/data/root/tmp/test/1m1995", "user"=>"root", 
    "direction"=>"recv", "start_byte"=>"0"}

    In the example above, the "file" key is used for processing, and the "startstop" key is used to route the workflow.

  2. Obtain the Aspera call URL.
    This URL will be entered later in aspera.conf, in the <validation_uri> parameter.
    Follow the procedure in Generating a Workflow Call URL to obtain the Aspera call URL of the workflow published in Step 1. The URL should contain a hostname, a route to the Orchestrator controller, and the workflow ID. Make sure to add the port to the URL if it is different from the default port, 443. Below is a sample URL.
    https://hostname/aspera/orchestrator/external_calls/validate/35?user=admin&password=admin
    In this example, hostname is the IP address or fully qualified domain name of the server on which Orchestrator is installed.
  3. To configure the transfer server for validation with URI, edit the configuration file, aspera.conf.
    Open the aspera.conf (located at /opt/aspera/etc/aspera.conf). For all available configuration options, see aspera.conf - Transfer.
    Note: If the validation takes more than 30 seconds, add the following line to the configuration to avoid premature timeout:
    <default>
         <session_timeout_sec>60</session_timeout_sec>
    </default>
    The value between the <session_timeout_sec> tags can be increased as needed.
  4. Increase the number of mongrels.
    For production servers, Aspera recommends that you increase the number of mongrels; this insures there are enough so that mongrel usage for ascp calls can be separated from mongrel usage for Orchestrator. Follow the procedure in Adding Mongrel Processes for a New Apache Port to increase the number of mongrels.
    Note: Apache must be restarted after this step.