Documentation for WITSML_Composite

Table of Contents

Master schema documentation file: WITSML_Composite.xsd.html


Schema Document Properties

Target Namespace
Version 1.3.1
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition

Declared Namespaces

Prefix Namespace
Schema Component Representation
<xsd:schema elementFormDefault="qualified" attributeFormDefault="unqualified" targetNamespace="" version="1.3.1">
<xsd:include schemaLocation="cs_productVolumeRelatedFacility.xsd"/>
<xsd:include schemaLocation="cs_productVolumeProduct.xsd"/>
<xsd:include schemaLocation="cs_productVolumelPortDifference.xsd"/>
<xsd:include schemaLocation="cs_datedComment.xsd"/>
<xsd:include schemaLocation="typ_catalog_prodVol.xsd"/>
<xsd:include schemaLocation="attgrp_uid.xsd"/>

Global Definitions

Complex Type: cs_productVolumeFlow

Super-types: None
Sub-types: None
Name cs_productVolumeFlow
Abstract no
Documentation WITSML - Product Volume Flow Component Schema.
XML Instance Representation
uid=" witsml:uidString [0..1]

'The unique identifier of a container element. This attribute is generally required within the context of a WITSML server. There should be no assumption as to the semantic content of this attribute. This should only be used with recurring container types (i.e., maxOccurs greater than one). The value is only required to be unique within the context of the nearest recurring parent element.'

<witsml:name> witsml:nameString </witsml:name> [1]

'The name of this flow within the context of this report. This might reflect some combination of the kind of flow, port, qualifier and related facility.'

<witsml:kind> witsml:ReportingFlow </witsml:kind> [1]

'Indicates the type of flow that is being reported. The type of flow is an indication of the overall source or target of the flow. A production flow has one or more wells as the originating source. An injection flow has one or more wells as the ultimate target. An import flow has an offsite source. An export flow has an offiste target. A consumption flow generally has a kind of equipment as a target.'

Start Choice [1]
<witsml:port> witsml:refNameString </witsml:port> [0..1]

'The Product Flow Port to which the flow is assigned. This is the port on the Product Flow Unit that represents the facility. Only one flow should be assigned to each port within the context of this report.'

<witsml:direction> witsml:ProductFlowPortType </witsml:direction> [0..1]

'The kind of port that this flow represents: inlet or outlet. This should only be specified if a Product Flow Model is not being referenced.'

End Choice
<witsml:qualifier> witsml:FlowQualifier </witsml:qualifier> [0..1]

'Qualifies the type of flow that is being reported.'

<witsml:relatedFacility> witsml:cs_productVolumeRelatedFacility </witsml:relatedFacility> [0..1]

'A second facility related to this flow. For a production flow, this would represent a role of \'produced for\'. For an import flow, this would represent a role of \'inport from\'. For an export flow, this would represent a role of \'export to\'.'

<witsml:version> witsml:timestamp </witsml:version> [0..1]

'A timestamp representing the version of this data. A flow (same port and products) with a more recent timestamp will represent the \"current\" version.'

<witsml:sourceFlow> witsml:refNameString </witsml:sourceFlow> [0..1]

'This is a pointer to the flow from which this flow was derived.'

<witsml:gor> witsml:volumePerVolumeMeasure </witsml:gor> [0..1]

'Gas oil ratio. The ratio between the total produced gas volume and the total produced oil volume including oil and gas volumes used on the installation.'

<witsml:gorMTD> witsml:volumePerVolumeMeasure </witsml:gorMTD> [0..1]

'Gas oil ratio month to date. The gas oil ratio from the beginning of the month to the end of the reporting priod.'

<witsml:waterConcMass> witsml:massConcentrationMeasure </witsml:waterConcMass> [0..1]

'Water concentration mass basis. The ratio of water produced compared to the mass of total liquids produced.'

<witsml:waterConcVol> witsml:volumePerVolumeMeasure </witsml:waterConcVol> [0..1]

'Water concentration volume basis. The ratio of water produced compared to the mass of total liquids produced.'

<witsml:atmosphere> witsml:pressureMeasure </witsml:atmosphere> [0..1]

'The average atmospheric pressure during the reporting period.'

<witsml:temp> witsml:thermodynamicTemperatureMeasure </witsml:temp> [0..1]

'Temperature of the port. Specifying the temperature here (as opposed to in Period) implies that the temperature is constant for all periods of the flow.'

<witsml:pres> witsml:pressureMeasure </witsml:pres> [0..1]

'Pressure of the port. Specifying the pressure here (as opposed to in Period) implies that the pressure is constant for all periods of the flow.'

<witsml:absoluteMinPres> witsml:pressureMeasure </witsml:absoluteMinPres> [0..1]

'Absolute minimum pressure before the system will give an alarm.'

<witsml:portDiff> witsml:cs_productVolumelPortDifference </witsml:portDiff> [0..*]

'The internal differences between this port and one other port on this unit.'

<witsml:product> witsml:cs_productVolumeProduct </witsml:product> [0..*]

'Reports a product flow stream.'

<witsml:comment> witsml:cs_datedComment </witsml:comment> [0..*]

'A timestamped remark about the flow.'

h-269201247 h846911511 h65068842 h1582104723 h-399055177 h46922799 h-622169519 h65068842 h-2131132250 h-2131132250 h-1588894038 h-2131132250 h1272623188 h-607763263 h1272623188 h1272623188 h1520503947 h-1327004112 h941142899 h-1931220815
Schema Component Representation
<xsd:complexType name="cs_productVolumeFlow">
<xsd:element name="name" type=" witsml:nameString " minOccurs="1" maxOccurs="1"/>
<xsd:element name="kind" type=" witsml:ReportingFlow " minOccurs="1" maxOccurs="1"/>
<xsd:choice minOccurs="1" maxOccurs="1">
<xsd:element name="port" type=" witsml:refNameString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="direction" type=" witsml:ProductFlowPortType " minOccurs="0" maxOccurs="1"/>
<xsd:element name="qualifier" type=" witsml:FlowQualifier " minOccurs="0" maxOccurs="1"/>
<xsd:element name="relatedFacility" type=" witsml:cs_productVolumeRelatedFacility " minOccurs="0" maxOccurs="1"/>
<xsd:element name="version" type=" witsml:timestamp " minOccurs="0" maxOccurs="1"/>
<xsd:element name="sourceFlow" type=" witsml:refNameString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="gor" type=" witsml:volumePerVolumeMeasure " minOccurs="0" maxOccurs="1"/>
<xsd:element name="gorMTD" type=" witsml:volumePerVolumeMeasure " minOccurs="0" maxOccurs="1"/>
<xsd:element name="waterConcMass" type=" witsml:massConcentrationMeasure " minOccurs="0" maxOccurs="1"/>
<xsd:element name="waterConcVol" type=" witsml:volumePerVolumeMeasure " minOccurs="0" maxOccurs="1"/>
<xsd:element name="atmosphere" type=" witsml:pressureMeasure " minOccurs="0" maxOccurs="1"/>
<xsd:element name="temp" type=" witsml:thermodynamicTemperatureMeasure " minOccurs="0" maxOccurs="1"/>
<xsd:element name="pres" type=" witsml:pressureMeasure " minOccurs="0" maxOccurs="1"/>
<xsd:element name="absoluteMinPres" type=" witsml:pressureMeasure " minOccurs="0" maxOccurs="1"/>
<xsd:element name="portDiff" type=" witsml:cs_productVolumelPortDifference " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="product" type=" witsml:cs_productVolumeProduct " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="comment" type=" witsml:cs_datedComment " minOccurs="0" maxOccurs="unbounded"/>
<xsd:attributeGroup ref=" witsml:attgrp_uid "/>


Complex Type:

Schema Component Type


Schema Component Name
Super-types: Address < AusAddress (by extension)
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<extension base=" Address ">
<element name="state" type=" AusStates "/>
<element name="postcode">
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
<attribute name="country" type=" string " fixed="Australia"/>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)


Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See:

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See:

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See:

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See:

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See:

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See:

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See:

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: