配置数据源映射

前提条件

已获取开发人员及以上权限用户的账号和密码。

配置关系型数据库映射（源端映射）

1. 登录LinkX-F系统首页。
2. 选择“模型设计 > 数据模型管理”，默认进入“数据实体”页面。
3. 单击目标实体的“编码”链接，在弹出的详情页单击“数据源映射”页签，默认进入“源端映射”页签。
4. 在关系型数据库映射处单击“新增”，弹出数据库映射新增页。
5. 填写映射信息，如表1所示：

   表1 新增数据库映射参数说明

   参数	说明
   映射名称	必填，不能与其他数据库映射名称重复，长度不能超过128个字符。
   数据源类型	必填，配置“关系型数据库”，包括Oracle、PostgreSQL、MySQL、SQL Server。
   数据源名称	必填，来源于“基础数据管理 > 数据源”中的关系型数据库类型的数据源。
   数据库类型	根据“数据源名称”选择不同自动写入。
   数据源所属领域	必填，选择“数据源类型”和“数据源名称”后自动写入。
   抽取方式	必填，物理表和自定义SQL。
   Schema	下拉自定义选择。仅当“抽取方式”选“物理表”时显示该参数。
   自定义SQL	填写SQL语句。仅当“抽取方式”选“自定义SQL”时才显示该参数。
   表名	数据库表名，下拉可选值随“Schema”参数选择而变化。
   增量字段	非必填，用于数据库表中支持增量更新数据的时间戳字段，只能选择数据库表中的时间型属性，无数据接入时无影响。
   源系统	非必填，在下拉框中选择源系统，可选值来源于“基础数据管理 > 源系统”。

6. 填写完后单击“保存”。
7. 发布关系型数据库映射。
   单击目标映射操作列处的或通过“映射编码”链接进入详情页后单击“发布”，

   

   新创建的关系型数据库映射要发布后才可生效。

   作为后续输出关系型数据库的首选映射，其使用场景和配置规则如下：

   • 首选映射的使用场景：主要作用于在数据实例中查询全量数据，在聚合服务中将非索引属性设置为出参，在数据入图对账中统计整合层数据量。
   • 首选映射的配置规则：仅“抽取方式”为物理表的关系型数据库才可被作为首选映射。当已发布的第一条关系型数据库映射满足条件时，会自动被设置为首选映射项。
   创建关系型数据库映射后，您可以对其进行一些相关操作，具体如下。

   表2 关系型数据库映射相关操作

   操作	说明
   修改关系型数据库映射	进入关系型数据库映射编辑状态。 在“正在工作”映射后单击或单击“映射名称”链接，在弹出的映射详情页单击“编辑”。 修改映射信息后，单击“保存”。
   删除关系型数据库映射	勾选一条或多条“正在工作”的映射，单击“删除”。
   测试关系型数据库映射	单击映射“操作”列处的，弹出数据映射测试窗口。 在“增量集成”处设置“数据条目数”、“起止时间”和“超时设置”等参数。 单击“测试”，验证返回数据。
   修订关系型数据库映射	单击已发布的目标映射操作列处的。 修订成功后即可复制一个“正在工作”状态的映射，其中“数据源类型”、“数据源名称”不可修改。
   作废关系型数据库映射	单击已发布的目标映射操作列处的。

配置API映射（源端映射）

1. 登录LinkX-F系统首页。
2. 选择“模型设计 > 数据模型管理”，默认进入“数据实体”页面。
3. 单击目标实体的“编码”链接，在弹出的详情页单击“数据源映射”页签，默认进入“源端映射”页签。
4. 在API映射处单击“新增”，弹出映射新增页。
5. 填写映射信息，如表3所示：

   表3 映射信息

   参数	说明
   基本信息
   映射名称	必填，必须以大写字母开头，且只能包含字母、数字、下划线，不能与当前实体内其他源系统API映射名称重复，长度不能超过128个字符。
   源系统	必填，来源于“基础数据管理 > 源系统”。
   API名称	必填，来源于“基础数据管理 > 源系统API”，根据“源系统”选择不同可选的下拉值不同，只可选API类型为“普通API”或“外键依赖API”的源系统API。
   API类型	根据“API名称”选择不同自动写入。
   API URL	根据“API名称”选择不同自动写入。
   映射类型	根据“API名称”选择不同自动写入。
   映射配置
   API出参	根据“API名称”选择显示对应API的出参。
   数据实体属性映射	配置API出参和当前数据实体的属性映射。必须保证至少一个唯一键和必填项属性有配置映射。 从“API出参”处拖动字段至“实体属性映射”对应字段后的填写框中。

6. 配置完后单击“保存”。
7. 发布API映射。

   单击目标映射操作列处的或通过“映射名称”链接进入详情页后单击“发布”。

   

   新创建的API映射要发布后才可生效。

   创建API映射后，您可以对其进行一些相关操作，具体如下。

   表4 API映射相关操作

   操作	说明
   修改API映射	进入API映射编辑状态。 在“正在工作”映射后单击或单击“映射名称”链接，在弹出的映射详情页单击“编辑”。 修改映射信息后，单击“保存”。
   删除API映射	勾选一条或多条“正在工作”的映射，单击“删除”。
   测试API映射	单击映射“操作”列处的，弹出数据映射测试窗口。 在“增量集成”处设置“数据条目数”、“起止时间”、“超时设置”和“业务参数”等参数。 说明： 其中业务参数区分非Body参数和Body参数。 如果业务参数选择非Body参数，则支持添加多个且最多不能超过5个，下拉可选值来源于源系统API接入时Swagger里解析出的入参参数。 如果业务参数选择Body参数，则需在“Body”框中输入Json格式的Body请求体参数。 单击“测试”，验证返回数据。
   修订API映射	单击已发布的目标映射操作列处的。 修订成功后即可复制一个“正在工作”状态的映射，其中“源系统”、“API名称”不可修改。
   作废API映射	单击已发布的目标映射操作列处的。可能出现以下情况： 如果当前映射未被入图任务引用且非唯一的已发布映射，则能成功作废。 如果当前映射被入图任务引用，请按界面提示操作后再作废。 如果仅有一条已发布的映射，则不支持作废。

查看xDM-F映射（源端映射）

xDM-F映射可作为后续数据实例入图的源端映射。根据集成方xDM-F模型是否存在扩展属性以及扩展属性的类型不同，实体发布后会同时生成一个非扩展表类型和多个扩展表类型的“已发布”的xDM-F映射。

1. 登录LinkX-F系统首页。
2. 选择“模型设计 > 数据模型管理”，默认进入“数据实体”页面。
3. 单击目标实体的“编码”链接，在弹出的详情页单击“数据源映射”页签，默认进入“源端映射”页签。
4. 在xDM-F映射处展示目标实体所有的xDM-F映射。单击具体映射的“映射编码”链接，弹出映射详情，关键参数信息说明如表5所示：

   表5 关键参数信息说明

   参数	说明
   映射名称	xDM-F映射名称。
   是否扩展表	表示是否存在扩展属性。
   xDM-F物理表	根据xDM-F模型类型是否扩展模型以及是否存在扩展属性，xDM-F物理表的组成显示格式有所不同： 如果是非扩展模型，非扩展表类型的组成显示格式为{xDM-F应用名称}_{数据实体英文名称}，扩展表类型的组成显示格式为{xDM-F应用名称}_{数据实体英文名称}{扩展属性类型}。 如果是扩展模型，非扩展表类型的组成显示格式为{xDM-F应用名称}_{父模型名称}，扩展表类型的组成显示格式为{xDM-F应用名称}_{数据实体英文名称}{扩展属性类型}。
   xDM-F扩展类型	基于实体扩展，显示对应xDM-F实体的英文名称。

配置图数据库映射（目标端映射）

实体发布后系统会为其自动生成一个“已发布”的默认图数据库映射。如有需要，您可继续对“已发布”实体的图数据库映射进行管理，如新增、修改、删除、发布、修订、作废等。

• 如果实体属性入图，则图数据库映射中的“数据库字段”会显示匹配字段。
• 集成xDM-F模型生成的LinkX-F实体仅支持更新图数据库映射操作，该类映射管理的其他操作均不支持。

配置设备API映射

仅当“产品阶段”为“运行态”的实体发布后才可配置该映射。此时，可根据需要对设备API映射进行管理，包括新增、修改、删除、测试、发布、修订、作废等操作。

集成xDM-F模型生成的LinkX-F实体不支持管理该类映射。

1. 登录LinkX-F系统首页。
2. 选择“模型设计 > 数据模型管理”，默认进入“数据实体”页面。
3. 单击目标实体的“编码”链接，在弹出的详情页单击“数据源映射”页签，默认进入“源端映射”页签。
4. 切换至“设备API映射”页签，对设备API映射进行管理。
5. 单击“新增”，弹出设备API映射新增页。
6. 配置映射信息，如表8所示：

   表8 设备API映射配置信息说明

   参数	说明
   基本信息
   映射名称	必填，不能与其他映射名称重复，必须以大写字母开头，且只能包含字母、数字、下划线，长度不能超过128个字符。
   设备API英文名称	必填，填写设备API的英文名称。来源于“基础数据管理 > 设备API”中已配置的设备API。
   映射配置
   从“规范API入参”处拖动字段至“数据实体属性映射”对应字段后的填写框中。 从“原始API出参”处拖动字段至“数据实体IoT属性映射”对应字段后的填写框中。

7. 配置完后单击“保存”。
8. 发布设备API映射。
   单击目标映射操作列处的或通过“映射名称”链接进入映射详情页单击“发布”。

   

   新创建的设备API映射发布后，才可被聚合服务引用或在数据探索中被用于OT数据查询。

   完成设备API映射创建后，您可以对其进行一些相关操作，具体如下。

   表9 设备API映射相关操作

   操作	说明
   修改设备API映射	进入设备API映射编辑状态。 单击或单击“映射名称”链接，在弹出的映射详情页单击“编辑”。 修改映射信息后，单击“保存”。
   测试设备API映射	单击目标映射操作列处的，弹出测试窗口。 输入请求参数，单击“连接测试”，验证运行结果。
   删除设备API映射	勾选一条或多条“正在工作”的映射，单击“删除”。
   修订设备API映射	单击已发布的目标映射操作列处的。可能出现以下情况： 修订成功后，可复制一个“正在工作”状态的映射。 如果映射已被聚合服务引用，则不支持修订。
   作废设备API映射	单击已发布的目标映射操作列处的。可能出现以下情况： 作废成功后，目标映射的状态更新为已作废。 如果映射已被聚合服务引用，则不支持作废。

后续操作

完成源端映射和目标端映射的创建及发布后，可通过数据入图任务将实体模型对应的实例数据入到图数据库，以便构建模型知识图谱，后续进行数据探索。数据入图任务相关操作请参考数据入图任务。