A data domain (domain) refers to a data model, such as student or course, and is defined by the parties responsible for data governance. The data domain defines the model schema and other attributes for that focus. Common examples of data domains are customers, students, employees, parts, and product orders. Data domains are typically created by the Data Governance Steward (DGS).
...
Federated: Federated domains do not store their data in YOUnite but retrieve and update the data on the systems in which it resides. For example, MIS, ERP, or CRM systems. Federated domains require adaptors, metadata, and governance configurations and are covered in detail *TODO: TUTORIAL ON FEDERATED*
Domain Model Schemas
A domain Model Schema refers to the attributes (properties), format, and other metadata that defines how a specific domain should expect to store the data (either in the YOUnite Data Store or Federated), for the purposes of standardizing how data is exchanged between systems. The Data Governance Steward is responsible for configuring and maintaining domain model schemas. A domain model schema is a JSON object describing/defining the properties for the domain's schema. The root node of the model schema is the properties element. See Valid Property Names and Valid Types for ModelSchema Properties below.
...
| property | required | valid values | description |
|---|---|---|---|
name | yes | Must be between 2 to 128 characters long and must start with an alpha character. The | The domain name. Must be unique to the entire YOUnite deployment since domains are typically shared. |
description | no | 0 to 255 characters long. If longer it will be truncated. | A human readable description of the domain. |
zoneUuid | yes | Owning zone's domain UUID | The zone that the domain, the domain's versions, and its data records will be tied to. If this is omitted the caller's current zone will be used. Note that the caller must have permissions to create a domain. |
domainType | no | MDM_DATA_STORE or FEDERATED | The domain type can be either: MDM_DATA_STORE, which is when the domain's data records are stored in YOUnite. This is used when the entire organization is comfortable or mandated to migrate a domain to a single store. MDM_DATA_STORE is optimal for reference data such as a list of states, countries, zip-codes, etc (default). FEDERATED domains do not store their data in YOUnite, but reference and update data on the systems in which it resides. Federated domains require adaptors, metadata, and governance configurations that are covered in detail. |
...
| property | required | valid values | description |
|---|---|---|---|
modelSchema | yes | See Model Schema Properties and Post a Domain below for details. | A JSON model describing the schema for the data domain; it defines the properties that make up the domains schema. The root node of the model schema is the properties element. |
description | no | 0 to 255 characters long. If longer it will be truncated. | A human readable description of the domain version. |
fastDuplicateDetectionProperties | yes | A list of of one or more valid properties for the given domain version. Each property must be of type either String. Number, Int or Boolean. | A list of properties that will insure that a given data record is unique for the domain version:
|
...
Fast Duplicate Dectection Properites Rules
Fast Duplicate Detection Properties are attributes of a Domain and identify those fields that, when combined, MDM should use to detect whether the DR is unique. Refer to Domain Uniqueness, Deterministic Uniqueness, and De-Duplication for more information.
- The value provided for the
displayPropertymust be unique between all domain entries of a given domain type (e.g. each entry in the "state"domain must have a uniquestateName). - Only one property in a domain can be the
displayProperty. If more than one property is required to ensure uniqueness see the Uniqueness Rules Property below. - Display properties are limited to type STRING.
- Properties designated as the
displayPropertyare required; i.e. null values are not allowed. - Display properties are case sensitive e.g. "California" is NOT equal to "california".
...
| Property | Description | ||||||
|---|---|---|---|---|---|---|---|
enumType | Types of enums:
| ||||||
xrefLocation | If For example, if a version of a domain "countries"contains a list of data record values that represent all countries then a domain can reference it by specifying an enumeration type of
A subset of the data record values in the domain can be specified using the | ||||||
data | An array containing a comma-separated list of enum values. e.g. Is a three-item string enumeration. If the
Assuming the display values for Canada, the United States, and Mexico are those shown above in the data elements. | ||||||
default | If the item is not provided or is null, the default value is used. | ||||||
required | A non-null value for this item must be provided (false by default). | ||||||
| description | A human-readable description of the property. |
URI
TODO: "xref" type and "xrefLocation" has been moved to a new type called "xref". Documentation needs to be updated.
A properly formed Uniform Resource Locator (URL). A URL is a type of Uniform Resource Identifier (URI). By default, a property of type uri can be any valid URI or it can be limited by a regex pattern or to a domain cross-reference (xrefLocation:"xref").
...
| Property | Description |
|---|---|
minItems | Minimum items allowed in the array. |
| Maximum items allowed in the array |
default | If the item is not provided or is null, the default value is used. |
| items | Contains the list of sub-properties in the node. |
required | A non-null value for this item must be provided (false by default). |
| description | A human-readable description of the property. |
Note: Updating arrays can be handled differently when the domain is federated and an "Array Advisory Practice" should be developed by the ZDS/DGS and communicated to developers.
For example, this can be illustrated using an array of phone numbers… e.g. mobile, home, work, home-fax, etc.
When an adaptor detects a change in a source entities' array of phone numbers, it can send up the entire array or just the modified phone number in the array. In either case, the router will forward it based on the ACLs. The recipient can take these changes and add or update existing entries based on the phone number type property.
Since adaptor developers can handle arrays in one of these two different ways, it is recommended that the ZDS/DGSs make a decision about the preferred method, an "Array Advisory Practice," and communicate this to the adaptor developers.
Data Governance (DG) may say:
Never send a partial array of phone numbers but only the entire set so the entire set at the receiving adaptor can do a complete delete and replace on all phone numbers.
— OR —
Just send updates to an array only and the receiving adaptors can process them as they see fit and handle them using an index (which would be an agreed-upon domain version property; in this example it would be “type” (phone number type)).
An example of a good way for DG to articulate this would be in the “description” field for the phone number array in the domain version modelSchema.
| Code Block | ||
|---|---|---|
| ||
{
"properties": {
"name": {
"type": "string",
"min": 2,
"max": 80
},
"phone": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"description": "An array of phone numbers - ADAPTOR DEV ADISORY - Sending/receiving individual phone numbers is OK - sending/receiving the entire list is not necessary ",
"items": {
"type": {
"type": "string",
"min": 2,
"max": 80,
"regex": "^[A-Za-z]+"
},
"number": {
"type": "number",
"min": 2,
"max": 10
}
}
}
}
}
|
...