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_businessAssociate.xsd"/>
<xsd:include schemaLocation="cs_geographicContext.xsd"/>
<xsd:include schemaLocation="typ_catalog_New.xsd"/>
<xsd:include schemaLocation="cs_productVolumeFacility.xsd"/>

Global Definitions

Model Group: grp_productVolume

Name grp_productVolume
Documentation The non-contextual content of a WITSML Product Volume object.
XML Instance Representation
<witsml:installation> witsml:facilityIdentifierStruct </witsml:installation> [0..1]

'The name of the facility which is represented by this report. The name can be qualified by a naming system. This also defines the kind of facility.'

<witsml:contextFacility> witsml:facilityIdentifierStruct </witsml:contextFacility> [0..*]

'The name and type of a facility whose context is relevant to the represented installation.'

<witsml:kind> witsml:kindString </witsml:kind> [0..1]

'The type of report.'

<witsml:periodKind> witsml:ReportingPeriod </witsml:periodKind> [0..1]

'The type of period that is being reported. This value must be consistent with the reporting start and end values.'

Start Choice [1]

'The reporting period. If one value from a pair are given the both values must be given.'

<witsml:dTimStart> witsml:timestamp </witsml:dTimStart> [1]

'The beginning date and time that the report represents.'

<witsml:dTimEnd> witsml:timestamp </witsml:dTimEnd> [1]

'The ending date and time that the report represents.'

<witsml:dateStart> witsml:date </witsml:dateStart> [1]

'The beginning date that the report represents.'

<witsml:dateEnd> witsml:date </witsml:dateEnd> [1]

'The ending date that the report represents.'

End Choice
<witsml:operator> witsml:cs_businessAssociate </witsml:operator> [0..1]

'The operator of the facilities in the report.'

<witsml:title> witsml:nameStruct </witsml:title> [0..1]

'The tile of the report if different from the name of the report.'

<witsml:geographicContext> witsml:cs_geographicContext </witsml:geographicContext> [0..1]

'The geographic context of the report.'

<witsml:issueDate> witsml:date </witsml:issueDate> [0..1]

'The date that the report was issued.'

<witsml:issuedBy> witsml:cs_businessAssociate </witsml:issuedBy> [0..1]

'The person or company that issued the report. This may contain the role of the person or company within the context of the report.'

<witsml:approvalDate> witsml:date </witsml:approvalDate> [0..1]

'The date that the report was approved.'

<witsml:approver> witsml:cs_businessAssociate </witsml:approver> [0..1]

'The person or company that approved the report. This may contain the role of the person or company within the context of the report.'

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

'The Product Flow Model for the overall installation. This model represents all Product Flow Units referenced within this report.'

<witsml:standardTempPres> witsml:StandardTempPress </witsml:standardTempPres> [0..1]

'Defines the standard temperature and pressure to which all standard volumes in this report have been corrected. This applies to all elements whose name is suffixed by Std and documented to be corrected to conditions of standard temperature and pressure.'

<witsml:facility> witsml:cs_productVolumeFacility </witsml:facility> [1..*]

'A facility for which product information is being reported.'

h970983430 h970983430 h-399087894 h-1881917846 h-622169519 h-622169519 h518884755 h518884755 h376706324 h-269190043 h-2063507186 h518884755 h376706324 h518884755 h376706324 h65068842 h-2000873299 h-977543806
Schema Component Representation
<xsd:group name="grp_productVolume">
<xsd:element name="installation" type=" witsml:facilityIdentifierStruct " minOccurs="0" maxOccurs="1"/>
<xsd:element name="contextFacility" type=" witsml:facilityIdentifierStruct " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="kind" type=" witsml:kindString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="periodKind" type=" witsml:ReportingPeriod " minOccurs="0" maxOccurs="1"/>
<xsd:choice minOccurs="1" maxOccurs="1">
<xsd:element name="dTimStart" type=" witsml:timestamp " minOccurs="1" maxOccurs="1"/>
<xsd:element name="dTimEnd" type=" witsml:timestamp " minOccurs="1" maxOccurs="1"/>
<xsd:element name="dateStart" type=" witsml:date " minOccurs="1" maxOccurs="1"/>
<xsd:element name="dateEnd" type=" witsml:date " minOccurs="1" maxOccurs="1"/>
<xsd:element name="operator" type=" witsml:cs_businessAssociate " minOccurs="0" maxOccurs="1"/>
<xsd:element name="title" type=" witsml:nameStruct " minOccurs="0" maxOccurs="1"/>
<xsd:element name="geographicContext" type=" witsml:cs_geographicContext " minOccurs="0" maxOccurs="1"/>
<xsd:element name="issueDate" type=" witsml:date " minOccurs="0" maxOccurs="1"/>
<xsd:element name="issuedBy" type=" witsml:cs_businessAssociate " minOccurs="0" maxOccurs="1"/>
<xsd:element name="approvalDate" type=" witsml:date " minOccurs="0" maxOccurs="1"/>
<xsd:element name="approver" type=" witsml:cs_businessAssociate " minOccurs="0" maxOccurs="1"/>
<xsd:element name="productFlowModel" type=" witsml:refNameString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="standardTempPres" type=" witsml:StandardTempPress " minOccurs="0" maxOccurs="1"/>
<xsd:element name="facility" type=" witsml:cs_productVolumeFacility " minOccurs="1" maxOccurs="unbounded"/>


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: