自定义属性

更新时间:
复制为 MD 格式

DataWorks数据地图提供自定义属性功能,允许您为工作空间、数据集扩展业务元数据信息。自定义属性支持属性继承机制,帮助您更高效地管理与治理业务元数据。

功能概述

在大规模企业级数据治理和资产化运营场景中,传统的”技术元数据”(如表结构、血缘关系、分区信息等)往往无法完整描述资产的业务内涵。DataWorks 自定义属性功能允许您根据实际业务需求,为工作空间、数据集扩展业务元数据信息,并通过引入继承机制,可支持通过元数据属性继承进行批量信息的维护管理,提升元数据信息的管理效率。

重要

当前您可以为工作空间数据集配置自定义属性。表、代码、API等对象暂不支持配置自定义属性。如果您有此类需求,请提交工单联系技术支持人员。

自定义属性功能可以帮助您解决以下问题:

  • 业务信息缺失:技术元数据无法回答”业务负责人是谁”、”该指标口径如何定义”等核心业务问题。

  • 配置效率低下:当数千个表或数据集需要遵循相同的治理规范(如统一的审批链接)时,逐个手动配置成本极高且难以维护。

自定义属性功能的核心能力包括:

  • 自定义属性声明:管理员可以定义属性名称、标识、类型(文本、枚举等)以及绑定的实体类型。

  • 属性值配置:用户可以对所绑定的实体查看和编辑自定义属性值。

  • 属性继承:支持在对象层级间自动继承属性值,减少重复配置工作量。

典型应用场景

  • 为数据集标记所属业务域、数据责任人等业务信息,便于在数据地图中检索和管理。

  • 为工作空间配置统一的数据审批链接,该空间下所有数据集自动继承,无需逐个配置。

使用限制

  • 自定义属性名称在租户内必须唯一。

  • 自定义属性的标识在租户内必须唯一,且创建后不可修改。

  • 自定义属性的类型创建后不可修改。

权限说明

自定义属性相关操作的权限要求如下表所示。阿里云账号(主账号)默认拥有所有权限,以下仅列出 RAM 用户及角色的权限要求。

操作

权限说明

自定义属性新建与管理

要求具备以下任一角色或权限:

  • 租户所有者

  • 租户管理员

  • 租户数据治理管理员

  • 具备 DataWorksFullAccess 权限的 RAM 用户

配置工作空间的自定义属性

要求具备以下任一角色:

租户级:租户所有者、租户管理员、租户数据治理管理员

工作空间级:工作空间所有者、工作空间管理员

配置数据集的自定义属性

要求具备以下任一角色:

租户级:租户所有者、租户管理员、租户数据治理管理员

工作空间级:工作空间所有者、工作空间管理员、工作空间开发

查看自定义属性、工作空间详情、数据集详情

不限制

新建自定义属性

管理员可以通过以下步骤新建自定义属性。

  1. 登录DataWorks控制台,在左侧导航栏,单击数据地图

  2. 鼠标悬停至左侧导航栏的配置管理图标,选择自定义属性配置

  3. 在自定义属性管理页面,单击+添加

  4. 新建自定义属性对话框中,配置各项参数。参数说明如下:

    类别

    参数

    说明

    属性配置

    标识

    自定义属性的唯一标识(Key),用于API调用等场景。仅支持英文字母、数字和下划线,创建后不可修改。

    名称

    自定义属性的显示名称,在租户内必须唯一。长度不超过128个字符。

    类型

    选择属性值的数据类型,创建后不可修改。支持以下类型:

    • 枚举项:属性值从预定义的选项列表中选择。

    • 文本:属性值为自由输入的文本字符串。

    • 链接:属性值为用户输入的链接,包括链接标题链接地址

    枚举项

    当属性类型选择枚举项时,需要配置可选的枚举值列表。

    描述

    自定义属性的描述信息。

    生效范围

    适用实体类型

    选择该自定义属性需要绑定的实体类型。支持的对象类型包括:工作空间、数据集。

    是否继承

    当前仅工作空间类型的对象支持开启此选项。

    开启后,该属性将支持继承,该工作空间关联的数据集将自动继承该属性值。

    例如,为某工作空间设置”环境类型:生产”后,其关联的数据集将自动获得相同的属性值。当父级属性值更新时,继承值将同步变更。

    是否支持覆盖

    开启后,子级对象可以修改继承的属性值。修改后,该属性将转为本地值,不再随父级变更而更新。

    是否支持作为筛选项

    当属性类型选择枚举项时,可将该自定义属性配置为筛选项,用户可在搜索时通过该属性快速筛选数据。

    是否在详情页展示

    设置该自定义属性是否在数据对象的详情页中展示。

  5. 单击确认。自定义属性创建成功后,将显示在自定义属性管理列表中。您可以在列表中对属性进行编辑或删除操作。

说明
  • 编辑属性:自定义属性创建后,您可以修改属性名称、描述、枚举值、绑定对象和继承规则,但属性标识和属性类型不支持修改。

  • 删除属性:若自定义属性已绑定到数据对象,删除该自定义属性时,对应数据对象上的属性值将被同步清除。此操作不可恢复,请谨慎操作。

配置与查看自定义属性值

自定义属性创建后,您可以为工作空间和数据集配置具体的属性值。

为工作空间配置自定义属性

  1. 数据地图页面的左侧导航栏中,单击image,进入数据目录页面。

  2. 展开DataSet,右侧将展示工作空间列表。

  3. 找到目标工作空间,即可编辑其自定义属性值。以 Test-Attribute 为例。

    image

  4. 配置完成后,您也可以在工作空间详情页查看自定义属性值。

    image

为数据集配置自定义属性

  1. 数据地图页面的左侧导航栏中,单击image,进入数据目录页面。

  2. 按照以下步骤为数据集配置自定义属性:

    1. 对于新增的数据集:

      在新建数据集的过程中,即可为其配置自定义属性值。

      image

    2. 对于已创建的数据集:

      1. 在数据目录页面,展开DataSet,选择目标工作空间,单击该工作空间下的目标数据集。

      2. 在数据集详情页中,即可编辑其自定义属性值。

  3. 在数据集详情页,即可查看所配置的自定义属性值。

    image

筛选自定义属性

对于类型为枚举项且已开启是否支持作为筛选项的自定义属性,您可以在搜索工作空间或数据集时,通过该属性进行快速筛选。

筛选工作空间

您可以通过以下两种方式根据自定义属性筛选工作空间:

方式一:在左侧导航栏中单击搜索图标image,进入高级搜索页面。选择类型为工作空间,并设置自定义属性的筛选条件。具体操作,请参见多维度筛选与浏览

方式二:在左侧导航栏中单击image,进入数据目录页面。展开DataSet,选择目标工作空间,并基于自定义属性的枚举值进行筛选。

image

筛选数据集

您可以通过以下两种方式根据自定义属性筛选数据集:

方式一:在左侧导航栏中单击搜索图标image,进入高级搜索页面。选择类型为数据集,并设置自定义属性的筛选条件。具体操作,请参见多维度筛选与浏览

方式二:在左侧导航栏中单击image,进入数据目录页面。展开DataSet,进入工作空间列表,单击数据集,并基于自定义属性的枚举值进行筛选。

image

核心机制:属性继承

自定义属性支持在对象层级间进行继承,子级对象可自动获取父级对象中已配置的属性值。

  • 继承链:自定义属性的继承遵循以下层级关系:工作空间 > 数据集

    例如,当您在工作空间级别配置了某自定义属性值后,该工作空间下的所有数据集将自动继承该属性值。

  • 继承策略:创建自定义属性时,可以选择是否支持覆盖

    • 支持覆盖:子级对象(数据集)默认继承父级(工作空间)的属性值,但允许在子级单独设置不同的值以覆盖继承值。例如,工作空间配置统一的普通审批链接,其下的大部分数据集自动继承;对于包含敏感信息的数据集,可单独覆盖为需要更高级别审批的链接。

    • 不可覆盖:子级对象强制继承父级的属性值,不允许在子级单独修改。

  • 父级值变更:当父级属性值发生变更时,所有继承该值的子级对象将同步更新。已覆盖继承值的子级不受影响。

  • 继承标识:在数据集详情页中,继承自工作空间的自定义属性旁会显示一个提示图标。悬停可查看集成来源和覆盖策略。

    image

相关文档