Skip to main content
Version: 3.9

Create New Workflow in R-COM Gateway

In R-COM Gateway, a workflow is a dynamic sequence of actions executed in response to an event, such as a device reading, API call, or scheduled trigger. Workflows are essential for transforming raw event data into meaningful automation, enabling real-time integrations with external systems, databases, notifications, and more.

Overview​

A workflow defines how incoming data is processed, from the moment it enters the Gateway to its final destination. This includes operations like:

  • Extracting or transforming input data
  • Triggering REST or MQTT calls to third-party systems
  • Modifying object records in the platform database
  • Sending emails, pushing alerts, or updating dashboards

Step 1: Open Workflow Management​

To begin:

  1. Log in to the R-COM Gateway Dashboard.
  2. Navigate to Automation > Workflows.
  3. Select Create Workflow to launch the workflow builder.
Create new workflow

Create new workflow

Step 2: Define Workflow Metadata​

The workflow editor opens with the workflow title and its header controls. Define the workflow metadata and runtime behavior before adding actions:

Design a new workflow

Design a new workflow

  • Name (Required): Give the workflow a unique, descriptive name.
  • Description (Required): Summarize what this workflow version accomplishes. A description is required for every workflow version.

Parameters​

Use Parameters in the workflow header to open Workflow Parameters. Parameters define values that an Event Rule or another workflow can pass into this workflow at runtime.

To add a parameter:

  1. Select Parameters and then Add Parameter.
  2. Enter a name, such as batchId or timestamp.
  3. Select a type. Available types are String, Int, Bool, DateTime, Decimal, Byte, Exception, Object, Guid, DateTimeOffset, List, Dictionary, and GhostData.
  4. Select Save in the Workflow Parameters panel.

Execution settings​

Use Execution settings in the workflow header to open the Execution settings panel. These values apply when a workflow starts; individual actions can override them during execution.

  • Default job status: Sets the initial status for jobs created from the workflow. Use SetJobStatus to change the status during execution.
  • Default job tags: Adds tags to every job created from the workflow. Use AddJobTags or RemoveJobTags to change tags during execution.
  • Execution Timeout (ms): Sets the maximum execution time in milliseconds. The workflow is terminated when it exceeds this duration.
  • Log Level: Sets the minimum level of workflow log entries to retain.
  • Store final context in database: Saves the final execution context with the workflow job.

Select Save Changes to apply the execution settings.

info

Consider disabling Store final context in database for production workflows that retrieve or generate large data sets. Persisting those values for every job can substantially increase database storage.

For finer control, use the FlushContext workflow action to whitelist or blacklist variables, retaining only the context needed for diagnostics.

Step 3: Add and Connect Actions​

Each workflow is built using Action Blocks, modular operations representing a specific task. For example, use WebRequest to call an external service or SetVar to store a value for later actions.

To add an action:

  1. In the Actions panel, use Search actions by name or purpose to find an action.
  2. Use the category filter to narrow the list by action category.
  3. Keep Latest Version Only enabled to show the current version of each action. Disable it when you need to select an earlier version. A version badge indicates that an action has more than one version.
  4. Drag an action, such as WebRequest, SetVar, or SendEmail, onto the canvas.
  5. Configure its inputs and outputs, then connect actions using arrows to define the execution flow.

Action blocks may receive input from previous blocks and output data to subsequent ones.

Customize an Action's Appearance​

Double-click an action on the canvas to open its settings, then select the Appearance tab. Changes apply only to this action node in the workflow.

  • Icon – Replaces the action's default icon. Select the icon, then choose another one from the list or use Search icons. Select Use default icon to restore the original icon.
  • Node Label – A custom name shown on the action node.
  • Custom Description – An optional note shown for this step.
  • Colors – The node's Background and Text color.

The Preview shows how the node will look. Select Apply Changes to update the node.

Step 4: Understand Connection Logic​

R-COM Gateway uses visual connectors to represent workflow transitions. Each connection line signifies what happens based on an action’s result:

Line TypeMeaning
Green SolidSuccess (Result = True) and this outcome is mandatory
Red SolidFailure (Result = False) and must be handled
Green DashedSuccess path that is optional (not required for workflow to proceed)
Red DashedOptional failure branch

Use these to build branching, error handling, and conditional flows.

Step 5: Save the Workflow​

Once your logic is complete:

  • Verify all action blocks are connected appropriately.
  • Ensure required inputs and outputs are defined.
  • Select Save when creating a workflow. When editing an existing version, select Update.
Example workflow

Example workflow

Manage Workflow Versions​

Select a workflow row from Automation > Workflows to open its workflow page. The Versions table lists each version with its required description, creation date, status, and available actions. Use the Failed Jobs Date Range filter to limit the failed jobs shown for a version.

From a workflow version, you can:

  • View the version without making changes.
  • Edit the version. Select Update to save your changes.
  • Copy workflow version to create a new version based on the selected version.
  • Open Failed jobs to investigate failed executions for that version.
  • Recompile workflow version after a relevant configuration change.
  • Delete workflow version when the version is no longer needed.

Bulk Actions​

Use bulk actions when the same maintenance task must be applied to several workflows. You can select up to 100 workflows at one time. The action applies to the selected supported workflow versions.

  1. Navigate to Automation > Workflows.
  2. Select the workflows and supported workflow versions that you want to manage, up to a maximum of 100 workflows.
  3. Select the required bulk action.
Bulk actionUse it to
ActivateActivate the selected supported workflow versions.
DeactivateDeactivate the selected supported workflow versions.
RecompileRecompile the selected supported workflow versions after a relevant configuration change.
DeleteRemove the selected supported workflow versions when they are no longer required.
warning

Review the selected workflow versions before using Delete. Confirm that none are still required by Event Rules or other operational processes.

Workflow bulk actions

Select workflows and their versions to use the Activate, Deactivate, Recompile, and Delete bulk actions.

Action Block Categories​

The Actions panel uses the current Gateway categories: Workflow Jobs, Cast, Storage, Logic, Data, Integration, and Utility. Use the category filter to browse actions, or Search actions by name or purpose to find an action directly. A version badge means that the action has multiple versions; disable Latest Version Only to show the earlier versions.

For parameters, return values, and examples, see Workflow Actions.

The action names below match the current category filters. For configuration details, input and return values, see Workflow Actions.

Data​

ConvertToGhostData, CreateExcelSheet, JsonPath, JsonPathValue, JsonSerializer, LoadExcelSheet, and ValidateJsonSchema.

Workflow Jobs​

AddJobTags, AddTime, EncodeGs1TagUri, RemoveJobTags, SetJobStatus, and StartTimer.

Logic​

Condition.

Integration​

MQTTChallengeResponse, MQTTPublisher, SendEmail, and SetHttpResponse.

Storage​

CheckStorageExists, CreateStorageLocation, GetObjectsOfStorage, GetStorageAreas, GetStorageBins, GetStorageLocations, GetStorageNumbers, SetStorageLocation, and SetStorageLocationByID.

Cast​

CastBool, CastDateTime, CastDateTimeOffset, CastDecimal, CastDictionary, CastDictionaryList, CastGuid, CastInt, CastObject, CastObjectList, and CastString.

Utility​

AddToList, Base64, ContainsItem, ContainsKey, CreateEpcisEvent, CreateObject, CreateTemporaryFile, CustomLinqQuery, CustomMySQL, CustomPostgresSQL, CustomScript, CustomSQL, Decode6Bit, DecodeData, DecodeGS1, DeleteAttachment, DeleteObject, DeleteObjectInstant, Encode6Bit, EncodeGS1, FlushContext, ForEach, GenerateGuid, GetAttachment, GetCustomTypeName, GetCustomTypeValue, GetDate, GetDateOffset, GetGroup, GetGroupId, GetKeyList, GetObjectAttachments, GetObjectChangeHistory, GetObjectGroupSchema, GetObjectsOfAttributes, GetObjectsOfObjectGroup, GetReferencingObjects, GetReferencingObjectsByGroup, HtmlEncode, IsObjectLocked, LinkAttachment, ListToString, LoadCsv, LoadTemporaryFile, LockObject, Log, LookupAttribute, LookupAttributes, MatchAndSortList, PublishRabbitMQ, ReadObject, ReadObjectGroup, RegexMatch, ReplaceWordPlaceholders, SaveAttachment, SetDictionary, SetGeoLocation, SetObjectAttributes, SetObjectInstant, SetVar, Sleep, SOAPRequest, SplitString, UnlockObject, UpdateGlobalVar, ValidateDecimalLimits, WaitLock, WebRequest, While, and XPath.

info

For detailed information on Action blocks and setup, refer to the guide:>>Workflow Actions.

Next Steps​

Once you've created and saved your workflow, you can test it by triggering the associated Event Rules. Monitor the logs and data flows to ensure the workflow behaves as expected.

Related Articles