diff --git a/site/docs/features/reference-data-management/consistent-valid-values.svg b/site/docs/features/reference-data-management/consistent-valid-values.svg new file mode 100644 index 0000000000..5bf64b1f02 --- /dev/null +++ b/site/docs/features/reference-data-management/consistent-valid-values.svg @@ -0,0 +1,4 @@ + + + +
«entity»
ValidValueDefinition
«entity»...
consistentValue
consistentVa...
consistentValue
consistentValue
«relationship»
ConsistentValidValues
«relationship»...

*
*
*
*
Text is not SVG - cannot display
\ No newline at end of file diff --git a/site/docs/features/reference-data-management/cross-field-validation-example.svg b/site/docs/features/reference-data-management/cross-field-validation-example.svg new file mode 100644 index 0000000000..29247258dd --- /dev/null +++ b/site/docs/features/reference-data-management/cross-field-validation-example.svg @@ -0,0 +1,4 @@ + + + +
fileExtension
fileExtension
pqt
pqt
fileType
fileType
Parquet File
Parquet File
deployedImplementationType
deployedImplementationType
Data File
Data File
Consistent Valid Values
Consistent Valid Values
Valid Value Sets
Valid Value Sets
Valid Values
Valid Values
Text is not SVG - cannot display
\ No newline at end of file diff --git a/site/docs/features/reference-data-management/reference-data-management.drawio b/site/docs/features/reference-data-management/reference-data-management.drawio index 54482a718a..48067a3aee 100644 --- a/site/docs/features/reference-data-management/reference-data-management.drawio +++ b/site/docs/features/reference-data-management/reference-data-management.drawio @@ -1,4 +1,4 @@ - + @@ -109,7 +109,7 @@ - + @@ -228,7 +228,7 @@ - + @@ -247,7 +247,7 @@ - + @@ -1017,4 +1017,132 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/site/docs/types/5/0545-Reference-Data.md b/site/docs/types/5/0545-Reference-Data.md index 0599cd8765..b21e53c7bf 100644 --- a/site/docs/types/5/0545-Reference-Data.md +++ b/site/docs/types/5/0545-Reference-Data.md @@ -16,7 +16,7 @@ Valid values can also be used as tags to indicate that an element has a particul ![UML](0545-Reference-Data.svg) -## ValidValueDefinition +## ValidValueDefinition entity Software often uses code values to store properties about a person, place, object or activity. Each code value is mapped to one or more strings when its value is to be displayed. This mapping is stored in a *code table*. @@ -27,7 +27,7 @@ The *ValidValueDefinition* can be used to represent a single code value along wi ![Valid Value Definition](/features/reference-data-management/valid-value-definition.svg) -## ValidValuesSet and ValidValueMember +## ValidValuesSet entity and ValidValueMember relationship Code tables group related code values together to act as a look-up table. The *ValidValuesSet* and the *ValidValueMember* relationship can be used to organize *ValidValueDefinition*s. @@ -37,13 +37,13 @@ Some code values need to be organized into a hierarchy. The *ValidValueMember* ![Hierarchical information codes](/features/reference-data-management/hierarchical-information-codes.svg) -## ValidValuesAssignment +## ValidValuesAssignment relationship Often the values in a data field need to be restricted to a set of valid values (or possibly a single valid value). The *ValidValuesAssignment* creates a link between the metadata element for the data field (typically a [GlossaryTerm](/types/3/0330-Terms) or a [SchemaElement](/types/5/0501-Schema-Elements)) and the appropriate valid values. ![Valid Values Assignment](/features/reference-data-management/valid-values-assignment.svg) -## ReferenceValueAssignment +## ReferenceValueAssignment relationship Valid values can be used to tag other metadata elements to make them easy to find. @@ -54,7 +54,7 @@ This tagging is done using the *ReferenceValueAssignment* relationship. ![Reference Value Assignment](/features/reference-data-management/reference-value-assignment.svg) -## ValidValuesMapping +## ValidValuesMapping relationship Valid values can come from many sources (such as standards, regulations, industry definitions etc.) and often there are equivalences between them. It is useful to be able to identify the corresponding values. @@ -64,9 +64,17 @@ The *ValidValuesMapping* relationship allows this mapping to be captured. ![Valid Values Mapping](/features/reference-data-management/valid-values-mapping.svg) +## ConsistentValidValues relationship +The *ConsistentValidValues* relationship is used for cross-field validation. It shows how the values in one valid value set should/could be used so that they are consistent with the values used in another valid values set. -## ValidValuesImplementation and ReferenceData +![Valid Values Mapping Example](/features/reference-data-management/cross-field-validation-example.svg) + +The *ConsistentValidValues* relationship allows this mapping to be captured. + +![Consistent Valid Values](/features/reference-data-management/consistent-valid-values.svg) + +## ValidValuesImplementation relationship and ReferenceData classification The implementation of a code table is represented in open metadata using an [Asset](/types/0/0010-Base-Model). This asset can be tagged as containing valid values using the *ReferenceData* classification. diff --git a/site/docs/types/5/0545-Reference-Data.svg b/site/docs/types/5/0545-Reference-Data.svg index 42374870b6..6e18d0353b 100644 --- a/site/docs/types/5/0545-Reference-Data.svg +++ b/site/docs/types/5/0545-Reference-Data.svg @@ -1,4 +1,4 @@ -
0545 - Reference Data
0545 - Reference Data
«entity»
ValidValueDefinition
«entity»...
name : string
description : string
category : string
usage : string
scope : string
preferredValue : string
isDeprecated : boolean
name : string...
«entity»
Referenceable
«entity»...
«entity»
Asset
«entity»...
«relationship»
ValidValuesImplementation
«relationship»...
symbolicName : string
implementationValue : string
additionalValues : map<string, string>
symbolicName : string...
*
*
*
*
validValues
validValues
validValuesImplementation
validValuesImplementation
«classification»
ReferenceData
«classification»...
«entity»
ValidValuesSet
«entity»...
«relationship»
ValidValuesAssignment
«relationship»...
strictRequirement : boolean
strictRequirement : boolean
memberOfValidValuesSet
memberOfValidVa...
validValuesSet
validValuesSet
validValuesConsumer
validValuesCons...
validValues
validValues
*
*
*
*
*
*
0..1
0..1
«relationship»
ValidValueMember
«relationship»...
isDefaultValue : boolean
isDefaultValue : boolean
matchingValue
matchingValue
matchingValue
matchingValue
«relationship»
ValidValuesMapping
«relationship»...
associationDescription : string
confidence : int
steward : string
stewardTypeName : string
stewardPropertyName : string
notes : string
associationDescription : string...
*
*
*
*
*
*
*
*
«relationship»
ReferenceValueAssignment
«relationship»...
attributeName : string
confidence : int
steward : string
stewardTypeName : string
stewardPropertyName : string
notes : string
attributeName : string...
assignedItem
assignedItem
referenceValue
referenceVal...
Text is not SVG - cannot display
\ No newline at end of file +
0545 - Reference Data
0545 - Reference Data
«entity»
ValidValueDefinition
«entity»...
name : string
description : string
category : string
usage : string
scope : string
preferredValue : string
isDeprecated : boolean
name : string...
«entity»
Referenceable
«entity»...
«entity»
Asset
«entity»...
«relationship»
ValidValuesImplementation
«relationship»...
symbolicName : string
implementationValue : string
additionalValues : map<string, string>
symbolicName : string...
*
*
*
*
validValues
validValues
validValuesImplementation
validValuesImplementation
«classification»
ReferenceData
«classification»...
«entity»
ValidValuesSet
«entity»...
«relationship»
ValidValuesAssignment
«relationship»...
strictRequirement : boolean
strictRequirement : boolean
memberOfValidValuesSet
memberOfValidVa...
validValuesSet
validValuesSet
validValuesConsumer
validValuesCons...
validValues
validValues
*
*
*
*
*
*
0..1
0..1
«relationship»
ValidValueMember
«relationship»...
isDefaultValue : boolean
isDefaultValue : boolean
matchingValue
matchingValue
matchingValue
matchingValue
«relationship»
ValidValuesMapping
«relationship»...
associationDescription : string
confidence : int
steward : string
stewardTypeName : string
stewardPropertyName : string
notes : string
associationDescription : string...
*
*
*
*
*
*
*
*
«relationship»
ReferenceValueAssignment
«relationship»...
attributeName : string
confidence : int
steward : string
stewardTypeName : string
stewardPropertyName : string
notes : string
attributeName : string...
assignedItem
assignedItem
referenceValue
referenceVal...
consistentValue
consistentVa...
consistentValue
consistentValue
«relationship»
ConsistentValidValues
«relationship»...

*
*
*
*
Text is not SVG - cannot display
\ No newline at end of file diff --git a/site/docs/types/5/area-5-models-and-schema.drawio b/site/docs/types/5/area-5-models-and-schema.drawio index fc273f964f..cd95e3df25 100644 --- a/site/docs/types/5/area-5-models-and-schema.drawio +++ b/site/docs/types/5/area-5-models-and-schema.drawio @@ -1,4 +1,4 @@ - + @@ -2711,7 +2711,7 @@ - + @@ -2727,16 +2727,16 @@ - + - + - + @@ -2759,14 +2759,14 @@ - + - + - + @@ -2784,7 +2784,7 @@ - + @@ -2796,7 +2796,7 @@ - + @@ -2805,7 +2805,7 @@ - + @@ -2814,37 +2814,43 @@ - + - - + + + + + + + - + - + - + - + - + + - + - + - + @@ -2888,6 +2894,45 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +