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

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="cs_productFlowExpectedPair.xsd"/>
<xsd:include schemaLocation="cs_productFlowPortConstraint.xsd"/>
<xsd:include schemaLocation="cs_connectedNode.xsd"/>
<xsd:include schemaLocation="typ_dataTypes_New.xsd"/>
<xsd:include schemaLocation="attgrp_uid.xsd"/>
...
</xsd:schema>
top

Global Definitions

Complex Type: cs_productFlowPort

Super-types: None
Sub-types: None
Name cs_productFlowPort
Abstract no
Documentation WITSML - Product Flow Port 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 the port within the context of the Product Flow Unit.'

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

'Defines whether this port is an inlet or outlet. This is a nominal intended direction.'

<witsml:facility> witsml:facilityIdentifierStruct </witsml:facility> [0..1]

'The name of the facility represented by this Product Flow Port The name can be qualified by a naming system. The facility name is assumed to be unique within the context of the facility represented by the unit. This also defines the kind of facility.'

<witsml:connectedNode> witsml:cs_connectedNode </witsml:connectedNode> [1..*]

'Defines the node to which this port is connected. A timestamp activates and deactivates the connection. Only one connectedNode should be active at any one point in time. There are no semantics for the node except common connection. All ports that are connected to a node with the the same name are inherently connected to each other. The name of the node is only required to be unique within the context of the current Product Flow Network (that is, not the overall model). All ports must be connected to a node and whether or not any other port is connected to the same node depends on the requirements of the network. Any node that is internally connected to only one port is presumably a candidate to be connected to an external node. The behavior of ports connected at a common node is as follows: a) There is no pressure drop across the node. All ports connected to the node have the same pressure. That is, there is an assumption of steady state fluid flow. b) Conservation of mass exists across the node. The mass into the node via all connected ports equals the mass out of the node via all connected ports. c) The flow direction of a port connected to the node may be transient. That is, flow direction may change toward any port(s) if the relative internal pressure of the Product Flow Units change and a new steady state is achieved.'

<witsml:constraint> witsml:cs_productFlowPortConstraint </witsml:constraint> [0..*]

'Defines a constraint or setpoint between this port and one other port. By convention, this should be defined on the outlet port of an inlet outlet pair.'

<witsml:expectedFlowProduct> witsml:cs_productFlowExpectedPair </witsml:expectedFlowProduct> [0..*]

'Defines the expected flow and product pairs to be assigned to this port by a Product Volume report.'

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

'A descriptive remark associated with this port.'

</...>
Diagram
h-269201247 h1582104723 h970983430 h-333205119 h-1435089615 h437979749 h-793122037 h-1931220815
Schema Component Representation
<xsd:complexType name="cs_productFlowPort">
<xsd:sequence>
<xsd:element name="name" type=" witsml:nameString " minOccurs="1" maxOccurs="1"/>
<xsd:element name="direction" type=" witsml:ProductFlowPortType " minOccurs="1" maxOccurs="1"/>
<xsd:element name="facility" type=" witsml:facilityIdentifierStruct " minOccurs="0" maxOccurs="1"/>
<xsd:element name="connectedNode" type=" witsml:cs_connectedNode " minOccurs="1" maxOccurs="unbounded"/>
<xsd:element name="constraint" type=" witsml:cs_productFlowPortConstraint " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="expectedFlowProduct" type=" witsml:cs_productFlowExpectedPair " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="comment" type=" witsml:commentString " minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attributeGroup ref=" witsml:attgrp_uid "/>
</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