华为云用户手册

请求示例 使用“BaseLineLink_create”接口将 数据实例 “焊接夹具”添加至基线对象“转试产”。 POST https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/common/api/BaseLineLink/create X-AUTH-TOKEN: ABCDEFG.... { "params": { "source":{ "id":"553881194513567744", "clazz":"BaseLine" }, "target":{ "id":553607469406887936, "clazz":"Fixture" } } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户的token。 表3 请求Body参数 参数 是否必选 参数类型 描述 source 是 Object 基线对象信息，需输入基线对象的ID和实体名称。 id：基线对象ID，即创建基线对象返回的ID。 clazz：基线对象的实体名称“BaseLine”。 target 是 Object 基线成员信息，需输入基线成员的ID和实体名称。 id：数据实例ID，即创建数据模型及其实例数据的数据实例唯一编码。 clazz：数据实例的实体名称。例如“Fixture”。 为篇幅起见，这里只展示部分内容。更多参数信息，您可以在全量数据服务进行查看。

响应参数 表4 响应Body参数 参数 参数类型 描述 id String 唯一编码。 rdmExtensionType String 实体类型。 rdmVersion Integer 系统版本。 className String 实体名称。 name String 基线对象的名称。 nameEn String 基线对象的英文名称。 description String 基线对象的描述。 descriptionEn String 基线对象的英文描述。 disableFlag Boolean 是否锁定。 true：锁定。 false：解锁，默认为false。 为篇幅起见，这里只展示部分内容。更多参数信息，您可以在全量数据服务进行查看。

使用说明 如果数据实体的父模型具有数据分类管理，该数据实体自动继承数据分类管理，且不可去除勾选。如果后续父模型删除了数据分类管理功能，该数据实体将不再继承父模型的数据分类管理功能，但可以自己重新勾选数据分类管理功能。 如果数据实体为Master-Version模型数据实体（即“父模型”选择为“VersionObject”），则只能在Version模型上选择数据分类管理功能，Master模型和Branch模型不支持选择数据分类管理功能。

概述 数据分类管理是工业数字模型驱动引擎-数据建模引擎（xDM Foundation，简称xDM-F）为了方便用户将同维度的数据实例进行分门别类管理、实例数据统一归集的能力。数据分类管理指的是数据实例之间存在的“多对多”关系数据结构，主要包含“数据分类”和“数据分类对象”两个部分。 数据分类：“父模型”为“AbstractCategory”的数据实体。“AbstractCategory”是xDM-F用于将用户自定义数据实体设置为数据分类的抽象概念。一个“父模型”为“AbstractCategory”的数据实体表示一种数据分类。 数据分类对象：具有“数据分类管理”功能的数据实体，即用户在应用设计态创建数据实体时，在“功能列表”中勾选了“数据分类管理”功能。具有“数据分类管理”功能的数据实体对外提供如下数据分类相关接口。 表1 数据分类管理相关接口 接口名称 描述 addToCategory 将数据分类对象数据实例添加至数据分类数据实例中。 removeFromCategory 将数据分类数据实例从数据分类对象数据实例中移除。 更多数据分类管理的接口信息请参见全量数据服务。

前提条件 已开通iDME设计服务和购买iDME运行服务。本章节以购买体验版数据建模引擎为例。 已创建与本地服务器已有数据库类型一致的应用，具体操作请参见创建应用。 即，如本地服务器的数据库类型为MySQL，则创建“数据库类型”为“MySQL”的应用。本章节以MySQL数据库类型为例。 已获取如下本地服务器的数据库信息，且该数据库可正常连通。 表1 MySQL数据库信息 类型 描述 数据库名称 database_test 用户名 root 密码 123456 数据库地址 192.168.10.10:3306/database_test 已确定需要将哪些物理表反向生成模型。

操作场景 反向建模是从数据库物理表到数据模型的映射。当您的本地服务器中已有数据库和大量物理表，且希望通过工业数字模型驱动引擎-数据建模引擎（xDM Foundation，简称xDM-F）统一管理所有模型时，可使用xDM-F的反向建模功能，将已有物理表反向建模至xDM-F的数据模型中，帮助您无需再次执行创建模型的操作，即可快速创建数据模型，节省了大量时间成本。 当您的本地服务器中已有数据库和物理表，且希望通过工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME）统一管理所有模型时，可使用反向建模功能，将已有物理表反向建模至iDME的数据模型中。此功能可帮助您无需再次执行创建模型的操作，即可快速创建数据模型，节省了大量时间成本。

下一步操作 反向建模完成后，您可以在iDME执行如下操作。 您可以... 进行... 进入“枚举类型”页面 为数据模型预设枚举值，具体操作请参见创建枚举。 进入“功能模型”页面 自定义功能模型，对数据实体或关系实体的公共特性进行抽象&接口化，具体操作请参见创建功能模型。 发布自定义的功能模型，具体操作请参见发布功能模型。 进入“数据实体”页面 查看创建的数据实体，具体操作请参见查看数据实体。 数据实体属性的添加、修改、删除和上下位置调整，具体操作请参见管理数据实体属性。 为创建的数据实体添加其他iDME内置的工业数据能力，具体操作请参见管理功能配置。 发布创建的数据实体，具体操作请参见发布数据实体。 进入“关系实体”页面 查看创建的关系实体，具体操作请参见查看关系实体。 关系实体属性的添加、修改、删除和上下位置调整，具体操作请参见管理关系实体属性。 为创建的关系实体添加其他iDME内置的工业数据能力，具体操作请参见管理功能配置。 发布创建的关系实体，具体操作请参见发布关系实体。 单击右上方的“应用发布” 应用的发布，生成相应代码包，具体操作请参见发布应用。 完成发布应用后，返回控制台 应用部署至数据建模引擎，具体操作请参见部署应用。 进入应用运行态 相关全量数据服务API的开发操作，具体操作请参见数据建模引擎使用指南。

入参 POST http://{Endpoint}/rdm_{appID}_app/services/dynamic/api/{entityName}/query/pageSize/curPage { "params": { "sorts": [ { "sort": "DESC", "orderBy": "属性名称" } ], "filter": { ...... }, "isNeedTotal": true } } {Endpoint}表示数据建模引擎所在 域名 或IP地址，{appID}表示应用ID，{entityName}表示实体的英文名称。 在URL上填写待查询的页码（curPage）和每页可显示的数据量（pageSize）。 在JSON代码中的设置sorts字段和filter字段。 sorts：填写需要按哪个字段进行排序，可填写模型自身属性、参考对象的属性、扩展属性及分类属性，也可为空。 filter：填写过滤条件，可为空。

入参示例 POST http://dme.cn-north-4.huaweicloud.com/rdm_01a2b2c4764d4e00f123g345fd9baa9f_app/services/dynamic/api/People/query/20/1 { "params": { "sorts": [ { "sort": "DESC", "orderBy": "name" }, { "sort": "DESC", "orderBy": "age" } ], "filter": { "joiner": "and", "conditions": [ { "conditionName": "gender", "operator": "=", "conditionValues": [ "男" ] } ] }, "isNeedTotal": true } }

出参示例 { "result": "SUC CES S", "data": [ { "id": "455304645330341888", "creator": "test1 3c03e719256a427eb9277b64fcXXXXXX", "createTime": "2023-01-13T01:38:07.000+00:00", "modifier": "test1 3c03e719256a427eb9277b64fcXXXXXX", "lastUpdateTime": "2023-01-13T01:38:07.000+00:00", "rdmExtensionType": "People", "tenant": { "id": "-1", "creator": "xdmAdmin", "createTime": "2022-08-03T11:27:44.000+00:00", "modifier": "xdmAdmin", "lastUpdateTime": "2022-08-03T11:27:44.000+00:00", "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "code": "basicTenant", "disableFlag": false, "dataSource": null }, "className": "People", "name": "李四", "description": null, "age": 20 }, { "id": "455304534248394752", "creator": "test1 3c03e719256a427eb9277b64fcXXXXXX", "createTime": "2023-01-13T01:37:40.000+00:00", "modifier": "test1 3c03e719256a427eb9277b64fcXXXXXX", "lastUpdateTime": "2023-01-13T01:37:40.000+00:00", "rdmExtensionType": "People", "tenant": { "id": "-1", "creator": "xdmAdmin", "createTime": "2022-08-03T11:27:44.000+00:00", "modifier": "xdmAdmin", "lastUpdateTime": "2022-08-03T11:27:44.000+00:00", "rdmExtensionType": "Tenant", "tenant": null, "className": "Tenant", "name": "basicTenant", "description": "默认租户", "code": "basicTenant", "disableFlag": false, "dataSource": null }, "className": "People", "name": "张三", "description": null, "age": 18 } ], "errors": [], "pageInfo": { "curPage": 1, "pageSize": 20, "totalRows": 2, "totalPages": 1 } }

操作场景 工业数字模型驱动引擎-数据建模引擎（xDM Foundation，简称xDM-F）可以将待上传的文件分成多个分块分别上传，上传完成后再调用“file_mergeFiles”接口将这些分块合并成一个对象存储至某个数据模型中。完成文件的分块上传后，可在调用数据实例的创建/更新接口时，将文件与该数据实例进行关联，从而实现对象化管理文件。 本文仅指导您如何通过API接口，采用预签名URL的方式分块上传文件至对象存储（OBS/S3）服务。预签名URL上传通过后端生成临时访问凭证，客户端直接与 对象存储服务 交互，既保证了安全性又提高了上传效率。关于如何创建/更新数据实例的接口请参见全量数据服务。

操作步骤 闪传文件。 如果您已上传某个文件，再上传该文件时，您只需执行本步骤即可完成文件上传。 接口相关信息 表1 startBatchUpload接口 接口信息 说明 URI格式 POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/file/startBatchUpload Endpoint：必填，String类型，承载REST服务端点的服务器域名或IP地址。 appID：必填，String类型，应用ID。 applicationId：必填，String类型，应用ID。 model_name：必填，String类型，数据模型的英文名称。 model_number：选填，String类型，数据模型的编码。 attribute_name：必填，String类型，数据模型的属性英文名称。 file_name：选填，String类型，待上传文件的名称。本参数与fileName参数必须二选一。不能同时为空，且优先级低于fileName。 file_size：必填，String类型，待上传文件的大小。 chunks：必填，String类型，待上传文件的分块数量。您可以根据构建数据模型时创建属性的约束（分块大小）计算待上传文件的分块数量。 check_code：必填，String类型，文件唯一校验码，即文件的哈希值。 instance_id：必填，String类型，数据实例的唯一编码。 username：必填，String类型，用户名称。 fileId：选填，String类型，文件ID。 encrypted：选填，Boolean类型，用户名称。 exaAttr：选填，String类型，是否为扩展属性。 0：非扩展属性 1：扩展属性 is_direct：选填，Boolean类型，是否为直链上传。 true：表示通过后端服务直接上传文件流，即直链上传。默认为true。 false：表示使用OBS/S3预签名URL进行上传，即预签名URL上传。 请求参数 Header参数 X-Auth-Token：必填，String类型，用户的token。 Body参数 fileName：选填，String类型，待上传文件的名称。本参数与file_name参数必须二选一。不能同时为空，且优先级高于file_name。 响应参数 result：String类型，调用是否成功。 SUCCESS：成功 FAIL：失败 data：List类型，调用的返回结果。 isMergedFile：是否合并文件。 true：合并文件。 false：不合并文件。 docId：文档ID。 fileId：文件ID。 errors：List类型，异常信息列表。 请求示例 新上传一个101MB的文件“testFile.zip”，由于在添加“文件”类型属性时“分块大小”为默认值（5MB），文件需分为21个分块。 POST https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/api/file/startBatchUpload?applicationId=fce01234567d41828cf3473b07fa7ae2&model_name=Craft_File&attribute_name=LargeFiles&file_name=testFile.zip&file_size=103424&chunks=21&check_code=1234567890&instance_id=1&username=XDM_User&is_direct=false X-Auth-Token: ABCDEFG.... 响应示例 { "result": "SUCCESS", "data": [ { "isMergedFile": false, "docId": "0000018BB1E33DC685E9C0045DFC7291", "fileId": "564032141298503680" } ], "errors": [] } 获取预签名URL。 根据调用startBatchUpload接口设置的分块数量，依次执行uploadLargeFile接口。 接口相关信息 表2 uploadLargeFile接口 接口信息 说明 URI格式 POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/upload/uploadLargeFile Endpoint：必填，String类型，承载REST服务端点的服务器域名或IP地址。 appID：必填，String类型，应用ID。 applicationId：必填，String类型，应用ID。 modelNumber：必填，String类型，数据模型的编码。 modelName：必填，String类型，数据模型的英文名称。 attributeName：必填，String类型，数据模型的属性英文名称。 docId：必填，String类型，文档ID，即1返回的docId。 fileId：必填，String类型，文件ID，即1返回的fileId。 fileName：必填，String类型，待上传文件的名称。 checkCode：必填，String类型，文件的唯一校验码，即文件的哈希值。 chunk：必填，Integer类型，待上传的分块位数。例如您上传第5块分块，填写5。 storageType：选填，Integer类型，文件的存储类型。 0：对象存储。 1：BLOB。 exaAttr：选填，String类型，是否为扩展属性。 0：非扩展属性。 1：扩展属性。 username：选填，String类型，用户名。 uploadType：选填，String类型，文件上传类型。 DIRECT_LINK：直链上传。 OUTBOUND_LINK：预签名URL上传。 请求参数 Header参数 X-Auth-Token：必填，String类型，用户的token。 响应参数 result：String类型，调用是否成功。 SUCCESS：成功。 FAIL：失败。 data：List类型，调用的返回结果。 errors：List类型，异常信息列表。 请求示例 根据请求示例的文件分块数量，依次执行如下接口。为篇幅起见，这里以上传第1个分块为例。 POST https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/api/upload/uploadLargeFile?attributeName=LargeFiles&modelName=Craft_File&applicationId=fce01234567d41828cf3473b07fa7ae2&fileId=564032141298503680&fileName=testFile.zip&checkCode=1234567890&chunk=1&docId=0000018BB1E33DC685E9C0045DFC7291&modelNumber=DM00127285&uploadType=OUTBOUND_LINK X-Auth-Token: ABCDEFG.... 响应示例 { "result": "SUCCESS", "data": [ { "actualSignedRequestHeaders": { "Host": "xdm-982f57b0e0964361a126cbdeff782c25-cnsouth4.obs.cn-south-4.myhuaweicloud.com:443", "Content-Type": "application/octet-stream;charset=UTF-8" }, "signedUrl": "https://xdm-982f57b0e0964361a126cbdeff782c25-cnsouth4.obs.cn-south-4.myhuaweicloud.com:443/c73f29f8ea664f66b6e0c5df5882ecb8/TestFileDE/Att1/0a16bf70-c018-4e9f-b7b2-1943846d17a4.xdmfl?AccessKeyId=xxx&Expires=1744685806&partNumber=1&uploadId=00000196371F8DFAA18400B4B91C75DB&x-obs-security-token=xxx&Signature=xxx" } ], "errors": [] } 分块上传文件。 接口相关信息 表3 预签名URL 接口信息 说明 URI格式 PUT 2获取的预签名URL（即signedUrl参数对应值） 请求参数 Header参数 Content-Type：内容类型。 响应参数 Header参数 Etag：被请求变量的实体值。 请求示例 PUT https://xdm-982f57b0e0964361a126cbdeff782c25-cnsouth4.obs.cn-south-4.myhuaweicloud.com:443/c73f29f8ea664f66b6e0c5df5882ecb8/TestFileDE/Att1/0a16bf70-c018-4e9f-b7b2-1943846d17a4.xdmfl?AccessKeyId=xxx&Expires=1744685806&partNumber=1&uploadId=00000196371F8DFAA18400B4B91C75DB&x-obs-security-token=xxx&Signature=xxx Content-Type: application/octet-stream;charset=UTF-8 响应示例 Etag: "e316ff262e7ad4461101357703f30ed2" 确认分块文件上传已完成。 接口相关信息 表4 confirm接口 接口信息 说明 URI格式 POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/upload/v1/confirm Endpoint：必填，String类型，承载REST服务端点的服务器域名或IP地址。 appID：必填，String类型，应用ID。 请求参数 Header参数 X-Auth-Token：必填，String类型，用户的token。 Body参数 chunk：必填，int类型，当前分段数。 chunk_file_size：必填，int类型，分块文件大小。 doc_id：必填，String类型，文档ID，即1返回的docId。 e_tag：必填，String类型，被请求变量的实体值，即3返回的响应头Etag。 file_id：必填，String类型，文件ID。 file_name：必填，String类型，文件名称。 响应参数 result：String类型，调用是否成功。 SUCCESS：成功。 FAIL：失败。 data：List类型，调用的返回结果。 fileSize：文件的大小。 fileId：文件ID。 errors：List类型，异常信息列表。 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/apiupload/v1/confirm X-Auth-Token: ABCDEFG.... { "doc_id": "ZTU3ODA2Y2ItN2VlYy00ZTQ4LWJmNDUtOGI1YTMxZGVjMzg4LjViYzBkMWUxLWZiMmMtNGJlNS1iZDhmLThkMzBkN2VmMDdmZA", "file_id": "753573461103742976", "chunk": 4, "file_name": "test.tar", "chunk_file_size": 6410240, "e_tag": "e316ff262e7ad4461101357703f30ed2" } 响应示例 { "result": "SUCCESS", "data": [], "errors": [] } 分块合并。 接口相关信息 表5 mergeFiles接口 接口信息 说明 URI格式 POST http://{Endpoint}/rdm_{appID}_app/services/rdm/basic/api/file/mergeFiles Endpoint：必填，String类型，承载REST服务端点的服务器域名或IP地址。 appID：必填，String类型，应用ID。 applicationId：必填，String类型，应用ID。 modelName：必填，String类型，数据模型的英文名称。 attributeName：必填，String类型，数据模型的属性英文名称。 docId：必填，String类型，文档ID，即1返回的docId。 fileId：必填，String类型，文件ID，即1返回的fileId。 fileName：必填，String类型，待上传文件的名称。 checkCode：必填，String类型，文件的唯一校验码，即文件的哈希值。 instanceId：选填，String类型，数据实例的唯一编码。 exaAttr：选填，String类型，是否为扩展属性。 0：非扩展属性。 1：扩展属性。 请求参数 Header参数 X-Auth-Token：必填，String类型，用户的token。 响应参数 result：String类型，调用是否成功。 SUCCESS：成功。 FAIL：失败。 data：List类型，调用的返回结果。 fileSize：文件的大小。 fileId：文件ID。 errors：List类型，异常信息列表。 请求示例 POST https://dme.cn-north-4.huaweicloud.com/rdm_fce01234567d41828cf3473b07fa7ae2_app/services/rdm/basic/api/file/mergeFiles?applicationId=fce01234567d41828cf3473b07fa7ae2&modelNumber=DM00127285&modelName=Craft_File&attributeName=LargeFiles&fileName=testFile.zip&checkCode=1234567890&docId=0000018BB1E33DC685E9C0045DFC7291&exaAttr=0&fileId=564032141298503680 X-Auth-Token: ABCDEFG.... 响应示例 { "result": "SUCCESS", "data": [ { "fileSize": "103424", "fileId": "564032141298503680" } ], "errors": [] }

操作流程 使用分块上传文件之前，您必须先调用“文件管理”的“file_startBatchUpload”接口校验待上传的文件之前是否上传至某个数据模型中。如果您之前已经上传某个文件，现在需要重新上传，那么该文件具有闪传能力，会自动闪传至数据模型中，无需重新分块上传。如果您没有上传过该文件，调用“file_startBatchUpload”接口时，初始化分块上传，成功执行此请求后将返回“docId”和“fileId”，用于后续的分块请求。 初始化分块上传后，调用“文件管理”的“upload_uploadLargeFile”接口根据指定的“docId”、“fileId”、“chunk”等参数值获取预签名URL。 获取预签名URL后，使用PUT请求方式，将2返回的请求头设为本次请求头，以二进制文件形式上传预先切分好的文件分块。 完成分块上传后，调用“文件管理”的“upload_v1_confirm”接口来确认分块上传的状态，用以确保所有分块都已成功上传，并且文件的完整性得到了验证。 当使用“upload_uploadLargeFile”完成所有分块上传后，您必须调用“file_mergeFiles”来完成整个文件的分块上传。在使用该接口时，您必须在请求体中给出“docId”、“fileId”和“chunk”等参数值，用来校验每个分块的有效性。当所有的分块验证通过后，系统将把这些分块合并成一个完整的文件。

步骤2：选择定时调度配置场景 定时调度是指制定定时调度计划后，系统会按照已设置调度计划中的执行时间和频次自动执行任务调度。 请注意，基础版-Lite租户中的模型数据入图任务不支持进行定时调度配置。 进入“数据入图任务”页面。 （可选）通过条件筛选功能，快速筛选出“数据入图类型”为“源系统API映射”的任务。 图4 数据入图类型为源系统API映射的任务 找到待操作的目标任务，单击其操作列处的，弹出调度计划配置窗口。 请注意，批量制定定时调度计划时，不支持选择多个源系统API映射类型的数据入图任务进行操作。 图5 调度计划配置窗口 配置调度计划参数。 表5 调度计划配置参数说明 参数 说明 调度周期 调度周期的时间单位，包括分、时、天、周和月。 间隔时间 选择调度执行的间隔时间。 调度首次执行时间 选择调度首次执行时间。 首次执行时间不能早于当前时间，确保调度计划能够正常运行。 调度截至执行时间 选择调度截至执行时间。 截止执行时间不能早于首次执行时间，默认为空表示无限期。 数据起始时间 确定入图的数据起始时间。 数据分片间隔 每次调度按分片间隔时间读取数据。 业务参数 业务参数区分非Body参数和Body参数。仅“数据入图类型”为“源系统API映射”才显示且非必填。 如果业务参数选择非Body参数，则支持添加多个且最多不能超过5个，下拉可选值来源于源系统API接入时Swagger里解析出的入参参数。 如果业务参数选择Body参数，则需在“Body”框中输入Json格式的Body请求体参数。 Body 输入Json格式的Body请求体参数。 仅当业务参数选择Body参数时显示且必填。 配置完调度计划后单击“保存”。 单击“启动”，启动定时调度任务。 如有需要，您也可进入目标任务的调度计划页面暂停或停止已启动的任务。根据实际的业务场景，支持批量启动、暂停或停止多个制定计划的任务，但请注意，该操作会同时影响对应任务中的所有调度。 启动任务：在任务列表中勾选已制定计划的任务，单击“启动”。 暂停任务：在任务列表中勾选已启动的任务，单击“暂停”。已暂停的任务再次启动时会延续上一次的进程。 停止任务：在任务列表中勾选已启动的任务，单击“停止”。已停止的任务再次启动时会重新开始进程。

步骤2：选择手工调度配置场景 同一任务可同时开启多个手工调度，且所有任务总计不超过10个调度。需保证处在“执行中”或“待执行”的各调度之间的调度数据起止时间不可重叠，否则无法执行。 进入“数据入图任务”页面。 （可选）通过条件筛选功能，快速筛选出“数据入图类型”为“源系统API映射”的任务。 图2 数据入图类型为API映射的任务 找到待操作的目标任务，单击其操作列处的，弹出手工调度配置窗口。 图3 手工调度配置窗口 配置手工调度参数。 表4 手工调度配置参数说明 参数 说明 数据起止时间 确定入图的数据范围，即数据起始时间和数据终止时间。 非首次制定计划数据起止时间根据上次调度数据结束时间与系统当前时间自动填充。 数据分片间隔 数据分片定义了系统从后台取数据的粒度，数据分片间隔根据选择单位和计数器制定。 分钟从5起步，自增长步长为5，最大不超过60。 小时、天、周和月从1起步，自增长步长为1。小时最大不超过24小时，天最大不超过30天，周最大不超过4周，月最大不超过12月。 业务参数 业务参数区分非Body参数和Body参数。仅“数据入图类型”为“源系统API映射”才显示且非必填。 如果业务参数选择非Body参数，则支持添加多个且最多不能超过5个，下拉可选值来源于源系统API接入时Swagger里解析出的入参参数。 如果业务参数选择Body参数，则需在“Body”框中输入Json格式的Body请求体参数。 Body 输入Json格式的Body请求体参数。 仅当业务参数选择Body参数时显示且必填。 VIP调度 VIP调度可享受最高调度优先级。 请注意，基础版-Lite租户中的模型数据入图任务不支持VIP调度功能。 配置完调度参数后单击“确定”，立即执行。

数据实例概述 实例是数据模型实例化的数据，包括数据实体实例以及关系实体实例。LinkX-F系统中数据实例来源有以下几种。 当数据模型的源端映射和目标端映射发布后，对应关系型数据库和图数据库中产生的数据实例。 xDM-F来源的实体发布后，如果在xDM-F应用运行态中更新对应实体的实例数据（如新增、修改、删除），相应的实例数据也会自动同步至LinkX-F系统并入图。 在数据实例页面为具体的实体模型新增的实例数据。 父主题： 数据实例

调用服务 聚合服务发布成功后，您可根据业务需要调用已发布的API接口。调用方在目标服务的“服务发布”页签中获取相应的API调用信息后，可通过API方式调用服务编排。 图1 获取API调用信息（纯脚本服务示例） API调用信息：包括生产环境API调用链接和测试环境API调用链接。其中测试环境API需在测试环境发布后才支持调用。 请求头参数说明：包括tenantId和Iam-X-Auth-Token。 表1 请求头参数获取方法 名称 获取方法 tenantId 登录LinkX-F系统后，在浏览器地址栏复制对应tenantId值。 Iam-X-Auth-Token Token获取的具体方法可参考认证鉴权。 请求体参数说明：来源于“服务定义”页签中设置的入参。

创建数据/关系实体及实例 开发人员及以上权限的用户，可通过“数据模型图谱”页面中的快捷入口，创建数据实体/关系实体，并向图数据库中添加相应实体的实例数据。 请注意，新创建的实体需要发布后才可在模型图谱中显示，具体操作请参考发布数据实体或发布关系实体。 创建数据实体：在画布空白处按鼠标右键调出的快捷菜单中单击“创建数据实体”，右侧弹出新增实体页面（更多操作请参见创建数据实体）。 创建数据实体的实例：在画布中选中数据实体模型节点，按鼠标右键调出的快捷菜单中单击“创建实例”，右侧弹出新增实例页面（仅显示“是否入图”为“是”的属性），填写实例信息后保存。 创建关系实体：按住Ctrl键，然后在画布中单击选中两个数据实体后，在其中一个数据实体上按鼠标右键调出的快捷菜单中单击“创建关系实体”，右侧弹出新增实体页面（更多操作请参见创建关系实体）。 创建关系实体的实例：在画布中选中实体间的关系线后，按鼠标右键调出的快捷菜单中单击“创建实例”，右侧弹出新增实例页面（仅显示“是否入图”为“是”的属性），填写实例信息后保存。请注意，此方法仅适用于实体关系实例的创建。

通过同步xDM-F方式创建单位类型 通过xDM-F同步任务，可将xDM-F单位类型同步至LinkX-F系统中的指定租户下，这类单位类型仅作为xDM-F来源模型的引用属性配置，不支持被LinkX-F自定义实体在管理属性时使用。您可以通过“单位来源”显示信息来区分是否为xDM-F单位类型。如果是，单位来源将显示对应的xDM-F应用和租户信息，显示规则为XDM_{xDM-F应用英文名称}_{xDM-F租户编码}。 同步xDM-F应用下模型数据的具体操作以及模型数据同步规则请参见xDM-F同步任务。

推荐业务流程二 图2 xDM-F数据同步推荐业务流程二 授权具有应用设计态角色的 IAM 用户为企业级管理员。 在全局用户授权页面，将具有应用设计态角色（包括应用责任人、应用开发人员和应用只读成员）的IAM用户授权为企业级管理员。 创建xDM-F数据同步任务。 在xDM-F同步任务页面，为将要同步的应用创建xDM-F同步任务。 在iDME控制台完成相关操作。 在iDME控制台，已完成应用的功能设计和开发，并打开数字主线引擎与对应基础版数据建模引擎间的数据连接通道开关，完成了应用部署。应用部署时会自动将xDM-F模型同步至LinkX-F。 发布LinkX-F数据模型。 在数据模型管理中，xDM-F来源的LinkX-F模型发布后会自动生成xDM-F映射和图数据库映射，即可实现增量实例数据的实时同步。具体操作可参考发布数据实体和发布关系实体。 创建实例调度任务。 在实例调度任务页面，可通过创建实例调度任务，实现xDM-F模型全量或指定时间范围内的实例数据定时同步。

推荐业务流程一 图1 xDM-F数据同步推荐业务流程一 授权具有应用设计态角色的IAM用户为企业级管理员。 在全局用户授权页面，将具有应用设计态角色（包括应用责任人、应用开发人员和应用只读成员）的IAM用户授权为企业级管理员。 在iDME控制台完成相关操作。 在iDME控制台，已完成应用的功能设计和开发，并打开数字主线引擎与对应数据建模引擎间的数据连接通道开关，完成了应用部署。 创建xDM-F数据同步任务。 在xDM-F同步任务页面，为将要同步的应用创建xDM-F同步任务。 手动同步xDM-F模型数据。 在xDM-F同步任务页面，执行手动同步操作可立即为您同步xDM-F数据。 发布LinkX-F数据模型。 在数据模型管理中，xDM-F来源的LinkX-F模型发布后会自动生成xDM-F映射和图数据库映射，即可实现增量实例数据的实时同步。具体操作可参考发布数据实体和发布关系实体。 创建实例调度任务。 在实例调度任务页面，可通过创建实例调度任务，实现xDM-F模型全量或指定时间范围内的实例数据定时同步。

iDME控制台相关操作 图3 在iDME控制台完成相关操作 开通服务和设计应用。 开通iDME设计服务、基础版/基础版-Lite数据建模引擎和数字主线引擎，并在应用设计态完成了应用的功能设计开发和发布，具体操作请参考开通服务和登录应用设计态。 连接数据建模引擎。 打开数字主线引擎与对应基础版/基础版-Lite数据建模引擎间的数据连接通道开关。具体操作请参考管理数据连接。 请注意，在公有云场景下必须执行此操作，而边缘云场景下则无需执行。 部署应用。 完成应用部署后可正常登录应用运行态，具体操作请参考部署应用和登录应用运行态。

系统权限说明 数字主线引擎（LinkX Foundation，简称LinkX-F）中预置了四种角色，即企业级管理员、租户级管理员、开发人员和只读人员。 关于设置系统权限的详细操作请参见用户权限管理。 企业级管理员（En_ADMINISTRATOR）：拥有系统操作的最高权限，并可对除自身外的其他用户进行数据权限授权。 数字主线引擎创建成功后会自动开通企业租户，即服务购买也是开通企业租户的账号。该账号登录数字主线引擎后，系统默认会为其配置该角色。 租户级管理员（Func_ADMINISTRATOR）：由企业级管理员授权，享有授权应用租户下除“领域”外的其他模块的数据操作权限，但不包含“xDM-F数据同步”和“全局用户授权”的可见可操作权限。 开发人员（Func_DEVELOPER）：由企业级管理员或租户级管理员授权，享有授权应用租户下除“领域”、“租户管理”和“用户权限管理”外的其他模块的数据操作权限，但不包含“xDM-F数据同步”、“全局用户授权”和“活动日志”的可见可操作权限。 只读人员（Func_READER）：由企业级管理员或租户级管理员授权，享有授权应用租户的数据只读权限，但不包含“xDM-F数据同步”、“全局用户授权”和“活动日志”的可见权限。 表1 我的工作空间 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 导出任务 查看 √ √ √ √ 导出任务 下载导出文件 √ √ √ × 导入任务 查看 √ √ √ √ 导入任务 下载错误报告 √ √ √ × 探索任务 查看 √ √ √ √ 探索任务 删除 √ √ √ × 探索任务 重命名 √ √ √ × 活动日志 查看 √ √ × × 我的申请 查看 √ √ √ √ 我的审批 查看 √ √ √ √ 我的审批 通过/驳回申请单 √ √ × × 表2 xDM-F数据同步 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 xDM-F同步任务 查看 √ × × × xDM-F同步任务 创建 √ × × × xDM-F同步任务 修改 √ × × × xDM-F同步任务 一键清除实例数据 √ × × × xDM-F同步任务 删除 √ × × × xDM-F同步任务 同步 √ × × × 实例调度任务 查看 √ × × × 实例调度任务 创建 √ × × × 实例调度任务 停止 √ × × × 表3 模型设计-数据模型图谱 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 数据模型图谱 查看 √ √ √ √ 数据模型图谱 创建实体 √ √ √ × 数据模型图谱 创建实例 √ √ √ × 表4 模型设计-数据模型管理 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 数据实体 查看 √ √ √ √ 数据实体 创建 √ √ √ × 数据实体 逆向建模 √ √ √ × 数据实体 导入 √ √ √ × 数据实体 删除 √ √ √ × 数据实体 编辑 √ √ √ × 数据实体 发布 √ √ √ × 数据实体 作废 √ √ √ × 数据实体 配置数据源映射 √ √ √ × 数据实体 管理单数据实体属性约束规则 √ √ √ × 数据实体 同步xDM-F实体变更信息 √ √ √ × 数据实体 失效 √ √ √ × 数据实体 修订 √ √ √ × 数据实体 导出 √ √ √ × 数据实体 管理实体标签 √ √ √ × 数据实体 批量删除模型实例 √ √ × × 数据实体 批量编辑责任人 √ √ × × 关系实体 查看 √ √ √ √ 关系实体 创建 √ √ √ × 关系实体 逆向建模 √ √ √ × 关系实体 导入 √ √ √ × 关系实体 删除 √ √ √ × 关系实体 编辑 √ √ √ × 关系实体 发布 √ √ √ × 关系实体 配置数据源映射 √ √ √ × 关系实体 同步xDM-F实体变更信息 √ √ √ × 关系实体 失效 √ √ √ × 关系实体 修订 √ √ √ × 关系实体 作废 √ √ √ × 关系实体 管理实体标签 √ √ √ × 关系实体 导出 √ √ √ × 关系实体 批量删除模型实例 √ √ × × 关系实体 批量编辑责任人 √ √ × × 公共数据实体 查看 √ √ √ √ 公共数据实体 申请/取消引用 √ √ √ × 公共关系实体 查看 √ √ √ √ 公共关系实体 引用 √ √ √ × 数据实例 查询 √ √ √ √ 数据实例 新增 √ √ √ × 数据实例 删除 √ √ √ × 引用属性配置-枚举类型 查看 √ √ √ √ 引用属性配置-枚举类型 创建 √ √ √ × 引用属性配置-枚举类型 编辑 √ √ √ × 引用属性配置-枚举类型 删除 √ √ √ × 引用属性配置-枚举类型 导入 √ √ √ × 引用属性配置-枚举类型 导出 √ √ √ × 引用属性配置-单位类型 查看 √ √ √ √ 引用属性配置-单位类型 创建 √ √ √ × 引用属性配置-单位类型 编辑 √ √ √ × 引用属性配置-单位类型 删除 √ √ √ × 表5 模型设计-数据看板 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 数据实体统计 查看 √ √ √ √ 数据实体属性统计 查看 √ √ √ √ 数据实体实例数据统计 查看 √ √ √ √ 数据源映射统计 查看 √ √ √ √ 表6 数据联接-数据入图 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 数据入图任务 查看 √ √ √ √ 数据入图任务 创建 √ √ √ × 数据入图任务 配置 √ √ √ × 数据入图任务 编辑 √ √ √ × 数据入图任务 删除 √ √ √ × 数据入图任务 作废 √ √ √ × 数据入图任务 调整任务优先级 √ √ √ × 数据入图调度 查看 √ √ √ √ 数据入图调度 暂停/恢复 √ √ √ × 数据入图调度 取消挂起 √ √ √ × 数据入图调度 重试/终止 √ √ √ × 数据入图对账 查看 √ √ √ √ 数据入图对账 实时对账 √ √ √ × 数据入图对账 设置对账映射 √ √ √ × 数据入图对账 导出 √ √ √ × 数据质量报表 查看 √ √ √ √ 数据质量报表 修改 √ √ √ × 数据入图记录 查看 √ √ √ √ 表7 数据质量 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 质量检查任务 查看 √ √ √ √ 质量检查任务 创建 √ √ √ × 质量检查任务 修改 √ √ √ × 质量检查任务 删除 √ √ √ × 质量检查任务 终止/重启 √ √ √ × 质量检查报告 查看 √ √ √ √ 表8 数据探索 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 模型图谱 查看 √ √ √ √ 数据探索-实例图谱探索 查看 √ √ √ √ 数据探索-实例图谱探索 创建 √ √ √ × 数据探索-实例图谱探索 修改 √ √ √ × 数据探索-实例图谱探索 删除 √ √ √ × 数据探索-模型路径探索 查看 √ √ √ √ 数据探索-模型路径探索 创建 √ √ √ × 数据探索-模型路径探索 配置数据源 √ √ √ × 数据探索-模型路径探索 发布 √ √ √ × 数据探索-模型路径探索 配置探索视图 √ √ √ × 数据探索-模型路径探索 修改 √ √ √ × 数据探索-模型路径探索 删除 √ √ √ × 探索视图 查看 √ √ √ √ 表9 数据服务 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 聚合服务编排 查看 √ √ √ √ 聚合服务编排 创建 √ √ √ × 聚合服务编排 修改 √ √ √ × 聚合服务编排 删除 √ √ √ × 聚合服务编排 发布 √ √ √ × 聚合服务编排 数据集配置 √ √ √ × 聚合服务编排 数据展示配置 √ √ √ × 聚合服务编排 另存 √ √ √ × 聚合服务编排 修订 √ √ √ × 聚合服务编排 作废 √ √ √ × 聚合服务编排 更新 √ √ √ × 聚合服务编排 标签操作 √ √ √ × 聚合服务编排 批量编辑责任人 √ √ × × 聚合服务编排 批量编辑维护人 √ √ × × 聚合服务编排 导出 √ √ √ × 环境变量 查看 √ √ √ √ 环境变量 创建 √ √ √ × 环境变量 修改 √ √ √ × 环境变量 删除 √ √ √ × 表10 数据黄页 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 总览 查看 √ √ √ √ 领域维度 查看 √ √ √ √ 租户维度 查看 √ √ √ √ 表11 数字化场景 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 数字化场景 查看 √ √ √ √ 数字化场景 创建 √ √ √ × 数字化场景 修改 √ √ √ × 数字化场景 管理关联的数据服务 √ √ √ × 数据化场景 删除 √ √ √ × 数据化场景 发布 √ √ √ × 数据化场景 修订 √ √ √ × 数据化场景 另存 √ √ √ × 数据化场景 作废 √ √ √ × 业务对象 查看 √ √ √ √ 业务对象 创建 √ √ √ × 业务对象 修改 √ √ √ × 业务对象 管理关联的数据实体 √ √ √ × 业务对象 删除 √ √ √ × 表12 基础数据管理 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 数据源 查看 √ √ √ √ 数据源 创建 √ √ √ × 数据源 修改 √ √ √ × 数据源 删除 √ √ √ × 源系统 查看 √ √ √ √ 源系统 创建 √ √ √ × 源系统 修改 √ √ √ × 源系统API 查看 √ √ √ √ 源系统API 创建 √ √ √ × 源系统API 修改 √ √ √ × 源系统API 删除 √ √ √ × 设备API 查看 √ √ √ √ 设备API 创建 √ √ √ × 设备API 修改 √ √ √ × 设备API 删除 √ √ √ × 标签 查看 √ √ √ √ 标签 创建 √ √ √ × 标签 修改 √ √ √ × 标签 删除 √ √ √ × 领域 查看 √ √ √ √ 领域 创建 √ × × × 领域 修改 √ × × × 领域 删除 √ × × × 表13 用户权限管理 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 租户用户授权 查看 √ √ √ √ 租户用户授权 授权 √ √ × × 租户用户授权 修改 √ √ × × 租户用户授权 删除 √ √ × × 全局用户授权 查看 √ × × × 全局用户授权 授权 √ × × × 全局用户授权 修改 √ × × × 全局用户授权 删除 √ × × × 角色管理 查看 √ √ √ √ 表14 租户管理 二级菜单 功能 企业级管理员 租户级管理员 开发人员 只读人员 我的租户 查看 √ √ √ √ 我的租户 修改 √ √ × × 租户管理 查看 √ √ √ √ 租户管理 创建 √ × × × 租户管理 启用/停用 √ √ × ×

实体创建方式概述 系统提供多种方式生成数据实体，包括自定义实体参数、集成xDM-F模型信息、逆向建模或导入数据实体。 自定义实体参数：自定义实体相关参数生成实体模型。 同步xDM-F模型：集成xDM-F应用下的模型信息自动生成正在工作的LinkX-F实体，快速同步xDM-F模型定义与属性信息。 逆向建模：将用户已有数据库的数据转换为模型，快速复刻复杂实体及实体对应的多个属性。 导入数据实体：通过上传xlsx文件，一次性批量导入实体及其属性。

通过同步xDM-F方式创建实体 通过xDM-F同步任务，可以将xDM-F数据实体模型及其属性信息同步至LinkX-F系统，从而快速生成与xDM-F模型相对应的LinkX-F数据实体。这些实体被存放在指定租户下，且状态处在“正在工作”中，“模型来源”值显示为“xDM-F”。有关如何同步xDM-F应用下模型数据，请参考xDM-F数据同步功能使用指引。 请注意，xDM-F来源的数据实体存在以下修改限制： 在“基本信息”中，不支持对“责任人”、“关联领域”、“源系统”、“是否主数据”、“产品阶段”和“标签”外的其他字段进行修改。 在“数据实体属性”中，仅支持上移、下移、置顶对应的自定义属性，其他操作均不支持（如新增、修改、删除、生效、失效等）。

注意事项 xDM-F来源的关系实体，仅支持上移、下移、置顶对应的自定义属性，其他操作均不支持（如新增、修改、删除、生效、失效等）。xDM-F模型的属性与LinkX-F属性自动匹配规则如下： 如果xDM-F模型属性的英文名称与LinkX-F“系统基本属性”相同（不区分大小写），则与系统基本属性匹配。其中实体属性“类型”保持LinkX-F系统固有不变，“系统基本属性”的“是否入图”值显示规则与LinkX-F自创建实体相同，实体发布后均更新为是。 如果其他属性（如扩展属性）同步过来后会自动匹配为自定义属性。如果属性是唯一键或关联属性，不论xDM-F实体属性是否“入图”，LinkX-F实体发布后都会自动为对应属性配置图数据库映射字段，后续自动入图。

相关操作 实体未发布前，您可进入实体编辑状态，在实体属性页签对实体的属性进行一些相关操作，具体如下。 表2 实体属性相关操作 操作 说明 修改实体属性 单击属性的“英文名称”，在弹窗中修改属性后保存。需注意，仅部分字段支持修改。 删除实体属性 勾选一条或多条自定义属性，单击列表上方的“删除”。可能出现以下情况： 勾选本次新添加的属性，成功删除。 勾选本次修订前已发布的属性，按钮置灰，不可操作。 失效实体属性 勾选一条或多条自定义属性，单击“失效”。失效实体时，请注意： 仅历史版本生效的属性支持失效。失效成功后，属性英文名称旁回显失效标识，并显示EOS日期，系统当前缺省将EOS时间定为60个自然日。已失效的属性字段在数据实例列表中不再展示。 实体最新版本新增的属性不支持失效，“失效”按钮置灰且不可操作。 生效实体属性 勾选处于“失效”状态的自定义属性，单击“生效”。 上移/下移实体属性 勾选实体的自定义属性，单击“上移”或“下移”，或直接单击实体属性“操作”列处的置顶。

通过同步xDM-F方式创建实体 通过xDM-F同步任务，可以将xDM-F数据实体模型及其属性信息同步至LinkX-F系统，从而快速生成与xDM-F模型相对应的LinkX-F关系实体。这些实体被存放在指定租户下，且状态处在“正在工作”中，“模型来源”值显示为“xDM-F”。有关如何同步xDM-F应用下模型数据，请参考xDM-F数据同步功能使用指引。 区分实体关系同步和非实体关系同步，如表3所示。 表3 同步规则说明 关系类型 同步规则说明 实体关系 仅同步xDM-F模型对应“基本信息”中“同步至LinkX-F”为“是”、“模型分类”为“业务数据模型”的关系实体。同时，实体属性会被全部同步，并根据xDM-F实体属性是否“入图”自动映射写入对应LinkX-F实体属性的“是否入图”值。但如果属性是唯一键或关联属性，不论xDM-F实体属性是否“入图”，LinkX-F实体发布后都会自动为对应属性配置图数据库映射字段，后续自动入图。 非实体关系 仅当同步过来的源端和目标端数据实体存在关联，且其中有类型为“参考对象”的扩展属性或基本属性时，LinkX-F系统会自动生成相关的非实体关系。非实体关系命名规则为{源端数据实体英文名称}_ForeignKey_{目标端数据实体英文名称}_{源端数据实体属性的英文名称}。 请注意，xDM-F来源的关系实体存在以下修改限制： 在“基本信息”中，不支持对“责任人”、“源系统”、“是否主数据”、“产品阶段”和“标签”外的其他字段进行修改。 在“关系实体属性”中，仅支持上移、下移、置顶对应的自定义属性，其他操作均不支持（如新增、修改、删除、生效、失效等）。

实体新增方式概述 系统提供多种方式生成关系实体，包括自定义实体参数、集成xDM-F模型信息、逆向建模和导入关系实体。 自定义实体参数：自定义实体相关参数生成实体模型。 集成xDM-F模型：集成xDM-F应用下的模型自动生成正在工作的LinkX-F实体，快速同步xDM-F模型定义与属性信息。 逆向建模：将用户已有数据库的数据转换为模型，快速复刻复杂实体及实体对应的多个属性。 导入关系实体：通过上传xlsx文件，一次性批量导入实体及其属性。