Building a C++ sample to send OMF to PI or ADH

Version: 1.0.9

ADH Test Status	EDS Test Status	PI Test Status

Building a sample with the rest calls directly

This sample doesn't help build the JSON strings for OMF messages. This works for simple examples, and for set demos, but if building something more complex it may be easier to form the JSON messages programatically.

OMF documentation

Prerequisites

Install Visual Studio with C++ support. See Install C and C++ support in Visual Studio

To Run this Sample in Visual Studio:

Clone the GitHub repository
Open the solution file in Microsoft Visual Studio, OMF_API.sln
Rename the file appsettings.placeholder.json to appsettings.json
Update appsettings.json with the credentials for the enpoint(s) you want to send to. See Configure endpoints and authentication below for additional details
Select the solution configuration "Release" and desired solution platform (x86 or x64) in the ribbon
Click Debug > Start Debugging (or F5)

To Test this Sample in Visual Studio:

Follow steps 1-4 from the section above
Select the solution configuration "Debug UnitTests" and desired solution platform (x86 or x64) in the ribbon
Click Debug > Run All Tests (or F5)

Customizing the Application

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.

Configure Endpoints and Authentication

The sample is configured using the file appsettings.placeholder.json. Before editing, rename this file to appsettings.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 appsettings.json. In addition, there are three types of endpoints: ADH, EDS, and PI. Each of the 3 types of enpoints are configured differently and their configurations are explained in the sections below.

ADH Endpoint Configuration

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

{
  "EndpointType": "ADH",
  "Resource": "https://uswe.datahub.connect.aveva.com",
  "NamespaceId": "PLACEHOLDER_REPLACE_WITH_NAMESPACE_NAME",
  "TenantId": "PLACEHOLDER_REPLACE_WITH_TENANT_ID",
  "ClientId": "PLACEHOLDER_REPLACE_WITH_APPLICATION_IDENTIFIER",
  "ClientSecret": "PLACEHOLDER_REPLACE_WITH_APPLICATION_SECRET",
  "ApiVersion": "v1",
  "VerifySSL": "PLACEHOLDER_REPLACE_WTIH_CERTIFICATE_PATH",
  "UseCompression": false
}

Parameters	Required	Type	Description
Selected	required	boolean	Tells the application if the endpoint should be sent to
EndpointType	required	string	The endpoint type. For ADH this will always be "ADH"
Resource	required	string	The endpoint for ADH if the namespace. If the tenant/namespace is located in NA, it is https://uswe.datahub.connect.aveva.com and if in EMEA, it is https://euno.datahub.connect.aveva.com
NamespaceId	required	string	The name of the Namespace in ADH that is being sent to
TenantId	required	string	The Tenant ID of the Tenant in ADH that is being sent to
ClientId	required	string	The client ID that is being used for authenticating to ADH
ClientSecret	required	string	The client secret that is being used for authenticating to ADH
ApiVersion	required	string	The API version of the ADH endpoint
VerifySSL	optional	string	The path to a base 64 encoded root certificate (.cer) for verifying the endpoint's certificate. If this is empty "", the certificate will not be verified.
UseCompression	optional	boolean	A feature flag for enabling compression on messages sent to the ADH endpoint

EDS Endpoint Configuration

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

{
  "EndpointType": "EDS",
  "Resource": "http://localhost:5590",
  "ApiVersion": "v1",
  "UseCompression": false
}

Parameters	Required	Type	Description
Selected	required	boolean	Tells the application if the endpoint should be sent to
EndpointType	required	string	The endpoint type. For EDS this will always be "EDS"
Resource	required	string	The endpoint for EDS if the namespace. If EDS is being run on your local machine with the default configuration, it will be http://localhost:5590
ApiVersion	required	string	The API version of the EDS endpoint
UseCompression	optional	boolean	A feature flag for enabling compression on messages sent to the ADH endpoint

PI Endpoint Configuration

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

{
  "EndpointType": "PI",
  "Resource": "PLACEHOLDER_REPLACE_WITH_PI_WEB_API_URL",
  "DataArchiveName": "PLACEHOLDER_REPLACE_WITH_DATA_ARCHIVE_NAME",
  "Username": "PLACEHOLDER_REPLACE_WITH_USERNAME",
  "Password": "PLACEHOLDER_REPLACE_WITH_PASSWORD",
  "VerifySSL": "PLACEHOLDER_REPLACE_WTIH_CERTIFICATE_PATH",
  "UseCompression": false
}

Parameters	Required	Type	Description
Selected	required	boolean	Tells the application if the endpoint should be sent to
EndpointType	required	string	The endpoint type. For PI this will always be "PI"
Resource	required	string	The URL of the PI Web API
DataArchiveName	required	string	The name of the PI Data Archive that is being sent to
Username	required	string	The username that is being used for authenticating to the PI Web API
Password	required	string	The password that is being used for authenticating to the PI Web API
VerifySSL	optional	string	The path to a base 64 encoded root certificate (.cer) for verifying the endpoint's certificate. If this is empty "", the certificate will not be verified.
UseCompression	optional	boolean	A feature flag for enabling compression on messages sent to the ADH endpoint

For the general steps or switch languages see the Task ReadMe
For the main OMF page ReadMe
For the main landing page ReadMe

AVEVA/sample-omf-basic_api-cpp