Templates

 

[For info/instructions on Template Folders, click HERE.]

 

To Add a Template:

  1. Expand your project in the Workbench, and then expand the Connected Field Worker node.

  2. Right-click on the Templates branch or on a Template Folder, then select Add Template from the pulldown menu, as shown below.

Add Template from the Project Explorer

 

-OR-

 

Select the Templates branch or a Template Folder in the Project Explorer 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, as shown below, within the Workbench. Enter a name for this configuration in the Name text entry field.

Template Properties

Template Diagram Tab

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:

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

 

NOTE: For Connected Field Worker provider Template configurations requiring use of the Expression Editor, note that are specific additions to ease expression construction. Click HERE for more info.

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

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

Worker Lookup

Worker Lookup Activity

 

The Worker Lookup activity utilizes a Dynamic Worker List.

 

The Worker Lookup activity has the following settings:

 

General Settings

Timeout Settings

Worker Lookup

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

Fixed Contact List

Fixed Contact List Activity

 

The Fixed Contact List activity uses a List of Workers. This block only supports name and destination. Use the Worker Lookup Block if the transaction requires additional information, such as location, scheduling, filter, acknowledgement, etc.

 

The Fixed Contact List activity has the following settings:

 

General Settings

Timeout Settings

Fix List

 

The Fix List allows for creation of a list worker/contacts for a specific user and alert destination.

 

Destination Dynamic Tags - Click on the + Click here to add new item link to enter the following information:

Retry Settings

Return to Top of Activity Library List

 

Dynamics Work Order

 

Dynamics Work Order Activity

 

The Dynamics Work Order activity creates a Dynamics Work Order.

 

The Dynamics Work Order activity has the following settings:

 

General Settings

Timeout Settings

Dynamics Work Order

General Tab

Details Tab

Data Schema

Data Filter

Retry Settings

Return to Top of Activity Library List

 

SalesForce Work Order

 

SalesForce Work Order Activity

 

The SalesForce Work Order activity creates a SalesForce Work Order.

 

The SalesForce Work Order activity has the following settings:

 

General Settings

Timeout Settings

Salesforce Work Order

General Tab

Details Tab

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

Ack

Ack Activity

 

The Ack activity is set as True if the current alarm state is Ack. Acknowledge is any state that is only acknowledge or disabled. Alarm can be either active or inactive.

 

NOTE: This block causes the workflow to update the workflow with the latest alarm data for the specific alarm that triggered the workflow.

 

The Ack activity has the following settings:

 

General Settings

Timeout Settings

Alarm Update Condition

Retry Settings

Return to Top of Activity Library List

Alarm

Alarm Activity

 

The Alarm activity is set at True if the current alarm state is Alarm. Alarm is any state that is only enabled and active.

 

NOTE: This block causes the workflow to update the workflow with the latest alarm data for the specific alarm that triggered the workflow.

 

The Alarm activity has the following settings:

 

General Settings

Timeout Settings

Alarm Update Condition

Retry Settings

Return to Top of Activity Library List

Normal

Normal Activity

 

The Normal activity is set as True if the current alarm state is Normal. Normal is any state that is only acknowledge and no longer in alarm OR disabled. Note: Normal can be expanded to include not in alarm by ORing  '|| {{triggerVariable:NewState}} == 0x0001' within the ')' to the existing condition.

 

NOTE: This block causes the workflow to update the workflow with the latest alarm data for the specific alarm that triggered the workflow.

 

The Normal activity has the following settings:

 

General Settings

Timeout Settings

Alarm Update Condition

Retry Settings

Return to Top of Activity Library List

Reject

Reject Activity

 

The Reject activity is set as True if the current CFS state is Reject.

 

NOTE: This block causes the workflow to update the workflow with the latest alarm data for the specific alarm that triggered the workflow.

 

The Reject activity has the following settings:

 

General Settings

Timeout Settings

Alarm Update Condition

Retry Settings

Return to Top of Activity Library List

Busy

Busy Activity

 

The Busy activity is set as True if current CFS state is Busy.

 

NOTE: This block causes the workflow to update the workflow with the latest alarm data for the specific alarm that triggered the workflow.

 

The Busy activity has the following settings:

 

General Settings

Timeout Settings

Alarm Update Condition

Retry Settings

Return to Top of Activity Library List

Assign

Assign Activity

 

The Assign activity is set as True if the current CFS state is Assign.

 

NOTE: This block causes the workflow to update the workflow with the latest alarm data for the specific alarm that triggered the workflow.

 

The Assign activity has the following settings:

 

General Settings

Timeout Settings

Alarm Update Condition

Retry Settings

Return to Top of Activity Library List

Accept

Accept Activity

 

The Accept activity is set as True if the current CFS state is Accepted.

 

NOTE: This block causes the workflow to update the workflow with the latest alarm data for the specific alarm that triggered the workflow.

 

The Accept activity has the following settings:

 

General Settings

Timeout Settings

Alarm Update Condition

Retry Settings

Return to Top of Activity Library List

Send Sms via ATT interface

Send Sms via ATT interface Activity

 

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

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 ATT SMS is sent using ICONICS AlertWorX Server. Please make sure that a default ATT node is configured correctly and that the email server is running.

 

Retry Settings

Return to Top of Activity Library List

Send Email

Send Email Activity 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

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 email node is configured correctly and that the email server is running.

 

Retry Settings

Return to Top of Activity Library List

 

Send SendGrid Email

 

Send Send Grid Email 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 SendGrid 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 Activity

 

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

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 SMS is sent using ICONICS AlertWorX Server. Please make sure that a default SMS node is configured correctly and that the Alert SMS server is running.

 

Retry Settings

Return to Top of Activity Library List

Send Twilio message

Send Twilio message Activity

 

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

 

The Send Twilio activity contains the following settings:

 

General Settings

AlertWorX Configuration

Timeout Settings

Twilio 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 SMS 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 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.

 

Delays of 10 seconds (10000 milliseconds) or greater will cause the workflow to enter Dehydration. In Dehydration, workflow pauses for the entire delay time. The paused workflow thread(s) are released for other tasks. The current state of the paused workflow is saved to memory.  This prevents long delays from locking out other work.

Delay is best used just before a condition check.

 

The Delay activity has the following settings:

 

General Settings

Delay Settings

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

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

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

Input Parameters

Timeout Settings

Retry Settings

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.

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:

Templates Folder

About CFSWorX