Templates

The Templates node of the Bridging provider in the Workbench contains the templates used for workflow diagrams in Transactions.

 

To Create a New Template:

  1. Open the Workbench and expand your project, then the Bridging node. Right-click on the Templates node, then click on Add Template, as shown below. You could also choose to create a separate template folder at this point.

Adding a Template from the Project Explorer in the Workbench

 

-OR-

 

Select the Templates node, then click on the Add Template button, shown below, in the Edit section of the Home ribbon in the Workbench.

 

Add Template Button

  1. This opens the Template properties, shown below. Enter a name for the template in the Template Name text entry field.

Template Properties

Template Diagram Tab

Activity Library

The Activity Library allows you to drag listed elements into the Diagram Editor. Each Activity brings up its own set of properties that appear to the right of the Diagram Editor when the Activity has been added.

 

Activities in the Activity Library include:

NOTE: See Creating a BridgeWorX64 Custom Activity for how to create a custom activity for use in BridgeWorX64.

 

You can select from the following items and set (or read) each Activity's individual properties:

Start

Start Activity

 

The Start activity is the starting activity of the workflow. It cannot be deleted and is unique in the whole workflow.

 

The Start activity has the following settings:

 

General Settings

Return to Top of Activity Library List

End

End Activity

 

The End activity returns a pre-defined result (Success or Failure) when it is executed.

 

The End activity has the following settings:

 

General Settings

Other Settings

Return to Top of Activity Library List

CSV File Reader

CSV File Reader Activity

 

The CSV File Reader activity reads the data from a CSV file. It eventually applies an expression filter to rows of data.

 

The CSV File Reader activity has the following settings:

 

General Settings

Timeout Settings

CSV File Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Bulk Real Time Input

Bulk Real Time Input Activity

 

The Bulk Real Time Input activity, from the Source DataSet, builds a dynamic list of Real Time points, reads their values and provides output DataSet to the next block

 

The Bulk Real Time Input activity has the following settings:

 

General Settings

Data Input

Timeout Settings

Other Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Real Time Input

Real Time Input Activity

 

The Real Time Input activity reads the data from a Real Time Data source, converts it into a stream and provides it to the next block. It eventually applies an expression filter to the Real Time Data stream.

 

The Real Time Input activity has the following settings:

 

General Settings

Data Sources

Timeout Settings

Data Source Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Data Set Reader

Data Set Reader Activity

 

The Data Set Reader activity reads the data from a DataSet source, converts it as a stream and provides it to the next block. It eventually applies an expression filter to the DataSet stream.

 

The Data Set Reader activity has the following settings:

 

General Settings

Data Source

Input Parameters

Output Parameters

Timeout Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Historical Alarms Input

Historical Alarms Input Activity

 

The Historical Alarms Input activity reads the data from an Historical Alarms source, converts it into a stream and provides it to the next block. It eventually applies an expression filter to the Historical Alarms stream.

 

The Historical Alarms Input activity has the following settings:

 

General Settings

Data Source

Timeout Settings

Historical Data Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Historical Input

Historical Input Activity

 

The Historical Input activity reads the data from a Historical Data source, converts it into a stream, and provides it to the next block. It eventually applies an expression filter to the Historical Data stream.

 

The Historical Input activity contains the following settings:

 

General Settings

Data Source

Timeout Settings

Historical Data Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

JSON Content Reader

JSON Content Reader

 

The JSON Content Reader activity reads the data from JSON content. It eventually applies an expression filter to rows of data.

 

The JSON Content Reader activity contains the following settings:

 

General Settings

Timeout Settings

JSON Reader Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

XML File Reader

XML File Reader Activity

 

The XML File Reader activity reads the data from an XML file. It eventually applies an extension filter to rows of data.

 

The XML File Reader activity has the following settings:

 

General Settings

Timeout Settings

XML Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Bulk Data Manipulator

Bulk Data Manipulator Activity

 

The Bulk Data Manipulator activity executes the GridWorX Data Manipulator for every row in the input DataSet, passing input parameter values for each data row and exposing output parameters as Output.

 

The Bulk Data Manipulator activity contains the following settings:

 

General Settings

Data Input

Data Source

Input Parameters

Output Parameters

Timeout Settings

Other Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

CSV File Output

CSV File Output Activity

 

The CSV File Output activity writes the (filtered) output of the previous activity into a CSV file.

 

The CSV File Output activity contains the following settings:

 

General Settings

Data Input

Timeout Settings

CSV File Settings

Retry Settings

Return to Top of Activity Library List

Bulk Real Time Output

Bulk Real Time Output Activity

 

The Bulk Real Time Output activity, from the Source DataSet, builds a dynamic list of Real Time points and corresponding data values, then writes those values to points.

 

The Bulk Real Time Output activity contains the following settings:

 

General Settings

Data Input

Timeout Settings

Expression Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Data Manipulator

Data Manipulator Activity

 

The Data Manipulator activity executes the GridWorX Data Manipulator, passing input parameter values and exposing output parameters as Output.

 

The Data Manipulator activity contains the following settings:

 

General Settings

Data Source

Input Parameters

Output Parameters

Timeout Settings

Other Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Generic JSON Writer

Generic JSON Writer Activity

 

The Generic JSON Writer activity prepares JSON content and writes it to the file.

 

The Generic JSON Writer activity contains the following settings

 

General Settings

Timeout Settings

Other Settings

Retry Settings

Return to Top of Activity Library List

Real Time Output

Real Time Output Activity

 

The Real Time Output activity writes the stream into a Real Time Data Tag.

 

The Real Time Output activity contains the following settings:

 

General Settings

Data Sources

Timeout Settings

Other Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Web Service Manipulator

Web Service Manipulator Activity

 

The Web Service Manipulator activity executes the Web Service Data Manipulator, passing input parameter values and exposing return value as Output.

 

The Web Service Manipulator activity contains the following settings:

 

General Settings

Data Source

Input Parameters

Output Parameters

Timeout Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

XML File Output

XML File Output Activity

 

The XML File Output activity writes the (filtered) output of some other activity into an XML file.

 

The XML File Output activity has the following settings:

 

General Settings

Data Input

Timeout Settings

XML File Settings

Retry Settings

Return to Top of Activity Library List

Data Set Transformer

Data Set Transformer Activity

 

The Data Set Transformer activity takes the output Data Set of some other activity and converts it into a different Data Set. You can hide or rename source column(s), add calculated columns, or filter source rows.

 

The Data Set Transformer activity has the following settings:

 

General Settings

Data Input

Timeout Settings

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Dynamic Tag Writer

Dynamic Tag Writer Activity

 

The Dynamic Tag Writer activity writes a value into a Dynamic DA Tag.

 

The Dynamic Tag Writer activity has the following settings:

 

General Settings

Timeout Settings

Destination Dynamic Tags

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Condition

Condition Activity

 

The Condition activity evaluates the expression and, depending on the expression, redirects the workflow.

 

The Condition activity has the following settings:

 

General Settings

Timeout Settings

Condition Settings

Retry Settings

Return to Top of Activity Library List

Information Broker Publisher

Information Broker Publisher

 

The Information Broker Publisher prepares JSON content and sends an outgoing message to Information Broker.

 

The Information Broker Publisher activity has the following settings:

 

General Settings

Timeout Settings

Information Broker Activity

Retry Settings

Return to Top of Activity Library List

Send Sms via ATT interface

Send Sms via ATT interface

 

The Send Sms via ATT interface activity sends a SMS using the server specified in the tag.

 

The Send Sms via ATT interface activity contains the following settings:

 

General Settings

AlertWorX Configuration

Timeout Settings

ATT SmS Settings

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

Note: The email is sent using ICONICS AlertWorX Server. Please make sure that a default email node is configured correctly and that the email server is running.

 

[See also Expression Functions for Datasets.]

Retry Settings

Return to Top of Activity Library List

Send Email

Send Email Activity

 

The Send Email activity sends an email using the server specified in the tag.

 

The Send Email activity contains the following settings:

 

General Settings

AlertWorX Configuration

Timeout Settings

Email Settings

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

Note: The email is sent using ICONICS AlertWorX Server. Please make sure that a default email node is configured correctly and that the email server is running.

 

[See also Expression Functions for Datasets.]

Retry Settings

Return to Top of Activity Library List

 

Send SendGrid Email

 

Send SendGrid Email Activity Activity

 

The Send SendGrid Email activity sends an email using the server specified in the tag.

 

The Send SendGrid Email activity contains the following settings:

 

General Settings

AlertWorX Configuration

Timeout Settings

Send Grid Email Settings

The following shortcuts can also be used in the message field:

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

Note: The email is sent using ICONICS AlertWorX Server. Please make sure that a default SendGrid email node is configured correctly and that the AlertRest server is running.

 

Retry Settings

Return to Top of Activity Library List

Send Sms

Send Sms

 

The Send Sms activity sends a SMS using the server specified in the tag.

 

The Send Sms activity contains the following settings:

 

General Settings

AlertWorX Configuration

Timeout Settings

SmS Settings

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

Note: The email is sent using ICONICS AlertWorX Server. Please make sure that a default email node is configured correctly and that the email server is running.

 

[See also Expression Functions for Datasets.]

Retry Settings

Return to Top of Activity Library List

Send Twilio message

Send Twilio message

 

The Send Twilio activity sends a message using the server specified in the tag.

 

The Send Twilio activity contains the following settings:

 

General Settings

AlertWorX Configuration

Timeout Settings

Twilio Settings

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

Note: The email is sent using ICONICS AlertWorX Server. Please make sure that a default email node is configured correctly and that the email server is running.

 

[See also Expression Functions for Datasets.]

Retry Settings

Return to Top of Activity Library List

Send Twilio Voice message

Send Twilio Voice message Activity

 

The Send Twilio Voice message activity sends a Twilio Voice message using the server specified in the tag.

 

The Send Twilio Voice message activity contains the following settings:

 

General Settings

AlertWorX Configuration

Timeout Settings

Twilio Voice Settings

The following shortcuts can also be used in the message field:

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

Note: The Twilio Voice message is sent using ICONICS AlertWorX Server. Please make sure that a default Twilio node is configured correctly and that the AlertRest server is running.

 

Retry Settings

Return to Top of Activity Library List

Send Twilio WhatsApp

Send Twilio WhatsApp Activity

 

The Send Twilio WhatsApp activity sends a message to WhatsApp using the server specified in the tag.

 

The Send Twilio WhatsApp activity contains the following settings:

 

General Settings

AlertWorX Configuration

Timeout Settings

Twilio WhatsApp Settings

The following shortcuts can also be used in the message field:

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

Note: The Twilio WhatsApp message is sent using ICONICS AlertWorX Server. Please make sure that a default WhatsApp node is configured correctly and that the AlertRest server is running.

 

Retry Settings

Return to Top of Activity Library List

Send Vonage message

Send Vonage message Activity

 

The Send Vonage activity sends a message using the server specified in the tag.

 

The Send Vonage activity contains the following settings:

 

General Settings

AlertWorX Configuration

Timeout Settings

Vonage Settings

The following shortcuts can also be used in the message field:

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

Note: The Vonage SMS is sent using the AlertWorX Server. Please make sure that a default Vonage node is configured correctly and that the AlertRest server is running.

 

Retry Settings

Return to Top of Activity Library List

Send Vonage Voice message

Send Vonage Voice message Activity

 

The Send Vonage Voice message activity sends a Voice message using the server specified in the tag.

 

The Send Vonage Voice message activity contains the following settings:

 

General Settings

AlertWorX Configuration

Timeout Settings

Vonage Voice Settings

The following shortcuts can also be used in the message field:

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

Note: The Vonage Voice message is sent using the AlertWorX Server. Please make sure that a default Vonage node is configured correctly and that the AlertRest server is running.

 

Retry Settings

Return to Top of Activity Library List

Send Vonage WhatsApp

Send Vonage WhatsApp Activity

 

The Send Vonage WhatsApp activity sends a message to WhatsApp using the server specified in the tag.

 

The Send Vonage WhatsApp activity contains the following settings:

 

General Settings

AlertWorX Configuration

Timeout Settings

Vonage WhatsApp Settings

The following shortcuts can also be used in the message field:

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

Note: The Vonage WhatsApp message is sent using the AlertWorX Server. Please make sure that a default WhatsApp node is configured correctly and that the AlertRest server is running.

 

Retry Settings

Return to Top of Activity Library List

Delay

Delay Activity

 

The Delay activity adds a delay to workflow execution.

 

The Delay activity has the following settings:

 

General Settings

Delay Settings

Retry Settings

Return to Top of Activity Library List

File Transfer

File Transfer Activity

 

The File Transfer activity transfers a file from one location to another.

 

The File Transfer activity has the following settings:

 

General Settings

Timeout Settings

Transfer Settings

Directory

Directory

FTP Server

FTP Server

Directory

FTP Server

Retry Settings

Return to Top of Activity Library List

GenEvent Output

GenEvent Output Activity

 

The GenEvent Output activity writes a message to the GenEvent Server.

 

The GenEvent Output activity has the following settings:

 

General Settings

Event Settings

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

[See also Expression Functions for Datasets.]

Retry Settings

Return to Top of Activity Library List

Alarm Event Output

Alarm Event Output Activity

 

The Alarm Event Output activity writes a message to the GenEvent Server that sources alarm data.

 

The Alarm Event Output activity has the following settings:

 

General Settings

Alarm Event Settings

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

 

[See also Expression Functions for Datasets.]

Retry Settings -

Return to Top of Activity Library List

NT Event Output

NT Event Output Activity

 

The NT Event Output activity writes an error, warning, information, success audit, or failure audit with the given message text to the event log, using the specified registered event source.

 

The NT Event Output activity has the following settings:

 

General Settings

Event Settings

/T - current workflow name

/B - activity in which last error occurred

/E - last error

/L - last executed activity name

/C - current activity name

/D - current activity description

Retry Settings

Return to Top of Activity Library List

Generate Report

Generate Report Activity

 

The Generate Report activity generates a new report using the report tag and the parameters specified.

 

The Generate Report Activity contains the following settings:

 

General Settings

Data Source

Timeout Settings

Retry Settings

Return to Top of Activity Library List

Diagram Editor

The Diagram Editor, when first opened, will display a Start Action. This is the starting activity of the Workflow. It cannot be deleted and is a unique element within the Workflow.

 

You can expand the Diagram Editor window in order to provide more room to create your Workflow Diagram. You can also use the following tools from the toolbar that first appears by default:

 

Snaps the items to the grid.

Toggles labels.

Toggles the Activity Library.

Autofit

Zoom in.

Zooms out.

Validation Log

The Validation Log provides immediate validating of the most recently added elements (activities, etc.) to the diagram.

  1. You can click Apply to save your template properties and Close to return to the Workbench. Your new template will now appear in the Project Explorer, beneath the Templates node or template folder.

Settings and Parameters Tab

Template Properties - Settings and Parameters Tab

 

Generic Properties

Conifigure the list of parameters in the workflow

  1. You can click Apply to save your template properties and Close to return to the Workbench. Your new template will now appear in the Project Explorer, beneath the Templates node or template folder.

See Also:

About Bridging

Transactions Node

Transaction Configurations

Transaction Folders

Transactions

Global Variables

Creating a BridgeWorX64 Custom Activity