Add Workflow

Explanation

This activity is used to add a workflow to an observation. The workflow is what defines which business process automation done with the observation once it has been received and registered in the system. Depending on the setup of the observation, the workflow models are either automatically executed or needs to be manually executed.

To add a workflow:
    1. Navigate to Observation Flow page and select a record.
    2. Select the tab Workflow Items and insert a new record. (Default view is card view here)
    3. Choose a workflow model Id by entering the identity.
    4. Choose an already defined event (for IoTObservationCache Lu) or create a new event using New Event toggle.
    5. Enter a description of your choice, describing what the Workflow Model does with the observation data.
    6. Save the record.

Note! Here the workflow model id needed to be valid and supportive of the type Process Enrichment.

Prerequisites

The workflow model id is needed to be a valid workflow process id deployed in the Camunda server. Refer Business Process Automation technical guide for more info. The process id can be either standard delivered one (refer Standard Workflow Models Delivered for IoT in this page.) or a newly created one using Workflow Designer tool. Otherwise the event action generation process will fail.

System Effects

A Custom Event (if marked as New Event) and an Event Action will be generated. Can be navigated to Event, Event Action. Observation Code will be added as a condition in the created Event Action. This Event and Event action can be configured per choice.

Limitations Compared to Operational Items

Observation is not marked as completed when a Workflow is run successfully errors will be thrown at once without registering in the Observation detail page.
IoT attachment is not updated based on Workflows.
No mention of used Workflows in Observation details page.
Parameter support is handled through PLSQL methods defined in the event.
Exception handling not supported for Workflows.

Standard Workflow Models Delivered for IoT

In order to use this workflow model when receiving an observation, user needs to configure custom attributes in the generated Custom Event.

Note! Without these definitions the workflow model will throw errors when executing.

Attribute names should be an exact match* here.

bpaIoTMeasurement

Can be used to create measurements against a defined equipment object. Device mapping needed to be done against incoming device id in the observation.

Custom Attribute Name*

Server Method

Data Type

ParameterCode

Iot_Workflow_Util_API.Get_Parameter_Id_Meas

(&NEW:DEVICE_ID, parameter_code_user_input_)

STRING

TestPointSeq

Iot_Workflow_Util_API.Get_Test_Pnt_Seq_Meas(&NEW:DEVICE_ID)

NUMBER

In ParameterCode attribute server method, define the parameter the measurement should be created upon, as the second passed parameter. This mentioned parameter must be defined in the mapped equipment object from device mapping. In this model always reading value is fetched as NUMBER 1 value of the Observation.

bpaIoTServiceRequest

Can be used to create a work order (work request) against a defined object. Device mapping should be done against incoming device id in the observation.

Custom Attribute Name*	Server Method	Data Type
MchCode	Iot_Workflow_Util_API.Get_Mch_Code_Serv_Req(&NEW:DEVICE_ID)	STRING
DeviceSite	Iot_Workflow_Util_API.Get_Device_Site_Serv_Req(&NEW:DEVICE_ID)	STRING
RegDate	Iot_Workflow_Util_API. Get_Date_Time()	STRING
OrgCode	Iot_Workflow_Util_API.Get_Maint_Org_Serv_Req (maintenance_organization_user_input_)	STRING
CustomerNo	Iot_Workflow_Util_API.Get_Customer_No_Serv_Req(&NEW:DEVICE_ID)	STRING

In OrgCode attribute server method, define the maintenance organization should be used as the passed parameter. This mentioned maintenance organization must be registered in the system against the object site.