全部文档
文档中心数据流功能参数

参数

参数的本质就是设定一些固定值,提供给数据流在各节点进行关联调用。 参数的值一旦设定,不可修改,可以理解为JavaScript里的const操作。 参数的赋值操作在数据流所有节点执行之前,数据流接受到执行请求后,先进行参数赋值,再执行后续流程节点。

数据源的编辑页面中,在左侧的侧边栏里,新增一个模块名为”参数”。 侧边栏中点击”参数”的icon即可打开参数列表的界面,大概界面如下图所示(具体页面表现以设计稿为准): 参数列表分为3个区域:参数顶部栏、参数添加区域、参数展示区域。

参数顶部栏有3个元素,边栏菜单名称(即“参数”文本,不可编辑)、搜索和收起。

点击放大镜icon可以唤起搜索栏,如图所示: 在搜索栏中输入参数名称或中英文名称,点击放大镜icon或敲击回车键,即可对所有参数展开搜索,并将符合搜索条件的参数展示在参数展示区域中。 搜索功能支持模糊搜索,但只支持基本的连续字符包含搜索,必须键入完整连续的值才能搜索到符合条件的参数。

点击右上角的“<<”icon即可关闭边栏菜单。

参数添加区域中只有一个添加按钮,点击添加按钮即可打开添加参数的弹框。 按参数属性输入对应的值后,点击确认,即可保存对应的参数。

编码是参数在当前数据流内的ID,只能由字母、数字和下划线组成,且必须以字母开头。 如果编码的格式录入错误,则编码字段报错,且显示报错文案“编码只能以字母开头,允许字母、数字、下划线”。 编码字段为必填项,且当前数据流内唯一。 如果编码字段未录入,点击确定时,编码字段报错,且显示报错文案“请输入编码”。 如果当前编码在当前数据流文件内的其他参数中已存在,点击确定时,编码字段报错,且显示报错文案“此编码已存在”。 编码字段只允许录入50个以内的字符,如果录入字符数量大于50,则编码字段报错,且显示报错文案“最多50个字符”。

名称的录入及多语言环境的名称配置请参考《多语言名称配置&显示逻辑梳理》

数据流的参数模块支持的数据类型有: 文本(String)、整数(Int)、小数(Decimal)、布尔值(Boolean)、日期时间(Datetime)。

如果在数据流的赋值过程中,出现值与参数的数据类型不匹配,例如将值”ABC”赋给了一个时间参数,则数据流在执行数据流时进行报错。 文本格式的数据类型可以被任意格式的值填充,不做类型校验。

赋值方式指的是在数据流执行过程中,创建参数时,将具体的值赋予当前参数的方式。 参数的初始赋值方式一共有3种,分别是:自定义值、引用变量元素、解析入参。

自定义值的赋值方式指的是在创建参数时,直接给予其一个设定好的值。 选择了初始值的配置方式后,直接在下方的初始值配置项中录入初始值即可。 不同的数据类型,其所对应的初始值输入框组件不同,具体对应关系如下:

参数的数据类型

初始值录入组件

文本

单行文本输入组件

整数

整数输入组件

小数

小数输入组件

布尔值

单项选择组件

日期时间

日期时间选择组件

引用变量元素的赋值方式指的是在创建参数时,先获取指定的变量元素和其指定成员的值,再将值赋给当前参数。 点击关联元素配置项后,系统会弹出变量元素的选择弹窗,其中有当前空间内的所有变量元素 变量元素仅支持单选,被选择的元素在配置项中显示元素名称,多语言环境下参考《多语言名称显示》。 选择了关联元素后,点击变量成员配置项,会显示当前变量元素中的变量成员作为下拉列表 变量成员配置项中,只能选择参数下的变量成员,无法选择变量元素本身。 变量成员仅支持单选,被选择的变量成员在配置项中显示成员名称,多语言环境下参考《多语言名称显示》。 变量成员选择后,再次修改或删除关联元素配置项,变量成员的已有值则随之清空。 如果通过变量成员获取的值,其数据格式与参数本身设置的数据类型不匹配,数据流则会在执行过程中报错。

变量元素的两个配置项,关联元素与变量成员在系统内保存的是元素本身。 当变量元素或成员的名称发生变化后,此处的名称显示保持随动,保持在重新打开参数编辑界面时,始终显示最新的名称。 如果某个参数设置关联了一个变量元素,保存并发布当前配置后,在空间内删除了该变量元素,此时:

  • 数据流可以正常运行,只是在运行时进行报错,表示无法获取到已配置的关联元素

  • 再进入数据流编辑栏时,系统显示报错,表示[XX]变量元素不存在

  • 如果用户没有删除该变量元素,仅删除了这个变量元素内配置的某个变量成员,再次进入数据流编辑页面时,系统显示报错,表示对应变量元素的成员不存在。

解析入参指的是对调用计算流的HTTP请求中所携带的入参进行解析,并通过JSON PATH表达式来获取其所指定的值。 选择”解析入参”后,用户即可在下面的【JSON PATH表达式】中,输入其自定义的表达式内容。 默认的JSON PATH表达式是字符”..ABC”。 当前参数的编码为空时,【JSON PATH表达式】默认显示为”作为首字符,如果用户键入的表达式不符合规范,应在点击确认时进行报错。

参数展示区域是展示当前数据流所有参数信息的区域,该区域一共有5个元素,分别是次序拖动icon、数据类型icon、编码、中文名称和删除icon(hover状态下才显示)。

次序拖动icon默认显示在参数展示区域每一行的最左侧,拖拽icon部分即可对参数列表中的参数进行拖动排序。 鼠标移动值icon热区部分,自动变为手型鼠标,表示可拖拽,icon示例如下: 鼠标点击后拖拽当前参数上下移动,被占位的参数排列自动填充,大概效果如下:

参数类型icon是用来区分参数的数据类型的标识,不同数据类型对应的icon须不同。

参数编码是参数的参数在当前数据流内的ID,这里的显示区域仅显示参数编码文本,显示宽度为90px,超过90px的部分显示…。

参数名称的显示区域显示当前语言环境下的名称配置文案,具体的多语言环境显示内容请参考《多语言名称显示》。 这里的显示区域仅显示当前语言环境对应的名称文本,显示宽度为50px,超过50px的部分显示…。 如果当前语言环境下没有设置参数名称,此处显示空白即可。

删除icon只有在鼠标hover时进行显示,点击后弹出确认弹框: 点击删除icon后,页面显示操作确认弹窗 上图为计算流的变量截图,数据流的参数内容在删除时,修改文案,删除其引用部分即可。 标题: “确定要删除这个参数吗?” 备注: “注:在参数列表中删除参数后,所有引用该参数的节点将无法获取到其值或得到空值,并可能在执行时产生错误。” 点击确定后,参数列表与所有相关节点相关参数配置中的参数选项将被其所对应的uuid替代并报错标红。

点击参数展示区域中除了次序拖动icon和删除icon响应区域以外的其他区域即可唤起参数编辑弹窗,弹窗样式与新建参数的弹窗样式一致,只是其中所有的字段值均是已设置过的参数属性值。

原「参数」对应的边栏菜单划分为上下两个区域,分别为系统参数和用户自定义参数。 两个区域各自独立,从概念上可以将两个区域看做两个页面,各自互不影响。 原参数栏和更新后的自定义参数栏表现一样,没有区别。 系统参数栏是显示当前系统提供给数据流的参数列表,其整体页面表现和自定义参数栏基本一致。 略有不同的是以下几个部分: 1、页面顶部的搜索功能在执行搜索时,会对两个区域的所有参数进行搜索,两个区域各自展示符合搜索条件的结果; 2、无论哪个页面参数高度超限,各自显示进度条,不可整个边栏菜单进行滚动; 3、系统参数不可添加,不可修改,不可删除,用户只有只读权限; 4、系统参数的展开栏不显示[赋值方式]和具体赋值的配置项。

本期提供9个系统参数:当前任务ID、当前任务开始时间、当前任务开始时间戳、上次任务ID、上次任务开始时间、上次任务开始时间戳、上次任务结束时间、上次任务结束时间戳。

当前任务ID(PRESENT_TASK_ID)是一个文本字段,记录的是当前数据流执行时系统所生成的任务ID,具体参数配置信息为: 编码:PRESENT_TASK_ID 名称:当前任务ID 数据类型:文本 备注:数据流每次运行都会生成一个任务ID,用以标识当前数据流任务。

当前任务开始时间(PRESENT_TASK_START_TIME)是一个时间字段,记录的是当前数据流执行时的系统时间,具体参数配置信息为: 编码:PRESENT_TASK_START_TIME 名称:当前任务开始时间 数据类型:时间 备注:指的是当前正在运行的数据流任务开始运行时的系统时间。

当前任务开始时间戳(PRESENT_TASK_START_TIMESTAMP)是一个整数字段,是[任务开始时间]所对应的毫秒时整数,具体参数配置信息为: 编码:PRESENT_TASK_START_TIMESTAMP 名称:当前任务开始时间戳 数据类型:整数 备注:指的是以毫秒时格式表示当前正在运行的数据流任务开始运行时的系统时间。

上次任务ID(LAST_TASK_ID)是一个文本字段,记录的是当前数据流执行时,其最近一次执行的任务ID,具体参数配置信息为: 编码:LAST_TASK_ID 名称:上次任务ID 数据类型:文本 备注:指的是离当前正在运行的数据流任务最近的已完成任务的任务ID。

上次任务开始时间(LAST_TASK_START_TIME)是一个时间字段,记录的是当前数据流执行时,距离其最近的执行任务开始执行时的系统时间,具体参数配置信息为: 编码:LAST_TASK_START_TIME 名称:上次任务开始时间 数据类型:时间 备注:指的是离当前正在运行的数据流任务最近的已完成任务刚开始运行时的系统时间。

上次任务开始时间戳(LAST_TASK_START_TIMESTAMP)是一个整数字段,是[上次任务开始时间]所对应的毫秒时整数,具体参数配置信息为: 编码:LAST_TASK_START_TIMESTAMP 名称:上次任务开始时间戳 数据类型:整数 备注:指的是以毫秒时格式表示离当前正在运行的数据流任务最近的已完成任务刚开始运行时的系统时间。

上次任务开始时间(LAST_TASK_END_TIME)是一个时间字段,记录的是当前数据流执行时,距离其最近的执行任务执行完成时的系统时间,具体参数配置信息为: 编码:LAST_TASK_END_TIME 名称:上次任务开始时间 数据类型:时间 备注:指的是离当前正在运行的数据流任务最近的已完成任务结束时的系统时间。

上次任务开始时间戳(LAST_TASK_END_TIMESTAMP)是一个整数字段,是[上次任务开始时间]所对应的毫秒时整数,具体参数配置信息为: 编码:LAST_TASK_END_TIMESTAMP 名称:上次任务开始时间戳 数据类型:整数 备注:指的是以毫秒时格式表示离当前正在运行的数据流任务最近的已完成任务结束时的系统时间。

上次任务状态(LAST_TASK_STATUS)是一个文本字段,记录的是当前数据流执行时,距离其最近的执行任务状态信息,具体参数配置信息为: 编码:LAST_TASK_STATUS 名称:上次任务状态 数据类型:文本 备注:指的是离当前正在运行的数据流任务最近的已完成任务的状态。

在所有读取系列节点的自定义SQL语句中,用户可以通过”${参数编码}”的方式来引用当前数据流内的某个参数。

回到顶部

咨询热线

400-821-9199

我们使用 ChatGPT,基于文档中心的内容以及对话上下文回答您的问题。

ctrl+Enter to send