OMF to Data Hub Quick Start Guide

Version: 1.1.1

The sample code in this folder demonstrates an example of using OMF to send data into CONNECT data services and the Sequential Data Store (SDS) using Python Jupyter Notebook. In order to run this sample, you need to have Python installed.

Data Example

The example in this guide will send data for a drone, including its location, battery, and operating temperature. It will cover how to create the OMF connection along with the appropriate OMF types and containers, and finally send data to an OMF endpoint. Once the data is sent to CONNECT data services it will validate the ingress process by reading the drone data from SDS.

Application Settings Parameters

• The notebook parameters are 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.
• Populate the values of appsettings.json with your value for each parameter. For example:

{
    "Resource": "PLACEHOLDER_REPLACE_WITH_RESOURCE",
    "ApiVersion": "PLACEHOLDER_REPLACE_WITH_API_VERSION",
    "TenantId": "PLACEHOLDER_REPLACE_WITH_TENANT_ID",
    "NamespaceId": "PLACEHOLDER_REPLACE_WITH_NAMESPACE_ID",
    "CommunityId": "PLACEHOLDER_REPLACE_WITH_COMMUNITY_ID",
    "ClientId": "PLACEHOLDER_REPLACE_WITH_APPLICATION_IDENTIFIER",
    "ClientSecret": "PLACEHOLDER_REPLACE_WITH_APPLICATION_SECRET",
    "OMFConnectionName" : "PLACEHOLDER_REPLACE_WITH_OMF_CONNECTION_NAME",
    "OMFConnectionDescription" : "PLACEHOLDER_REPLACE_WITH_OMF_CONNECTION_DESCRIPTION"
}

Parameters	Required	Type	Description
Resource	required	string	The endpoint for ADH of the namespace. If the 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
ApiVersion	required	string	The version of the API to be used
TenantId	required	string	The id of the tenant to use
NamespaceId	required	string	The id of the namespace to use
CommunityID	options	string	The name of the community to use (if any)
ClientId	required	string	The id of the client credentials client to use
ClientSecret	required	string	The secret of the client credentials client to use
OMFConnectionName	required	string	The name of the OMF connection to create
OMFConnectionDescription	optional	string	The description of the OMF connection to create

Running the Jupyter Notebook

1. Install required modules by running:

   pip install -r requirements.txt

2. Open a terminal and type in jupyter notebook. This will open a browser window. Navigate to the cloned repository and open up quickstart.ipynb. Run the cells one by one and you can see the output in browser itself.

Documentation

The documentation for the various topics and APIs used here can be found at the CONNECT data services documentation website

---

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