WITSML Data Schema Overview

Version 1.3.1

This document contains the following sections:

This version represents an incremental change to version 1.3.0 which is being deprecated. Commercial implementations of v1.3.0 are stronly discuraged by the WITSML Special Interest Group. Data Schema changes between versions 1.3.0 and 1.3.1 are summarized in the Change Summary

Backward compatibility concerns has resulted in the creation of an XSL transformation file to convert v1.2 XML files to v1.3.1 XML files for a subset of the WITSML objects. Transforms in the reverse direction are also supported. A spreadsheet documents a mapping between the v1.2 and v1.3.1 schemas.

This overview is non-normative and is not part of the standard.

Introduction

The Wellsite Information Transfer Standard Markup Language (WITSML) is a standard for sending well site information in an XML document format between business partners. XML schemas are used to define the content of an XML document.  The WITSML standard consists of two specifications which will be versioned independently: Data Schema and Application Program Interface (API). This document provides an overview of the Data Schema. The WITSML data schema consists of a set of independent but relatable data object schemas. A data object schema defines a set of data that can be transmitted within a single XML document and represents a cohesive subset (e.g.; well, wellbore, rig, etc.) of an overall logical schema related to a single domain (well). Data object schemas contain attributes, elements, and included component sub-schemas.

Component schemas are XML schemas, but these schemas do not represent complete data objects. A component schema may be included by more than one data object schema. All component schemas are prefixed with (cs_). Each component schema file generally defines one type that has the same name as the file name.

An attribute group file (attgrp_uid.xsd) is used to define a unique identifier (uid) attribute for all recurring container elements. A container element is an element that contains other elements. The uid attribute is optional but is required within the context of a WITSML server. This is the equivalent of a RDBMS system generated primary key.

Low level simplistic types are defined in the following files. Each file defines many types. Each component schema file must directly or indirectly include file typ_dataTypes.xsd. If a component schema includes another component schema then it will be indirectly including typ_dataTypes.xsd.

File typ_catalog.xsd file contains enumerations that are considered to be relatively static and should not require frequent changes. However for some data the list of recognized values may change relatively frequently. For this type of data the values are enumerated in file enumValues.xml.

The unit of measure conversion information is defined in file witsmlUnitDict.xml. Abbreviations used within the WITSML schemas are documented here.

In addition, an overall composite schema has been defined which allows data from all of the data object schemas to be included in one document. However, this schema is not intended for use with the API.

Data object schema design:

Since all XML documents can only have one root level element and there are situations where it is necessary to send multiple occurrences of a data object in a single XML document (e.g.; multiple wellbores in a well), a pluralized version of the data object name was established as the schema root element. That is, the object name followed by an "S" (e.g.; wells, wellbores, etc.).  In some cases, this leads to incorrect pluralization (e.g., trajectorys), but is required to order to meet the requirements of the WITSML API which generates root tag names based on the data object name. One component schema is included in all plural data object schemas:

The unique identifiers (uid) for data objects are always defined as attributes at the singular data object name level.

Naming convention in schemas:

A WITSML type can be one of four kinds; a definition only with possibly a restricted size specified, a definition with enumerated values that are permitted, a reference to a component schema and a reference to a element group schema. While not really a type, the element group schemas allow the same elements to be used in multiple different contexts. In order, to help identify which type is being referenced, the following naming convention is used.

Wells and Wellbores

WITSML has adopted the following definitions:

The definition of wellbore is intended to allow it to represent one and only one sidetrack or initial borehole. This assumes that only one sidetrack can have a particular bottomhole point. The wellbore may partially or completely overlap other sidetracks but it would not represent them.

For data bases that only contain wells, the name of the well generally contains knowledge of a specific sidetrack that is represented by that well. Information which is common to all sidetracks must be copied to each sidetrack well. Information from other sidetracks may also be redundantly copied to the sidetrack well. That is, the sidetrack well generally represents information from bottomhole to surface. In the WITSML view, the common data maps to a well and the sidetrack information maps to a wellbore. Data from other sidetracks may or may not be redundantly copied to a wellbore. Information about a borehole maps to a wellbore when that information is located using measured depths from the surface.

WITSML Schemas, XML documents, and Stylesheets:

The WITSML standard includes the following data object schemas, component schemas and element group schemas:

WITSML Composite schema

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
  WITSML_composite.xsd
  (this file utilizes "grp_" files that can be referenced below)
XSD      


bhaRun data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_bhaRun.xsd XSD XML XML/XSL XSL
      grp_bhaRun.xsd XSD      
           cs_drillingParams.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


cementJob data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_cementJob.xsd XSD XML XML/XSL XSL
      grp_cementJob.xsd XSD      
           cs_wbGeometry.xsd XSD      
                grp_wbGeometry.xsd XSD      
                     cs_wbGeometrySection.xsd XSD      
           cs_cementStage.xsd XSD      
                cs_cementingFluid.xsd XSD      
                     cs_cementPumpSchedule.xsd XSD      
                     cs_cementAdditive.xsd XSD      
           cs_cementTest.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


convCore data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_convCore.xsd XSD XML XML/XSL XSL
      grp_convCore.xsd XSD      
           cs_geologyInterval.xsd XSD      
                cs_lithology.xsd XSD      
                     cs_qualifier.xsd XSD      
                cs_show.xsd XSD      
                cs_chromatograph.xsd XSD      
                cs_mudGas.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


dtsInstalledSystem data object

Click here for an overview of Distributed Temperature Survey.

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_dtsInstalledSystem.xsd XSD XML XML/XSL XSL
      grp_dtsInstalledSystem.xsd XSD      
           cs_fiberInformation.xsd XSD      
                cs_fiber.xsd XSD      
                     cs_refractiveIndex.xsd XSD      
                     cs_oneWayLoss.xsd XSD      
                     cs_calibration.xsd XSD      
                          cs_calibrationParameter.xsd XSD      
           cs_boxInformation.xsd XSD      
                cs_instrumentBox.xsd XSD      
                     cs_nameTag.xsd XSD      
                     cs_instrumentBoxCalibration.xsd XSD      
                          cs_calibrationParameter.xsd XSD      
           cs_fiberEndPoint.xsd XSD      
           cs_fiberInstalledPoints.xsd XSD      
                cs_singleInstalledPoint.xsd XSD      
           cs_pumpActivity.xsd XSD      
                cs_pumpLogTable.xsd XSD      
                     cs_pumpLogRow.xsd XSD      
           cs_otdr.xsd XSD      
           cs_calibration.xsd XSD      
                cs_calibrationParameter.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


dtsMeasurement data object

Click here for an overview of Distributed Temperature Survey.

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_dtsMeasurement.xsd XSD XML XML/XSL XSL
      grp_dtsMeasurement.xsd XSD      
           cs_singleInstalledPoint.xsd XSD      
           cs_errorReport.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


fluidsReport data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_fluidsReport.xsd XSD XML XML/XSL XSL
      grp_fluidsReport.xsd XSD      
           cs_fluid.xsd XSD      
                cs_rheometer.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


formationMarker data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_formationMarker.xsd XSD XML XML/XSL XSL
      grp_formationMarker.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


log data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_log.xsd XSD XML XML/XSL XSL
      grp_log.xsd XSD      
           cs_logCurveInfo.xsd XSD      
                cs_axisDefinition.xsd XSD      
           cs_logData.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


message data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_message.xsd XSD XML XML/XSL XSL
      grp_message.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


mudLog data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_mudLog.xsd XSD XML XML/XSL XSL
      grp_mudLog.xsd XSD      
           cs_mudLogParameter.xsd XSD      
           cs_geologyInterval.xsd XSD      
                cs_lithology.xsd XSD      
                     cs_qualifier.xsd XSD      
                cs_show.xsd XSD      
                cs_chromatograph.xsd XSD      
                cs_mudGas.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


opsReport data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_opsReport.xsd XSD XML XML/XSL XSL
      grp_opsReport.xsd XSD      
           cs_activity.xsd XSD      
           cs_drillingParams.xsd XSD      
           cs_wbGeometry.xsd XSD      
                grp_wbGeometry.xsd XSD      
                     cs_wbGeometrySection.xsd XSD      
           cs_dayCost.xsd XSD      
                cs_nameTag.xsd XSD      
           cs_trajectoryStation.xsd XSD      
                grp_trajectoryStation.xsd XSD      
                     cs_stnTrajRawData.xsd XSD      
                     cs_stnTrajCorUsed.xsd XSD      
                     cs_stnTrajValid.xsd XSD      
                     cs_stnTrajMatrixCov.xsd XSD      
                     cs_location.xsd XSD      
                     cs_refWellboreTrajectoryStation.xsd XSD      
                cs_commonData.xsd XSD      
           cs_fluid.xsd XSD      
                cs_rheometer.xsd XSD      
           cs_scr.xsd XSD      
           cs_pitVolume.xsd XSD      
           cs_mudVolume.xsd XSD      
                cs_mudLosses.xsd XSD      
           cs_inventory.xsd XSD      
           cs_rigResponse.xsd XSD      
           cs_pumpOp.xsd XSD      
           cs_shakerOp.xsd XSD      
                cs_shakerScreen.xsd XSD      
           cs_hse.xsd XSD      
                cs_incident.xsd XSD      
           cs_personnel.xsd XSD      
           cs_supportCraft.xsd XSD      
           cs_weather.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


realtime data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_realtime.xsd XSD XML XML/XSL XSL
      grp_realtime.xsd XSD      
           cs_realtimeHeader.xsd XSD      
                cs_interval.xsd XSD      
                cs_groupDefinition.xsd XSD      
                     cs_interval.xsd XSD      
                     cs_channelDefinition.xsd XSD      
                          cs_interval.xsd XSD      
                          cs_axisDefinition.xsd XSD      
           cs_channel.xsd XSD      
           cs_record.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


rig data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_rig.xsd XSD XML XML/XSL XSL
      grp_rig.xsd XSD      
           cs_bop.xsd XSD      
                cs_nameTag.xsd XSD      
                cs_bopComponent.xsd XSD      
           cs_pit.xsd XSD      
                cs_nameTag.xsd XSD      
           cs_pump.xsd XSD      
                cs_nameTag.xsd XSD      
           cs_shaker.xsd XSD      
                cs_nameTag.xsd XSD      
           cs_centrifuge.xsd XSD      
                cs_nameTag.xsd XSD      
           cs_hydrocyclone.xsd XSD      
                cs_nameTag.xsd XSD      
           cs_degasser.xsd XSD      
                cs_nameTag.xsd XSD      
           cs_surfaceEquipment.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


risk data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_risk.xsd XSD XML XML/XSL XSL
      grp_risk.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


sidewallCore data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_sidewallCore.xsd XSD XML XML/XSL XSL
      grp_sidewallCore.xsd XSD      
           cs_swcSample.xsd XSD      
                cs_lithology.xsd XSD      
                     cs_qualifier.xsd XSD      
                cs_show.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


surveyProgram data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_surveyProgram.xsd XSD XML XML/XSL XSL
      grp_surveyProgram.xsd XSD      
           cs_surveySection.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


target data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_target.xsd XSD XML XML/XSL XSL
      grp_target.xsd XSD      
           cs_location.xsd XSD      
           cs_targetSection.xsd XSD      
                cs_location.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


trajectory data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_trajectory.xsd XSD XML XML/XSL XSL
      grp_trajectory.xsd XSD      
           cs_refWellboreTrajectory.xsd XSD      
           cs_trajectoryStation.xsd XSD      
                grp_trajectoryStation.xsd XSD      
                     cs_stnTrajRawData.xsd XSD      
                     cs_stnTrajCorUsed.xsd XSD      
                     cs_stnTrajValid.xsd XSD      
                     cs_stnTrajMatrixCov.xsd XSD      
                     cs_location.xsd XSD      
                     cs_refWellboreTrajectoryStation.xsd XSD      
                cs_commonData.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


trajectoryStation data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_trajectoryStation.xsd XSD XML XML/XSL XSL
      grp_trajectoryStation.xsd XSD      
           cs_stnTrajRawData.xsd XSD      
           cs_stnTrajCorUsed.xsd XSD      
           cs_stnTrajValid.xsd XSD      
           cs_stnTrajMatrixCov.xsd XSD      
           cs_location.xsd XSD      
           cs_refWellboreTrajectoryStation.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


tubular data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_tubular.xsd XSD XML XML/XSL XSL
      grp_tubular.xsd XSD      
           cs_tubularComponent.xsd XSD      
                cs_nameTag.xsd XSD      
                cs_bitRecord.xsd XSD      
                     cs_customData.xsd XSD      
                cs_nozzle.xsd XSD      
                     cs_customData.xsd XSD      
                cs_connection.xsd XSD      
                     cs_customData.xsd XSD      
                cs_jar.xsd XSD      
                     cs_customData.xsd XSD      
                cs_mwdTool.xsd XSD      
                     cs_sensor.xsd XSD      
                          cs_customData.xsd XSD      
                     cs_customData.xsd XSD      
                cs_motor.xsd XSD      
                     cs_customData.xsd XSD      
                cs_stabilizer.xsd XSD      
                     cs_customData.xsd XSD      
                cs_bend.xsd XSD      
                     cs_customData.xsd XSD      
                cs_holeOpener.xsd XSD      
                     cs_customData.xsd XSD      
                cs_rotarySteerableTool.xsd XSD      
                     cs_sensor.xsd XSD      
                          cs_customData.xsd XSD      
                     cs_customData.xsd XSD      
                cs_customData.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


wbGeometry data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_wbGeometry.xsd XSD XML XML/XSL XSL
      grp_wbGeometry.xsd XSD      
           cs_wbGeometrySection.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


well data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_well.xsd XSD XML XML/XSL XSL
      grp_well.xsd XSD      
           cs_wellDatum.xsd XSD      
                cs_refWellWellbore.xsd XSD      
                cs_refWellWellboreRig.xsd XSD      
           cs_location.xsd XSD      
           cs_referencePoint.xsd XSD      
                cs_location.xsd XSD      
           cs_wellCRS.xsd XSD      
                cs_projectionx.xsd XSD      
                cs_geodeticModel.xsd XSD      
                cs_localCRS.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


wellbore data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_wellbore.xsd XSD XML XML/XSL XSL
      grp_wellbore.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


wellLog data object

  Schemas   Links to Documents
  XSD
  Schema
  XML
  Document
  XML via
  Stylesheet
  Stylesheet
  Source
 obj_wellLog.xsd XSD XML XML/XSL XSL
      grp_wellLog.xsd XSD      
           cs_wellLogCurveInfo.xsd XSD      
                cs_axisDefinition.xsd XSD      
           cs_blockInfo.xsd XSD      
                cs_blockCurveInfo.xsd XSD      
           cs_wellLogData.xsd XSD      
      cs_commonData.xsd XSD      
      cs_customData.xsd XSD      


Copyright(c) 2005 Petrotechnical Open Standards Consortium, Inc. (POSC) All rights reserved.
POSC® and the POSC logo® are registered trademarks and WITSML™ and the WITSML logo™ are trademarks of POSC