更新时间:2024-12-04 GMT+08:00
分享

创建关系实体

操作场景

本文指导您如何在应用设计态创建关系实体。

图1 创建关系实体流程图

前提条件

登录应用设计态

步骤1:填写基本信息

  1. 在左侧导航栏中,选择数据模型管理 > 关系实体,进入关系实体页面。
  2. 单击“创建”
  3. 根据页面提示,配置如下信息。

    图2 基本信息
    表1 基本信息-参数说明

    类型

    参数

    参数说明

    基本信息

    英文名称

    关系实体的英文名称。

    需以大写字母开头,只能包含字母、数字和“_”,不能以History、Query、VersionView、LifecycleManagedReviseAnd、LifecycleManagedCheckoutAnd、Version、VersionCheckoutAnd和VersionReviseAnd结尾(不区分大小写),长度不能超过60个字符。

    中文名称

    关系实体的中文名称。

    只能包含中文、英文字母、数字、“_”和“-”,长度不能超过128个字符。

    英文描述

    关系实体的英文描述。

    不能包含中文字符,长度不能超过1024个字符。

    中文描述

    关系实体的中文描述。

    支持各种字符,长度不能超过1024个字符。

    模型分类

    xDM-F提供如下两种模型,请根据实际需求进行选择。

    • 业务数据模型:用于承载业务数据的模型。
    • 系统配置模型:用于承载为实现业务逻辑而增加的模型,该模型不会与上下游集成。

    责任人

    关系实体的责任人。

    关系类型

    xDM-F提供如下两种类型,请根据实际需求进行选择。

    • 多对多:用于为数据实体、关系实体或接口模型建立M:N关系。例如电器相关的零件开发,工程师和零件开发为多对多关系。
    • 单边不确定:用于为数据实体/关系实体/接口模型和抽象模型(BasicObject)建立M:N关系。例如标签数据与业务数据的关联。

    联动更新关系实例

    更新两端实例时,是否更新关系实例。默认为“是”

    表名称

    根据关系实体的英文名称自动填充,可修改。表名称总长度不能超过64个字符,同一个应用下表名称不可重复。

    同步至LinkX-F

    如果您希望当前元模型及其实例数据可以继续在LinkX-F进行数据入图、数据探索、编排数据服务等操作时,您可以开启此配置项。

    说明:

    此配置项需要已开通LinkX-F,否则配置后不生效。如果您未开通LinkX-F,请开通数字主线引擎

    • 是:当前元模型及其实例数据自动同步至LinkX-F

      开启后,即可通过LinkX-F来实现汇聚企业全场景数据,构建企业级数据图谱去进行数据索引、分析、追溯等。具体操作请参见xDM-F应用同步

    • 否:当前元模型及其实例数据不同步至LinkX-F。默认为“否”

    入图标识

    “同步至LinkX-F“是”时,必填项。

    表示此元数据在入图时的别名或标识。

    入图标识需以字母开头,只能包含字母、数字和“_”。例如a0_01。

    标签

    • 如果您没有可使用的标签,可选择“自定义”
    • 如果您已有可使用的标签,可选择“添加标签”

    更多关于标签的操作请参见主服务标签

    二级缓存

    针对读多写少的业务场景,xDM-F提供了作用于实体级的级缓存功能。开启此配置项后,系统会自动缓存实体的实例信息,从而提高系统整体的性能。

    如果实体有参考对象类型的属性,该属性的参考对象建议同步开启二级缓存功能。

    更多信息请参见数据建模引擎相关问题

    源/目标数据实体名称

    • 支持选择“正在工作”“已发布”的数据实体、关系实体或接口模型。
    • 如果“关系类型”“单边不确定”,目标数据实体名称默认为“BasicObject”,且禁止修改。

    源/目标数据实体别名

    根据源/目标数据实体名称自动填充,可自定义。

    需以字母开头,只能包含字母、数字和“_”,长度不能超过128个字符。

    同一个关系实体的源数据实体别名和目标数据实体别名不可相同,不可同与当前关系实体的属性名称相同。

    源端/目标端引用类型

    • 强引用:被设置为强引用的一端(源端/目标端)数据实例在删除时,系统自动删除受引用的关系实例数据。
    • 弱引用:被设置为弱引用的一端(源端/目标端)数据实例在删除时,受引用的关系实例数据保留,不会自动删除。

    功能列表

    基础功能

    xDM-F提供的标准能力,包含基础数据服务、文件服务和关系实体服务三种功能。

    可选功能

    xDM-F提供系统版本、扩展属性、扩展类型、分类管理、权限管理、失效管理等可选功能,请根据实际需求进行选择。

    更多功能详情请参见数据建模引擎功能

  4. 单击“保存”

步骤2:添加关系实体属性(可选)

完成基本信息的填写后,该关系实体会继承系统的基本属性,例如唯一编码、创建者、租户、源实体、目标实体等属性。如果系统的基本属性已满足您实际的业务场景,可跳过此步骤,后续可参见管理关系实体属性管理该实体的属性。如果系统的基本属性满足不了您实际的业务场景,可通过如下操作添加属性。

  1. 选择“关系实体属性”页签,进入关系实体属性页面。
  2. 单击“新增”
  3. 在弹出的窗口中,填写如下信息。

    图3 新增属性
    表2 关系实体属性-参数说明

    类型

    参数

    参数说明

    基本信息

    英文名称

    属性的英文名称。

    需以字母开头,只能包含字母、数字和“_”,长度不能超过58个字符。

    中文名称

    属性的中文名称。

    只能包含中文、英文字母、数字、“_”和“-”,长度不能超过58个字符。

    英文描述

    属性的英文描述。

    不能包含中文字符,长度不能超过1024个字符。

    中文描述

    属性的中文描述。

    支持各种字符,长度不能超过1024个字符。

    类型

    xDM-F提供如下属性类型,请根据实际需求进行选择。
    • 文本:可存储较短的字符串数据,文本长度不能超过4000个字符。
    • 长文本:可存储较长的字符串数据,例如大型文章。文本长度最大支持524288个字符。如果您需要存储超长的字符串数据,建议使用“文件”类型的属性进行存储。
      • 如果应用的数据库类型为mysql,对应数据库的字段类型为LongText。
      • 如果应用的数据库类型为postgresql,对应数据库的字段类型为TEXT。
    • 整型:对应数据库的字段类型为int。
    • 长整型:对应数据库的字段类型为long。
    • 浮点型:对应数据库的字段类型为float。
    • 浮点型(自定义精度):浮点型数据并且可以自定义精度。
    • 参考对象:为对象建立1:N或主外键关系,例如部门和员工。
      • 参考对象值可以选择该应用下“正在工作”“已发布”的数据模型以及默认应用(XDM)下发布的所有数据模型(不包括扩展类型子数据模型)。
      • 如果参考非默认应用(XDM)对象,则当前属性作为外键生成一条虚拟的N:1的关系。
    • 文件:支持“BLOB”对象存储两种文件存储方式,默认为对象存储
    • 布尔值:true/flase。
    • 日期:展示为年/月/日/时/分/秒。
    • 枚举:为几乎没有变化的对象列举值,例如性别(男/女)。
    • 人员:企业/部门人员的名称。
    • URL:长度不能超过4000个字符,匹配正确格式。
    • JSON:JSON数据类型。

    属性分类

    用户自定义,可根据各维度自定义分类,便于管理属性。

    EOS日期

    EOS(End of Service,停止服务)日期主要用于标识属性的生效/失效时间。您可以通过EOS日期预设置某个属性字段的截止日期,以便于后续在业务开发时通过该参数控制相应的业务逻辑。

    约束信息

    文本长度

    “类型”选择为“文本”“长文本”时,必填项。

    其中,“文本”类型属性的最长文本长度为4000个字符,“长文本”类型属性的最长文本长度为524288个字符。

    为保障部署在数据建模引擎的应用运行态性能最优,建议您合理控制“长文本”类型属性的文本长度设置。

    有效范围

    “类型”选择为“整型”“长整型”“浮点型”“浮点型(自定义精度)”时,可根据实际业务需求进行设置。

    “类型”选择为“浮点型”“浮点型(自定义精度)”时,“有效范围”只能选择为“左开右开()”

    • 左开右开():表示不包括区间边界的两个值。例如(a,b),即a<x<b,取值不包括a和b。
    • 左闭右闭[]:表示包括区间边界的两个值。例如[a,b],即a≤x≤b,取值包括a和b。
    • 左开右闭(]:表示不包括开区间一边的边界值,包括闭区间一边的边界值。例如(a,b],即a<x≤b,取值不包括a,包括b。
    • 左闭右开[):表示不包括开区间一边的边界值,包括闭区间一边的边界值。例如[a,b),即a≤x<b,取值包括a,不包括b。

    指定合法值类型

    “类型”选择为“文本”“整型”“长整型”“浮点型”“浮点型(自定义精度)”“人员”时,可根据实际业务需求进行设置。

    仅支持输入英文名称。

    指定枚举类型

    “类型”选择为“枚举”时,必填项。

    • 如果您没有可指定的枚举类型,可选择
    • 如果您已有可指定的枚举类型,可选择已有枚举类型。
    • 在下拉选项列表中,单击枚举右侧的,可查看该枚举的详细信息。

    单位类型

    “类型”选择为“整型”“长整型”“浮点型”“浮点型(自定义精度)”时,可根据实际业务需求进行设置。

    如果您设置了单位类型,完成属性创建后,关系实体会自动创建一个英文名称格式为属性英文名称_unit“参考对象”类型属性,不可编辑。当您在运行态创建数据实例时,其“参考对象”类型的属性用于表示对应数值型属性的计量单位。

    仅支持选择xDM-F内置的国标单位,如果内置的国标单位满足不了您实际业务需求,后续您可以在应用运行态中自定义单位类型,然后在关系实体的扩展属性中选择该单位类型。具体操作请参见创建单位类型

    设计默认单位

    “单位类型”设置单位时,必填项。

    如果用户在应用运行态中设置了“运行默认单位”,创建数据实例时优先选择应用运行态设置的默认单位,否则创建的数据实例默认选择“设计默认单位”

    标度

    “类型”选择为“浮点型”“浮点型(自定义精度)”时,必填项。

    小数位范围1-30,若实例值超过标度范围,采用四舍五入方式处理。

    默认值

    “类型”选择为“文本”“长文本”“整型”“长整型”“浮点型”“浮点型(自定义精度)”“布尔值”“日期”“枚举”“人员”“URL”时,可根据实际业务需求进行设置。

    • “唯一键”选择为“是”,默认值为空且不能修改。
    • “指定合法值类型”设置了合法值类型,默认值只能设置为该配置项对应合法值类型中的合法值。

    参考对象

    “类型”选择为“参考对象”时,必填项,支持选择数据实体、关系实体和接口模型。

    根据业务需求,在参考对象下拉列表中选择需要参考的数据模型类型和对应模型的具体模型,使当前数据模型和选择的参考对象形成一种参考关系。

    组合关系

    默认为“否”

    参考对象类型只能选择为“否”

    存储方式

    “类型”选择为“文件”时,必填项。

    支持BLOB和对象存储两种。

    • BLOB:数据库存储,最大支持1M。
    • 对象存储:使用对象存储服务存储文件,文件≤100M使用普通上传,文件>100M使用分块上传,最大支持10G。

    文件格式

    “类型”选择为“文件”时,可根据实际业务需求进行设置。

    以英文逗号分隔输入文件类型。例如“pdf,docx”

    文件最大值

    “类型”选择为“文件”,且“存储方式”“对象存储”时,可根据实际业务需求进行设置。

    支持输入大于100MB且小于等于10GB的值。

    分块大小

    “类型”选择为“文件”,且“存储方式”“对象存储”时,可根据实际业务需求进行设置。

    分块大小建议设置5MB到200MB之间,默认为5MB。

    密级

    支持内部公开、机密、秘密和绝密四种。

    • 内部公开:指可在公司内部公开发布的信息,不属于保密信息。
    • 秘密:是公司比较重要或敏感的信息,其泄露会使公司利益受到一定损害,但影响范围有限;适合在体系、部门或特定组织范围公开的信息。
    • 机密:对公司运营管理非常重要或内容非常敏感,其泄露会使公司利益遭受巨大损害,且影响范围广泛;只适合在极少数人员或指定岗位范围公开的信息。如:重要产品的路标规划、营销策略、经营分析报告、销售项目一览表、商务授权及价格信息。
    • 绝密:对公司市场竞争、领先对手起决定性作用,其泄露会使公司利益遭受巨大损害,且影响范围广泛;只适合在极少数人员或指定岗位范围公开的信息。如:核心算法、定价策略、战略意图。

    唯一键

    只能为“否”,且不支持修改。

    必填

    默认为“否”

    文件类型只能选择为“否”

    多值

    “类型”选择为“枚举”“人员”时,必填项。

    值可变

    “类型”选择为“文本”“长文本”“整型”“长整型”“浮点型”“浮点型(自定义精度)”“参考对象”“布尔值”“日期”“枚举”“人员”“JSON”“URL”时,必填项。

    默认为“是”。若选择为“否”,则该实例的值保存后不支持修改。

    值存储方式

    “类型”选择为“文本”“长文本”时,必填项。

    支持原值、大写和小写三种,默认为“原值”

    • 原值:实例值按照实际输入的字符串存储。
    • 大写:将实例值中小写字符串转换为大写字符串存储。
    • 小写:将实例值中大写字符串转换为小写字符串存储。

    索引

    “类型”选择为“文本”“整型”“长整型”“浮点型”“浮点型(自定义精度)”“日期”“人员”时,可根据实际业务需求进行设置。

    “类型”选择为“人员”时,默认为“是”;其他类型默认为“否”

    “类型”选择为“文本”时,如果应用的数据库类型为mysql,且“文本长度”的设置大于768个字符,则该配置无效,无需配置。

    入库

    默认为“是”。若选择为“否”,发布后在数据库不会生成字段。模型发布后不能修改。

    加密

    “类型”选择为“文件”,且“密级”“机密/秘密/绝密”时,必填项。

    “密级”“内部公开”时,不支持加密。

    加密方式

    “加密”“是”时,必填项。

    支持对称加密和非对称加密。

    • 对称加密:即私钥加密,需使用同一个密钥进行加密或解密。
    • 非对称加密:即公钥加密,需使用一对密钥(公钥和私钥)进行加密或解密。

    入图

    需在填写基本信息时将“同步至LinkX-F设置为“是”,才展示该配置项。

    用于将当前属性与LinkX-F图数据库中的图数据属性进行对应,进而对数据实例实现从多类型数据源到图数据库的转换。

    说明:

    此配置项需要已开通LinkX-F,否则配置后不生效。如果您未开通LinkX-F,请开通数字主线引擎

    • 是:当前属性将在LinkX-F中入图。
    • 否:当前属性不在LinkX-F中入图。默认为“否”

    入图标识

    “入图”“是”时,必填项。

    此元数据在入图时的别名或标识。

    入图标识需以字母开头,只能包含字母、数字和“_”。

    引用类型

    “类型”选择为“参考对象”时,可根据实际业务需求进行设置。

    • 强引用:假设实体A参考实体B,实体B的数据实例被删除时,会返回引用信息,我们称这两种引用依赖为强引用。
    • 弱引用:假设实体A参考实体B,实体B的数据实例被删除时,实体A的数据实例仍然存在,我们称这种引用依赖为弱引用。

  4. 单击“保存”

    如需创建多个属性,可单击“保存继续创建”

步骤3:功能配置(可选)

完成基本信息的填写后,您可根据实际业务场景,在“功能配置”中设置基础功能或可选功能相对应的功能规则。如果系统提供的默认功能配置已满足您实际的业务需求,可跳过此步骤。

  1. 选择“功能配置”页签,进入功能配置页面。

    图4 功能配置

  2. 根据实际需求,设置如下信息。

    表3 功能配置-参数说明

    类型

    参数

    参数说明

    设置规则

    扩展属性

    如果在填写基本信息时,“功能列表”添加了“扩展属性”,可在“功能配置”中设置“扩展属性”的规则,用于约束应用运行态下该实体可添加的扩展属性类型数量、文本长度等配置。

    单击“新增”,参考如下说明进行设置。

    • 属性类型:用于约束应用运行态下该实体可添加的扩展属性类型。当前支持选择文本、长文本、整型、长整型、浮点型、浮点型(自定义精度)、布尔值、日期、枚举、分类、URL和文件类型。
    • 数量:用于约束应用运行态下该实体可添加对应扩展属性类型的数量。
      • 如果应用的数据库类型为mysql,文本、长文本、布尔、日期、分类类型的属性数量不可超过200个,整型、长整型、浮点型、浮点型(自定义精度)类型的属性数量不可超过100个,枚举类型的属性数量不可超过55个,URL类型的属性数量不可超过4个,文件类型的属性数量不可超过183个。
      • 如果应用的数据库类型为postgresql,每种类型的属性数量不可超过200个。
    • 文本长度:表示存储至数据库的文本总长度。如果应用的数据库类型为mysql,其文本总长度不可超过14234字节(Byte)。
    • 是否索引:选择为“是”,系统会在对应实体扩展表中创建普通索引,后续您在应用运行态为该实体添加“索引”“是”的扩展属性时,将自动匹配至有索引的列。同时存在如下约束:
      • 长文本、文件、布尔值、URL不支持选择“索引”“是”
      • 文本、日期和分类类型的属性数量不可超过60个,整型、长整型、浮点型和浮点型(自定义精度)类型的总属性数量不可超过60个。
      • 如果应用的数据库类型为postgresql,枚举类型的属性数量不可超过60个。
      • 如果应用的数据库类型为mysql,且“文本长度”的设置大于768个字符,则该配置无效,无需配置。
    • 扩展表名称:默认为“应用英文名称_关系实体英文名称_REL+属性类型+EXAValue”,可自定义。

      例如应用名为DMEApp,数据实体为Parts,属性类型为整型,扩展表名称默认为“DMEApp_Parts_RELNumberEXAValue”

    联合索引管理

    关系实体的默认功能,如果您需要对该实体进行多属性查询时,可在“功能配置”中定义联合索引,提高查询效率。更多关于联合索引的介绍请参见联合索引管理

    API列表

    -

    应用发布后,API列表中的API会注册到APIG,提供调用。

  3. 单击“保存”

相关操作

完成关系实体的创建后,您还需发布关系实体、发布应用生成相应代码包、部署应用生成运行态,才可在应用运行态中调用关系实体API、创建关系实体实例等操作。相关操作请参见:

相关文档