Skip to content

Changes

Page history
Update M19 Release Notes with Data Definitions' contributions authored by Thomas Gehrmann [InvitedE]'s avatar Thomas Gehrmann [InvitedE]
Show whitespace changes
Inline Side-by-side
M19-Release-Notes.md
View page @ a748168a
......@@ -24,14 +24,89 @@ TBD
### Data Definition
1. **Major topic-1**<br>
TBA:
1. TBA
2. TBA
7. **Major topic-2**<br>
1. TBA
2. TBA
#### M19 (v0.22.0) Changes
1. **Data Quality**<br>
Feedback via practical use of `DataQuality:1.*.*` caused a major revision of the data quality related entities.
The amount of change justified a clean start with a breaking change `work-product-component--DataQuality:2.0.0`. The
new record captures evaluated rules _and_ their assessment states, as well as the scores by quality dimension:
1. [DataQuality:2.0.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/work-product-component/DataQuality.2.0.0.md)
2. referring to better named reference
data [DataQualityRule](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/reference-data/DataQualityRule.1.0.0.md)
and [DataQualityRuleSet](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/reference-data/DataQualityRuleSet.1.0.0.md);
the latter can now aggregate rules and other rule sets and is used by technical assurance.
3. This is
the [first major version change](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/Guides/MigrationGuides/M19/work-product-component--DataQuality.1.3.0.md),
which can be used to train more complex record upgrades.
A [simplistic JOLT transformation is provided](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/ReferenceValues/Manifests/reference-data/LOCAL/SchemaUpgradeSpecification.1.0.0.json#L6852-6889)
but needs adaptation to actual usage patterns for DataQuality:1.*.*.
2. **TechnicalAssurance**<br>
The TechnicalAssurance records can now be associated with the DataQualityRuleSet (see above) passing/failing the
acceptable and unacceptable usages. Quality assessment evidence can be supplied by a relationship to a DataQuality
record. In addition to the extensions, the property naming has been improved. The migration instructions are recorded
in [this report](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/Guides/MigrationGuides/M19/abstract--AbstractTechnicalAssurance.1.1.0.md). <br>
The new version of the schema
fragment [AbstractTechnicalAssurance:1.2.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/abstract/AbstractTechnicalAssurance.1.2.0.md)
is included by:
1. [AbstractMaster:1.2.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/abstract/AbstractMaster.1.2.0.md),
which is included by **_all 52 master-data types_** existing in M18 and earlier.
2. [AbstractWPCGroupType:1.2.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/abstract/AbstractWPCGroupType.1.2.0.md),
which is included by **_all 68 work-product-component types_** existing in M18 and earlier.
3. **Column Based Tables**<br>
The column definition for work-product-component--ColumnBasedTable:1.2.0 and AbstractColumnBasedTable:1.1.0 has completed by a modification of [AbstractReferencePropertyType:1.1.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/Guides/MigrationGuides/M19/abstract--AbstractReferencePropertyType.1.1.0.md): A column unit of measure context can be defined via `UnitOfMeasureID`, and the column name in the dataset can be associated with the column definition in the work-product-component record. The impacted types are:
1. [AbstractColumnBasedTable:1.1.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/abstract/AbstractColumnBasedTable.1.1.0.md)
2. [work-product-component--ColumnBasedTable:1.2.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/work-product-component/ColumnBasedTable.1.2.0.md)
3. [work-product-component--WellboreIntervalSet:1.2.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/work-product-component/WellboreIntervalSet.1.2.0.md) (including AbstractColumnBasedTable:1.1.0)
4. **Reservoir Management** <br>
The previous experimental relationship targets Reservoir:0.0.0 and ReservoirSegment:0.0.0 are replaced by 'proper'
1. [master-data--Reservoir:1.0.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/master-data/Reservoir.1.0.0.md)
2. [master-data--ReservoirSegment:1.0.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/master-data/ReservoirSegment.0.0.0.md)
<br>And the following work-product-component types:
3. [work-product-component--ReservoirModelScenario:1.0.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/work-product-component/ReservoirModelScenario.1.0.0.md)
4. [work-product-component--ReservoirEstimatedVolumes:1.0.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/work-product-component/ReservoirEstimatedVolumes.1.0.0.md)
<br>The extensions of AbstractReferencePropertyType:1.2.0 were used in the [WorkedExample for ReservoirEstimatedVolumes](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/Examples/WorkedExamples/ReservoirManagement#column-definition)
5. 3 Reservoir Management specific reference value lists have been provided.
5. **Minor Extensions**
1. **Seismic Datasets** can now declare their individual numeric resolution, e.g. [dataset--FileCollection.SEGY:1.1.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/Guides/MigrationGuides/M19/dataset--FileCollection.SEGY.1.0.0.md), and compression state where applicable, e.g. [dataset--FileCollection.Bluware.OpenVDS:1.1.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/Guides/MigrationGuides/M19/dataset--FileCollection.Bluware.OpenVDS.1.0.0.md).
2. **AbstractInterpretation** got extended by `MeanPossibleAge`, effectively adding this to 15 interpretation specializations.
3. **Well Domain**: corrections to [work-product-component--FormationIntegrityTest:1.2.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/work-product-component/FormationIntegrityTest.1.2.0.md)
6. **Preferred Schema Version** configurations<br>
A new reference value list
[reference-data--PreferredSchemaVersion:1.0.0](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/E-R/reference-data/PreferredSchemaVersion.1.0.0.md)
is made available, which allows platform owners and operators to 'control' the schema version adoption by setting
guidelines: minimum required schema version, maximum permitted and preferred version. At the moment, there is no
documented usage. The reference value list is under LOCAL governance, thus under owner/operator control. OSDU
will default the list with the first and latest major schema versions. The code for the records is defined via
the kind, stripped by the minor and patch version numbers, e.g. `osdu:wks:master-data--Wellbore:1.`. The current
OSDU defaults are provided
in
this [manifest](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/ReferenceValues/Manifests/reference-data/LOCAL/PreferredSchemaVersion.1.0.0.json#L2104-2133).
See also the Schema Usage
Guide [Appendix D.5 Schema Version Management/Configuration](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/Guides/Chapters/93-OSDU-Schemas.md#appendix-d5-schema-version-managementconfiguration).
#### M21 (v0.24.0) Change Warning
OSDU uses group-type classifications for the entities. The definitions for the group-types are provided in
the [Schema Usage Guide](https://community.opengroup.org/osdu/data/data-definitions/-/blob/v0.22.0/Guides/Chapters/02-GroupType.md#2-group-type).
Over time some of the entities' group-type classifications have been challenged. The following types appear in the wrong
group-type:
1. Reports are seen as non-tangible state descriptions/snapshots
1. master-data--FluidsReport proposed migrated to &rarr; work-product-component--WellFluidsReport.
2. master-data--OperationsReport proposed migrated to &rarr; work-product-component--WellOperationsReport.
2. Tubulars - when exchanged they are often transported using datasets/files, but the data themselves are tangible and
associated with an investment making them master-data.
1. work-product-component--TubularAssembly proposed migrated to &rarr; master-data--TubularAssembly.
2. work-product-component--TubularComponent proposed migrated to &rarr; master-data--TubularComponent.
3. work-product-component--TubularExternalComponent proposed migrated to &rarr;
master-data--TubularExternalComponent.
Obviously, this will impact operators who have ingested a large number of such data/records. This advance notice is
intended to prepare for this change and/or engage with data definitions, specifically
the [Well Delivery work-stream](https://opensdu.slack.com/archives/CL7MK8KMW), to influence the implementation of the
change.
---
### Core and Helper Services
- Search Service - [Indexer schema augmentation](https://community.opengroup.org/osdu/platform/system/indexer-service/-/issues/81)
......