Performing Inline Validation

  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' => "1048576000", 'end_byte' => "1048576000", 'file_csum_type' => "none", 'session_id' => "ab658c6e-648f-4249-abe9-d5c3801ef534", 'target_rate_kbps' => "10000", 'cipher' => "aes-128", 'file_name_encoding' => "utf16", 'min_rate_kbps' => "0", 'startstop' => "running", 'user_id' => "0", 'client_ip' => "50.19.236.72", 'host' => "66.211.109.190", 'rate_policy' => "fair", 'file' => "/LargeFiles/Washington U", 'user' => "aspera-nyc", 'direction' => "recv", 'start_byte' => "0"}

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

  2. Obtain the Aspera call URL.
    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://localhost/aspera/orchestrator/external_calls/validate/35?user=admin&password=admin
  3. Open the configuration file, aspera.conf (located at C:\Program Files (x86)\Aspera\product_name\etc\aspera.conf) and edit the <user> section of the file using the steps below.
    1. Choose a transfer user that will be used for inline validation and enter it in the <name> parameter.
      In the example below, the user is faspex.
          <name>faspex</name>
      
    2. Add the <transfer> content shown below.
      <transfer>
              <validation_uri>https://localhost/aspera/orchestrator/external_calls/validate/35?user=admin&password=admin
              </validation_uri>    
              <validation_threshold_kb>1000</validation_threshold_kb>
          </transfer>

      The value for <validate_uri> is the URL obtained in Step 2.

    3. If the validation takes more than 30 seconds, add the following line (also in the longer code example above) to avoid premature timeout:
      <session_timeout_sec>60</session_timeout_sec>
      The value between the <session_timeout_sec> tags can be increased as needed.
    The example below illustrates the <user> parameters described in steps 3.a - 3.c.
    <user>
        <session_timeout_sec>60</session_timeout_sec>
        <name>faspex</name>
        <transfer>
            <validation_uri> https://localhost/aspera/orchestrator/external_calls/validate/35?user=admin&password=admin
            </validation_uri>    
            <validation_threshold_kb>1000</validation_threshold_kb>
        </transfer>
    </user>
    
  4. Confirm the version of ascp and Aspera Connect.
    • Check the installed version of ascp by executing the ascp –A command. If the installed version is not 3.5 or above, please contact Technical Support for an upgrade.
    • Check the version of the Aspera Connect browser plugin. It must be version 3.4 or higher to ensure that the error messages generated by the system are correct.
  5. Configure mongrels.
    For production servers, Aspera recommends that mongrel usage for ascp calls be separated from the user's usage of 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.