创建源系统API映射类型的入图任务
通过在LinkX-F中创建源系统API映射类型的数据入图任务,您可以实现将指定模型源端源系统API中对应的实例数据写入到目标端指定的图数据库中。
通过配置手工调度或定时调度,基于数据入图任务生成入图调度,通过队列机制,可以实现有序地将目标实体对应的实例数据成功入图。
| 调度类型 | 说明 |
|---|---|
| 手工调度 | 按照已配置的手工调度立即执行,即手动触发调度且单次运行。 |
| 定时调度 | 制定定时调度计划后,系统会按照已设置调度计划中的执行时间和频次自动执行任务调度。相比手工调度,定时任务调度可以自动化定时地完成数据处理过程。 请注意,基础版-Lite租户中的模型数据入图任务不支持进行定时调度配置。 |
前提条件
已获取开发人员及以上权限用户的账号和密码。
步骤1:定义任务信息
- 登录LinkX-F系统首页。
- 选择,默认进入“数据入图任务”页面。
- 单击“创建”,系统右侧弹出“任务定义”页面。
- 填写基本信息和入图配置信息。如表2和表3所示:
表2 基本信息 参数
说明
任务名称
必填,只能包含中文、英文字母、数字、“_”、“-”,且必须唯一,长度不能超过128个字符。
任务描述
必填,长度不能超过1024个字符。
任务类型
必填,默认“周期任务”且不支持修改。
导入对象类型
必填,选择导入对象的类型。
- 数据实体&关系:默认选项,表示导入数据实体和非实体型关系类型的对象。
- 关系:表示导入非实体型关系的对象。
- 关系实体:表示导入实体型关系的对象。
任务owner
必填,任务所有者。
数据实体
选择数据实体。
支持下拉选择或手工输入联想,可选值仅展示“已发布”的所有数据实体。
仅当“导入对象类型”选“数据实体&关系”或“关系”时显示该字段且必填。
关系实体
选择关系实体。
支持下拉选择或手工输入联想,可选值仅展示“已发布”的“是否实体”为“是”的关系实体。
仅当“导入对象类型”选“关系实体”时显示该字段且必填。
数据入图类型
必填,选择数据入图类型,可选“数据库映射”、“CSV文件”或“源系统API映射”,当导入对象类型为关系实体时,还可以选择“关联规则”。
此处选择“源系统API映射”类型。
删除数据
默认为“否”,且不支持修改。
必填,仅当导入对象类型选“数据实体&关系”或“关系实体”时显示该字段。
父数据实体
自动写入已选数据实体的父数据实体。
仅当导入对象类型选“数据实体&关系”或“关系”时显示该字段。
优先级
设置任务被调度的优先级。必选,默认值为10,表示最低优先级。
设置任务优先级目的是为了在执行任务调度时,在所有处于就绪状态的任务中,优先级越高的任务优先会被调度。
表3 入图配置 参数
说明
源端信息:当“数据入图类型”选择“源系统API映射”时,填写下列配置项。
映射名称
选择“基本信息”中已选定实体中已发布的API映射。可选值来自选定实体详情页的中的API映射。
源系统名称
根据映射名称自动写入不能修改。
API名称
根据映射名称自动写入不能修改。
URL
根据映射名称自动写入不能修改。
目标端信息
映射名称
选择“基本信息”中已选定实体中已发布的图数据库映射。可选值来自目标实体详情页的中的图数据库映射。
数据源名称
必填,由选择的映射名称自动写入不能修改。
数据源类型
根据数据源名称自动写入不能修改。
数据库类型
根据数据源名称自动写入不能修改。
Schema
根据数据源名称自动写入不能修改。
删除标识
仅当“删除数据”选“是”时才显示该字段且必填,可下拉选择。
数据实体间关系
选择数据实体间关系
仅当导入对象类型选择“数据实体&关系”或“关系”,才需要选择数据实体之间的关系。
- 当选择“数据实体&关系”时支持多选,可同时入图数据实体间的多条关系。
- 当选择“关系”时只支持单选,可以确保入图的关系明确且唯一。
图标签与映射配置
图标签
必填,根据选择的目标端映射名称自动写入表名,不能修改。
当“导入对象类型”选择“关系实体”时,需配置“源端图标签”和“目标端图标签”。
映射配置
根据“源端信息”中已选API映射返回的参数值自动映射数据实体的对应属性。
根据选择的映射名称自动获取不能修改。
- 填写完成后单击“保存”。
步骤2:选择手工调度配置场景
同一任务可同时开启多个手工调度,且所有任务总计不超过10个调度。需保证处在“执行中”或“待执行”的各调度之间的调度数据起止时间不可重叠,否则无法执行。
- 进入“数据入图任务”页面。
- (可选)通过条件筛选功能,快速筛选出“数据入图类型”为“源系统API映射”的任务。
- 找到待操作的目标任务,单击其操作列处的
,弹出手工调度配置窗口。 - 配置手工调度信息。
如果源系统API映射未配置系统入参映射,则可跳过此步骤。
表4 手工调度信息说明 参数
说明
数据起止时间
确定入图的数据范围,即数据起始时间和数据终止时间。
非首次制定计划数据起止时间根据上次调度数据结束时间与系统当前时间自动填充。
数据分片间隔
数据分片定义了系统从后台取数据的粒度。数据分片间隔将根据设置的“数据起止时间”计算出的时间跨度自动确定,规则如下。
- 5分钟:0<时间跨度≤1小时
- 1小时:1小时<时间跨度≤24小时
- 1天:1天<时间跨度≤7天
- 1周:7天<时间跨度≤1个月
- 1个月:1个月<时间跨度
VIP调度
VIP调度可享受最高调度优先级。
请注意,基础版-Lite租户中的模型数据入图任务不支持VIP调度功能。
- 在API参数处手动输入或引用环境变量传入相应的请求参数值,单击“确定”后,系统会自动进行API调试,您可根据调试结果提示进行后续操作。
步骤2:选择定时调度配置场景
定时调度是指制定定时调度计划后,系统会按照已设置调度计划中的执行时间和频次自动执行任务调度。如果源系统API映射未配置系统入参映射,则不允许配置定时调度。
请注意,基础版-Lite租户中的模型数据入图任务不支持进行定时调度配置。
- 进入“数据入图任务”页面。
- (可选)通过条件筛选功能,快速筛选出“数据入图类型”为“源系统API映射”的任务。 图2 数据入图类型为源系统API映射的任务
- 找到待操作的目标任务,单击其操作列处的
,弹出定时调度配置窗口。 请注意,批量制定定时调度计划时,不支持选择多个源系统API映射类型的数据入图任务进行操作。
- 配置定时调度信息。
表5 定时调度信息配置说明 参数
说明
调度周期
调度周期的时间单位,包括分、时、天、周和月。
间隔时间
选择调度执行的间隔时间。
调度首次执行时间
选择调度首次执行时间。
首次执行时间不能早于当前时间,确保调度计划能够正常运行。
调度截止执行时间
选择调度截止执行时间。
截止执行时间不能早于首次执行时间,默认为空表示无限期。
数据起始时间
确定入图的数据起始时间。
数据分片间隔
每次调度按分片间隔时间读取数据。
备注
输入备注信息。
- 在API参数处手动输入或引用环境变量传入相应的请求参数值,单击“保存”后,系统会自动进行API调试,您可根据调试结果提示进行后续操作。
- 单击“启动”,启动定时调度任务。
如有需要,您也可进入目标任务的调度计划页面暂停或停止已启动的任务。根据实际的业务场景,支持批量启动、暂停或停止多个制定计划的任务,但请注意,该操作会同时影响对应任务中的所有调度。
- 启动任务:在任务列表中勾选已制定计划的任务,单击“启动”。
- 暂停任务:在任务列表中勾选已启动的任务,单击“暂停”。已暂停的任务再次启动时会延续上一次的进程。
- 停止任务:在任务列表中勾选已启动的任务,单击“停止”。已停止的任务再次启动时会重新开始进程。