Section 5. Procedures

1. Priorities

In the mid-90's, a series of types of Dictionary entries was defined in a prioritized list, such that higher priority kinds of definitions would be addressed sooner than others. It is not know whether this guidelines was used or useful. It is presented here in a form relevant for current circumstances for consideration pending a decision to keep it, further modify it, or eliminate it.

1. Definitions from Groups working on PIDX or POSC formal data transfer specification developments.
   Note: POSC was added based on the current Memorandum of Understanding between POSC and PIDX.
   Note: The original limitation of this item to EDI specification development has been removed.

2. Corrections, Additions, etc. from ongoing Dictionary content reviews. 

3. Definitions from formal industry associations' own definition activities.
   Note: Examples cited originally were COPAS and the SPE. 

4. Definitions from formal industry data modeling activities
   Note: Class definitions (data model entities) were given precedence over element definitions (data model attributes).

2. Entries

   1. Usage. An entry is a distinct definition, term name, and associated dictionary attribute values.
      Note: An entry is uniquely identified by a Thread Id and Version Number. The Thread Id is arbitrary but consistent for all entry versions derived from a starting (Version 0) entry. Version Numbers are sequential reflecting the order of entry creation.

   2. Types. Entries may be of the following types: Class, Element, [more to be added]
      Note: Class generally corresponds to Glossary in earlier usage.

3. Term Names

   1. Usage. An entry term name is the required title for an entry and is expected to be the primary way an entry is addressed in human communication.

   2. Uniqueness. The reuse of an entry term name (other than in a successor entry version) is generally not permitted. Correcting a prior error (anticipated to be a rare occurrence) may lead to an exception to this guideline.

   3. Singularity. Term names are entered in singular form, except where a plural word is the normal reference to a single instance.

   4. Compounds. Term names may not include the word AND or the word OR or in any manner suggest a list of alternative or inclusive words or phrases. Consider these invalid Term Names: WELL NAME AND NUMBER, ONSHORE OR OFFSHORE CODE.

   5. Abbreviations and Acronyms. Term names may include abbreviations and acronyms only when these are in common use in relevant industry activities. Such abbreviations and acronyms must be associated with their spelled out equivalents in the entry definition.

   6. Case. Term names are entered in Upper Case letters.

   7. Special Characters. Term names may not contain any special characters, such as / or |. Valid characters are the 26 English (Latin) letters, 10 numerals, and the blank space.
      Note: Possessives should omit the apostrophe, such as DARCYS LAW for Darcy's Law.

4. Definition

   1. Usage. An entry definition is the full expression of the meaning, scope, and semantics of a Dictionary entry. Every entry has a Definition or a direct reference to a definition. Definitions express meaning and/or significance.

   2. Special Characters. An entry definition may contain special characters.

   3. Direct References. An entry definition may be a direct reference to another entry. This is the technique that should be used for entries that are like or related to another where only the referenced entry has an explicit definition. The form of such a definition must be, "SEE " followed by the Term Name of the referenced entry. Alias entries may be handled in this manner. Circular references, in which two entries directly reference each other, are not permitted.  

   4. Supplemental References. An entry definition may contain one or more supplemental references. This is the technique that should be used for entries that are like or related to others where this entry needs a definition to distinguish and enhance it from those referenced. Following the local definition, the form must be, "SEE ALSO" followed by the Term Names of the referenced entries.
      Note: Do not use this technique to refer to examples, rather use the form, "e.g." followed by a list.
      Note: Phrases such as "commonly abbreviated as" or "also referred to as" are not treated as Supplemental References, but are treated as part of the content of the definitions.

   5. Positive Definitions. Definitions should be stated in the positive rather than negative manner. For example, DEFORMED ICE should not be defined as "the antithesis of smooth ice". 

   6. Redundant Definitions. One definition should not be repeated as part of another definition. For example, BOTTOMHOLE PRESSURE DEPTH should be defined as the "measured depth ..." rather than as "The distance along the path of the wellbore ..." depending on the separate definition of MEASURED DEPTH.

   7. Cross-references. Cross references to other terms and their definitions may be included in a definition as long as the referenced entries exist.

   8. Physical System Characteristics. Definitions may not contain, convey, or restrict physical system characteristics, e.g. value range, representation size, character set/subset, etc.

   9. Abbreviations and Acronyms. Definitions may contain abbreviations and acronyms as long as these are followed immediately by full spelling on their first usage within the definition.

   10. Units of Measure. Definitions should not reference specific units of measure (unless the Entry itself is for a unit of measure definition).

   11. Multiple Definitions. Definitions may contain multiple sub-definitions, each introduced by an incremented number, e.g. (1), (2), and (3). 

5. Context

   1. Usage. An entry context is an optional limitation on the applicability of an entry, such as to a single discipline, geographic region, etc.
      Note: This Dictionary attribute was not previously used.

   2. Future Guidelines will add clarity and specificity to this Dictionary attribute.

6. Class Entries

   1. Usage. A Class Entry is an entry that describes something of relevance to the industry in terminology commonly used in the industry. Data values may be associated with instances of a Class through associated Elements. For example, WELL is a class and there are a number of Element entries that may be used to describe features of an instance of a well, such as WELL NAME.

   2. Technology Constructs. Class Entries are generally associated with specific constructs in various specification technologies, such as relational data base design tables, entity relationship data model entities, object model classes, and XML schema elements that have substructures.

   3. Property Qualifiers. Class Entry Term Names should not include Property Qualifier Names as this would tend to transform the entry into an Element Entry, e.g. FORMATION (a Class) + NAME (a Property Qualifier) would become FORMATION NAME (an Element). 

7. Element Entries

   1. Usage. An Element Entry is an entry that describes a descriptive or quantitative characteristic of something of relevance to the industry, i.e. to a Class defined in a Class Entry. Element instances permit the storage of specific values.

   2. Term Names. Element Entry Term Names consist of two parts: an optional Class Name and a Property Name. Property Names consist of two parts: an optional Property Proper Name and a Property Qualifier Name. For example, WELL NAME, WELL SPUD DATE, and REMARK, where WELL is a Class Name; NAME, DATE, and REMARK are Property Qualifiers; and SPUD is a Property Proper Name. A Property Qualifier is required as the last portion of an Element Term Name.

   3. Specific and Generic Class References. The Class may be explicitly stated in the Term Name or may be generic, in which case, no Class is stated in the Term Name.

   4. Class Cross References. An Element Entry definition should not explicitly cross reference the associated Class entry.

8. Property Qualifiers

   1. Usage. A Property Qualifier Entry is an entry that describes a purely generic descriptive or quantitative characteristic applicable to many properties, classes, and contexts. For example, NAME.

9. Punctuation.

   1. Use complete sentences.

   2. Separate sentences with one space.

   3. Direct References are formed by "SEE" followed by one space followed by a capitalized reference term name followed by a period, e.g. "SEE Well Name."

   4. Supplemental References are formed by "SEE ALSO followed by one space followed by a comma separated list of capitalized reference term names followed by a period, e.g. "SEE ALSO Well Name, Wellbore Name."

10. Lists

    1. Compound Words: The following are treated as single words:
       backflow, backwash, baseline, blowby, blowout, boilerhouse, borehole, bottomhole, breakout, buildup, builkhead, bullhead
       checkshot, counterbalance, counterweight, crossline, crossover
       doghouse, dogleg, downdraft, downhole, downstream, downthrouwn, drillstem, downtime, drawdown, drawworks
       falloff, flowline
       groundwater, gunbarrel, guyline
       inflow, inside
       knockout
       leasehold, lockopen, lowcut
       midpoint
       noncompliance
       offset, offshore, offsite, onshore, outside, overbalance, overburden, overfill, overflow, overhead, overload, overpayment, overpressure, overproduction, overriding, oversize
       payload
       rollover
       sandstone, setdown, shutdown, sidetrack, sidewall, stopcock, superheater
       ultrasonic, underbalance, undercut, underfill, underflow, underground, undersaturated, underwater
       wellbore, wellhead, whipline, whipstock, wireline

    2. Property Qualifier List: (to be added)

11. (xxx)