XML Component Documentation

Revision History

History of this document:

Initial Version: 2001-11-18

Initial Publication: 2002-02-20

Added Links: 2002-03-12

Altered Well Information: 2002-03-19

Changed MeasurementType to QuantityType in units: 2002-05-02

R2 of the Geodetics: 2002-05-24

Change status of units, identification: 2002-06-04

Added Version 1.1 of the Well Information: 2002-08-07

Added Well Test and Well Report: 2002-08-08

Documentation for Version 1.0: 2002-10-03

Separated and archived this page.

POSC Disclaimer: All files distributed by POSC are subject to the POSC Software License Agreement with the following modification. The definition of "Software Product" in section 1 is modified to include the distributed files, and all files referenced or included under the distributed files.

Archived Version

This page contains information that is not current. The most current documentation is accessible through the main index page.

POSC has been developing components and datatypes for use in XML. The purpose of these components is threefold:

To achieve consistency among XML applications.
To allow for easier development of applications.
To allow a simpler review process.

It is hoped that the presentation of the smaller bits of information (the components) will make it easier for users to understand the XML and to make comments that will meet their needs.

This document is developed to serve as an index to the components. The components will be available as XML schema documents (in a zipped file), and as MS Word documents.

Meeting the Goals

The three goals mentioned above are met at different levels. At the lowest level are the core components (to use OASIS terminology). An example of a core component would be the quantityType datatype, which is discussed in the Units Documentation. The main goal of this document is how to handle units of measure, particularly with their use in quantities, which require a value and a unit of measure.

The second level is to develop more complex datatypes. An example of this is the location component, which has a common way of giving locations. Whenever it is necessary to give the location of an object, this component can be inserted, and will give a common way of expressing that component. The location component is documented in the Location Documentation document.

The next level up is business objects. These are collections of information that go together in a business sense. These are components that occur in many different transactions. The purpose of the POSC project is to develop these components, and use them in a consistent manner throughout. Examples of business components would be a Business Associate, a Basic Well Information, and a Binset description.

It should be noted that these components use each other. For example, the Basic Well Information uses the Business Associate when referring to the Operator. It also uses the location component when giving the surface location of the well, and when giving the bottomhole location. Of course, all of them use the quantityType datatype in many places.

In addition to a consistent set of components themselves, we have also developed a set of guidelines for developing the components. These guidelines are given in a Guidelines Document.

Status of the Components

All of the components and the documentation documents are work in progress. The purpose of exposing them in this state is to get comments and make changes before they become embedded into applications. It is also hoped that potential users will tell us whether the information captured in the components is complete and properly captured. The table below will inform you when the component is stable.

Note: The version 1.0 collection has been saved and documented. Click here to go to the Version 1.0 Table

Component	Description	Downloads	Status
Units of Measure	Definition of the quantityType datatype, and related datatypes. Pattern of usage for units of measure. The pattern is also usable for other referenceable objects. Also included are a sample XML units dictionary, and an XSLT example that references the dictionary.	[Units Document] [Units Recommendations] [Schemas (zip)] [XSLT Sample (zip)] [Units Dictionary]	Quantity Type frozen. Dictionary definition stable, not frozen.
Identification	A standard component for identifying a business object by name, along with aliases for the business object. This is incorporated into most business objects.	[Identification Doc] [Schemas (zipped)]	Version is frozen.
Location	Description of four location datatypes: Geopolitical, Onshore (legal description), Offshore, and Survey. Used in other components.	[Location Document] [Schemas (zipped)]	changeable. extendable.
Geodetics	OpenGIS specification of coordinate reference systems and coordinate transformations extracted from GML (geographic markup language) and put into POSC components. Based on the "frozen" version GML 3.0, a new document was developed to capture some of these changes and to give the differences between the POSC geodetics and GML 3.0 Geodetics portion.	[Geodetics R1 Document] [Geodetics R2 Document] [Schemas R2 (zipped)] [Sample XML (R2)]	stable, not frozen.
Document Header	A standard set of information for a document header, including audit trail, security information, and other metadata.	[Document Info] [Schemas (zipped)]	stable, not frozen.
Business Associate	Information about companies and people, including contact information.	[Business Assoc] [Schemas (zipped)]	open discussion
Well Information 1.0	Basic information about a well, that should be appropriate whenever a well is encoded into XML. This component is very general. It is intended that it will be restricted for particular uses.	[Well Info Document] [Schemas (zipped)]	Frozen.
Well Information 1.1	The Well Information XML 1.0 was frozen. This is the 1.1 version. The differences are not major. They have been added to more fully meet the needs of users.	[Well Info 1.1 Document] [Schemas (zipped)]	stable, not frozen.
Binset	Conversion of GeophysicalML into schema, with alteration to fit present guidelines. This captures the UKOOA P6/98 standard.	[Binset Document] [Schemas (zipped)]	open discussion.
Well Test	A module for reporting a well test. Geared for regulatory reports.	[Well Test Document] [Schemas (zipped)]	open discussion.
Production Report	Two modules. One for monthly reporting, the other for annual. This is geared for regulatory reports.	[Well Report Document] [Schemas (zipped)]	open discussion.
Formation Picks	A standard way of giving formation picks - names and locations.	[Formation Document] [Schemas (zipped)]	open discussion.
XML Guidelines	A set of guidelines and principles that POSC is developing to control the generation of schema and schema components.	[Guidelines Document]	open discussion.
Model Driven Schemas	A set of guidelines and principles that POSC is developing for the conversion of data models into schemas.	[MDS Document]	open discussion.