创建关系实体
操作场景
本文指导您如何在应用设计态创建关系实体。
前提条件
已登录应用设计态。
步骤1：填写基本信息
- 在左侧导航栏中，选择，进入关系实体页面。
- 单击“创建”。
- 根据页面提示，配置如下信息。
图2 基本信息
表1 基本信息-参数说明 类型
参数
参数说明
基本信息
英文名称
关系实体的英文名称。
需以大写字母开头，只能包含字母、数字和“_”，不能以History、Query、VersionView、LifecycleManagedReviseAnd、LifecycleManagedCheckoutAnd、Version、VersionCheckoutAnd和VersionReviseAnd结尾（不区分大小写），长度不能超过60个字符。
中文名称
关系实体的中文名称。
只能包含中文、英文字母、数字、“_”和“-”，长度不能超过128个字符。
英文描述
用户自定义，用于说明当前创建的关系实体的作用、使用场景等，以便协同其他用户快速了解与使用。
长度不能超过1024个字符。推荐使用英文字符填写，同时支持中文及其他字符输入。
中文描述
用户自定义，用于说明当前创建的关系实体的作用、使用场景等，帮助协同用户快速了解实体功能。
长度不能超过1024个字符。支持中文、英文及其他字符输入，建议优先使用中文填写以适配中文阅读场景。
模型分类
xDM-F提供如下两种模型，请根据实际需求进行选择。
- 业务数据模型：用于承载业务数据的模型。
- 系统配置模型：用于承载为实现业务逻辑而增加的模型，该模型不会与上下游集成。
责任人
关系实体的责任人。
关系类型
xDM-F提供如下两种类型，请根据实际需求进行选择。
- 多对多：用于为数据实体、关系实体或功能模型建立M:N关系。例如电器相关的零件开发，工程师和零件开发为多对多关系。
- 单边不确定：用于为数据实体/关系实体/功能模型和抽象模型（BasicObject）建立M:N关系。例如标签数据与业务数据的关联。
联动更新关系实例
用于控制在更新关系实体的源端或目标端数据实例时，是否同步更新关联关系实例的“最后更新日期”。默认设置为“否”。
- 是：当源端或目标端的数据实例发生更新时，系统将自动更新该关系实例的“最后更新日期”，确保关系状态与数据变更保持同步。
- 否：仅更新数据实例本身，关系实例的“最后更新日期”不随之变更，保持原有时间戳。
表名称
关系实体存储至数据库的表名称，可修改。
“模型分类”选择为“业务数据模型”的默认格式为“应用名称_关系实体英文名称_REL”，“模型分类”选择为“系统配置模型”的默认格式为“应用名称Sys_关系实体英文名称_REL”。
表名称总长度不能超过64个字符，同一个应用下表名称不可重复，且不能以xdm开头。
同步至LinkX-F
如果您希望当前元模型及其实例数据可以继续在LinkX-F进行数据入图、数据探索、编排数据服务等操作时，您可以开启此配置项。
此配置项需要已开通LinkX-F，否则配置后不生效。如果您未开通LinkX-F，请开通数字主线引擎。
入图标识
“同步至LinkX-F”为“是”时，必填项。
表示此元数据在入图时的别名或标识。
入图标识需以字母开头，只能包含字母、数字和“_”。例如a0_01。
标签
- 如果您没有可使用的标签，可选择“自定义”。
- 如果您已有可使用的标签，可选择“添加标签”。
更多关于标签的操作请参见主服务标签。
二级缓存
针对读多写少的业务场景，xDM-F提供了作用于实体级的二级缓存功能。开启此配置项后，系统会自动缓存实体的实例信息，从而提高系统整体的性能。
如果实体有参考对象类型的属性，该属性的参考对象建议同步开启二级缓存功能。
更多信息请参见数据建模引擎相关问题。
源/目标数据实体名称
- 支持选择“正在工作”和“已发布”的数据实体、关系实体或功能模型。
- 如果“关系类型”为“单边不确定”，目标数据实体名称默认为“BasicObject”，且禁止修改。
源/目标数据实体别名
根据源/目标数据实体名称自动填充，可自定义。
需以字母开头，只能包含字母、数字和“_”，长度不能超过128个字符。
同一个关系实体的源数据实体别名和目标数据实体别名不可相同，不可与当前关系实体的属性名称相同。
源端/目标端引用类型
- 强引用：被设置为强引用的一端（源端/目标端）数据实例在删除时，系统自动删除受引用的关系实例数据。
- 弱引用：被设置为弱引用的一端（源端/目标端）数据实例在删除时，受引用的关系实例数据保留，不会自动删除。
功能列表
基础功能
xDM-F提供的标准能力，包含基础数据服务、文件服务和关系实体服务三种功能。
可选功能
xDM-F提供系统版本、权限管理、分类管理、扩展属性、扩展类型、失效管理、结构化文档管理等可选功能，请根据实际需求进行选择。
更多功能详情请参见数据建模引擎功能。
- 单击“保存”。
步骤2：添加关系实体属性（可选）
属性是关系实体所具有的特征或性质，用于描述关系实体的特征。完成基本信息的填写后，该关系实体会继承系统的基本属性，例如唯一编码、创建者、租户、源实体、目标实体等属性。如果系统的基本属性已满足您实际的业务场景，可跳过此步骤，后续可参见管理关系实体属性管理该实体的属性。如果系统的基本属性满足不了您实际的业务场景，可通过如下操作添加属性。
- 选择“关系实体属性”页签，进入关系实体属性页面。
- 单击“新增”。
- 在弹出的窗口中，填写如下信息。
图3 新增属性
- 基本信息：设置属性的各项基础信息，完成属性的初步定义。
表2 设置属性基本信息 参数
参数说明
英文名称
用户自定义，表示当前创建的属性的英文名称。
需以字母开头，只能包含字母、数字和“_”，长度不能超过58个字符。
不能以数据库的关键词作为属性的英文名称，例如where、select等。
xDM-F会自动以类小驼峰方式转换属性的英文名称，以作为key值存储至系统中。后续您在调用API时，请避免使用实际定义的属性英文名称作为参数名。例如，您定义的属性英文名称为“Part_model_number”，调用API时需使用“part_Model_Number”作为参数名。
中文名称
用户自定义，表示当前创建的属性的中文名称。
只能包含中文、英文字母、数字、“_”和“-”，长度不能超过58个字符。
英文描述
用户自定义，表示当前创建的属性的英文描述。
长度不能超过1024个字符。推荐使用英文字符填写，同时支持中文及其他字符输入。
中文描述
用户自定义，用于说明当前创建的属性的用途、特征等，以便于其他用户可以快速了解和使用该属性。
长度不能超过1024个字符。支持中文、英文及其他字符输入，建议优先使用中文填写以适配中文阅读场景。
类型
xDM-F提供如下属性类型，请根据实际需求进行选择。
- 文本：用于存储较短的字符串数据，例如产品名称、标题、简短描述等，文本长度不能超过4000个字符。
- 长文本：用于存储较长的字符串数据，例如完整的文章内容、产品详情、日志记录、报告文档等。文本长度最大支持524288个字符。如需存储超长字符串数据，建议使用“文件”类型属性。
- 整型：用于存储整数数据，例如年龄、数量、状态码、序号等。
- 长整型：用于存储范围较大的整数数据，例如订单编号、时间戳、大数据量统计等。
- 浮点型：用于存储带有小数的数值，例如价格、评分、比例、不需要高精度的测量值等。
- 浮点型（自定义精度）：允许用户根据需求自定义浮点数的精度，适用于对数值精度有较高要求的应用场景。
- 参考对象：用于关联其他数据模型，实现数据的关联查询、整合以及业务逻辑的联动处理。允许为相同类型的对象建立1:N或主外键关系，例如汽车和轮胎。
- 文件：用于存储图片、文档、压缩包等各类文件。
- 布尔值：用于表示逻辑上的真或假，例如开关状态、是否同意等。
- 日期：用于记录时间信息，显示格式为年/月/日/时/分/秒，例如文章发布时间、订单创建时间等。
- 枚举：用于存储具有固定取值范围的数据，例如性别（男/女）、订单状态（待支付/已支付/已发货）等。
- 人员：用于标识企业或部门内的人员名称，例如负责人、创建人、团队成员等。
- URL：用于存储网址链接，长度不能超过4000个字符，且需要符合标准的URL格式。例如图片链接、API端点、外部资源链接等。
- JSON：用于存储结构化的JSON数据，例如配置信息、部件规格参数等。
不同的属性类型在各个数据库中的字段类型略有差异，具体的对应关系请参见属性类型与数据库字段类型对照。
属性分类
用户自定义，可根据各维度自定义分类，便于管理属性。
EOS日期
EOS（End of Service，停止服务）日期主要用于标识属性的生效/失效时间。您可以通过EOS日期预设置某个属性字段的截止日期，以便于后续在业务开发时通过该参数控制相应的业务逻辑。
- 约束信息：在“基本信息”中选定属性具体类型后，还需要为其配置相应的约束信息，以确保后续在应用运行态用户录入的实例数据满足完整性与准确性要求，从而有效防止无效数据的输入。
表3 关系实体属性-参数说明 参数
参数说明
文本长度
当您将属性的“类型”选择为“文本”或“长文本”后，您需要进一步设置最大长度限制。
- “文本”类型：最大支持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之间的小数位数作为标度。如果输入的实例值小数位数超过设定的标度值，xDM-F会自动按照四舍五入的原则进行处理。
例如，您将标度设置为2，而输入的实例值为3.145，那么系统将存储与显示该实例值为3.15。
默认值
当您将属性的“类型”选择为“文本”、“长文本”、“整型”、“长整型”、“浮点型”、“浮点型（自定义精度）”、“布尔值”、“日期”、“枚举”、“人员”或“URL”后，您可以根据实际业务需求为属性设置初始值。当用户在应用运行态创建数据实例时，如果未指定该属性的值，将自动填充此默认值。
- 如果“唯一键”选择为“是”，默认值为空且不能编辑。
- 如果“指定合法值类型”设置了合法值类型，默认值只能设置为该配置项对应合法值类型中的合法值。
参考对象
当您将属性的“类型”选择为“参考对象”后，您需要进一步指定其关联的目标数据模型。支持关联的目标数据模型如下：
- 当前应用下“状态”为“正在工作”和“已发布”的用户自定义数据模型。
- 默认应用（XDM）下的所有内置模型。
当用户指定非默认应用（XDM）作为参考对象时，系统会自动以当前属性作为外键，生成一条虚拟的N:1的关系。该关系可用于数据关联查询，但不会实际修改目标应用的数据结构。
组合关系
当您将属性的“类型”选择为“参考对象”后，组合关系只能设置为“否”，且不能编辑。
表示普通关联或聚合关系，适用于松散耦合的场景。例如，用户与所属部门的聚合关系。
存储方式
当您将属性的“类型”选择为“文件”后，您需要进一步指定文件数据在应用中的具体存储方式。目前支持BLOB（Binary Large Object）和对象存储两种方式。
- BLOB：文件会以二进制形式直接存储在数据库表中，适合处理较小的数据量，单文件最大支持1MB。
- 对象存储：利用对象存储服务来存储文件。不同大小的文件，提供不同的上传策略：
- 对于≤100MB的文件，采用普通上传方式。
- 对于＞100MB的文件，采用分块上传方式。单个文件最大支持20GB。
如需了解更多详细信息，请参见文件服务实践。
文件格式
当您将属性的“类型”选择为“文件”后，您可以根据实际业务需求设置允许上传的文件格式，多个文件格式间以英文逗号（,）分隔。例如，仅允许上传PDF和Word文件，可设置为“pdf,docx”。
为确保文件格式限制的有效性，请确认当前设置的文件格式在对应应用运行态的中有匹配项。如果不存在匹配格式，此文件格式限制将无法生效。
如果未设置文件格式（即“文件格式”为空），默认允许上传当前应用运行态中的所有文件格式。
文件最大值
当您将属性的“类型”选择为“文件”，并选择“对象存储”作为存储方式时，您可以根据实际业务需求对文件最大值进行灵活设置。
为确保系统稳定运行，您输入的值需大于100MB且不超过20GB。
分块大小
当您将属性的“类型”选择为“文件”，并选择“对象存储”作为存储方式时，您可以根据实际业务需求对文件上传的分块大小进行个性化配置。
分块大小的取值范围为5MB-200MB，默认设置为5MB。
密级
用于标识数据的安全等级，对数据进行分类管理，进而实施有针对性的安全防护措施。用户依据数据特性和业务需求，为数据设置合理密级，降低数据安全风险。
- 内部公开：指可在公司内部公开发布的信息，不属于保密信息。
- 秘密：是公司比较重要或敏感的信息，其泄露会使公司利益受到一定损害，但影响范围有限；适合在体系、部门或特定组织范围公开的信息。
- 机密：对公司运营管理非常重要或内容非常敏感，其泄露会使公司利益遭受巨大损害，且影响范围广泛；只适合在极少数人员或指定岗位范围公开的信息。例如，重要产品的路标规划、营销策略、经营分析报告、销售项目一览表、商务授权及价格信息。
- 绝密：对公司市场竞争、领先对手起决定性作用，其泄露会使公司利益遭受巨大损害，且影响范围广泛；只适合在极少数人员或指定岗位范围公开的信息。例如，核心算法、定价策略、战略意图。
唯一键
用于标识属性值是否需要在关系实体中保持唯一性，确保数据记录的特定字段不出现重复值。
“长文本”类型属性不支持唯一键配置，其他类型属性只能设置为“否”，且不能编辑。
必填
用于标识当前属性在应用运行态创建或修改数据实例时，是否必须提供有效值。xDM-F依据属性类型，对此配置项做出如下默认配置及限制：
- “参考对象”类型属性默认设置为“是”，其他类型属性默认设置为“否”。
- “文件”类型属性只能设置为“否”。
多值
当您将属性的“类型”选择为“枚举”或“人员”后，您需要设置该属性是否允许关联多个值。例如，一辆汽车可以具有多种颜色（红色、蓝色、绿色），或者使用不同类型的燃料（汽油、柴油）等。
值可变
当您将属性的“类型”选择为“文本”、“长文本”、“整型”、“长整型”、“浮点型”、“浮点型（自定义精度）”、“参考对象”、“布尔值”、“日期”、“枚举”、“人员”、“JSON”或“URL”后，您需要设置该属性在创建数据实例后，其值是否可以被修改。
- 是：允许在创建数据实例后修改属性值，默认为“是”。适用于需要灵活调整属性值的场景，例如项目状态（进行中、已完成等）可能随时间变化而改变，或者团队成员的分配可能会根据项目进展进行调整。
- 否：在创建数据实例后，不允许修改该属性值。适用于初始化后不再变化的属性值，例如项目的唯一标识符、员工的工号或网站的固定链接地址等。
值存储方式
当您将属性的“类型”选择为“文本”或“长文本”后，您需要设置其值的存储方式，以确保数据的完整性和一致性。系统提供了三种存储方式供您选择，默认的值存储方式为“原值”。
- 原值：属性值会按照用户实际输入的字符串进行存储，不做任何大小写转换。该存储方式适用于对原始输入内容的精确性有高要求的场景，例如合同中的条款编号、特定术语、代码中的变量名等。
- 大写：系统会将属性值中的小写字符串自动转换为大写字符串后再进行存储。该存储方式适用于需要统一以大写形式展示或处理数据的场景，例如标准化编码（如产品型号、零件编号）、机器生成的识别码（如条形码、二维码对应的字符信息）等。
- 小写：系统会将属性值中的大写字符串自动转换为小写字符串后再进行存储。该存储方式适用于所有数据都需以小写形式存在的场景，例如URL路径、标签和关键词等。
索引
当您将属性的“类型”选择为“文本”、“整型”、“长整型”、“浮点型”、“浮点型（自定义精度）”、“日期”或“人员”后，可以根据实际业务需求进行设置。具体规则如下：
- 如果“类型”选择为“人员”，索引默认设置为“是”。当“类型”为上述列举的其他类型时，索引默认设置为“否”。
- 当“类型”选择为“文本”，且应用的数据库类型为mysql，同时“文本长度”设置大于768个字符时，此索引配置无效，您无需进行该项配置。
入库
用于控制当前属性是否作为数据库表字段持久化存储。
- 是：当用户在应用设计态完成数据模型设计并发布，进而将应用发布和部署至应用运行态后，该属性将作为一个数据库表字段进行存储。
- 否：该属性不会在数据库中生成字段，仅作为临时计算字段使用，例如订单折扣计算中间值属性、支付验证码。
此外，xDM-F依据属性类型，对此配置项做出如下默认配置及限制：
- “参考对象”和“人员”类型属性只能设置为“是”，且不能编辑。
- “文件”类型属性只能设置为“否”，且不能编辑。
- 其他类型属性默认设置为“是”，可根据实际业务需求进行选择。
加密
当您将属性的“类型”选择为“文件”，且将“密级”设置为“机密/秘密/绝密”时，您需要进一步指定是否对该属性进行加密操作，强化对高密级文件的安全防护。
如果“密级”设置为“内部公开”，“文件”类型属性不支持加密配置。
加密方式
当您将“加密”设置为“是”后，您需要进一步指定具体的加密方式。当前支持对称加密和非对称加密两种方式。
- 对称加密：也被称为“私钥加密”。在加密和解密过程中，均使用同一个密钥。适用于对大量数据进行快速加密处理的场景，例如需要对员工信息文档进行加密保存。
- 非对称加密：即公钥加密。其加密和解密过程依赖一对密钥，即公钥与私钥。公钥可公开分发，用于数据加密；私钥则由数据接收方妥善保管，用于解密。
入图
当您将“基本信息”页签中的“同步至LinkX-F”设置为“是”后，您需要设置该属性是否映射至LinkX-F图数据库中的图数据属性，以实现多类型数据源到图数据库的转换。
此配置项需要已开通LinkX-F，否则配置后不生效。如果您未开通LinkX-F，请开通数字主线引擎。
- 是：当前属性将同步至LinkX-F中，并作为图数据属性进行存储。
- 否：当前属性不会同步至LinkX-F中。默认设置为“否”。
入图标识
当您将“入图”设置为“是”后，还需要指定一个入图标识。该标识将在LinkX-F图数据库中用作存储名称（别名）或标识，以便更清晰、准确地识别和引用相关元数据。
必须以字母（A-Z, a-z）开头，且只能包含字母、数字和下划线（_）。
引用类型
当您将属性的“类型”选择为“参考对象”后，您可以通过此配置项定义实体间的数据依赖关系，控制关联对象的删除行为对当前对象的影响。
- 基本信息：设置属性的各项基础信息，完成属性的初步定义。
- 单击“保存”。
如需创建多个属性，可单击“保存继续创建”。
步骤3：功能配置（可选）
完成基本信息的填写后，您可根据实际业务场景，在“功能配置”中设置基础功能或可选功能相对应的功能规则。如果系统提供的默认功能配置已满足您实际的业务需求，可跳过此步骤。
- 选择“功能配置”页签，进入功能配置页面。
图4 功能配置
- 根据实际需求，设置如下信息。
表4 功能配置-参数说明 类型
参数
参数说明
设置规则
扩展属性
如果在填写基本信息时，“功能列表”添加了“扩展属性”，可在“功能配置”中设置“扩展属性”的规则，用于约束应用运行态下该实体可添加的扩展属性类型数量、文本长度等配置。
单击“新增”，参考如下说明进行设置。
- 属性类型：用于约束应用运行态下该实体可添加的扩展属性类型。当前支持选择文本、长文本、整型、长整型、浮点型、浮点型（自定义精度）、布尔值、日期、枚举、分类、URL和文件类型。
- 数量：用于约束应用运行态下该实体可添加对应扩展属性类型的数量。
- 如果应用的数据库类型为mysql，文本、布尔、日期、分类类型的属性数量不可超过200个，长文本类型的属性数量不可超过185个，整型、长整型、浮点型、浮点型（自定义精度）类型的属性数量不可超过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，提供调用。
- 单击“保存”。
