-
SDK部署使用是否有宽限期? iDME内置SDK服务部署使用及宽限期说明 对于已购买MBM SDK和数据建模引擎SDK的华为账号,iDME将提供相应SDK的免费试用服务。自应用首次生成SDK成功之日起,MBM SDK和xDM-F SDK均可免费试用30天。同一华为账号下,所有应用生成的xDM-F SDK,其总的免费试用期限为180天。SDK免费试用到期后,若无有效License授权将停止使用。 xDM-F SDK和MBM SDK的运行由License进行授权控制,购买SDK服务成功后,建议您及时申请License。 License授权有效期:License授权自申请License之日起即激活,授权有效期为下单SDK服务时的购买时长。 License授权宽限期:为确保您的xDM-F SDK或MBM SDK正常使用以及License授权到期前后有充足时间进行调整,在License授权到期后将进入30天的宽限期。宽限期内您的xDM-F SDK或MBM SDK依旧可以正常使用,宽限期后如果您未进行续费将无法使用相对应的SDK。 第三方SDK服务部署使用及宽限期说明 iDME集成的SDK服务受第三方规定的服务使用限制条件约束,具体以第三方服务提供商的规定为准。
-
SDK服务的计费项是什么? iDME内置的SDK服务按照用户数收费,计费项只有“基础版 数据建模引擎 用户”,计费模式为包年/包月(提供包1年、包3年和包5年三种规格)。选择“通用SDK”组件时,用户的起购数量为50;选择“MBM SDK”组件时,用户的起购数量是100。 iDME集成的第三方SDK服务包含三种计费的计算单元,计费项包括“基础版 数据建模引擎 用户”、“基础版 数据建模引擎 节点”和可自定义量纲换算的“数字主线引擎 MCU”,计费模式均为包年/包月(提供包1年、包3年和包5年三种规格)。在购买时,请根据元服务实际显示的计算单元进行配置,费用将根据您所设置的计算单元数量及使用时长来计算。
-
SDK列表 表1 SDK列表 SDK分类 功能 支持的语言 数据建模引擎运行SDK 数据建模引擎运行SDK是对访问xDM-F应用运行态提供的REST API进行的封装,以简化用户的开发工作。 用户直接调用数据建模引擎运行SDK提供的接口函数即可实现使用xDM-F业务能力的目的。 Java 流程引擎流程SDK 流程引擎流程SDK是对访问xDM-F的流程引擎特性提供的REST API进行的封装,以简化用户的开发工作。 用户直接调用流程引擎流程SDK提供的接口函数即可实现使用流程引擎业务能力的目的。
-
约束与限制 目前流程引擎流程SDK仅支持在通用服务器中部署,不支持容器化部署。 针对已购买xDM-F SDK的华为账号,单个应用生成的xDM-F SDK可免费试用30天,所有应用生成的xDM-F SDK累计免费试用180天。单应用免费试用期从应用首次生成SDK成功之日起计算,到期后,该应用的xDM-F SDK将触发停服无法启动。 xDM-F SDK的运行由License进行授权控制,购买“通用SDK”基础版数据建模引擎成功后,请及时申请License。 License授权有效期:License授权自申请License之日起即激活,授权有效期为下单购买“通用SDK”基础版数据建模引擎的购买时长。 License授权宽限期:为确保您的xDM-F SDK正常使用以及License授权到期前后有充足时间进行调整,在License授权到期后将进入30天的宽限期。宽限期内您的xDM-F SDK依旧可以正常使用,宽限期后如果您未进行续费将无法使用xDM-F SDK。 一个License只能配置一个应用ID,且至多可配置八台本地通用服务器。即,一个xDM-F SDK至多可部署在八台不同的本地通用服务器中,且实际部署的本地通用服务器需与License文件配置的本地通用服务器保持一致,否则会部署失败。 购买“通用SDK”基础版数据建模引擎,并将xDM-F SDK部署至本地通用服务器/容器之后,系统会自动与现有存量用户进行匹配。如果现有存量用户大于已购买“通用SDK”的用户数,现有存量用户不影响使用,新增用户仅支持查看,不支持操作。
-
步骤2:选择定时调度配置场景 定时调度是指制定定时调度计划后,系统会按照已设置调度计划中的执行时间和频次自动执行任务调度。如果源系统API映射未配置系统入参映射,则不允许配置定时调度。 请注意,基础版-Lite租户中的模型数据入图任务不支持进行定时调度配置。 进入“数据入图任务”页面。 (可选)通过条件筛选功能,快速筛选出“数据入图类型”为“源系统API映射”的任务。 图3 数据入图类型为源系统API映射的任务 找到待操作的目标任务,单击其操作列处的,弹出定时调度配置窗口。 请注意,批量制定定时调度计划时,不支持选择多个源系统API映射类型的数据入图任务进行操作。 配置定时调度信息。 表5 定时调度信息配置说明 参数 说明 调度周期 调度周期的时间单位,包括分、时、天、周和月。 间隔时间 选择调度执行的间隔时间。 调度首次执行时间 选择调度首次执行时间。 首次执行时间不能早于当前时间,确保调度计划能够正常运行。 调度截至执行时间 选择调度截至执行时间。 截止执行时间不能早于首次执行时间,默认为空表示无限期。 数据起始时间 确定入图的数据起始时间。 数据分片间隔 每次调度按分片间隔时间读取数据。 备注 输入备注信息。 在API参数处输入相应的请求参数值,单击“保存”后,系统会自动进行API调试,您可根据调测结果提示进行后续操作。 单击“启动”,启动定时调度任务。 如有需要,您也可进入目标任务的调度计划页面暂停或停止已启动的任务。根据实际的业务场景,支持批量启动、暂停或停止多个制定计划的任务,但请注意,该操作会同时影响对应任务中的所有调度。 启动任务:在任务列表中勾选已制定计划的任务,单击“启动”。 暂停任务:在任务列表中勾选已启动的任务,单击“暂停”。已暂停的任务再次启动时会延续上一次的进程。 停止任务:在任务列表中勾选已启动的任务,单击“停止”。已停止的任务再次启动时会重新开始进程。
-
步骤2:选择手工调度配置场景 同一任务可同时开启多个手工调度,且所有任务总计不超过10个调度。需保证处在“执行中”或“待执行”的各调度之间的调度数据起止时间不可重叠,否则无法执行。 进入“数据入图任务”页面。 (可选)通过条件筛选功能,快速筛选出“数据入图类型”为“源系统API映射”的任务。 图2 数据入图类型为API映射的任务 找到待操作的目标任务,单击其操作列处的,弹出手工调度配置窗口。 配置手工调度信息。 如果源系统API映射未配置系统入参映射,则可跳过此步骤。 表4 手工调度信息说明 参数 说明 数据起止时间 确定入图的数据范围,即数据起始时间和数据终止时间。 非首次制定计划数据起止时间根据上次调度数据结束时间与系统当前时间自动填充。 数据分片间隔 数据分片定义了系统从后台取数据的粒度,数据分片间隔根据选择单位和计数器制定。 分钟从5起步,自增长步长为5,最大不超过60。 小时、天、周和月从1起步,自增长步长为1。小时最大不超过24小时,天最大不超过30天,周最大不超过4周,月最大不超过12月。 VIP调度 VIP调度可享受最高调度优先级。 请注意,基础版-Lite租户中的模型数据入图任务不支持VIP调度功能。 在API参数处输入相应的请求参数值,单击“确定”后,系统会自动进行API调试,您可根据调测结果提示进行后续操作。
-
调用服务 聚合服务发布成功后,您可根据业务需要调用已发布的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键,然后在画布中单击选中两个数据实体后,在其中一个数据实体上按鼠标右键调出的快捷菜单中单击“创建关系实体”,右侧弹出新增实体页面(更多操作请参见创建关系实体)。 创建关系实体的实例:在画布中选中实体间的关系线后,按鼠标右键调出的快捷菜单中单击“创建实例”,右侧弹出新增实例页面(仅显示“是否入图”为“是”的属性),填写实例信息后保存。请注意,此方法仅适用于实体关系实例的创建。
-
查看实体详情 在“数据实体”页面,单击实体的“编码”,查看目标实体的详情信息,包括“基本信息”、“数据实体属性”、“数据源映射”、“数据实体间关系”、“单数据实体属性约束规则”、“使用情况”和“修订记录”等。 表1 实体详情页签介绍 详情页签 说明 基本信息 展示当前实体的基本信息,包括“基本信息”、“物理表信息”和“版本信息”等。 数据实体属性 展示当前实体的属性信息,包括“自定义属性”和“系统基本属性”等(属性更多操作请参考配置数据实体属性)。 数据源映射 展示当前实体的所有数据源映射信息,包括源端映射和目标端映射。 源端映射:展示当前实体的实例数据入图的源端数据来源,区分关系型数据库映射、API映射或xDM-F映射。 目标端映射:展示当前实体的实例数据入图的目标端。 设备API映射:展示当前实体接入LinkX-F系统的OT数据来源,仅当“产品阶段”为“运行态”的实体才会显示该页签。 数据实体间关系 展示当前实体的“图结构”、“源数据实体关系”或“目标数据实体关系”信息等。 图结构:展示以当前实体为源数据实体,以及以当前实体为目标数据实体的所有关系实体组成的图结构视图。 源数据实体关系:展示以当前实体为源数据实体的关系实体列表。 目标数据实体关系:展示以当前实体为目标数据实体的关系实体列表。 单数据实体约束规则 展示当前实体所有的属性约束规则。单数据实体属性约束规则是用作后期数据入图后,进行数据质量清洗时,判定数据是否满足条件的标准。 请注意,在应用租户中,引用模型的详情页中不会显示该信息页签。 使用情况 展示当前实体被聚合服务、关系、入图任务和租户等的引用情况。 请注意,租户的引用情况仅会在平台租户中模型的使用情况中显示。 修订记录 展示当前实体的所有版本修订记录。修订记录不可创建和编辑,每次有版本修订此处会自动增加修订内容。 查看详情:单击“修订号”链接,弹出对应记录的详细信息。 对比记录:如果实体有多条版本修订记录,可对比记录查看差异。勾选2个以上4个以内不同的版本,比较不同版本“数据实体属性”、“数据实体关系”之间的差异。
-
数据同步规则说明 在进行xDM-F数据同步时,遵循以下数据同步规则。 仅会同步xDM-F同步任务清单中所选应用运行态及对应xDM-F租户下的数据,同步过来的模型和实例数据将被存放在LinkX-F系统中的指定租户下。通过检查LinkX-F实体的“模型来源”,来判断实体是否集成了xDM-F模型的信息。xDM-F模型概念详细介绍请参考数据模型概述。 xDM-F来源的实体存在以下修改限制: 在“基本信息”页签中,不支持对“责任人”、“关联领域”(仅数据实体)、“源系统”、“是否主数据”(仅数据实体)、“产品阶段”和“标签”外的其他字段进行修改。 在实体属性页签中,仅支持上移、下移、置顶自定义属性,其他操作均不支持(如新增、修改、删除、生效、失效等)。但如果该类数据实体中存在“是否入图”为是的自定义属性,则这类属性的“是否关联属性”值支持修改,此操作是为了便于后续手动创建非实体关系。
-
实体创建方式概述 系统提供多种方式生成数据实体,包括自定义实体参数、集成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来源的关系实体存在以下修改限制: 在“基本信息”中,不支持对“责任人”、“源系统”和“标签”外的其他字段进行修改。 在“关系实体属性”中,仅支持上移、下移、置顶对应的自定义属性,其他操作均不支持(如新增、修改、删除、生效、失效等)。