OSIsoft Message Format (OMF)
Welcome to the OSIsoft Message Format feature suggestion box. We created this forum to hear your ideas, suggestions and feedback. For more information on OMF, please refer to: http://omf-docs.readthedocs.io
Please suggest your most important features and design change ideas on this site! Also vote for your favorite features now! We welcome your feedback.
- NOTE: for bugs, please report to OSIsoft Tech Support at https://techsupport.osisoft.com/My-Support/My-Cases/New/ rather than entering them on this site.
- NOTE: for documentation feedback and bugs, please report to Documentation@osisoft.com rather than entering them on this site.
-
Send only data that has changed.
When transferring data via satellite it is necessary to keep bandwidth usage to a bare minimum. Currently OMF must send all values regardless of whether they have changed or not. If it could send only the data parameters that have changed that would be very helpful.
11 votes -
OMF: Binary data format support
Provide a binary data format option in addition to JSON in the OSIsoft Message Format (OMF) spec.
8 votes -
OMF: Time Range / Events / Spans Support
Support the concept of time ranges / events EFs / spans as a pre-defined type in the OSIsoft Message Format (OMF) spec.
8 votesFor the spans implementation, let’s consider implications on PI, OCS and EDS. E.g. how does the data source represent spans and/or how does the OMF application recognize these spans? Who / what uses the span data? How does the thing using the span data represent a span and associated data? Do we have scenarios with non-time based spans for OCS and EDS?
-
OMF: Unit of Measure (UOM) Support
Support units of measure for types and streams in the OSIsoft Message Format (OMF) spec.
8 votesCompleted in OMF 1.1 for Types. Planned for OMF 1.2 for Containers.
-
OMF: Data Quality Support
Add a data quality keyword to the OSIsoft Message Format (OMF) spec and allow specification of a data quality format.
8 votesPlanned for OMF 1.2
-
Support CORS for OMF ingress to PI Server
Request for OMF writing to PI Server that CORS (Cross-Origin Resource Sharing) is supported.
5 votes -
OMF: Property Bags
Allow reuse of a set of properties for multiple type definitions in the OSIsoft Message Format (OMF) spec.
4 votes -
OMF: Swagger Specification
I think it would be beneficial to have a Swagger Specification for OMF similar to what currently exists for the PI Web API. As a programmer, I would like to be able to reduce startup time by having a pre-existing libraries that allow me to reduce syntactical errors in HTTP requests by leveraging the intellisense provided by swagger specification libraries.
3 votes -
Clearly state that a Data message cannot include both a container ID and a type ID
Right now, the documentation:
https://omf-docs.readthedocs.io/en/v1.0/Data_Messages.html
Mentions that "For each object, either typeid or containerid must be specified". However, it does not clearly state that you CANNOT include both in a data message, even if either the typeid or containerid is null (and the other is non-null). It's a minor distinction, but it helps prevent folks from trying to create a base class for a data message that includes both a typeid and containerid.
2 votes -
Provide authoritative advice/document on how to configure/connect ESBs to stream to OMF
In transportation, a common pattern is to use an ESB to gather all field data and make it the central point for interoperability. Examples include: JMS bus, Tibco ESB, HP OMi + IIB of Kafka, others. I believe it should be possible to configure those platforms to send OMF compliant messages, but i have no reference and can hardly estimate the approach and efforts needed.
1 vote -
Support an analogue to the "step" PI Point attribute when creating PI Points
Even though it will indeed be useful to be able to specify whether data should be retrieved in a step-wise fashion, for new PI Points (assuming you're writing data to a PI Connector), it's important to be able to specify that those tags should have the step attribute set to true, so that the step option is set at the central, database level where it can apply to all users who query that PI Point.
1 vote -
OMF: Per-object CRUD operation override
Add the ability to override the message-level CRUD mode for each object (Type, Container, or Data) within the body.
0 votesPlanned for OMF 1.2
-
OMF: Ability to patch data messages
Add the ability to provide partial information for an existing data point. This is meant as a partial update which replaces values for some properties of a type without affecting others.
0 votesPlanned for OMF 1.2
-
OMF: Container-level overrides
Ability to override Type-level property keywords on a Container level.
0 votesPlanned for OMF 1.2
- Don't see your idea?