Creating Attributes in Schema Studio

Syncaroo
Syncaroo
  • Updated

This article will help you with Creating Attributes in Schema Studio within the Syncari unified data model.  

Prerequisites:

Creating attributes in Schema Studio

Syncari provides a default unified data model that is a data model that can be used for most Synapses. This helps you get started quickly with Syncari. We recommend using the default unified data model with your connected Synapses as often as possible.

To create a common language for the various Synapse Sources, you may need to create new attributes within the Syncari unified data model.

NOTE

If you believe your use case may require creating new entities, please contact a member of our Onboarding and Support Team to discuss your use case.

Using Schema Studio

Create an Entity Draft

From Schema Studio, you can create new attributes within the Syncari unified data model, to do that first create an Entity Draft:

1. Click the Kebab menu besides the relevant entity.

2. Click the New Draft option.

Creating an Attribute

After you create a Draft of the selected Entity you are ready to create a new attribute:

1. Click Attributes.

2. Click New Attribute

3. Fill in the Basic Details for creating an Attribute:

  1. Provide a Display Name
  2. Provide an API Name
  3. Select a Data Type
  4. Provide a Data Store Name
  5. Provide a Description
  6. Click Create Now to create the attribute or click Validation Rules to set up data validation rules.  

4. Once you have created the attribute, click Publish

Your new attribute is now available within your selected Entity in the Syncari unified data model.

Creating Validation Rules and Data governance 

Setting Up Validation Rules

Validation rules let you enforce data quality standards on an attribute before records sync to the destination.

Use this when you need a record to be reviewed and corrected by a business user before it moves further through the pipeline, for example, rejecting records where an email address doesn't contain your company domain, or where a status field is set incorrectly.

To create Validation Rules:

1. From the attribute's Basic Details screen, click Validation Rules.

2. Click +Add Condition.

3. Define the condition the attribute must meet.

Now as you have added validation rules, when a record fails a rule, it's flagged and routed to a validation review queue instead of syncing normally. For this to happen you should have a Validation Review node present in your pipeline. Records in the validation review queue are corrected in Business Studio, not Schema Studio. 

Only users with an authorized role (e.g., Admin) can edit the record's attributes. Correct each flagged attribute until it satisfies the validation rule. Once all errors are resolved, the record automatically exits the queue and moves to the next pipeline stage (such as a manual review node).

Data Governance

After adding validation rules, you can click on the Data Governance option at the bottom to go to that screen. 

This is descriptive information about an attribute, its business meaning, ownership, and sensitivity, and does not affect how records move through the pipeline.

Use this when you need to document what an attribute represents, who's responsible for it, and how sensitive it is, for business and compliance reference.

1. From the attribute's detail screen, go to the Data Governance section.

2. Under Business Metadata, fill in:

  1. Business Definition - what the attribute represents.
  2. Business Rules applied to the attribute - any business-level rules to note.
  3. Synonyms - alternative names used for this attribute.
  4. Domain Classification - the data domain it belongs to.
  5. Subject Area Assignment - the subject area it belongs to.

3. Under Ownership & Stewardship, fill in:

  1. Data Owner - the business-accountable party.
  2. Data Steward - the operational responsible party.
  3. Subject Matter Expert (SME) - the go-to contact for questions.
  4. Technical Contact/Developer - the technical point of contact.
  5. Department/Business Unit - the owning organization.

4. Under Classification & Sensitivity, fill in:

  1. Data Classification - Public, Internal, Confidential, or Restricted.
  2. Privacy Classification - PII, PHI, PCI, GDPR, or other.
  3. Sensitivity Level - Low, Medium, or High.
  4. Regulatory Tags - GDPR, HIPAA, CCPA, or other.
  5. Security Classification - the attribute's security classification.

Once added, you can click Create Now.

What's Next?

Congratulations! You finished Creating Attributes in Schema Studio.
Check out this next article Pipeline Studio Overview

Share this

Was this article helpful?

0 out of 0 found this helpful