Workflow
This context lets you access and manage a single workflow.
Unique Actions
[?]
Configure
This Configure action is used to edit the properties of the workflow.
![]() | Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier. |
Action Type: |
EDIT TEMPLATE
This action is supported only in Iotellect Client. Is starts the GUI Builder and allows to edit the workflow template.
Action Name: | editTemplate |
Non-Interactive Mode: | Not Supported |
Permissions: | Accessible at Manager permission level |

Launch
This action starts a workflow. See Launching Workflows for more information.
Action Name: | launch |
Non-Interactive Mode: | Supported |
Permissions: | Accessible at Observer permission level |
Execution Parameters: | Widget Window Location Widget Dashboard Properties |
Common Actions
[?]
Delete, Make Copy, Replicate, Edit Context Permissions, Monitor Related Events, View Status
Context States and Icons
This context has no states. It is always represented by the icon.
Advanced Information
Context Information
Context Type: workflow Context Name: provided by user Context Description: provided by user Context Path: users.USER_NAME.workflows.WORKFLOW_NAME Context Mask: users.*.workflows.*
Context Permissions
[?]
Level | Description |
None | No access allowed. |
Observer | Workflow configuration browsing. Basic event monitoring. Status browsing. |
Operator | Same as Observer. |
Manager | Workflow removal in addition to Operator permissions. |
Engineer | Same as Manager. |
Administrator | Workflow configuration in addition to Engineer permissions. |
Public Variables (Properties)
[?]
Common Variables: groupMembership (Group Membership), validity (Validity), activeAlerts (Active Alerts)
Properties
See description of the variable and its fields here.
Variable Name: | childInfo |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | 1 - 50 symbols |
description | String | 1 - 50 symbols |
template | String |
|
normalConcurrentBindings | Integer |
|
maximumConcurrentBindings | Integer |
|
maximumBindingQueueLength | Integer |
|
multiUserWorkflowExecution | Boolean |
|
logWorkflowExecution | Boolean |
|
Thread Pool Statistics
Returns statistical information about workflow's thread pool.
Variable Name: | threadPoolStatus |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
activeCount | Integer | Number of active tasks. |
completedCount | Long | Number of completed tasks. |
totalCount | Long | Total number of tasks. |
coreSize | Integer | Pool core size. |
largestSize | Integer | Pool largest (peak) size. |
maximumSize | Integer | Pool maximum allowed size. |
queueLength | Integer | Task queue length. |
Public Functions
[?]
Headless Execution of Workflow
This function starts a workflow. Input parameter is DataTable which used as Default Data Table.
Function Name: | execute | ||
Permissions: | Accessible at Engineer permission level | ||
Input Records: | 1 | ||
Input Format: | |||
Name | Type | Description | |
---|---|---|---|
defaultDataTable | DataTable | Table name | |
Output Records: | 0 | ||
Output Format: | None. |
Public Events
[?]
Common Events: info (Information)
The following events are fired if the property Generate Workflow Execution Events is enabled for the workflow.
Binding Execution
This event is generated each time a workflow binding is executed.
Event Name | bindingExecution |
Permissions: | Accessible at Observer permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
context | String | Workflow context. |
target | String | Binding target. |
expression | String | Binding expression. |
value | String | String representation of binding expression result. |
activator | String | Binding activator. |
condition | String | Binding condition. |
execution | String | Binding execution mode (On startup, On event, or Periodical). |
cause | String | Binding execution cause (reference to an event or changed variable that has caused the execution). |
Binding Error
This event is generated each time a workflow binding fails with an error.
Event Name | bindingError |
Permissions: | Accessible at Observer permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
context | String | Workflow context |
target | String | Binding target. |
expression | String | Binding expression. |
activator | String | Binding activator. |
execution | String | Binding execution mode (On startup, On event, or Periodical). |
cause | String | Binding execution cause (reference to an event or changed variable that has caused the execution). |
error | String | Text of the error message. |
stack | Data Table | Table that contains stack trace of binding error. |
Workflow Execution
This event is generated each time a workflow block is executed.
Event Name | workflowExecution |
Permissions: | Accessible at Observer permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
workflowExecutionElement | String | Name of block which will be executed |
workflowExecutionInputValue | String | Environment variable with the name "value" |
Workflow Error
This event is generated each time a block fails with an error.
Event Name | workflowError |
Permissions: | Accessible at Observer permission level |
Expiration Period: | Non-persistent |
Records: | 1 |
Record Format:
Field Name | Field Type | Notes |
target | String | Name of block |
error | String | Text of the error message. |
stack | Data Table | Table that contains stack trace of binding error. |
Was this page helpful?