AS2 Module

Definition

The "AS2" tool module, standard module for use in any flow, was created to send messages using the AS2 protocol (Applicability Statement 2).

The "AS2" module consists of a single operation: Send an AS2 message.

Configuring the AS2 module

Before you can add an "AS2" module, you need to connect a station account and a partner account.

Register Station

To register a station within a flow, click on "Settings".

On the screen that appears, continue to the "Connected Accounts" tab. Make sure that "AS2" is selected under "Manage connected accounts" and then click "Add account".

Complete the following fields:

  • Station name: name of the station that will send the message

  • AS2 identifier: AS2 user, which will form the beginning of the AS2 trigger URL

  • Secret key: AS2 password

  • Private key: click to load a private key file (.pem)

For more information on connected accounts, read here.

Register a Partner

To register a Partner:

Within a flow, click on "Settings". On the screen that appears, continue to the Connected Accounts tab. Make sure that "AS2" and "Partner" are selected under "Manage connected accounts" and then click on "Add account".

Complete the following fields:

  • Name: partner name

  • AS2 identifier: AS2 user

  • URL: address of the partner station

  • Certificate: click to upload a public key file (.pem)

For more information on connected accounts, read here.

Configuring the AS2 module

The "AS2" module appears in the Tools option when editing a flow. As soon as you click to add it, the modal opens for configuration:

Configuring parameters

Configure the parameters in the "AS2" module.

Where:

  • Station ID: the Station account that will send the message, which must be previously registered.

  • Partner ID: the Partner account that will receive the message, which must be previously registered.

  • Message: enter the message here, which can be received from other components in the flow or even from an AS2 Trigger.

  • Encrypt message: select to encrypt the message to be sent

  • Sign message: select to digitally sign the message to be sent

In the second part of the "AS2" module configuration, you will test the module to validate the accounts used.

Parameters

The following parameters are sent by the "AS2" module and can be used by other modules in the flow:

  • responseHeader: message header

  • as2_message_id: unique identifier of the message

  • message: message sent

  • status: execution status, which can be processed or failed

To finish configuring the module, click on "Save".

Last updated