Petroleum Industry Data Dictionary (PIDD) Web Application
(Work-in-Progress, August 2004, v0.3)
User Instructions

Introduction

This is the work-in-progress Web application for the Petroleum Industry Data Dictionary (P.I.D.D Dictionary). 

The Dictionary was developed by a collaborative effort that began in the early 90's. Active work continued into the late 90's. The result of this work is over 7000 dictionary entries of data element terms, data object names, and other information items. 

A standing, volunteer organization managed the creation of most of the Dictionary content. The PIDX REGS User Group contributed most of the several hundred new entries made after '95. Note: Quite a few entries that do not follow the Dictionary guidelines due, probably, to unawareness of the guidelines.

The Dictionary existed physically as a database with one table of over 20 columns and over 7200 rows. It has been available on the PIDX Web site as a series of lists of Dictionary entries by the initial letter of the Dictionary Term. The listing presents the Term and the Definition only. A diskette of the physical database is available for purchase.

The Dictionary Work Group is working to refresh and extend the Dictionary so that the Dictionary remains an integral player in the data and information context of the industry. The following tasks are being carried out:

  1. Existing and newly created data definition usage sets are being cross-referenced to the Dictionary. Data definition sets includes: reference value standards (also known as code lists, enumerations, etc.), EDI transaction sets, XML DTD and schema standards, and data models.

  2. Besides the two kinds of entries originally intended: data elements and data objects, several other kinds of defined things have been and will continue to be contained in the Dictionary. These may include data values, business processes or activities, material and equipment classes, and more. 

This work-in-progress Web application is an effort to improve the ability to access and use the Dictionary. The application provides a keyword match query on both Terms and Definitions. It also presents the results of definition usage set mappings with the Dictionary. 

On behalf of the Dictionary work group and the sponsoring organizations, you are invited to become knowledgeable and involved as a user and a contributor to this valuable work effort. For further information, contact Alan Doniger, Dictionary Work Group Chair (+1 713 267 5124, Doniger@POSC.org).   

For offline work, downloads can be made of snapshots of universal dictionary definition queries and of a sample usage set mapping. 

The Web Application presents the following main menu:

01. Dictionary Definition Query
Select by searching on a string.
Link to Query 12. Dictionary Term Cross-Reference List.
Link to Query 13. Dictionary Thread History List.
02. Usage Set Id Query
Select by searching on a string.
Optional link to Query 11. Usage Set Item List.
04. Dictionary Thread Query
Select by searching on a thread id.
Optional link to Query 12. Dictionary Term Cross-Reference List.
05. Usage Item Cross Reference Query
Select by searching on a usage item name.

01. Dictionary Definition Query. This query acts on the Dictionary definitions and terms through keyword searches. 

Note that all previously defined entries are presented with suitable null/default values for new dictionary attributes, such Context and Version. 

The maximum number of entries returned from a single query is 200. 

By default, only approved entries are retrieved, Optionally, draft entries may also be retrieved.

By default, only the current versions of entries are retrieved. Optionally, all versions may be retrieved.  

Results may be presented in a tabular form or a report form. 

The results display the following Dictionary attributes for each entry/version:

  • Internal Id - a unique internal key assigned not intended to be used in any external references or documents.
  • Term - the word or phrase being defined. 
  • Definition - the definition associated with the Term.
  • Current Version - a sequential number, beginning at zero, indicating the number of additions threaded onto the original entry.
  • Date - the date on which the entry was recorded in the Dictionary. If historically unknown, an approximate date appears.
  • Type - the general kind of 'thing' represented by the Term and Definition. 'Class' entries were known as 'GLOSSARY' entries previously. 
  • Status - the entry's input, review, and approval status. The values are: original (for entries made before 2002), draft, active, rescinded, and deprecated. 
  • Context Id - the entry's contextual constraints, if any. Guidelines for using this new capability will be defined probably based on similar work being done elsewhere.
  • Thread Id - a universally unique identifier assigned to new (Version = 0) entries and carried forward to all future Versions. 
  • Successor Version - the version number of the successor entry, if any, otherwise, zero. 
  • User - the dictionary work group representative responsible for recording the entry, or 'system' for pre-existing entries.
  • Comment - a word or phrase to explain the reason for creating the entry, or 'system' for pre-existing entries. 

Two extended lists can be displayed for an entry:

12. Dictionary Term Cross-Reference List. This query lists the mapped usages of the selected entry in definition usage sets. 

The results display the following for each cross-referenced Usage Item:

  • Set Id - a unique identifier for a Usage Set. 
  • Path - the hierarchical path in the Usage Set to reach this item, if applicable.
  • Type - the generic classification of the item 
  • Tag - the local, immediate name of this item
  • Dictionary Mappings: (one or both may apply)
    • Class Name and Version - used for class items and split class-property cross references for element items
    • Term/Property Name and Version - used for element items and split class-property cross references for element items.
  • Definition - the local definition of this item, if any. (There should not be any significant conflict between the local definition and the Dictionary definition.)
  • Item id - a unique internal key for the item.
  • Physical Characteristics: There is provision for a number of physical item definition characteristics.

13. Dictionary Thread History List.  This query lists all of the versions of the selected entry. 

02. Usage Set Id Query. This query lists the definition usage sets that have been mapped with the Dictionary. 

Note that a number of usage sets were derived from the previous form of the Dictionary. These are being validated and may be updated or removed. 

11. Usage Set Item List. This query lists the items in the selected Usage Set.

04. Dictionary Thread Query. This query lists the definition entry corresponding to the universally unique Dictionary Thread Id.

12. Dictionary Term Cross-Reference List. This query lists the definition entry corresponding to the entered Thread Id.

05. Usage Item Cross Reference Query. This query lists definitions entries corresponding to a local data element name (Item Tag) defined in one or more cross referenced Usage Sets.