|
| 1 | +# Demo Adder Multi-step Orchestration |
| 2 | + - The demo adder analytic has been modified to take as input a trained model. This model is in the form of a threshold value. The addition is performed and if the result is greater than the threshold value, |
| 3 | + a -1 value will be written to the output. |
| 4 | + - The first step adds KW and vibration tag values and writes output to bearing temperature tag in timeseries. |
| 5 | + - The second step adds bearing temperature from first step output with vibration tag value and writes output to bearing temperature final tag in timeseries. |
| 6 | + |
| 7 | +# File list |
| 8 | +| File/Directory | Description | |
| 9 | +| -------------- | ----------- | |
| 10 | +| InitialData | The data that needs to be loaded into Timeseries to support the orchestration and the asset group and tag map queries that will used by the runtime.| |
| 11 | +| Orchestration | The orchestration configuration files. | |
| 12 | + |
| 13 | +# Steps to load and run the orchestration |
| 14 | + |
| 15 | +1. Load the data into time series |
| 16 | + - Use the websocket connection in the Predix Tool Kit (basic: https://predix-starter.run.aws-usw02-pr.ice.predix.io/#!/wsClient) to load the sample data into your Predix Timeseries instance. |
| 17 | + 1. log in as a user from your UAA |
| 18 | + 2. use Time series ingest to load the data from the following files in the InitialData folder |
| 19 | + - rawTimeSeriesData_KW.json |
| 20 | + - rawTimeSeriesData_vibration.json |
| 21 | + - predix-zone-id is your Time series guid (zone id/instance id) |
| 22 | + 1. open the socket |
| 23 | + 2. use the contents of rawTimeSeriesData_KW.json as the request body and send the message |
| 24 | + 3. repeat for the rest of the timeseries data files listed above |
| 25 | + 4. close the socket |
| 26 | + 3. use get timeseries tag values request from validateDataLoaded folder in the postman collection to verify that timeseries data has been loaded. |
| 27 | + |
| 28 | +2. Load the Timeseries Demo Adder with model Analytic to your Analytics Catalog |
| 29 | + 1. get the timeseries-adder-java code from https://github.com/PredixDev/predix-analytics-sample/tree/master/analytics/demo-timeseries-adder-with-model/demo-timeseries-adder-with-model-java |
| 30 | + 2. build it (mvn clean install) |
| 31 | + 3. use the requests from addAnalytics folder in the postman collection or the UI to create the catalog entry and upload the jar and template file (see instructions for adding an analytic to the catalog) |
| 32 | + 4. update Orchestration/TwoStepOrchestration.bpmn20.xml to reference this analytic |
| 33 | + * update analyticInstanceId, analyticName, and analyticVersion in the demoAdder serviceTask with the catalog entry instance id, entry name and version |
| 34 | + 5. test the analytic (this will deploy it) (see Predix IO Analytics Catalog docs for instructions on deploying an analytic) (sample data for testing the analytic is included in the analytic's github repository) |
| 35 | + |
| 36 | +3. Load the orchestration configuration |
| 37 | + 1. create the orchestration entry using the Create Orchestration Configuration Entry request in addOrchestrationConfiguration folder in the postman collection. |
| 38 | + 2. validate the bpmn using the Validate Orchestration request in addOrchestrationConfiguration folder in the postman collection. |
| 39 | + * the bpmn file should have been updated with the catalog entry id for the analytic (Both steps use same catalog entry id) |
| 40 | + * the expected response should appear as show below (the analyticIds will be the catalog entry ids from the bpmn) |
| 41 | + * if the response does not contain status "200" for each analytic, the analytic is not running or the runtime is not set up properly. Redeploy the analytic and validate the runtime setup. |
| 42 | +<pre> |
| 43 | +{ |
| 44 | + "analyticValidationStatusMap": { |
| 45 | + "http://analyticId.grc-apps.svc.ice.ge.com/api/v1/analytic/execution": "200", |
| 46 | + "http://analyticId.grc-apps.svc.ice.ge.com/api/v1/analytic/execution": "200" |
| 47 | + }, |
| 48 | + "id": "<responseId>" |
| 49 | +} |
| 50 | +</pre> |
| 51 | + 3. upload the bpmn using Create Orchestration BPMN Artifact request in the addOrchestrationConfiguration postman folder |
| 52 | + 4. upload the first step's port to field map using Create Orchestration Port to Field Map Artifact request in the addOrchestrationConfiguration postman folder after updating the request as follows: |
| 53 | + * fill in the orchestrationEntryId |
| 54 | + * set the name to the step name from the bpmn (sid-10001) |
| 55 | + * select the Orchestration/step1-portToFieldMap.json |
| 56 | + 5. upload the second step's port to field map using Create Orchestration Port to Field Map Artifact request in the addOrchestrationConfiguration postman folder after updating the request as follows: |
| 57 | + * fill in the orchestrationEntryId |
| 58 | + * set the name to the step name from the bpmn (sid-10002) |
| 59 | + * select the Orchestration/step2-portToFieldMap.json |
| 60 | + 6. verify that the configuration has been loaded using the Get Artifact Metadata for an Orchestration Configuration request in the addOrchestrationConfiguration postman folder |
| 61 | + * update the <orchestration entry id> in the url with the id from step 8.i above |
| 62 | + * the response should contain entries for the bpmn and 2 port to field maps |
| 63 | + 7. upload the threshold model using the postman Upload Model request in the addOrchestrationConfiguration postman folder after updating the request as follows: |
| 64 | + * set modelKey to 'model-key' |
| 65 | + * select the thresholdModel.json file in the Orchestrations directory |
| 66 | + 8. validate that the models have been uploaded with the Get Orchestrations Models in the addOrchestrationConfiguration postman folder |
| 67 | + |
| 68 | +4. Run the orchestration |
| 69 | + * use the postman Run Orchestration request in the postman folder after updating the request as follows: |
| 70 | + * put the following json in the request body. Updating the orchestrationEntryId with the orchestration entry id from step 8.i above. |
| 71 | +<pre> |
| 72 | +{ |
| 73 | + "orchestrationConfigurationId": "<orchestrationEntryId>", |
| 74 | + "assetId": null, |
| 75 | + "assetGroup": null, |
| 76 | + "assetDataFieldsMap": {"KW": "KW", "vibration": "vibration", "bearing_temperature" : "bearing_temperature", "bearing_temperature_final" : "bearing_temperature_final"}, |
| 77 | + "modelGroupKey":"model-key" |
| 78 | + } |
| 79 | +</pre> |
| 80 | + * note down the orchestration request id in the response |
| 81 | + |
| 82 | +5. View the orchestration status using the Orchestration Status request in the postman folder. |
| 83 | + * replace orchestrationRequestId in the uri with the orchestration request id from the response in step 4. |
| 84 | + |
| 85 | +# Congratulations! You have a 2 step orchestration running! |
0 commit comments