Skip to content

Flow documentation · legacy product

Actions ​

An Action is the culmination of your configuration. An Action is essentially the definition of a work flow to perform a desired task (or list of tasks). You include within the Action the appropriate modules to perform the desired task. The Action is then assigned a schedule for when it should execute, and you assign trading partners to it that need to be involved in the process.

The Action has reference to all the Data Definitions that are going to be used to perform the task. Each of these data definitions can have their connections reassigned (run time assignment). The Action uses the list of references to manage the connection and opening of the data definitions.

The Action has a reference to the list of steps to be performed as part of the work flow. These steps could involve other modules like Reports and Maps, or could be simple internally defined steps such as Shell Execute commands, custom script, or bespoke SQL statements. It is these steps that defines the tasks the action performs.

An Action is given a schedule for when it should execute. This may be either manually by an operator running the Action when desired, or automatically at scheduled intervals or by monitoring for a file to arrive. An Action could also be published as a web service allowing a third party to trigger the action by consuming the web service. By publishing as a web service it allows Flow actions to participate in a service oriented architecture, and this loose coupling allows for greater flexibility and stability for future changes.

Trading Partners are assigned to Actions that they need to participate in. This could be either by them sending data to be consumed by the Action, or the Action creating data to be sent to the trading partner. An example is an Action that outputs invoices, by assigning different trading partners to the Action you can output the invoices in a manner suitable for each trading partner.

Create a Action
  1. Open the Flow Designer

  2. Navigate to Configuration > Actions

  3. Right click Actions and select New

  4. Fill in the details and click Save. See Action

Edit a Action

TIP

A single left click on the Action will also open the edit window

  1. Open the Flow Designer
  2. Navigate to Configuration > Actions
  3. Right click the desired Action and select Edit
  4. Change the details as required and click Save. See Action
Delete a Action
  1. Open the Flow Designer

  2. Navigate to Configuration > Actions

  3. Right click the desired Action and select Delete

  4. Click Yes to confirm your choice

Copy a Action
  1. Open the Flow Designer
  2. Navigate to Configuration > Actions
  3. Right click the desired Action and select Copy
  4. The copy of the Action will display in the edit window. Change the details as required and click Save. See Action
Export a Action
  1. Open the Flow Designer

  2. Navigate to Configuration > Actions

  3. Right click the desired Action and select Export

  4. The template file will be assigned a default file name consisting of the name and type of the module. Change the name if desired and click Save. See Exporting and Importing

Import a Action
  1. Open the Flow Designer

  2. Navigate to Configuration > Actions

  3. Right click Actions and select Import

  4. Select the Template file you wish to import and click Open

  5. Choose the import method and click OK. See Exporting and Importing A confirmation screen will show what has been imported.

TIP

Note how dependant modules like the Connections , Definitions, Transports, Reports, Maps, and trading partners have been imported. When exporting a module that is dependant on other modules, these dependant modules are also included in the Template so that it can be recreated exactly when imported

Change Security on Action
  1. Open the Flow Designer
  2. Navigate to Configuration > Actions
  3. Right click the desired Action and select Security
  4. Change the details as required and click Save. See Managing Security
Refresh list of Actions
  1. Open the Flow Designer
  2. Navigate to Configuration > Actions
  3. Right click Actions and select Refresh