在 DataHub 中完成 Compliance Form从任务中心到批量核查的完整实操指南【免费下载链接】datahubThe Context Platform for your Data and AI Stack项目地址: https://gitcode.com/GitHub_Trending/da/datahub本指南以 DataHub 的 Compliance Forms合规表单为核心面向已被指派任务的 Assignee受托人讲解如何在资产页面或 Task Center任务中心中打开表单、完成单个或多个资产的 Question 作答、理解不同完成状态并对 Verification核查类表单执行最终签核。阅读本文后你将掌握 Compliance Form 从被指派到完成/已核查的完整闭环操作并了解其背后的 GraphQL 实现原理submitFormPrompt与verifyForm以及在 DataHub Core 中的编程式完成方式。:::note 适用版本说明 通过 DataHub UI 完成 Compliance Form 仅适用于DataHub Cloud。若你使用的是DataHub Core表单完成可以通过 GraphQL mutationssubmitFormPrompt、verifyForm以编程方式完成。有关表单的通用管理创建、更新、分配可参考 Compliance Forms API Guide。 :::前置概念一篇就位的背景正式操作前先快速对齐 Compliance Form 的组成要素详见 About DataHub Compliance FormsAssets表单作用范围内的数据资产或字段Column是合规举措的覆盖范围。QuestionsPrompt为每个资产收集关键属性所设置的题目例如描述Documentation、域Domain、所有者Owners、标签Tags、术语表术语Glossary Terms以及自定义的结构化属性Structured Properties。Assignees负责完成表单的用户或用户组可以是资产所有者、领域专家或数据管家Data Steward等。一旦表单被发布Assignees 会通过 Task Center 的通知收到待办任务同时系统开始采集资产合规进度。本文示例使用Governance Initiative 2024——一个包含 3 个必答题的 Verification 类表单。:::tip 表单类型差异Completion完成型全部必答题作答后表单即视为完成适合基础性合规要求。Verification核查型全部必答题作答后还需要 Assignee 显式核查verify确认答案的准确性与有效性表单才算完成。适合需要最终签核的场景。 :::打开 Compliance Form资产页面与任务中心当你被指派任务后会在资产页面右侧看到Complete Documentation完成文档或Complete Verification完成核查入口点击即可打开对应资产的表单。DataHub Cloud用户还可以通过导航栏进入Task Center集中查看并处理所有待完成的 Compliance Form 请求。任务中心把所有待办聚合在一个视图中是批量处理场景的入口。完成任务时的三种交互细节填写单个资产的表单时你面对的是针对该资产量身定制的问题列表需要注意以下三个行为Question 详情每个问题都会标明是必答Required还是选答Optional。必答题未完成时无法提交表单。预填充元数据如果问题对应的元数据已存在于资产中表单会自动预填该值。你可以确认现有值也可以按需更新。他人已作答的可见性如果其他 Assignee 已提交过答案会显示作答者姓名与提交时间。你可以看到之前的输入但仍然可以更新响应。:::tip Verification 表单的最终签核 对于 Verification 类表单在完成所有必答题后系统会提示你进行最终 sign-off签核确认所有响应完整且准确随后表单才进入可提交状态。 :::当所有必答响应完成后侧边栏会更新资产状态Documented已文档化所有必答题已完成无需核查。Verified已核查所有必答题已完成并通过核查。在待办资产之间导航在表单页面右上角有导航箭头用于跳到下一个仍待完成表单或待核查的资产。只有需要采取行动的资产会出现在该流程中让你无需多余步骤即可聚焦剩余任务。为多个资产批量作答DataHub Cloud当你想为多个资产提供相同回答时可在右上角选择By Question按问题模式逐题遍历表单并将同一响应应用到多个资产。:::note 多资产批量完成表单问题仅在 DataHub Cloud 中支持。 :::批量应用示例为 DEMO_DB Schema 设置删除日期假设我们要为 SnowflakeDEMO_DBSchema 中所有数据集回答同一个问题筛选资产筛选出DEMO_DBSnowflake Schema 下的全部数据集。设置响应针对所选问题作答例如将 Deletion Date删除日期设置为2024-12-31。应用到全部选中资产使用批量应用功能将这一响应应用到所有筛选出的资产。之后逐题切换为不同资产组合提供各自所需的回答。批量核查对 Verification 类表单作答过程中右上角会显示可核查资产的数量方便你跟踪哪些资产已满足要求。准备批量核查时系统会要求你确认所有响应均完整、准确后才继续。切换完成模式你可以在Complete By Asset按资产与Complete By Question按问题两种视图间随时切换兼顾灵活性与完成/核查效率。理解不同 Question 的完成状态同一表单中不同问题可能呈现不同状态取决于资产现有元数据或此前 Assignees 的作答记录。以下结合原文档的三种典型场景说明。1. 什么是该资产的主要用途Documentation 类必答描述中没有任何文本说明资产目前完全没有文档。这是待填写状态——你需要为资产补充文档。2. 该资产何时被删除Structured Property 类问题已带预填充值。当元数据来自表单之外的来源如采集管道时你可以选择更新并保存该值也可以直接Confirm确认该值准确。这一确认动作本身会写入表单完成记录避免重复劳动。3. 谁是该资产的数据管家Ownership 类3 天前已有另一位 Assignee 通过表单作答。所有 Assignees 仍可更新答案但界面会展示他人已提交的响应帮助团队对齐口径、避免覆盖冲突。编程式完成submitFormPrompt 与 verifyFormDataHub Core原文档明确指出DataHub Core 中表单完成可通过 GraphQL mutations 编程实现。仓库源码完整佐证了这一点。在 forms.graphql 中SubmitFormPromptInput定义了提交单题响应所需的字段promptId本次响应所针对的 Question IDformUrn该 Question 所属表单的 URNtypeQuestion 类型FormPromptType枚举包含STRUCTURED_PROPERTY资产级结构化属性与FIELDS_STRUCTURED_PROPERTYSchema 字段级结构化属性fieldPath当类型为FIELDS_STRUCTURED_PROPERTY时必须提供指明响应关联的 Schema 字段路径structuredPropertyParams结构化属性参数含属性 URN。对应的 mutation 声明位于 entity.graphqlsubmitFormPrompt(urn: String!, input: SubmitFormPromptInput!): Boolean底层解析器 SubmitFormPromptResolver.java 展示了完整调用链根据type分流——STRUCTURED_PROPERTY调用FormService.submitStructuredPropertyPromptResponseFIELDS_STRUCTURED_PROPERTY则要求提供fieldPath并调用submitFieldStructuredPropertyPromptResponse最终将响应写入对应资产的结构化属性。verifyFormmutation 用于对 Verification 类表单执行核查verifyForm(input: VerifyFormInput!): BooleanVerifyFormInput仅需两个字段见 forms.graphqlformUrn与被核查资产的entityUrn。解析器 VerifyFormResolver.java 在核查前会调用FormService.isFormAssignedToUser校验当前用户是否已被指派该表单结合用户的组成员关系未指派则抛出AuthorizationException通过后才调用verifyFormForEntity完成核查——这从源码层面印证了必须被指派才能完成/核查的权限模型。对应的单元测试 VerifyFormResolverTest.java 覆盖了成功路径断言verifyFormForEntity被调用一次与未授权路径断言抛出CompletionException。权限要求速查操作所需权限通过 UI / GraphQL mutations 完成已指派给自己的表单无需Manage Compliance Forms通过 UI / GraphQL mutations 核查已指派给自己的表单无需Manage Compliance Forms创建/更新/删除/指派表单含batchAssignForm、batchRemoveForm、createDynamicFormAssignmentManage Compliance FormsPlatform 权限Admin、Editor 默认持有通过 OpenAPI / Rest.li / CLI 直接写入forms、dynamicFormAssignmentaspectManage Compliance Forms 目标资产的Edit EntityFAQ 与故障排查为什么我在任务中心或资产页面看不到任何 Compliance Form请与表单作者确认你的 DataHub 用户账户已被指派完成一个或多个资产的表单。表单可以指派给资产所有者、特定 DataHub 用户或两者的组合。回答表单问题是否会更新资产本身会。表单是规模化采集和更新关键数据资产属性的强有力工具问题被回答时响应会直接更新对应资产的属性。表单问题与已有元数据如何交互如果资产已有与表单问题对应的元数据Assignee 可以选择确认现有值、覆盖该值或追加补充细节。这正是上一节预填充元数据与确认值两种状态设计的初衷。Completion 与 Verification 表单的区别两者都用于配置一组必答/选答问题Verification 表单在必答题全部完成后还会呈现最终核查步骤相当于对提交信息准确性的最终确认。一个资产可以同时被指派多个表单吗可以但一个资产只有在所有已指派表单的必答题全部完成时才会被视为 Documented 或 Verified。如何跟踪表单完成进度DataHub Cloud 内置了 Compliance Form Analytics详见 Form Analytics提供 Overall、按表单、按域、按 Assignee 四个维度的视图可按指派日期最近 7/30/90/365 天、全部时间过滤并可下载原始数据做深度分析。继续深入若你负责创建与发布表单Create a Compliance Form若需要理解表单的整体概念与收益About DataHub Compliance Forms若要在 DataHub Core 中通过 CLI / GraphQL 全量管理表单Compliance Forms API Guide若需了解完成进度的可视化追踪Form Analytics表单 YAML 示例可参考 metadata-ingestion/examples/forms/forms.yaml其中包含结构化属性题目资产级与字段级、实体 URN 列表与筛选条件两种分配方式以及 Assignees 配置的完整写法。【免费下载链接】datahubThe Context Platform for your Data and AI Stack项目地址: https://gitcode.com/GitHub_Trending/da/datahub创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考