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

New Concept: Simple Types

PI Web API OMF Services 2019 SP1 introduces the simple type concept. A simple type is a dynamic type that has a single value property. Simple types are not part of the OMF specification: they are specific to the PI Web API. When discussing types, the term complex types is used to describe dynamic types with more than one value property.

Using a simple type changes how some resources are represented in your PI AF or PI Data Archive:

Comparison DetailSimple TypeComplex Type
Type message [{ "id": "simple-dynamic-type1", "version": "1.0.0.0", "type": "object", "classification": "dynamic", "properties": { "time": { "type": "string", "format": "date-time", "isindex": true }, "attribute1": { "type": "string", "name": "Attribute One" } } }] [{ "id": " complex-dynamic-type1", "version": "1.0.0.0", "type": "object", "classification": "dynamic", "properties": { "time": { "type": "string", "format": "date-time", "isindex": true }, "attribute1": { "type": "string" "name": "Attribute One" }, "attribute2": { "type": "string" "name": "Attribute Two" } } }]
Container message [{ "id": "simple-container1", "name": "Simple Container", "typeid": "simple-dynamic-type1" }] [{ "id": "complex-container1", "name": "Complex Container", "typeid": "complex-dynamic-type1" }]

PI Points created in version 2019 simple-container1.attribute1 complex-container1.attribute1 complex-container1.attribute2
PI Points created in version 2019 SP1 simple-container1 complex-container1.attribute1 complex-container1.attribute2

AF Attributes created in version 2019 (using __link) Simple Container.Attribute One Complex Container.Attribute One Complex Container.Attribute Two
AF Attributes created in version 2019 SP1 (using __link) Simple Container Complex Container.Attribute One Complex Container.Attribute Two

New Concept: UPDATE Action

PI Web API 2019 SP1 introduces limited UPDATE action support. UPDATE is supported for DATA messages. UPDATE is not yet implemented for TYPE or CONTAINER messages.

When an UPDATE message is received, it will be treated as an insert-or-replace operation. If the specified resource already exists, it will be replaced. If the specified resource does not exist, it will be created.

New Concept: Migrations

PI Web API 2019 SP1 introduces limited OMF migration support. This migration support allows somes resource types created using prior versions of PI Web API OMF Services — as well as non-OMF resources — to be re-purposed for use with the current version of PI Web API OMF Services. When a migration occurs, the resource will be modified for use with the PI Web API — sometimes destructively.

When a CREATE LINK DATA message is received, AF Attribute migration may occur. If a link between a static instance and a container already exists, AF Attributes belonging to that link may be renamed: for example, from Simple Container.Attribute One to Simple Container.

When a CREATE CONTAINER message is received, PI Point migration may occur. If a PI Point exists with the name PI Web API was going to use, it will be re-purposed for use with PI Web API OMF Services.

When migrating a PI Point, the way it was created affects how it will be migrated for use with PI Web API OMF Services 2019 SP1. PI Points are grouped in the following manner for migration:

For PI Points created using OMF (PI Web API 2019), PI Points belonging to containers using a simple type will be renamed: for example, from simple-container-id.attribute1 to simple-container-id.

For any migrated PI Point — regardless of how it was created — some PI Point attributes will be overwritten:

Schema Changes

Types

Containers

Data

Enabling Operational Intelligence