OMF Endpoint Notes (PI Web API OMF Services)

The Open Message Format (OMF) defines a format for data messages that can be read by compliant OSIsoft products. It defines an abstract message type, where a message consists of a set of key/value pairs, called the header, and a binary payload, called the body. It defines how the messages should be constructed and what they can contain. OMF messages can be constructed using any message protocol that defines headers and bodies. See the Open Message Format specification for more information about the Open Message Format.

The Developer Companion Guide is specific to the PI System and describes how to use OMF in your application to send data to PI System destinations, including PI AF Server and PI Data Archive. It includes:

• How different message types are interpreted by the PI System
• OMF event codes
• Restrictions and limitations
• Development considerations
• Getting started information
• Information on migrating existing OMF applications to OMF with PI Web API

Additional resources are available to help you get started with OMF:

• OMF on PI Square
• OMF Samples