WITSML Converter

This repo provides a library and tool for converting WITSML documents between versions 1.4, 2.0, and 2.1 of the WITSML standard.

These conversions are implemented as XML transformations with additional processing being done in code.

Usage

Requirements

The library, Petrolink.WitsmlConverter, is built against .NET Standard 2.0. The command line tool is built against .NET 6.0 (LTS).

All projects are written using C# 11 and require either Microsoft Visual Studio/Build Tools 2022 version 17.4, or the .NET 7 SDK to build.

Integration

The Petrolink.WitsmlConverter library can be included as a dependency for a C# project. This library provides a static WitsmlTransformer class that can be used to perform the transformations.

If a command line tool is needed, the Petrolink.WitsmlConverter.Tool project, which builds the WitsmlConvert.exe file, can be used. This tool is merely a wrapper around the WitsmlTransformer class. Execute WitsmlConvert.exe --help for usage details.

For example - to convert a 1411 Well object to 2.0 Well object the command will be witsmlconvert transform -i "C:\Samples\well1411_1.xml" -o "C:\Samples\Output" -t "well" -x "Witsml14To20"

Development

Building

The repository provides a Visual Studio 2022 solution containing 4 projects:

• Petrolink.WitsmlConverter - The WITSML converter library.
• Petrolink.WitsmlConverter.Mappings - Contains generated mapping files used by Petrolink.WitsmlConverter.
• Petrolink.WitsmlConverter.Tests - Tests for Petrolink.WitsmlConverter.
• Petrolink.WitsmlConverter.Tool - The command line wrapper around Petrolink.WitsmlConverter. Builds WitsmlConvert.exe.

Simply open WitsmlConverter.sln in Visual Studio and build the project, or use the dotnet build command to build the project.

Conversion

WITSML conversion is implemented using XML transformations combined with additional post-processing depending on the conversion type.

The conversions steps are as follows:

1. Parse and optionally validate the input WITSML document.
2. Execute the XML transformation according to the specified destination type.
3. If converting from WITSML 1.4 to 2.0, add <eml:Creaiton> elements to all <eml:Citation> elements with the creaiton time specified by the WitsmlTransformOptions.
4. If converting from WITSML 1.4 to 2.0, or from 2.0 to 1.4, then check all uom attributes in the document and attempt to convert their values between the equivalent WITSML 1.4 and 2.0 unit symbols.
5. Write the new WITSML document to a string.

Currently, conversion will fail if the input document violates the minOccurs or maxOccurs constraints of the WITSML schema. This will be changed in the future to allow invalid inputs, as some WITSML servers accept them.

Mappings

The mappings used for the WITSML conversion are generated using Altova MapForce 2023 Professional. The mapping definitions are included in this repository in the Mappings folder. These definitions were used to generate C# code that is included in the Petrolink.WitsmlConverter.Mappings project to be used by the Petrolink.WitsmlConverter library.

To load the mapping definitions, modify them, and regenerate the mapping code, Energistics standards files are required. These files are not included in this repository and must be obtained separately from Energistics.

See this file for instructions on where to put these files.