Faspex Delivery Plugin



This action plugin generates Faspex packages and exposes upload links.

Saved Parameters Description

  • Name: The name used to identify a saved FaspexDelivery configured instance.
  • Comments: Some comments about this saved FaspexDelivery configured instance.
  • Faspex Node: The node where Aspera Faspex server is installed. If no remote node is configured, use the Advanced parameters section.
  • Faspex service address: Advanced - The full URL or the host name of the faspex server, if not configured as Remote Node.
  • Sender hostname or IP address: Advanced - Deprecated, it should not be used anymore.
  • Internal hostname or IP address: Advanced - Deprecated, it should not be used anymore.
  • Faspex sender user: The Faspex user to use for creating the Package. This user will be the sender of the package.
  • Faspex sender Password: The password for the Faspex user to use for creating the Package.
  • Use faspex legacy api: Used for backward compatibility.
  • Title: The Faspex package title.
  • Note: The note to add to the Faspex package.
  • Recipients: A comma separated values of receipients for the Package. Depending on the user rights, this can be a list of users, external users, workgroups or dropboxes.
  • Package metadata: The metadata specifications for the package. Metadata must be well formatted to be accepted. See examples
  • Use encryption at rest: If set the package will be stored encrypted in the Faspex storage.
  • Send upload result: If set Faspex will send an email to the package creator to signal the end of the upload.
  • Use remote source?: If set the Faspex package will be built with files from a remote source.
  • Remote source id: The id of the remote source to use as source for this package
  • Remote file_paths: The list of files to include in the Faspex Package from the remote source.
  • Target rate: It allows to specify the upload target rate. Deprecated.
  • Package encryption passkey: If encryption at rest specified, the encryption password to use.
  • Embed account info in url: It allows to include the account credentials in the url. This is useful when the files upload is done via an orchestrator Fasp Transfer step.
  • Allow insecure: By default the package creation will fail if the connection to Faspex is insecure, meaning the SSL certificate of Faspex is not valid or correctly signed.

Outputs Description

  • package_id: The UUID of the created Faspex package.
  • package_post_url: The Fasp URL to use to upload files to this Faspex package.

The following outputs are not available in legacy mode:

  • Cookie: The Faspex generated Cookie to use when uploading to this package.
  • Token: The Faspex authentication token to use when uploading to this package.
  • Destination_path: The path, relative to the faspex docroot, where the files will be stored.
  • Tags: The Faspex tags for this package. They include information on the sender like first and last names, email address, and so on.

Supported Actions

None

Dependencies

None

Operating Instructions:

How to send to Dropboxes

In order to send to a Dropbox, the dropbox name must be specified in the recipient list.
Note: In order to identify a dropbox, its name must be prefixed by '*'.

If you want to send a package to the dropbox Test dropbox 1, the value to specify in the recipient list is *Test dropbox 1.

How to specify Metadata

In order to specify the metadata for a new package, the syntax to use is the following:

"Target":"VOD Distrib","Profile":"MPEG2"
Note: At this stage no validation is done at the plugin level for metadata specifications.