Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

OMF with PI Web API

Development environment requirements

  • Last UpdatedSep 04, 2025
  • 1 minute read

It is considered best practice to use a test system for initial implementation and testing. You should not use your production environment until you are confident in the application you have created.

Before you begin developing an OMF application, the following products should be installed and configured:

  • PI Web API

    To develop an OMF application to ingress data into the PI System, you must have access to PI Web API with the Open Message Format (OMF) Services component installed. For more information, see the PI Web API User Guide.

  • PI Server

    You must have administrative access to the Asset Framework Server and PI Data Archive. One way to create a development environment is by creating a PI Developers Club subscription at PI Square.

While developing your OMF application in your test environment, it may be necessary to delete intermediate Asset Framework templates, elements, and PI points. Ensure that you have sufficient access rights to accomplish this. For more information, see the PI System Explorer user manual and the PI System Management Tools user manual.

To speed up the development process, we recommend that these components be installed on computers in the same Windows domain.

Note: This topic covers the basic OMF application development process, not the administrative aspects of configuring and securing the entire solution.

TitleResults for “How to create a CRG?”Also Available in