Faspex Inbox Watcher Action Plugin



This action plug-in provides a way to trigger workflows based on the arrival of incoming packages in a Faspex inbox.

Saved Parameters Description

  • Name: The name used to identify a saved FaspexInboxWatcher configured instance.
  • Comments: Some comments about this saved FaspexInboxWatcher 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.
  • Packages root: The mount point on Faspex server or Enterprise server where Faspex packages are stored. This value can be found from aspera.conf on Enterprise server linked to Faspex
  • Faspex user: The Faspex user to use for creating the Package. This user will be the sender of the package.
  • Faspex Password: The password for the Faspex user to use for creating the Package.
  • Embed account info in URL: This flag must be checked. The authentication tokens are passed along with the 'faspe' URL to be submitted.
  • Mailbox: Choose among of inbox, sent or archive mailbox to monitor.
  • Faspex version: Choose among the values <3.5, 3.5 or >3.5. Depending on Faspex version, the 'faspe' URL is parsed differently
  • Filter conditions: Filter conditions executed at run-time on incoming package
  • Keep trigger on-going?: If set work order will be cloned to continue looking for new Faspex packages.
  • Trigger before package is fully uploaded?: If set Orchestrator will trigger on inprogress transfers.
  • Ignore packages already in inbox on start-up?: If set Orchestrator will ignore current Faspex packages in the mailbox.
  • Ignore faspex failures?: If set Orchestrator will continue to poll Faspex when Faspex is unavailable instead of failing the step.
  • Polling frequency: Determines how often Faspex should be polled for new packages.
  • Trigger persistence scope: Sets the scope/availability of the trigger output. The default value is 'by workorder group'. The definitions are: 'by workorder group', 'by action template', 'absolute', 'by step', 'by workflow', 'none'

  • Details:

  • 'by workorder group' - Trigger packages are tracked while the workorder is executing and will only be trapped once for a workorder group. If the workorder is restarted (new workorder group), all past triggers will be detected again if still matching the search criteria.

  • 'by workflow' - Same as 'by workorder group' except no triggering will occur upon a 'restart' action for the same workflow.

  • 'by action template' - Allows the tracking and thus non-triggering in another workflow for previously processed trigger files shared across workflows via the same template.

  • 'absolute' - The trigger list is tracked regardless of where it occurs.

  • 'by step' - Similar to 'by workflow', but allows for multiple independent trigger steps within the workflow.

  • 'none' - No persistence at all. If a past trigger package is still present, it will re-trigger if 'keep on-going' is selected. This option is recommended when 'keep on-going' is not selected.

Inputs Description

The list of inputs depends on the configuration of the FaspexInboxWatcher action template.

Changes in this list of inputs will override any values set in the action template.

  • Faspex Node: Orchestrator remote node chosen from the dropdown
  • Faspex service address: If node is not present, Faspex server address should be provided here.
  • Faspex user: If node is not present, Faspex user's login should be provided here
  • Faspex Password: If node is not present, Faspex user's password should be provided here
  • Filter conditions: Filter conditions executed at run-time on incoming package

Outputs Description

  • Title: Title of Faspex package.
  • Content: Body of the Faspex package.
  • Id: UUID of the Faspex package.
  • Published: Date and time when Faspex package was sent.
  • Updated: Date and time when Faspex package was updated at.
  • Status: Status of the Faspex package whether it is open, unopened, completed or failed.
  • Author_name: Faspex sender's login
  • Author_email: Faspex sender's email
  • Meta_data: The Faspex tags for this package. They include information on the sender like first and last names, email address etc.
  • Recipient_name: Faspex recipient's login
  • Recipient_email: Faspex recipient's email
  • Links: Faspex packages' content as faspe: links
  • Package_location: Faspex package's absolute file path, if package root was provided
  • File_list: List of file names included in the Faspex package
  • File_to_link_map: Map containing file name and its corresponding faspe: link

Supported Actions

None

Dependencies

None

Operating Instructions

How to configure a Faspex Inbox Watcher

In order to watch a Faspex server for user packages, you need the IP address or hostname of Faspex server; firewall access on port 443 (default) from Orchestrator to Faspex; valid Faspex user login and password; Faspex user must have download rights on the package.

Configure the step with the above details and select the version and filter options.

How to test the login of Faspex user

Access the Faspex server via a web browser and login with Faspex login and password. If the login does not work, contact the server administrator.

How to test the connectivity to Faspex server

Create a Orchestrator remote node (Type as IP) to the Faspex server with the IP address or hostname and TCP por as 443. Test TCP connectivity. If the connectivity fails, contact the server administrator.

How to test that the configuration is correct

After logging into the Faspex server, if the packages are present in the user's mailbox then Orchestrator should be able to trigger on the package.

Troubleshooting when packages are not triggered on

Without a valid user and password, packages are not detected.

Without download permissions on the package, packages are not detected.