Energistics RESQML v1.1 Data Schema Files

This file and all of the files associated with this version of the RESQML Data Schema can be downloaded via a Zip file. This document describes the file content of folder ./resqml_v1.0.0_data/ in the zip structure. Folder ./abstract_v1.0/ contains a required abstract schema which is used across multiple Energistics domains.

File ./doc/RESQML_schema_overview.html represents the browsable overview documentation.

Normative Files

The normative data schema specification consists of the following files.

• ./xsd_schemas/*.xsd

and the content of files:

• ./ancillary/enumValuesResqml.xml [RESQML standard instance values (enumeration loader file). The standard values have been copied into the typ_catalogResqml.xsd files but this file contains other meta data about the values such as what units of measure are allowed for each property kind.]

This schema is dependent on three other schemas:

• The schema files assume that the Energistics abstract schema is copied into the proper relative folder structure. The zip file will include a copy of the abstract schema in the proper location.
• The schema files assume that the Dublin Core schema is copied into the proper relative folder structure. The zip file will include a profiled version of the Dublin Core schema in the proper location. See the comments in the profiled schema for a list of changes. The primary purpose of the profiled schema is for code generation so that unnecessary items are not included in the proxy. Any XML which validates against the profiled schema will also validate against the normative Dublin Core schema.
• The schema files assume that a copy of the GML v3.2.1 schema is copied into the proper relative folder structure. The zip file will include a profiled version of the GML schema in the proper location. See the comments in the profiled schema for a list of changes. The primary purpose of the profiled schema is for code generation so that unnecessary items are not included in the proxy. Any XML which validates against the profiled schema will also validate against the normative GML schema.

Variant Schemas

The following files represent generated variants of the normative data schemas. These files are only normative when used within the context of a web service. The PRODML GDA should use the read schemas while the WITSML API will use the read, write and update schemas.

• ./generated_read_schemas/*.xsd
• ./generated_write_schemas/*.xsd
• ./generated_update_schemas/*.xsd
• ./generated_delete_schemas/*.xsd

Read Schemas

The generated read schema files are a copy of the normative files except that all elements and attributes are optional. Just as in SQL, mandatory data is not required to be requested. If used within a WITSML web service, these schema files must represent the XMLout response from the WITSML WMLS_GetFromStore method.

Write Schemas

The generated write schema files are a copy of the normative files except that some unique identifier attributes have had their optionality changed. If used within a WITSML web service, these schema files must represent the XMLin input to the WITSML WMLS_AddToStore method.

Update Schemas

The generated update schema files are a copy of the normative files with all elements and attributes optional except that all unique identifier attributes and uom attributes are mandatory. If used within a WITSML web service, these schema files must represent the XMLin input to the WITSML WMLS_UpdateInStore method.

Delete Schemas

The generated delete schema files are a copy of the normative files with all elements and attributes optional except that all object and parentage uids are mandatory. If used within a WITSML web service, these schema files must represent the QueryIn input to the WITSML WMLS_DeleteFromStore method.

Non-normative files

The following files are informative and are not part of the normative specification.

• ./index_resqml_schema.html [This file.]
• ./CHANGE_DETAIL_RESQML.TXT [A detailed change history within this release cycle. A change summary is available from the browsable overview.]
• ./doc/*.*
• ./doc/schema/*.html [Represent browsable versions of the ./xsd_schemas/*.xsd files and are referenced from the browsable overview file.]
• ./xml_examples/*.* [An example XML file for each data object. These examples do not represent a best-practice.]
• ./ancillary/RESQML_v1.0_content.xls [A spreadsheet representing the content of the XSD files.]
• ./ancillary/cs_enumValuesResqml.xsd [A schema for the enumValuesResqml file.]
• ./ancillary/enumValuesResqml_spreadsheet.xls [A spreadsheet representing the content of enumValuesResqml.xml]

The following file is not normative but it contains a copy of normative data from the the enumValuesResqml.xml file. This schema file can be used as a substitute for the normative file for the purpose of XML validation of certain information from the enumValuesResqml.xml file.

• ./ancillary/typ_catalog.xsd [A copy of the typ_catalog.xsd file with explicit enumerations from the enumValuesResqml.xml file.]