Documentation for WITSML_Composite

Table of Contents

Master schema documentation file: WITSML_Composite.xsd.html

top

Schema Document Properties

Target Namespace http://www.witsml.org/schemas/131/addendum/combo
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
  • This schema includes components from the following schema document(s):

Declared Namespaces

Prefix Namespace
witsml http://www.witsml.org/schemas/131/addendum/combo
xml http://www.w3.org/XML/1998/namespace
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xsd:schema elementFormDefault="qualified" attributeFormDefault="unqualified" targetNamespace="http://www.witsml.org/schemas/131/addendum/combo" version="1.3.1">
<xsd:include schemaLocation="typ_dataTypes.xsd"/>
...
</xsd:schema>
top

Global Definitions

Complex Type: auditType

Super-types: None
Sub-types: None
Name auditType
Used by (from the same schema document) Complex Type cs_documentInfo
Abstract no
Documentation The audit records what happened to the data, to produce the data that is in this file. It consists of one or more events.
XML Instance Representation
<...>
<witsml:Event> witsml:eventType </witsml:Event> [1..*]
</...>
Diagram
h-645864913
Schema Component Representation
<xsd:complexType name="auditType">
<xsd:sequence>
<xsd:element name="Event" type=" witsml:eventType " minOccurs="1" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: cs_documentInfo

Super-types: None
Sub-types: None
Name cs_documentInfo
Abstract no
Documentation A schema to capture a set of data that is relevant for many exchange documents. It includes information about the file that was created, and high-level information about the data that is being exchanged within the file.
XML Instance Representation
<...>
<witsml:DocumentName> witsml:nameStruct </witsml:DocumentName> [1]

'An identifier for the document. This is intended to be unique within the context of the NamingSystem.'

<witsml:DocumentAlias> witsml:nameStruct </witsml:DocumentAlias> [0..*]

'Zero or more alternate names for the document. These names do not need to be unique within the naming system.'

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

'The date of the creation of the document. This is not the same as the date that the file was created. For this date, the document is considered to be the set of information associated with this document information. For example, the document may be a seismic binset. This represents the date that the binset was created. The FileCreation information would capture the date that the XML file was created to send or exchange the binset.'

<witsml:documentClass> witsml:nameStruct </witsml:documentClass> [0..*]

'A document class. Examples of classes would be a metadata classification or a set of keywords.'

<witsml:FileCreationInformation> witsml:fileCreationType </witsml:FileCreationInformation> [0..1]

'The information about the creation of the exchange file. This is not about the creation of the data within the file, but the creation of the file itself.'

<witsml:SecurityInformation> witsml:securityInfoType </witsml:SecurityInformation> [0..5]

'Information about the security to be applied to this file. More than one classification can be given.'

<witsml:Disclaimer> witsml:commentString </witsml:Disclaimer> [0..1]

'A free-form string that allows a disclaimer to accompany the information.'

<witsml:AuditTrail> witsml:auditType </witsml:AuditTrail> [0..1]

'A collection of events that can document the history of the data.'

<witsml:Owner> witsml:nameString </witsml:Owner> [0..1]

'The owner of the data.'

<witsml:Comment> witsml:commentString </witsml:Comment> [0..1]

'An optional comment about the document.'

</...>
Diagram
h-269190043 h-269190043 h-622169519 h-269190043 h782485690 h497871565 h-793122037 h-484474128 h-269201247 h-793122037
Schema Component Representation
<xsd:complexType name="cs_documentInfo">
<xsd:sequence>
<xsd:element name="DocumentName" type=" witsml:nameStruct " minOccurs="1" maxOccurs="1"/>
<xsd:element name="DocumentAlias" type=" witsml:nameStruct " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="DocumentDate" type=" witsml:timestamp " minOccurs="0" maxOccurs="1"/>
<xsd:element name="documentClass" type=" witsml:nameStruct " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="FileCreationInformation" type=" witsml:fileCreationType " minOccurs="0" maxOccurs="1"/>
<xsd:element name="SecurityInformation" type=" witsml:securityInfoType " minOccurs="0" maxOccurs="5"/>
<xsd:element name="Disclaimer" type=" witsml:commentString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="AuditTrail" type=" witsml:auditType " minOccurs="0" maxOccurs="1"/>
<xsd:element name="Owner" type=" witsml:nameString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="Comment" type=" witsml:commentString " minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: eventType

Super-types: None
Sub-types: None
Name eventType
Used by (from the same schema document) Complex Type auditType
Abstract no
Documentation An event type captures the basic information about an event that has affected the data.
XML Instance Representation
<...>
<witsml:EventDate> witsml:timestamp </witsml:EventDate> [1]

'The date on which the event took place.'

<witsml:ResponsibleParty> witsml:nameString </witsml:ResponsibleParty> [0..1]

'The party responsible for the event.'

<witsml:Comment> witsml:commentString </witsml:Comment> [0..1]

'A free form comment that can further define the event that occurred.'

</...>
Diagram
h-622169519 h-269201247 h-793122037
Schema Component Representation
<xsd:complexType name="eventType">
<xsd:sequence>
<xsd:element name="EventDate" type=" witsml:timestamp " minOccurs="1" maxOccurs="1"/>
<xsd:element name="ResponsibleParty" type=" witsml:nameString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="Comment" type=" witsml:commentString " minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: fileCreationType

Super-types: None
Sub-types: None
Name fileCreationType
Used by (from the same schema document) Complex Type cs_documentInfo
Abstract no
Documentation A block of information about the creation of the XML file. This is different than the creation of the data that is included within the file.
XML Instance Representation
<...>
<witsml:FileCreationDate> witsml:timestamp </witsml:FileCreationDate> [1]

'The date and time that the file was created.'

<witsml:SoftwareName> witsml:nameString </witsml:SoftwareName> [0..1]

'If appropriate, the software that created the file. This is a free form string, and may include whatever information is deemed relevant.'

<witsml:FileCreator> witsml:nameString </witsml:FileCreator> [0..1]

'The person or business associate that created the file.'

<witsml:Comment> witsml:commentString </witsml:Comment> [0..1]

'Any comment that would be useful to further explain the creation of this instance document.'

</...>
Diagram
h-622169519 h-269201247 h-269201247 h-793122037
Schema Component Representation
<xsd:complexType name="fileCreationType">
<xsd:sequence>
<xsd:element name="FileCreationDate" type=" witsml:timestamp " minOccurs="1" maxOccurs="1"/>
<xsd:element name="SoftwareName" type=" witsml:nameString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="FileCreator" type=" witsml:nameString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="Comment" type=" witsml:commentString " minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: securityInfoType

Super-types: None
Sub-types: None
Name securityInfoType
Used by (from the same schema document) Complex Type cs_documentInfo
Abstract no
Documentation Information about the security classification of the document. This is intended as a documentation of the security so that the file will not inadvertently be sent to someone who is not allowed access to the data. This block also carries a date that the security classification expires. For example, a well log is confidential for a period of time, and then becomes open. All security classes are characterized by their classification systems.
XML Instance Representation
<...>
<witsml:Class> witsml:kindString </witsml:Class> [0..1]

'The security class in which this document is classified. Examples would be confidential, partner confidential, tight. The meaning of the class is determined by the System in which it is defined.'

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

'The security classification system. This gives context to the meaning of the Class value.'

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

'The date on which this security class is no longer applicable.'

<witsml:Comment> witsml:commentString </witsml:Comment> [0..1]

'A general comment to further define the security class.'

</...>
Diagram
h-399087894 h-399087894 h-622169519 h-793122037
Schema Component Representation
<xsd:complexType name="securityInfoType">
<xsd:sequence>
<xsd:element name="Class" type=" witsml:kindString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="System" type=" witsml:kindString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="EndDate" type=" witsml:timestamp " minOccurs="0" maxOccurs="1"/>
<xsd:element name="Comment" type=" witsml:commentString " minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • 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">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

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: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

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: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

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: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

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 http://www.w3.org/2001/XMLSchema-instance 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: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

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: http://www.w3.org/TR/xmlschema-1/#element-sequence.

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: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top