DSP® Application Development

Populate the Bulk Update Tables to Publish Rules and Terms to the Knowledge Tier

Overview

KnowledgeCapture™ allows metadata surrounding rules and terms to be captured in the Stewardship Tier and uploaded to the Knowledge Tier. For Advanced Data Migration, the Wave Metadata Harvesting Application extracts and collates the rules and terms from a Migration Wave and allows users to review and update those rules and terms before publishing to the Syniti Knowledge Tier. For migration projects, request the Syniti Solutions Wave Metadata Harvesting WebApp and associated documentation by entering a ticket with Syniti Support. For KnowledgeCapture™ outside of a migration project, users must create the required staging tables and populate them so that the agents running on the Stewardship Tier can collect the content from the staging tables and upload them to the Knowledge Tier for publishing.

To configure staging tables for KnowledgeCapture™ for a non-migration project:

  1. Create SQL Tables
  2. Populate Tables with Rules and Terms
  3. Let the DSP Connector Agent Run

Create SQL Tables

Run the following script in the DSP database server to create the two required tables, xtRuleInsV1 and xtTermInsV1:

USE [DataConstructionServer]

GO

/****** Object: Table [dbo].[xtRuleInsV1] Script Date: 5/1/2020 6:55:57 AM ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

CREATE TABLE [dbo].[xtRuleInsV1](

[ReportID] [uniqueidentifier] NOT NULL,

[RuleStatement] [nvarchar](250) NOT NULL,

[RuleImplication] [nvarchar](500) NULL,

CONSTRAINT [PK_xtRuleInsV1] PRIMARY KEY CLUSTERED

(

[ReportID] ASC

)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON, FILLFACTOR = 80) ON [PRIMARY]

) ON [PRIMARY]

GO

/****** Object: Table [dbo].[xtTermInsV1] Script Date: 5/1/2020 6:55:57 AM ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

CREATE TABLE [dbo].[xtTermInsV1](

[TermID] [uniqueidentifier] NOT NULL,

[Term] [nvarchar](100) NOT NULL,

[Definition] [nvarchar](500) NOT NULL,

[AdditionalInformation] [nvarchar](500) NULL,

[CriticalDataElement] [bit] NULL,

CONSTRAINT [PK_xtTermInsV1] PRIMARY KEY CLUSTERED

(

[TermID] ASC

)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON, FILLFACTOR = 80) ON [PRIMARY]

) ON [PRIMARY]

GO

ALTER TABLE [dbo].[xtTermInsV1] ADD CONSTRAINT [DF_xtTermInsV1_TermID] DEFAULT (newid()) FOR [TermID]

GO

Populate Tables with Rules and Terms

To populate the staging tables, you can either:

  • Build views on top of the two staging tables and build a custom WebApp to populate the tables and integrate with Excel, or
  • Populate the tables directly.

The following are descriptions of the fields in the staging tables:

Table: xtRuleInsV1
ColumnDescription
ReportID (uniqueidentifier)Can be any valid UniqueIdentifier but normally populated with the GUID from the Target Report or Data Quality Report. If no GUID exists then generate a new value and assign. This is not ingested into the Knowledge Tier.
RuleStatement nvarchar(250)Populate with the Business Rule Statement as you want it to appear in the Knowledge Tier.
RuleImplication nvarchar(500)Populate with the rule implication as you want it to appear in the Knowledge Tier.
Table: xtTermInsV1
ColumnDescription
TermID (uniqueidentifier)Can be any valid UniqueIdentifier and can be auto generated if not specifically tying the Term to a source data element. This is not ingested into the Knowledge Tier.
Term nvarchar(100)Populate with the Term as you want it to appear on the Knowledge Tier.
Definition nvarchar(500)Populate with the Term Definition as you want it to appear on the Knowledge Tier.
Additional Information nvarchar(500)Populate with the Term Additional Information value as you want it to appear on the Knowledge Tier.
Critical Data Element (bit)Populate with 1 for terms that you wish to indicate are Critical Data Elements, populate with 0 if not.

Let the DSP Connector Agent Run

Once the tables are populated, the DSP Connector agent polls the tables once a day to ingest the contents of the tables and send the package to the Remote Uploads page of the Knowledge Tier. Once the rules and terms have been uploaded, you can publish them in the Knowledge Tier. Refer to Upload Assets Remotely in the Knowledge Tier online help for more information.