跳转至

8.1、工作流

功能模块如图所示:

积木功能

调用工作流(行)

功能:此节点可用于调用本地工作区中的其他工作流。

积木功能

配置界面功能说明:

配置-工作流:

  • 工作流路径:要调用的工作流的路径。如果以斜杠开头,路径可以是本地工作区的绝对路径,如果不是以斜杠开头,则路径可以是当前工作流的相对路径。你也可以使用相对于当前工作流的路径,例如:/工作流名称。

调用工作流(表)

功能:此节点可用于调用本地工作区中的其他工作流。

积木功能

配置界面功能说明:

配置-工作流:

  • 工作流路径:要调用的工作流的路径。如果以斜杠开头,路径可以是本地工作区的绝对路径,如果不是以斜杠开头,则路径可以是当前工作流的相对路径。你也可以使用相对于当前工作流的路径,例如:/工作流名称。
  • 高级设置
    • 容器输入(表):选择被调用的工作流中的容器输入(表)的参数名称。
    • 容器输出(表):选择被调用的工作流中的容器输出(表)的参数名称。
    • 对输入和输出参数使用完全限定名称:勾选后,会显示调用的工作流中的容器输入(表)和输出(表)的配置中的参数名称和节点ID,以保证参数的唯一性。

容器输入(表)

功能:该节点从外部调用者(即调用工作流(基于表的)节点)接收一个数据表。通过配置参数,外部调用者可以看到容器输入(表),并允许外部调用者将数据表发送到容器输入(表)节点。如果数据表连接到可选输入,节点将简单地将该表转发到输出端口,除非通过应用程序接口提供表,在这种情况下,提供的表将在输出端口可用。如果没有给出输入,则输出一个配置好的模板表。

积木功能

配置界面功能说明:

配置:

  • 参数名称:输入参数的名称(最好是唯一的)。该名称在应用程序接口和命令行工具节点中公开。
  • 将唯一ID附加到参数名称:如果选中,上面设置的名称将由节点的ID修改,以保证参数名称的唯一性。
  • 模板表:模板表可用于定义允许工作流正确执行的表结构。模板表的主要目的是填充生成的OpenAPI规范的“输入参数”字段,该字段提供给最终用户用于文档编制。
    • 将输入表设置为模板:通过选择此按钮,输入表(给定一个输入表)将被设置为新的模板表。
    • 使用整个输入表:选择后,整个输入表将被设置为模板。
    • 仅使用第一行:选中后,只有前n行被用作模板表。
    • 省略API定义的表规范:选中后,模板表中只有数据部分公开给OpenAPI定义,显示格式正常的简化示例输入。

容器输入(流变量)

功能:该节点从外部调用者(即REST接口)接收流变量,并使它们在工作流中可用。配置的参数使容器输入(流变量)对外部调用者可见,并允许外部调用者将变量发送到容器输入(流变量)节点。

积木功能

配置界面功能说明:

配置:

  • 参数名称:流变量输入参数的名称(最好是唯一的)。此名称在REST接口中公开。
  • 将唯一ID附加到参数名称:如果选中,上面设置的名称将由节点的ID修改,以保证参数名称的唯一性。
  • 描述:对输入参数的描述。该描述显示在REST接口的API规范中。
  • 接收任何输入:接受具有任意数量变量的任何格式规范的输入。输入必须是一个对象。每个属性(键/值)对代表一个变量。属性键定义变量名(必须是有效的名称)。属性值定义变量值。变量的类型将使用属性值的JSON类型来确定。
  • 要求输入至少包含以下模版变量:只接受与模板变量规范匹配的输入。输入必须是受支持类型的对象或值。
    如果需要对象,则每个属性(键/值)必须与规范中的一个变量完全匹配。属性键必须匹配变量名,属性的JSON类型必须匹配变量类型。
    如果启用了“使用简化JSON格式”,则必须使用值而不是对象。JSON值的类型必须与变量规范中唯一的变量定义的类型匹配。
  • 模板变量:外部输入需要匹配的模板变量。定义变量的类型、名称和默认值。通过填充模板变量生成的API规范中的“InputParameters”字段,该字段将向最终用户展示以供文档目的使用。
    • 将输入流变量设置为模板:在变量导入处加载变量(不是全局常量)作为新的模板变量。只有受支持的类型才会被加载。
      有两种模式可以将变量加载到模板中:
      • replace:替换已经由导入的变量定义的所有变量。
      • merge:合并来自导入的变量和模板中已经定义的变量。如果还没有定义名称,则该变量将被附加到末尾。否则,匹配变量的类型和值将更新为加载变量的类型和值。
    • 使用简化的JSON格式:这个选项只能在只定义了一个变量的情况下使用。通过直接使用值而不是将变量定义为属性的对象,可以使外部输入格式更简单。
      注:如果启用此选项,则变量将始终具有与参数名称相同的名称,而不附加唯一ID。
    • 添加:点击按钮可以用来添加一个新的模板流变量。
    • 流变量类型:这是要创建的模板变量的类型。根据不同的类型,变量值的要求可能会发生变化。
      支持以下四种基本数据类型:
      • String:字符串类型。当添加了新的模板变量时,默认值为空字符串。
        注:要在外部变量中使用这种类型,必须使用JSON字符串。
      • Integer:整数类型,默认值为“0”。取值范围为2³¹-1到-2³¹的整数。必须是有效的数字,且必须在此范围内。如果值的大小超过该限制,则可以尝试使用Double类型。
      • Double:双精度浮点数,其可以表示的数字的绝对值范围大约是:-1.79E+308 ~ +1.79E+308。除了数字值之外,您还可以指定以下三个(区分大小写)特殊值之一:
        Infinity表示正无穷,-Infinity表示负无穷,NaN表示“非数字”。如果数字太大或太小,则可以将其转换为这些特殊值。
      • Boolean:布尔值,其值是“true”或“false”的值。默认值为false。
        注:要在外部变量中使用这种类型,必须使用JSON布尔值。
        注:任何其他值将被解释为“false”。
    • 流变量名称:您可以自定义您的流变量名称。但是名称不能为空,也不能是已经在节点或其他模板变量中已被使用的名称。
    • 流变量值:模板变量的值。它必须符合流变量类型要求。
      注:如果没有外部值,此值将用作输出。
    • 移动/删除变量:为了提高模板变量的可读性(例如,将特定类型的变量分组),你可以使用行尾的箭头按钮来调整它们的顺序。
      如果希望删除已添加的流变量,可以点击行尾的删除按钮图标。

容器输出(表)

功能:该节点向外部调用者(即调用工作流(基于表)节点)输出一个数据表。配置的参数使容器输出(表)对外部调用方可见,并使外部调用方能够从容器输出(表)节点获取数据表。如果一个数据表连接到输入端口,节点将简单地将这个表转发到输出端口。

积木功能

配置界面功能说明:

配置:

  • 参数名称:输入参数的名称(最好是唯一的)。该名称在应用程序接口和命令行工具节点中公开。
  • 将唯一ID附加到参数名称:如果选中,上面设置的名称将由节点的ID修改,以保证参数名称的唯一性。
  • 描述:输出参数的描述。该描述显示在REST接口的API规范中。