WITSML - Common Data Component Schema An identifier to indicate the data originator. This identifies the server that originally created the object and thus most of the uids in the object (but not necessarily the uids of the parents). This is typically a url. When the data was created at the persistent data store. Last change of any element of the data at the persistent data store. The change time is not updated for a growing object while it is growing. The item state for the data object. Comments and remarks. WITSML - Custom or User Defined Element and Attributes Component Schema. Specify custom element, attributes, and types in the custom data area. Any element or attribute in any namespace. It is strongly recommended that all custom data definitions be added to a unique namespace. 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. An identifier for the document. This is intended to be unique within the context of the NamingSystem. constraints:@minOccurs="1" Zero or more alternate names for the document. These names do not need to be unique within the naming system. 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. A document class. Examples of classes would be a metadata classification or a set of keywords. 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. Information about the security to be applied to this file. More than one classification can be given. A free-form string that allows a disclaimer to accompany the information. A collection of events that can document the history of the data. The owner of the data. WITSML query parameters. An optional comment about the document. A structure for WITSML query parameters. The intent is to allow a query for all objects within an index range (whether or not the object is growing). These would typically be something like a daily report. The minimum start time for an object. This only applies to objects with a root level date and/or dateTime element(s). The objects may or not be growing objects but the See the API specification for behavior related to this query parameter. The maximum start time for an object. This only applies to objects with a root level date and/or dateTime element(s). See the API specification for behavior related to this query parameter. 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. The date and time that the file was created. constraints:@minOccurs="1" If appropriate, the software that created the file. This is a free form string, and may include whatever information is deemed relevant. The person or business associate that created the file. Any comment that would be useful to further explain the creation of this instance document. 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. 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. The security classification system. This gives context to the meaning of the Class value. The date on which this security class is no longer applicable. A general comment to further define the security class. The audit records what happened to the data, to produce the data that is in this file. It consists of one or more events. constraints:@minOccurs="1" An event type captures the basic information about an event that has affected the data. The date on which the event took place. constraints:@minOccurs="1" The party responsible for the event. A free form comment that can further define the event that occurred. Data that represents a foreign key to a wellbore. The wellbore may be defined within the context of another well. A pointer the wellbore with which there is a relationship. constraints:@minOccurs="1" A pointer to the well that contains the wellboreReference. This is not needed unless the referenced wellbore is outside the context of a common parent well. A reference to a rig within a wellbore. The wellbore may be defined within the context of another well. This value represents a foreign key from one node to another. A pointer to the rig with which there is a relationship. constraints:@minOccurs="1" A pointer to the wellbore that contains the rigReference. This is not needed unless the referenced rig is outside the context of a common parent wellbore. A pointer to the well that contains the wellboreParent. This is not needed unless the referenced wellbore is outside the context of a common parent well. Within the context of a WITSML Server, this data should duplicate the equivalent information in the well object. Name of the field in which the well is located. An alias name associated with the well. If the wellName is associated with a naming system then it should be included in this list. A datum to which elevations and depths are referenced. Defines the datums associated with elevation, vertical depth and measured depth coordinates within the context of a well. The human understandable contextual name of the reference datum. The code value that represents the type of reference datum. This may represent a point on a device (e.g., kelly bushing) or it may represent a vertical reference datum (e.g., mean sea level). The name of the vertical reference datum in a particular naming system. This should only be specified if the above 'code' represents some variation of sea level. An optional short name (code) can also be specified. Specifying a well known datum is highly desired if the above code is a variant of sea level because sea level varies over time and space. An example would be to specify a name of 'Caspian Sea' with a code of '5106' in the 'EPSG' naming system. Since various activities may use different points as measurement datums, it is useful to characterize the point based on its usage. A well reference datum may have more than one such characterization. For example, it may be the datum used by the driller and logger for measuring their depths. Example usage values would be 'permanent','driller', 'logger' 'WRP' (well reference point) and 'SRP' (site reference point). A pointer to the wellbore that contains the reference datum. This should be specified if a measured depth is given. A pointer to the rig that contains the device used as a reference datum. The rig may be associated with a wellbore in another well (e.g., pattern drilling using a rig on a track). The gravity based elevation coordinate of this reference datum as measured from another datum. Positive moving upward from the elevation datum. An elevation should be given unless this is a vertical reference datum (e.g., sea level). The measured depth coordinate of this reference datum as measured from another datum. The measured depth datum should either be the same as the elevation datum or it should be relatable to the elevation datum through other datums. Positive moving toward the bottomhole from the measured depth datum. This should be given when a local reference is "downhole", such as a kickoff point or ocean bottom template, and the borehole may not be vertical. If a Depth is given then an Elevation should also be given. A contextual description of the well reference datum. True indicates that this is the default reference datum for measured depth coordinates. False or not given indicates that this is not the default reference datum. Measured depth coordinates that do not specify a datum reference should be assumed to be measured relative to this default reference datum. Only one reference datum may be designated as the default measured depth datum for each well. Values are "true" (or "1") and "false" ( or "0"). True indicates that this is the default reference datum for vertical depth coordinates. False or not given indicates that this is not the default reference datum. Vertical depth coordinates that do not specify a datum reference should be assumed to be measured relative to the default reference datum. Only one reference datum may be designated as the default vertical depth datum for each well. Values are "true" (or "1") and "false" ( or "0"). True indicates that this is the default reference datum for elevation coordinates. False or not given indicates that this is not the default reference datum. Elevation coordinates that do not specify a datum reference should be assumed to be measured relative to the default reference datum. Only one reference datum may be designated as the default elevation datum for each well. Values are "true" (or "1") and "false" ( or "0"). 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. Well test data gathered at the bottomhole. The pressure at the bottomhole of the well. The temperature at the bottomhole of the well. The P/Z value at the bottomhole. This is P/Z, pressure over gas compressibility factor (z), at the bottomhole of the well. Note that the uom is units of pressure., since Z is dimensionless. The measured depth of the bottomhole. Defines the wellbore (sidetract) represented by the measured depth. This must be given when the well has multiple wellbores and the measured depth value is deeper than the first kickoff point. It is recommended that it always be given. The cumulative amounts of the fluids at the time of the well test. The fluids are oil, gas, and water. The cumulative amount of oil. The cumulative amount of gas. The cumulative amount of water. The fluid level achieved in the well. The value is given as length units from the top of the well. constraints:@minOccurs="1" The lowest usable water depth as measured from the surface. See TxRRC H-15. The business associate that conducted the test. This is generally a person. The fluid flow rate. The fluid flow rate that has been corrected to standard temperature and pressure. Class for Natural Gas. This is not valid for oil or water. The time length (with uom) of the well test. The interval tested. This element includes a top and base depth, and the formation tested. The fluid that is being injected. The cumulative volumes of fluids at the time of the well test. The fluids are oil, gas, and water. The size of the opening in the flow choke at the wellhead. The minimum pressure measured at the annulus. The maximum pressure measured at the annulus. The flowing pressure measured at the wellhead during the test. The maximum pressure measured at the wellhead during the well test. The production results of the test. Oil, gas, and water volumes and rates measured during the well test. The volumes allow either actual volumes or standard (corrected) volumes. The densities are also recorded with the volumes. Oil volumes measured during the well test. Oil rates measured during the well test. Gas volumes measured during the well test. Gas rates measured during the well test. Water volumes measured during the well test. Water rates measured during the well test. The measured depth to the top of the interval. constraints:@minOccurs="1" The measured depth to the bottom of the interval. constraints:@minOccurs="1" Defines the wellbore (sidetract) represented by the measured depth. This must be given when the well has multiple wellbores and the measured depth value is deeper than the first kickoff point. It is recommended that it always be given. A formation that was tested. The relative opening of the downhole control valve for the tested zone. This is for surface controllable valves. constraints:@minOccurs="1" Well test data gathered at points in the wellbore. The pressure at the point. The temperature at the point. The P/Z value at the point. This is P/Z, pressure over gas compressibility factor (z). Note that the uom is units of pressure., since Z is dimensionless. The measured depth of the bottomhole. Defines the wellbore (sidetract) represented by the measured depth. This must be given when the well has multiple wellbores and the measured depth value is deeper than the first kickoff point. It is recommended that it always be given. A value of true (1 or "true") indicates that the point is at the bottomhole. A value of false (0 or "false") or not given indicates otherwise. A value of true (1 or "true") indicates a static (non-flowing) pressure. A value of false (0 or "false") or not given indicates otherwise. The pressure may be measured (e.g., shut-in well) or calculated. The time length (with uom) of the well test. The interval tested. This element includes a top and base depth, and the formation(s) tested. It also includes control data for the tested interval. This element records measurements made and settings made at the wellhead. DEPRECATED - Use pointData instead. This element records measurements made at the bottomhole. This element records temperature and pressure at points in the wellbore. This element records the measurements (pressure and temperature) at the separator. The method being used to operate the well. Examples are 'flowing', 'pumping', 'gas lifted'. The cumulative volumes of fluids at the time of the well test. The fluids are oil, gas, and water. The production results of the test. Oil, gas, and water volumes and rates measured during the well test. The volumes allow either actual volumes or standard (corrected) volumes. The densities are also recorded with the volumes. Oil volumes measured during the well test. Oil rates measured during the well test. Gas volumes measured during the well test. Gas rates measured during the well test. Water volumes measured during the well test. Water rates measured during the well test. condensate volumes measured during the well test. Condensate rates measured during the well test. The ratio of the volume of gas and the volume of oil that was produced. The ratio of water produced compared to the volume of total liquids produced. The density of the fluid mixture. The velocity of the overall fluid mixture. This is the condensate yield, which describes the amount of condensate per unit of natural gas produced This is the measured of impurities present in crude oil as it comes from the well. BSandW content is commonly used as a measure for treating performance of hydrocarbon liquids This is the the potential of the well to produce crude oil. This represents the flow rate that could be achieved under maximum drawdown. This is the potential of the well to produce natural gas. This represents the flow rate that could be achieved under maximum drawdown. the volume of sand that was produced. True ("true" or "1") indicates that the the split factors are allocated as opposed to measured. False ("false" or "0") or not given indicates otherwise. The split factor for Oil relative to the overall volume of the test. The split factor for Gas relative to the overall volume of the test. The split factor for Water relative to the overall volume of the test. The split factor for Condensate relative to the overall volume of the test. Well test data gathered at the separator. The pressure measured at the separator during the well test. The temperature measured at the separator during the well test. The following sequence of four elements can be used for reporting of most production fluids. The volume is the fluid, corrected to standard conditions of temperature and pressure. The volume, uncorrected. This volume is generally reported at reservoir conditions. The density of the fluid, corrected to standard conditions of temperature and pressure. The density of the fluid, uncorrected. Class for Natural Gas. This is not valid for oil or water. Basic measurements at the wellhead, during the well test. The temperature measured at the wellhead during the well test. The flowing pressure measured at the wellhead during the well test. The shut-in pressure measured at the wellhead during the well test. The pressure measured at the flow line connected to the wellhead during this well test. The size of the choke opening at the wellhead. constraints:@minOccurs="1" The pressure of the lift gas at the wellhead. The temperature of the lift gas at the wellhead. Lift gas volumes injected during the well test at the wellhead. Lift gas rates injected during the well test at the wellhead. The size of the gas lift choke opening. constraints:@minOccurs="1" The WITSML API mandated plural root element which allows multiple singular objects to be sent. The plural name is formed by adding an "s" to the singular name. Information about the XML message instance. Information about a single well test. Data object schema version. The fourth level must match the version of the schema constraints (enumerations and XML loader files) that are assumed by the document instance. constraints:@use="required" Human recognizable context for the well that contains the well test. constraints:@minOccurs="1" Human recognizable context for the well test. constraints:@minOccurs="1" The minimum time index contained within the object. The minimum and maximum indexes are server query parameters and will be populated with valid values in a "get" result. That is, all wellTest for a well in the specified period defined by the min/max. See the WITSML API Specification appendix on "Special Handling" of growing objects for a description of the behavior related to this parameter. The maximum time index contained within the object. The minimum and maximum indexes are server query parameters and will be populated with valid values in a "get" result. See the WITSML API Specification appendix on "Special Handling" of growing objects for a description of the behavior related to this parameter. The definition of the "current time" index for this object. The current time index is a server query parameter which requests the selection of a single node from a recurring set (e.g., the data related to one point in a time series). That is, the "most recent" (at or before the specified time) wellTest for a well. See the WITSML API Specification appendix on "Special Handling" of growing objects for a description of the behavior related to this parameter. Contextual data about the well that was tested. The date-time of well test. The date-time of the previous well test. The date-time of the last valid well test. The reason for the well test: initial, periodic, revision. The type of well production test. DEPRECATED: use productionTest/wellheadData/chokeOrificeSize or injectionTest/chokeOrificeSize. The size of the opening in the flow choke at the wellhead. A port on a Product Flow Unit that is represented by this test. The Product Flow Unit represented by the port. This is defined within the Product Flow Model The Product Flow Model that represents the above Product Flow Unit. 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 StdTempPres. Data from a fluid level test. Data from a production test. Multiple tests generally indicate that there are multiple components of a single overall test. For example, for multi-zoned wells. Data from an injection test. Multiple tests generally indicate that there are multiple components of the overall test. For example, for multi-zoned wells. A container element that contains elements that are common to all data objects. A container element that can contain custom or user defined data elements. Unique identifier for the well. This uniquely represents the well referenced by the (possibly non-unique) nameWell. 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. This type disallows an "empty" boolean value. This type should not be used directly except to derive another type. All boolean types should be derived from this type rather than using xsd:boolen. This type disallows an "empty" dateTime value. This type should not be used directly except to derive another type. All dateTime types should be derived from this type rather than using xsd:dateTime. This type disallows an "empty" double value. This type should not be used directly except to derive another type. The intended abstract supertype of all strings. This abstract type allows the control over whitespace for all strings to be defined at a high level. This type should not be used directly except to derive another type. Replace tab, line feed and carriage return with a space, collapse contiguous sequences of spaces to a single space and then remove leading and trailing spaces. The empty string is not allowed. This constraint conbined with the whiteSpace collapse constraint means that a blank value is not allowed. constraints:@minLength="1", This defines the maximum acceptable length of a string that can be stored in a data base. This value should be the smallest "maximum size of a variable length character type" in commonly used DBMSs. This is the maximum size of a VARCHAR2 in Oracle 8. The intended abstract supertype of all user assigned human recognizable contextual name types. There should be no assumption that (interoperable) semantic information will be extracted from the name by a third party. This type of value is generally not guaranteed to be unique and is not a candidate to be replaced by an enumeration. The intended abstract supertype of all locally unique identifiers. The value is not intended to convey any semantic content (e.g., it may be computer generated). The value is only required to be unique within a context in a document (e.g., defined via key and keyref). There is no guarantee that the same data in multiple documents will utilize the same uid value unless enforced by the source of the document (e.g., a document server). Spaces are not allowed. The intended abstract supertype of all comments or remarks intended for human consumption. There should be no assumption that semantics can be extracted from the field by a computer. Neither should there be an assumption that any two humans will interpret the information in the same way (i.e., it may not be interoperable). The intended abstract supertype of all enumerated "types". This abstract type allows the maximum length of a type enumeration to be centrally defined. This type should not be used directly except to derive another type. It should also be used for uncontrolled strings which are candidates to become enumerations at a future date. The intended abstract supertype of all "units of measure". This abstract type allows the maximum length of a UOM enumeration to be centrally defined. This type is abstract in the sense that it should not be used directly except to derive another type. The type of local or permanent reference datum for vertical gravity based (i.e., elevation and vertical depth) and measured depth coordinates within the context of a well. This list includes local points (e.g., kelly bushing) used as a datum and vertical reference datums (e.g., mean sea level). casing flange: A flange affixed to the top of the casing string used to attach production equipment. crown valve derrick floor ground level kelly bushing rotary bushing rotary table sea floor Lowest Astronomical Tide. The lowest tide level over the duration of the National Tidal Datum Epoch (19 years). Mean Sea Level - A tidal datum. The arithmetic mean of hourly heights observed over the National Tidal Datum Epoch (19 years). Mean Higher High Water - A tidal datum. The average of the higher high water height of each tidal day observed over the National Tidal Datum Epoch (19 years). Mean High Water - A tidal datum. The average of all the high water heights observed over the National Tidal Datum Epoch (19 years). Mean Lower Low Water - A tidal datum. The average of the lower low water height of each tidal day observed over the National Tidal Datum Epoch (19 years ). Mean Low Water - A tidal datum. The average of all the low water heights observed over the National Tidal Datum Epoch (19 years). Mean Tide Level - A tidal datum. The arithmetic mean of mean high water and mean low water. Same as half-tide level. kickoff point The value is not known. This value should not be used in normal situations. All reasonable attempts should be made to determine the appropriate value. Use of this value may result in rejection in some situations. The meaning of the endpoint for min/max query parameters on "growing objects". The list of standard values is contained in the PRODML enumValues.xml file. The endpoint of the range is inclusive of the specified range value. hat is, a node index value which matches the specified range value is considered to be within the range. The endpoint of the range is exclusive of the specified range value. That is, a node index value which matches the specified range value is considered to be outside the range. The endpoint of the range may be extended to the first encountered value if an exact value match is not found. That is, if a node index value does not match the specified range value then the next smaller value (on minimum end) or larger value (on maximum end) in the index series should be used as the endpoint. Basically, this concept is designed to support interpolation across an undefined point. The endpoint of the range may be extended to the first encountered value if the interval is overlapped with the index interval. That is, if a node index value does not match the specified range value then the next smaller value (on minimum end) or larger value (on maximum end) in the index series should be used as the endpoint. This concept is designed to select ALL nodes whose index interval overlap with the query range. The value is not known. This value should not be used in normal situations. All reasonable attempts should be made to determine the appropriate value. Use of this value may result in rejection in some situations. Fluids which are injected into a well. The list of standard values is contained in the PRODML enumValues.xml file. The value is not known. This value should not be used in normal situations. All reasonable attempts should be made to determine the appropriate value. Use of this value may result in rejection in some situations. These values represent the state of a WITSML object. Actual data measured or entered at the well site. Model data used for "what if" calculations. A planned object. That is, one which is expected to be executed in the future. The value is not known. This value should not be used in normal situations. All reasonable attempts should be made to determine the appropriate value. Use of this value may result in rejection in some situations. Combinations of standard temperature and pressure. The list of standard values is contained in the PRODML enumValues.xml file. A temperature of zero degrees Centigrade and a pressure of one atmosphere. A temperature of sixty degrees Centigrade and a pressure of one atmosphere. A temperature of fifteen degrees Fahrenheit and a pressure of one atmosphere. The value is not known. This value should not be used in normal situations. All reasonable attempts should be made to determine the appropriate value. Use of this value may result in rejection in some situations. A reason for running a well test. The list of standard values is contained in the PRODML enumValues.xml file. The value is not known. This value should not be used in normal situations. All reasonable attempts should be made to determine the appropriate value. Use of this value may result in rejection in some situations. A timestamp value used for min/max query parameters related to "growing objects". The meaning of the endpoint of an interval can be modified by the endpoint attribute. The element value for which a match is requested. The default is "inclusive". Values of "true" (or "1") and "false" (or "0"). A date with the time of day and an optional time zone. While the time zone is optional, it is strongly advised that the zone always be specified in each date time value. A reference to a name in another node of the xml hierachy. This value represents a foreign key from one element to another. The element value for which a match is requested. A reference to the unique identifier (uid attribute) in the node referenced by the name value. This attribute is required within the context of a WITSML server. A reference to a wellDatum in the current well. This value must match the uid value in a WellDatum. This value represents a foreign key from one element to another. This is an exception to the convention that a foreign key must utilize both a human contextual name and a uid value. For messages outside the context of a server then this value will commonly match the value of the name of the wellDatum (e.g., 'KB') if uids are not not used in that context. This was a compromise in order to allow the coordinate structures to be simple and still be usable both within the context of a server and outside the context of a server. A user assigned human recognizable contextual name of something. There should be no assumption that (interoperable) semantic information will be extracted from the name by a third party. This type of value is generally not guaranteed to be unique and is not a candidate to be replaced by an enumeration. A comment or remark intended for human consumption. There should be no assumption that semantics can be extracted from this field by a computer. Neither should there be an assumption that any two humans will interpret the information in the same way (i.e., it may not be interoperable). A community assigned human recognizable name. This type of value is intended to be unique and is generally a candidate to be constrained to an enumerated list. A locally unique identifier. The value is not intended to convey any semantic content (e.g., it may be computer generated). The value is only required to be unique within a context in a document (e.g., defined via key and keyref). There is no guarantee that the same data in multiple documents will utilize the same uid value unless enforced by the source of the document (e.g., a document server). A reference to the unique identifier of another element. This value represents a foreign key from one element to another. The value should match the value of an attribute of type uidString. The version of the schema. The first three levels are fixed. The fourth level can vary to represent the constraints defined in enumerations and XML loader files. The name of something within a naming system. The element value for which a match is requested. The naming system within the name is (hopefully) unique. The name of something within a mandatory naming system with an optional code. The element value for which a match is requested. The naming system within the name is unique. constraints:@use="required" A unique (short) code associated with the name. A measured depth coordinate in a wellbore. Positive moving from the reference datum toward the bottomhole. All coordinates with the same datum (and same uom) can be considered to be in the same Coordinate Reference System and are thus directly comparable. The element value for which a match is requested. The unit of measure of the quantity value. constraints:@use="required" A pointer to the reference datum for this coordinate value as defined in WellDatum. This value is assumed to match the uid value in a WellDatum. If not given then the default WellDatum must be assumed. The units of measure that are valid for measured depths in a wellbore. meter International Foot US Survey Foot A vertical (gravity based) elevation coordinate within the context of a well. Positive moving upward from the reference datum. All coordinates with the same datum (and same uom) can be considered to be in the same Coordinate Reference System and are thus directly comparable. The element value for which a match is requested. The unit of measure of the quantity value. If not given then the default unit of measure of the explicitly or implicitly given datum must be assumed. constraints:@use="required" A pointer to the reference datum for this coordinate value as defined in WellDatum. If not given then the default WellDatum must be assumed. The units of measure that are valid for vertical gravity based coordinates (i.e., elevation or vertical depth) within the context of a well. meter International Foot US Survey Foot British Foot 1865 The element value for which a match is requested. constraints:@use="required" The element value for which a match is requested. constraints:@use="required" The element value for which a match is requested. constraints:@use="required" The element value for which a match is requested. constraints:@use="required" The element value for which a match is requested. constraints:@use="required" The element value for which a match is requested. constraints:@use="required" The element value for which a match is requested. constraints:@use="required" The element value for which a match is requested. constraints:@use="required" The element value for which a match is requested. constraints:@use="required" The element value for which a match is requested. constraints:@use="required"