Version: 2.0.4

OCS Test Status	EDS Test Status	PI Test Status

The sample code in this topic demonstrates how to send OMF messages using Python.

The samples were built and tested against Python 3. If you are using a different version you might encounter errors or unexepected behavior.

1. Clone the GitHub repository
2. Install required modules: pip install -r requirements.txt
3. Open the folder with your favorite IDE
4. Rename the placeholder config file config.placeholder.json to config.json
5. Update config.json with the credentials for the enpoint(s) you want to send to. See Configure endpoints and authentication below for additional details
6. Run program.py

1. Run test.py

1. Install pytest pip install pytest
2. Run pytest program.py

This application can be customized to send your own custom types, containers, and data by modifying the OMF-Types.json OMF-Containers.json, and OMF-Data.json files respectively. Each one of these files contains an array of OMF json objects, which are created in the endpoints specified in config.json when the application is run. For more information on forming OMF messages, please refer to our OMF version 1.1 documentation.

In addition to modifying the json files mentioned above, the get_data function in program.py should be updated to populate the OMF data messages specified in OMF-Data.json with data from your data source. Finally, if there are any other activities that you would like to be running continuously, this logic can be added under the while loop in the main() function of program.py.

The sample is configured using the file config.placeholder.json. Before editing, rename this file to config.json. This repository's .gitignore rules should prevent the file from ever being checked in to any fork or branch, to ensure credentials are not compromised.

The application can be configured to send to any number of endpoints specified in the endpoints array within config.json. In addition, there are three types of endpoints: OCS, EDS, and PI. Each of the 3 types of enpoints are configured differently and their configurations are explained in the sections below.

An OMF ingress client must be configured. On our OSIsoft Learning Channel on YouTube we have a video on Ceating an OMF Connection.

The format of the configuration for an OCS endpoint is shown below along with descriptions of each parameter. Replace all parameters with appropriate values.

{
  "endpoint-type": "OCS",
  "resource": "https://dat-b.osisoft.com",
  "namespace": "REPLACE_WITH_NAMESPACE_NAME",
  "tenant": "RPLACE_WITH_TENANT_ID",
  "client-id": "REPLACE_WITH_APPLICATION_IDENTIFIER",
  "client-secret": "REPLACE_WITH_APPLICATION_SECRET",
  "api-version": "v1",
  "verify-ssl": true,
  "use-compression": true,
  "web-request-timeout-seconds": 30
}

The format of the configuration for an EDS endpoint is shown below along with descriptions of each parameter. Replace all parameters with appropriate values.

{
  "endpoint-type": "EDS",
  "resource": "http://localhost:5590",
  "api-version": "v1",
  "use-compression": true,
  "web-request-timeout-seconds": 30
}

The format of the configuration for a PI endpoint is shown below along with descriptions of each parameter. Replace all parameters with appropriate values.

{
  "endpoint-type": "PI",
  "resource": "REPLACE_WITH_PI_WEB_API_URL",
  "data-server-name": "REPLACE_WITH_DATA_ARCHIVE_NAME",
  "username": "REPLACE_WITH_USERNAME",
  "password": "REPLACE_WITH_PASSWORD",
  "verify-ssl": true,
  "use-compression": true,
  "web-request-timeout-seconds": 30
}

For the main OMF basic samples page ReadMe
For the main OMF samples page ReadMe
For the main OSIsoft samples page ReadMe