MFG OSIPI Machine Data System API - Implementation Template
Data mappings
This document provides information generated from the DataWeave scripts included in the project, such as function definitions, variable definitions, and data mapping tables.
| Module | Description |
|---|---|
| getAttributesRequest | |
| getAttributesResponse | |
| getPointsResponse | |
| getValuesRequest | |
| getValuesResponse |
getAttributesRequest
Source:
./src/main/resources/dwl/getAttributesRequest.dwl
Mapping Tables
Generates response object which includes attributes and data values for the OSI PI points.
| Source field | Target field | Description |
|---|---|---|
| 1.Method | pi.method config | since this is bulk fetch request this field represent actual REST method - GET in this case |
| 1.Resource | resource url | actual URL being called to fetch attributes for all PI points by the above GET method |
getAttributesResponse
Source:
./src/main/resources/dwl/getAttributesResponse.dwl
Mapping Tables
Generates response object which includes attributes and data values for the OSI PI points.
| Source field | Target field | Description |
|---|---|---|
| webId | WebId | unique web id of the OSI PI point |
| id | Id | unique id of the OSI PI point |
| tagName | Name | name of the OSI PI point e.g. Temperature |
| descriptor | Descriptor | description of the OSI PI point. It is being used to store machine id e.g. Machine1 |
| dataType | PointType | type of the data of the OSI PI point e.g. Int32 |
| units | EngineeringUnits | units of the data of the OSI PI point e.g. Degree F |
| span | Span | maximum value of the OSI PI point |
| zero | Zero | minimum value of the OSI PI point |
| displayDigits | DisplayDigits | number of digits to display in the value of the OSI PI point |
| link | Links.Self | web URL of the OSI PI point |
getPointsResponse
Source:
./src/main/resources/dwl/getPointsResponse.dwl
Variables
var s
Generates response object which includes attributes and data values for the OSI PI points.
Mapping Tables
Generates response object which includes attributes and data values for the OSI PI points.
| Source field | Target field | Description |
|---|---|---|
| attributes | attributes | attributes of the OSI PI point |
| data.timestamp | timestamp | date-time when data value was captured in OSI PI |
| data.value | value | data value for OSI PI point. It may be present in the data.value or data.value.Value field |
| data.good | good | flag representing if the data value for OSI PI point is current or old |
getValuesRequest
Source:
./src/main/resources/dwl/getValuesRequest.dwl
getValuesResponse
Source:
./src/main/resources/dwl/getValuesResponse.dwl
Mapping Tables
Generates response object which includes attributes and data values for the OSI PI points.
| Source field | Target field | Description |
|---|---|---|
| webId | WebId | unique web id of the OSI PI point |
| id | Id | unique id of the OSI PI point |
| tagName | Name | name of the OSI PI point e.g. Temperature |
| timestamp | Timestamp | date-time when data value was captured in OSI PI |
| value | value | data value for OSI PI point |
| good | Good | flag representing if the data value for OSI PI point is current or old |