Introduction:

These instructions are made based on the DLE POC developed for P2. P2 is an OEM PM partner, Oil and Gas service company which serve their clients with PM.

POC goal: How PM can manage asynchronous calls from a transactional bus or other service / micro service architectures.

Initial considerations:

A custom instance with a DLE plugin must be deployed, by the time this document was made, Gustavo Silva S. was supporting SE in the provision of the instance with the required stack.

A data model (DM) is required to connect DLE to the process developed in PM. DM is based on a JSON file with the representative fields of a class / module / component information to be processed by the workflow. An example can be found later in this document.

Before developing any process it is required to deploy the data model, and then the baseline fields of the case are created automatically based on DM.

Always check if the versions of the data model are configured in the DLE instance, sometimes the instance is a copy of other client stack and DM versions aren't configured in that particular PM instance. Always check this with the provider of the instance, since this can't be configured from the PM interface.

To test the DLE plugin it is required to simulate web service calls. It is suggested to install an API development environment like Postman to do this.

To obtain the required access token to test the web services, open the web console in the design process view and extract the following parameter to use later as Bearer:  (Inspect → Network → XHR → Request Headers)

Steps to reproduce a POC with DLE plugin:

1. Request an instance with the DLE plugin configured
2. Create a DM. Example of a Gas Well data model 
3. Load the DM into PM
4. Create a HEDM process, selecting the deployed DM and its version
5. Develop the process using the pre loaded variables and save
6. Activate the process
7. Test the case with the following parameters with the API IDE

Method: Post URL: https://<<demo_name>>.processmaker.net:<<port>>/api/1.0/workflow/dle/requests

Headers:

• Authorization:<<Bearer>>
• Content-Type:application/json

Body (Raw):

{
 "data": {
   "resource": {
     "name": "gas_well",
     "id": "8874b288-7cba-45ef-958a-8b090e111b5e",
     "version": "application/vnd.hedtech.integration.v3+json"
   },
   "id": "161623",
   "published": "2017-03-28T12:44:55.276Z",
   "operation": "replaced",
   "contentType": "resource-representation",
   "content": {
     "company_name": "STURGEON RESOURCES J V5",
     "company_phone": "3304242822",
     "well_name": "R HILL",
     "well_number": "1",
     "completed_date": "8/13/1976",
     "well_latitude": "40.7352355973684",
     "well_longitude": "-80.7979850890101",
     "status": "CA",
     "id": "8874b288-7cba-45ef-958a-8b090e111b5e"
   }
 }
}

8. Case should be displayed in inbox

To keep in mind

• User notification is not working if is required once the case is started.
• Dropdown options configuration + Json string definition looks unstable