Energistics Standards DevKit & ETP DevKit

Energistics Standards DevKit & ETP DevKit2018-06-07T02:37:31+00:00

Overview

This page provides the information and links to all the materials for developers interested in implementing Energistics standards and ETP.

Standards DevKit

The Standards DevKit is designed to remove the complexity of using the WITSML, PRODML and RESQML standards so a developer can concentrate on integrating these standards into their business solution.

ABOUT THE STANDARDS DEVKIT

The WITSML, PRODML and RESQML schemas provide the definition for standard data exchange formats within the oil and gas industry. However, developing a software solution that uses these standard formats has not always been simple. The Standards Devkit removes the complexity of using the WITSML, PRODML and RESQML standards and lets the developer concentrate on the important work of integrating the standards into their business solution.

The Standards Devkit wraps the WITSML, PRODML and RESQML schemas with Microsoft .NET objects. The developer can work directly with these objects rather than having to deal with the XML definition itself. It provides all of the conveniences that .NET developers are familiar with such as full IntelliSense support,  XML Serialization, .NET naming conventions, enumerations, and more.

In addition to dealing with the data format itself, the Devkit also provides direct interfaces to the WITSML and PRODML APIs so the developer does not have to handle the details of web service communication with backend servers. The Devkit provides synchronous and asynchronous methods for all WITSML and PRODML web methods. It also provides a wrapper for WMLS that provides simplified calls, secure password management, and error handling.

RESQML differs from the other Energistics standards in that it contains a binary representation of large data arrays using an HDF5 file but this functionality is not currently supported in the Standards DevKit.

INSTRUCTION VIDEO

Note: instruction video will be updated soon to include RESQML instructions.

DOWNLOAD THE DEVKIT

Standards DevKit download (via BitBucket)

USING THE STANDARDS DEVKIT

The Devkit is provided as an open source project under the Apache License, Version 2.0. It includes a code generator that parses the WITSML, PRODML and RESQML XSD files into .NET 3.5 classes, which makes extending the Devkit for future versions of the standards easy. It also includes documentation, sample code, and a basic data browser application to help developers learn how to use the Devkit.

The Standards DevKit was developed by ExxonMobil and is licensed to Energistics for maintenance, support and administration. Further development will be guided by Energistics and the user community.

ETP DevKit

The ETP DevKit provides a common foundation and basic infrastructure to simplify and standardize creating applications that transfer WITSML, PRODML and RESQML data via the Energistics Transfer Protocol.

ABOUT THE DEVKIT

The ETP Specification defines the messages and interfaces that can be used to exchange data between applications that support the EnergyML family of data standards: WITSML, PRODML and RESQML.  The messages define the content that is exchanged between applications and the interfaces define the expected behavior in exchanging messages.  More information about ETP resources can be found at here.

The ETP DevKit is a .NET library providing a common foundation and the basic infrastructure needed to communicate via the Energistics Transfer Protocol (ETP).  The library is written in C# using the .NET Framework version 4.5.2.  It is designed to simplify and standardize ETP client and server development by integrating the necessary dependencies and abstracting away the lower level details of communicating via ETP.  It builds on the ETP Messages library, which provides .NET definitions for the ETP messages and associated data structures.

The ETP DevKit provides a definition and base implementation of each interface described in the ETP Specification.  Each interface implementation has been developed as a protocol handler that can be used out of the box or extended to provide additional functionality.  This abstracts away the low level details of sending and receiving messages between clients and servers.  Customized processing of messages can be achieved either by registering handlers for the various interface events or by deriving from the library’s protocol handlers and overriding the virtual message handling methods.

The aim of the ETP DevKit is to reduce the time it takes to develop and evaluate the latest version of the standards utilizing the Energistics Transfer Protocol and to provide a shared and tested framework for establishing and facilitating communication between applications needing to exchange data.

DOWNLOAD THE DEVKIT

ETP DevKit download (via BitBucket)

To install ETP.DevKit-PDS via NuGet, run the following command in the Visual Studio Package Manager Console

Install-Package ETP.DevKit-PDS

USING THE ETP DEVKIT

The ETP DevKit is provided as an open source project under the Apache License, Version 2.0.  The library can be built from source or added as a NuGet package reference using the links above.

The ETP DevKit was developed by Petrotechnical Data Systems (PDS) and contributed to Energistics.  Further development will be guided by Energistics and the user community.

Other Resources

Documentation

There is a large body of documentation on the standards, their implementation and other reference materials. These will be available end Q1 2018 at the Energistics Online Documentation site for perusal and download.

Training, Consulting and Certification

These services are available for nominal fees or in some cases are complementary as a part of a company’s membership benefits.

Support

We can offer limited support should a developer encounter problems or have occasional questions related to implementation. Response times are not guaranteed. Email info@energistics.org