Overview
This material is provided to help in the design, development and testing of software based on the WITSML™ standard. The members of the WITSML SIG contribute time and expertise to define each version of the standard, and provide various tools to make it easier to build software based on the standard, test it and deploy it.
Current Version
WITSML v2.0
Version 2.0 was released in 2016, and it is the current version of the WITSML standard. It should be used for all new developments.
WITSML v2.0 combines with components of the Common Technical Architecture on which all Energistics standards v2.0 and above are built:
- Energistics Transfer Protocol (ETP) v1.1, a standard to accelerate and smooth the streaming of real-time data.
- Energy Industry Profile for Metadata.
- Units of Measure (UOM)
WITSML Development tools
The following resources are available for developers:
- Software Development Kits (SDKs): SDK kit for Java and .NET object wraps.
- Sample datasets: these allow developers to test new or modified software.
- Energistics Online: a comprehensive interactive documentation system for version 2.0 and later.
WITSML Server Certification
Energistics currently offers certification testing for v1.3.1 and v1.4.1.1 WITSML Servers (the v2.0 certification program is under development). Click here for more information.
WITSML Version history
Prior versions are still in use across the industry,
- Version 1.4.1.1 is supported by Energistics.
- Version 1.3.1 is obsolete and deprecated.
Collaboration with other standards organizations
Energistics works with other organizations to explore new capabilities that promote a broader use of standards:
- Integration of Energistics standards in the Open Subsurface Data Universe (OSDU) platform
- WITSML – PPDM mapping project
Licensing & Legal
Click here to access the information regarding licensing, intellectual property, trademarks and other legal information for companies intending to develop and deploy software using the Energistics Standards
Current Version – WITSML v2.0
WITSML V2.0 DATA SCHEMAS
This is the preferred version for new and upgraded production implementations. Use with Energistics Transport Protocol v1.1.
WITSML Version 2.0 leverages the Energistics Common Technical Architecture (CTA), which delivers a common technology foundation for the Energistics domain standards—which includes WITSML, PRODML, and RESQML. This common architecture makes it easier for companies to implement the standards. It also makes it easier to share data “across” the standards for integrated operations workflows. For example, RESQML and PRODML can leverage well data in WITSML.
The previous version of WITSML, v1.4.1.1, specified a set of 27 data object definitions and a Web services specification.
In v2.0, the main changes include:
- A revised set of data objects. For a list, see Table 1 of the WITSML Technical Usage Guide.
- Replacement of the Web services with the Energistics Transfer Protocol (ETP), which is part of the Energistics CTA.
The Technical Usage Guide describes each WITSML data object, including its business use and an overview of its design.
WITSML DATA SCHEMA SPECIFICATIONS, VERSION 2.0
Standard | Link |
Browse the Data Schema Specifications – Overview, December 2016 | <Data Schema> |
Download Data Schema Specifications – December 2016 Includes the normative xsd and data files and the non-normative files such as example and style sheet files. |
![]() ![]() |
Download the ETP v1.1 for WITSML v2.0 Implementation Specification – October 2017 Provides guidance for implementation of the Energistics Transfer Protocol with WITSML v2.0 schemas (also included in the Data Schema Specifications Standards Download file) |
![]() ![]() |
WITSML Development Tools
Standards DevKit
The Standards DevKit wrap WITSML, RESQML and PRODML schemas with Microsoft .NET objects. Go to page
Sample WITSML XML data
These data sets represent real world examples.
- WITSML v1.4.1 data sets donated by Statoil (May 2016) – auto-download.
Other data
- Members of Energistics have access to additional datasets on demand, contact [email protected]
- Equinor has made available the entire data for the Volve field decommissioned in 2018. It is accessible on their website here
More on this data set here
WITSML Server Certification
CERTIFICATION PROGRAM OVERVIEW
Automated software testing improves the reliability of results and interoperability of WITSML-enabled products. Testing and certification benefits vendor companies developing server products, as it demonstrates compliance. At this point in time there is no certification process for clients. Energistics developed this program so that vendors can certify that their products comply with related Energistics standards and may use the appropriate Energistics certified product logo.
Upon achieving product certification, vendors may display the WITSML Certified Product Logo.
Current version (2018 – ) | Previous version (2016 – 2017) |
![]() |
![]() |
Details of the certification process, terms and conditions are described in the Certified Product License Agreement for Energistics standards. For questions or more information on certification, contact Energistics.
Certification of WITSML 2.0 servers
This certification program is under development, contact [email protected] for more information
Certification of WITSML 1.4.1.1 servers
This certification program has been developed for WITSML servers, API version 1.4.1. and 1.4.1.1. The keystone of the WITSML Certification Program is an open source testing tool that automates running a suite of tests, which use standard WITSML queries, data-object definitions, and behaviors defined in the WITSML schemas and the WITSML Store Application Interface (API) v1.4.1. Current certified products are here.
Step | Links |
(1) Download the Certification Testing Tool | DOWNLOAD |
(2) Open or download the PDF file containing the WITSML v1.4.1.1 Certification Testing Tool Installation and User Guide | |
(3) Open or download the PDF file containing the WITSML v1.4.1.1 Certification Overview and Process Guide | |
(4) Submit the email form if you would like Energistics to run the automated test suite against your server. This will complete the certification process | WITSML Certification Form |
If a server passes all of the required tests for stated capabilities, it is designated WITSML-certified by Energistics.
This behavior-based, automated software Testing Tool and Certification program replaces all previous certification programs (beginning with v1.4.1) and eliminates the variable nature of former programs by bringing consistency and objectivity to the testing process. This program improves the interoperability and data reliability provided by WITSML. Upon completion of the certification process, certified v1.4.1 products will be posted to the Energistics website. Vendors will also be authorized to use the WITSML Certified Product logo.
Certification of WITSML 1.3.1 servers
WITSML v1.3.1 has been deprecated but new server certification services are available upon request. Contact Energistics for more information at [email protected]
For the list of certified WITSML 1.3.1 servers click here
Certification Fees
Participation in the Energistics Certification Program is a benefit of membership.
Companies that are not members of the Energistics Consortium must pay a specified certification fee in an amount equal to a one-year contributing membership. This fee includes membership for the remainder of the calendar year upon agreement to comply with Energistics policies governing participation. Continued membership will be invoiced automatically, fee based on the company’s annual revenue and membership type. Contact Energistics for more information.
WITSML Version History
V1.4.1.1
The information provided here is for developers and users who are working with an existing system based on version 1.4.1.1 and require resources for maintenance and operation. Version 2.0 should be used for new developments.
Standard | Links |
Browse the Data Schema Specifications (including dpethRegImage) – July 2015 Includes the normative xsd and data files and the non-normative files such as example and style sheet files. |
<Data Schema> |
Download the API Specifications v1.4.1.1, July 2014 Includes the normative xsd and data files and the non-normative files such as example and style sheet files. The API specification has been updated for clarification purposes only. There is no change to behavior. Updates are identified in the Change History. |
![]() ![]() |
Download the ETP v1.1 for WITSML v1.4.1.1 Implementation Specification – October 2017 Provides guidance for implementation of the Energistics Transfer Protocol (protocols 0, 1) with WITSML v1.4.1.1 log only |
![]() ![]() |
COMPLETION DATA-OBJECT
This new data-object is compatible with WITSML v1.4.1.1 and PRODML v1.3.
Details found here.
SUPPORTING DOCUMENTATION
In addition to the API and schema specifications, a series of usage guides and other supporting documentation and tools are under development to help assist users and implementers. This library will grow over time.
USAGE GUIDES
- stimJob Object Usage Guide
- Lithology Element Usage Guide(Updated January 2012)
TOOLS
RASTERIMAGE ADD_ON SCHEMA
The current v1.4.1.1 Data Schema includes the RasterImage add-on. The RasterImage data object, known as depthRegImage in the schemas, was published in 2016, and it can be added to earlier v1.4.1.1 implementations; it is not a standalone data object.
Follow these instructions to install the depthRegImage data object to a v1.4.1.1 implementation.
WITSML 1.3.1.
Version 1.3.1 is deprecated. New production implementations should use Version 2.0.
For developers or users operating WITSML 1.3.1 systems, contact [email protected] to request access to archived documents related to that version.
Collaborations with Standards Organizations
Integration of Energistics Standards into the OSDU™ Data Platform
BACKGROUND
Energistics was invited to join the OSDU Forum in October 2018, the first non-operator to officially become a member. From the beginning, OSDU experts have stated their intent to use existing standards for data schemas within the platform.
Energistics members and staff actively participate in a number of the committees across a number of topics.
OSDU INITIATIVES RELATED TO WITSML
Real-Time data is part of the development plans for the OSDU platform, and WITSML will play an important part when that capability is added.
Proof of Concept (POC) to map WITSML and PPDM
BACKGROUND
Under the banner of the Standards Leadership Council (SLC), Energistics and Petroleum Data Management Association (PPDM) and their respective members joined forces around a proof of concept (POC) to map selected portions of WITSML and the PPDM data model.
The objectives of the POC included:
- determine the feasibility and usefulness of a general mapping of these data models for specified use cases
- gauge community interest to extend the mapping
- identify best practices for development projects involving multiple standards organizations
PROOF OF CONCEPT
The project team identified 5 high value use cases which involve 7 WITSML data objects and associated PPDM tables.
- Move WITSML well data into an “empty” PPDM store
- Move WITSML data into a populated PPDM store
- Directional survey
- Transfer real-time LWD data (e.g., gamma ray) using WITSML into PPDM data repository
- Transfer LWD data (e.g., gamma ray) from a PPDM data repository to a WITSML-enabled application
Download use cases (ZIP)
Download mapping (XLS)
RESULTS
The project team determined that:
- It is feasible to map WITSML and PPDM but the result is a starting point for an organization, not a magic bullet. Because organizations use data in different ways for different purposes, they may make different judgment calls when mapping data.
- While there is agreement that mapping WITSML and PPDM is a good idea, this is not a high priority of the membership of either organization when considered against other development and adoption priorities.
- Mapping WITSML and PPDM is a time- and labor-intensive process that requires dedicated time by subject matter experts of WITSML and PPDM. There are no plans to extend the POC at this time but a project would be considered with proper funding and resourcing.
APPRECIATION
Energistics and PPDM leadership extend our sincere thanks and appreciation to the dedicated volunteers who worked on this project. This project serves as an example of how standards organizations are working together for the benefit of the industry. For more information about the Standards Leadership Council (SLC), see http://oilandgasstandards.org.