Overview: Workflow module structure (Console)

This article explains the general exterior and interior structure of workflow modules in the Workflows workspace in Console.

In this article

Overview

All workflow modules share the same exterior structure. They all include a title, a customizable name that you create to quickly identify the purpose of the module and ports. These ports are located on the top and bottom of the workflow module. 

A workflow module port is where data goes into the module when the path of a workflow session reaches the module, and the exit port is where data leaves the module once the workflow module has been processed. All workflow modules have one entry port. However, they differ regarding the number of exit ports they have. 

While all workflow modules look the same on the outside, they vary greatly on the inside. The interior structure of each module includes all the configurations you need to set up the module to work.  Visit the Workflows module library to learn more about each individual module and how to best configure it. 

This article outlines the basic structure of the outside and inside of a workflow module to help you better understand them.

Visual breakdown

Exterior of module

The exterior structure of modules is fairly similar across all modules. Familiarize yourself with each important area of the exterior structure below.

• • Entry Port: The entry port, which is located across the entire top of the workflow module, is the entrance to a workflow module. There is one entry port, but there also is no limit to the number of links into a module.

  • Module Name: The module name, which is located within the middle of the workflow module, is the title of the module that was created by the admin that configured the module. This means that the admin creates and enters this name to best help you explain the module’s purpose and function.

  • Exit Port(s): The exit port, which is located across the entire bottom of the workflow module, is the exit point from the workflow module. Each module has different configurations, so the number of exit ports varies per module. However, there can only be one link from each exit port. This means there is only one path out of a workflow module. For example, in the above workflow example, this module has two exit ports: ‘Delivered’ and ‘Bounced’.

  • Link: The workflow module link (lines leading in and out of the module) are the connection lines between workflow modules. A link from one module and to another module creates a path between the modules.

Interior of module

Unlike the exterior structure, the interior structure of each workflow module varies. 

Some modules are very simple and execute one specific action, and other workflow modules are more complex, so they execute more than one action. Familiarize yourself with the main interior features that are similar across all modules.

• Label: The Label text field in the top-left corner is where you name the module.

• Save: Click the Save button in the top-right corner to save any changes to a module.

• Cancel (X): Click the X (cancel) button to close the module without saving.

All other areas of the module are referred to as the Configuration Workspace. The contents of this area varies from module to module.

The Configuration Workspace is where you set up the module. Visit the Workflows module library to learn more about each workflow module and how to best configure the inside of it.