2023 SP1 - Detailed Changes (PI Web API OMF Services)

Non-Breaking Change: Caching is implemented in CREATE/UPDATE for TYPE and CONTAINER

PI Web API 2023 SP1 implements caches to handle CREATE/UPDATE messages when creating Types and Containers. This new feature should improve performance in situations when OMF clients retart and resend those OMF messages.

Non-Breaking Change: Compressing setting is turned off when the Interpolation property of a Dynamic TYPE is discrete

OMF PI Point's compressing setting is turned off, when its TYPE's Interpolation property is discrete.

Note: "Turning off compressing" only applies to new OMF PI Points to be created. If the PI points already exist, their compressing settings won't be changed.

Non-Breaking Change: OMF PI Points Support for Future Data

PI Web API 2023 SP1 adds the ability to create OMF PI Points with future data support in OMF CONTAINER message's metadata property. The following CONTAINER sample message shows how to set future to true in metadata property.

[{ "id": "PredictedEnergyCost", "typeid": "TimeIndexed.Single", "datasource":"ADH", "metadata": { "future": true } }]

Note: Future data support in OMF PI Points is limited and obeys the following rules:

• For CREATE messages, if the PI Point doesn't exist and the request has future=true in the metadata property, then a new PI Point is created with future data support enabled.
• For CREATE messages, if the PI Point exists, then PI Web API won't make any change to the existing PI Point but returns a success status with a warning message of "PI Point already exists".
• For UPDATE messages
  • If the existing PI Point's future data setting matches the existing CONTAINER, the future metadata in the new message will be ignored.
  • If the existing CONTAINER has future=true and the UPDATE message specifies future=false, a success status with a warning message of "future metadata was ignored" is returned.
  • If the existing CONTAINER has future=false and the UPDATE message specifies future=true, an error status (409 conflict) is returned.
  • If multiple CONTAINER/OMF PI Points are in the CONTAINER message, then the CONTAINER/OMF PI Points without conflict should continue to be processed and the response should indicate which ones are failed.
  • If the PI Point does not exist, then the UPDATE process will behave as the same as the CREATE process.

Non-Breaking Change: Support PI Data Quality

PI Web API 2023 SP1 adds ability to write PI Data Archive's SYSTEM digtial state value to OMF PI Points with a new PI Quality Mapping. The following dynamic TYPE message shows how to specify the PI Quality Mapping.

[{ "id": "TimeIndexed.Single.PIQuality", "name": "Single", "description": "Represents a PI Data Archive float32 point type.", "type": "object", "classification": "dynamic", "metadata": { "DataQualitySchema": "PI" }, "properties": { "Timestamp": { "type": "string", "format": "date-time", "isindex": true }, "Value": { "type": "number", "format": "float32" }, "Quality": { "type": ["integer", "null"], "format": "int32", "isquality": true } } }]

Notes: Please reference PI Data Archive Administration Guide for more information on the SYSTEM digital set.