Console Notification Action Plugin



This plugin inserts anentry in the Aspera Console representing Orchestrator events.

Saved Parameters Description

  • Name: The name used to identify a saved Console Notification configured instance.
  • Comments: Some comments about this saved Console Notification configured instance.
  • Console node name or host address: The remote node name/address of the console server.
  • Use node credentials?: This is checked if the credentials need to be provided for the console server. When this is checked the console port, user and passwords should be provided.
  • Console db port: The port number of the console db server.
  • Console db user: The username to login to the console db server.
  • Console DB password: The password to login to the console db server.
  • Aspera cookie pattern: By default, the cookie is generated using the format 'aspera.orchestrator:[workstep id]:[expanded event payload]'. The string used can contain static text and refer to the executing workstep ID and the expanded event payload.
  • Event payload: The event_payload is used to generate the content of the event field included as the [expanded event payload] section of the cookie. The string used can contain static text and variable expanded at run time.
  • Saved Inputs: The default values for the run time variables.
  • Journal the transaction?: Check this if the transaction needs to be journaled
  • Journal status: The status of the file that would be journaled
  • Journal step: The step name to be journaled

Inputs description

The list of inputs depends on the configuration of the Console Notification action template.

All parameters are available as inputs at run time if not specified by the template. This plug-in does not support value overwrites: if a value is specified in the template it will not be available as input of the step at run time.

These inputs are mandatory:

  • Console node name or host address: The remote node name/address of the console server.
  • event_name: This is a mandatory run time variable that must be provided.

Outputs description

The only output provided is the constructed message.