Description

The Aspera plugin uses the Aspera secure copy (ascp) client to upload and download files to and from an Aspera server. The Aspera ascp client uses the FASP transfer protocol, which can outperform TCP-based file transfer protocols such as FTP and HTTP.

Quick Info

Product
HCL Launch
Type
plugin
Compatibility
HCL Launch version 7.0 or later
Created by
HCL Software
Website
Version Name Action

3.1100729

launch-aspera-3.1100729.zip

launch-aspera-3.1100729.zip

3.1100729


Summary

The Aspera plugin uses the Aspera ascp (Aspera secure copy) client to upload and download files to and from an Aspera server. The Aspera ascp client uses the FASP transfer protocol, which can outperform TCP-based file transfer protocols such as FTP and HTTP. For more information about FASP transfer technology, see the Aspera website.

Compatibility

The HCL Launch automation plugin for Aspera requires access to an Aspera server, version 2.7 or higher.

The Aspera ascp client is required for the download and upload steps. The Aspera ascp client can be downloaded from the Aspera website. The ascp client is installed when you install the browser plugin.

This plugin requires HCL Launch version 7 or later.

This plugin runs on all operating systems that are supported by the HCL Launch agent.

Installation

See Installing plugins in HCL Launch for installing and removing plugins.

History

The following table describes the changes made in each plugin version.

Plugin history details
Version Description
2 Support added for defining files to upload and download by using a text file.

Usage

To use this plugin, create a component to define the Aspera artifacts to be used. For more information, see Creating components.

  1. On the Components page in HCL Launch, click Create New Component.
  2. In the Source Config Type list, select Aspera.

  3. Complete the settings required to import the desired artifacts. See the Setting tab for descriptions.
  4. Click Save.
  5. Click the Versions tab for the component.
  6. Click Import New Versions.

Step palette

To access this plug-in in the palette, click Repositorie > Artifact > Aspera.

Steps

The following process steps are available in the Aspera plugin.

Download Artifacts

Runs an Aspera FASP transfer process from an Aspera server to the localhost computer.

Input properties for the Download Artifacts step
Name Type Description Required
Additional Arguments String Enter additional arguments, or a text file containing additional arguments for the Aspera command. Separate each argument with a newline character or comma. No
Aspera Host String The IP address of the source Aspera server that contains the source files to transfer. For example: 192.0.2.1 Yes
Aspera Password Password The password used to connect to the Aspera server. No
Aspera Script Location String The full path to the folder that contains the ascp script. Yes
Aspera Username String The user name used to connect to the Aspera server. No
Destination File Path String The path to the local directory used to store the downloaded files and folders. Yes
Download Rate Enumeration Select the maximum download rate, in Mbps. Valid values are: -1, 1000, 5000,10000,25000,50000,75000, and 100000. No
Overwrite Strategy Enumeration Select the method for overwriting existing files with the same name as the source. Valid values are diff, older, diff+older, never, and always. No
Source File Paths String Specify a list of paths to the files or folders to download from the Aspera server. Separate each path with newline characters or commas. This list is appended to the Source Text File list and duplicates are removed. The combined list must contain at least one file. No
Source Text File String Specify the path to a text file that contains a list of paths to source files to download. Separate each path in the text file with newline characters or commas. This list is appended to the Source File Paths list and duplicates are removed. The combined list must contain at least one file. No

Upload Artifacts

Runs an Aspera FASP transfer process from the localhost computer to an Aspera server.

Input properties for the Upload Artifacts step
Name Type Description Required
Additional Arguments String Enter additional arguments, or a text file containing additional arguments for the Aspera command. Separate each argument with a newline character or comma. No
Aspera File Path String The path to the destination directory to use to store the uploaded files and folders on the Aspera server. Yes
Aspera Host String The IP address of the Aspera server that is the destination for the uploaded source files and folders. For example: 192.0.2.1 Yes
Aspera Password Password The password used to connect to the Aspera server. No
Aspera Script Location String The full path to the folder that contains the ascp script. Yes
Aspera Username String The user name used to connect to the Aspera server. No
Download Rate Enumeration Select the maximum download rate, in Mbps. Valid values are: -1, 1000, 5000, 10000, 25000, 50000, 75000, and 100000. No
Overwrite Strategy Enumeration Select the method for overwriting existing files with the same name as the source. Values are diff, older, diff+older, never, and always. No
Source File Paths String Specify a list of paths to the files and folders to upload to the Aspera server. Separate each path with newline characters or commas. This list is appended to the Source Text File list and duplicates are removed. The combined list must contain at least one file. No
Source Text File String Specify a path to a text file that contains a list of paths to source files to upload. Separate each path in the text file with newline characters or commas. This list is appended to the Source File Paths list and duplicates are removed. The combined list must contain at least one file. No