Data Catalog Onboarding & Glossary Checklist (Interactive)

{ "Title": "Data Catalog Onboarding Checklist", "IntroductionHtml": "

Use this interactive checklist to onboard a dataset into your catalog. Answer each item, provide owners and examples, then submit to save the onboarding record. Records can be reused, audited, and reported on to reduce rediscovery and increase trust in your data.

", "SubmitLabel": "Save Onboarding Record", "SuccessMessage": "Onboarding record saved. You can update this entry later through the catalog.", "DataType": "DataCatalogOnboardingChecklist", "SchemaVersion": "1.0", "Fields": [ { "Key": "dataset_name", "Label": "Dataset name", "Type": "text", "Required": true, "HelpText": "Friendly name used in the catalog (e.g., Sales.Orders)." }, { "Key": "dataset_id", "Label": "Canonical dataset ID or catalog path", "Type": "text", "Required": false, "HelpText": "Unique identifier, path, or asset GUID if available." }, { "Key": "dataset_description", "Label": "Short description and primary business use cases", "Type": "textarea", "Required": true, "HelpText": "What the dataset contains and the main decisions or processes it supports." }, { "Key": "step_description_complete", "Label": "1) Dataset description and business use cases complete?", "Type": "yesno", "Required": true }, { "Key": "step_description_details", "Label": "Notes or examples for the description (optional)", "Type": "textarea", "Required": false }, { "Key": "step_fields_complete", "Label": "2) Field-level definitions and units complete?", "Type": "yesno", "Required": true }, { "Key": "step_fields_details", "Label": "If not complete, list missing fields or units", "Type": "textarea", "Required": false, "HelpText": "Include datatype, units, and business meaning for uncertain fields." }, { "Key": "owner_assigned", "Label": "3) Data owner and steward assigned?", "Type": "yesno", "Required": true }, { "Key": "owner_name", "Label": "Data owner / steward (name & role)", "Type": "text", "Required": false }, { "Key": "owner_contact", "Label": "Owner contact (email / phone)", "Type": "text", "Required": false }, { "Key": "lineage_complete", "Label": "4) Upstream lineage and ingestion schedule documented?", "Type": "yesno", "Required": true }, { "Key": "lineage_details", "Label": "Lineage summary (upstream systems and key transformations)", "Type": "textarea", "Required": false, "HelpText": "List primary sources, transformations, and where the canonical copy is stored." }, { "Key": "ingestion_schedule", "Label": "Ingestion schedule (frequency or cron)", "Type": "text", "Required": false }, { "Key": "privacy_classification", "Label": "5) Privacy classification", "Type": "select", "Required": true, "Options": [ {"Value": "public", "Label": "Public"}, {"Value": "internal", "Label": "Internal"}, {"Value": "confidential", "Label": "Confidential"}, {"Value": "restricted", "Label": "Restricted"} ], "HelpText": "Choose the least-privilege classification that still allows safe use." }, { "Key": "access_controls", "Label": "Access controls / groups", "Type": "textarea", "Required": false, "HelpText": "Which roles, groups, or catalog policies are required to access this dataset?" }, { "Key": "quality_checks", "Label": "6) Quality checks and SLA defined?", "Type": "yesno", "Required": true }, { "Key": "quality_checks_list", "Label": "Quality checks (summary) and SLA", "Type": "textarea", "Required": false, "HelpText": "E.g., null-rate checks, row-count thresholds, freshness/latency SLA and alerting." }, { "Key": "example_queries_available", "Label": "7) Example queries and sample records included?", "Type": "yesno", "Required": true }, { "Key": "example_queries", "Label": "Example queries (SQL or pseudocode)", "Type": "textarea", "Required": false, "HelpText": "Provide 1–3 typical queries that demonstrate correct usage." }, { "Key": "sample_record_note", "Label": "Sample record or schema snapshot", "Type": "textarea", "Required": false, "HelpText": "Paste a single-row example or a schema JSON/snippet. Do not include sensitive values." }, { "Key": "tagging_complete", "Label": "8) Tagging and search metadata for discoverability complete?", "Type": "yesno", "Required": true }, { "Key": "tags", "Label": "Suggested tags and classification keywords (comma-separated)", "Type": "text", "Required": false }, { "Key": "discoverability_notes", "Label": "Discoverability notes (related assets, consumer teams)", "Type": "textarea", "Required": false }, { "Key": "readiness_score", "Label": "Onboarding readiness (1=needs work, 5=ready)", "Type": "scale", "Required": true, "ScaleMin": 1, "ScaleMax": 5 }, { "Key": "submitter_name", "Label": "Submitted by (name)", "Type": "text", "Required": true }, { "Key": "submitter_email", "Label": "Submitted by (email)", "Type": "text", "Required": true }, { "Key": "final_comments", "Label": "Final comments or next steps", "Type": "textarea", "Required": false } ] }