GitLab

Closes #80 (closed)

DDSC commit 1b05145a18bde08ef16900909cb026fe0b1e8a6e

Summary of changes

The links refer to the OSDU member GitLab.

1. VirtualProperties
   Based on the community search-service ADR #69 the schemas for storable records were extended to carry a JSON extension tag defining virtual properties to resolve the following two challenges:
   1. Ambiguous Location information
      A number of schemas offer more than one property with map coordinates. The data.VirtualProperties.DefaultLocation list disambiguates the locations by providing a priority. This way a deterministic map location be achieved.
   2. Default Name
      There is no standard name property for all schemas. While Name is present in most of the OSDU schemas there are notable exceptions, e.g. Well and Wellbore with FacilityName instead. The data.VirtualProperties.DefaultName definition refers to where the default name property is to be derived from.
2. VirtualProperties Support
   
   1. The script to create new proposal workbooks or proposal workbooks from existing schemas has been modified to populate a new fixed sheet 'VirtualPropertiesSpecification'.
   2. The script to parse schema proposals to JSON schema definitions has been updated to create the data block under the x-osdu-virtual-properties tag.
   3. An overview report about the VirtualProperties has been provided in VirtualPropertiesReport.md.
3. Indexing Hint Changes
   The following schema fragments were changed such that queries into arrays of objects frequently used return more scoped responses. This causes a massive re-indexing of existing records since virtually all storable osdu kinds include the following fragments - see more details in the following Migration Guides:
   1. osdu:wks:AbstractFacility:1.0.0
   2. osdu:wks:AbstractMaster:1.0.0
   3. osdu:wks:AbstractProject:1.0.0
   4. osdu:wks:AbstractReferenceType:1.0.0
   5. osdu:wks:AbstractWorkProductComponent:1.0.0
4. LogCurveType and LogCurveFamily augmented with explicit relationships; the associated OSDU reference value manifests for LogCurveType and LogCurveFamily are updated with the new relationships.
   
   1. LogCurveType:1.1.0 records now relate to other reference-data types, such as:
      1. → PropertyType, via AbstractPropertyType data.PropertyType.PropertyTypeID and data.PropertyType.Name
      2. → UnitQuantity, via data.UnitQuantityID
      3. → StandardsOrganisation via data.AcquisitionCompanyID
   2. LogCurveFamily:1.1.0
      1. → PropertyType, via AbstractPropertyType data.PropertyType.PropertyTypeID and data.PropertyType.Name
      2. → UnitQuantity, via data.UnitQuantityID