更新时间:2024-07-01 GMT+08:00
分享

从空白开始创建流

流由一个触发事件和一个或多个执行动作组成,支持如下两种类型:

  • 自动化流:开启流之后,当触发事件发生,可自动执行后续动作。
  • 手动触发流:需要手动单击“运行”启动流。例如,通过单击“运行”向邮箱发送天气预报。

操作步骤

  1. 在开天集成工作台界面中,选择左侧导航栏中的“流编排 > 我的流”。
  2. 单击“创建流”。
  3. 选择和配置触发事件。可根据创建的流类型选择对应连接器的触发事件。

    • 触发事件是指触发器从连接器读取数据。触发器关注发生的特定事件,例如正在创建的新联系人或订单,并提供相关数据,以便用户可以对该事件采取行动。
    • 连接器分为系统内置连接器和用户自定义连接器,各个系统内置的连接器的功能和参数的详细介绍请参见公共连接器
    • 创建手动触发流:选择“手动触发流”连接器对应的触发事件。
      1. 在“选择触发事件”区域中选择“手动触发流”连接器,在右侧“触发事件”中选择“手动触发器触发事件”,如图1所示。
        图1 选择触发事件(手动触发流)
        • 您可以通过单击连接器图标右上方的图标收藏使用频率高的连接器,收藏的连接器会显示在“我的收藏”页签,您可以在该页签快速选择连接器。
        • 单击已收藏的连接器图标右上方的图标可取消收藏。
        • 单击图标,可以通过拖动的方式移动页签的顺序。
      2. 在界面右侧区域配置触发事件,参数说明如表1所示。
        表1 手动触发器触发事件参数说明

        参数

        说明

        参数类型

        选择参数类型,可以选择文本或者数目。

        参数名称

        输入自己需要的参数名称。

        设定参数的预设值。

      3. (可选)单击下方的“调测节点”对当前节点进行正确性测试。默认勾选“输入样本预览”且不支持取消勾选,调测成功后,会将测试的输出数据(即样本数据)及输入数据进行展示,并会在该条节点的左上角标记图标。如果提示“调测失败,请检查接口参数配置是否准确”,请检查并重新配置参数后重试。
        图2 调测触发事件节点
    • 创建自动化流:选择除“手动触发流”以外的其他连接器对应的触发事件。
      1. 此处以每天17:00自动运行流为例,在“选择触发事件”区域中选择“计划”连接器,在右侧“触发事件”中选择“重复执行”,如图3所示。
        图3 选择触发事件(自动化流)
        • 您可以通过单击连接器图标右上方的图标收藏使用频率高的连接器,收藏的连接器会显示在“我的收藏”页签,您可以在该页签快速选择连接器。
        • 单击已收藏的连接器图标右上方的图标可取消收藏。
        • 单击图标,可以通过拖动的方式移动页签的顺序。
      2. 在界面右侧区域配置触发事件。不同触发事件的配置参数不同,以每天17:00运行一次流为例,配置如图4所示。
        图4 配置触发事件

        您还可以对触发事件进行以下操作。

        • 在画布中您可以进行的操作如表2所示。
          表2 触发事件的画布操作

          操作

          子操作

          操作描述

          单击触发事件节点的

          节点名称

          修改触发事件名称。

          说明:

          修改触发事件名称后,鼠标放在连接器上系统会自动提示原来的触发事件名称,界面显示为“连接器名称-原执行动作名称”。

          查看详情

          查看该触发事件的详细信息,包括基本信息,输入参数和输出参数信息。

          设置

          敏感信息配置

          • :表示关闭。
          • :表示开启。开启后,运行时不记录当前节点的输入和输出数据。

          业务配置项

          • :表示关闭。
          • :表示开启。需要设置节点顺序、标题、描述。开启业务配置项后,该节点在配置管理界面展示。

          删除

          删除该触发事件。

          说明:

          流编排支持快速删除,单击进行快速删除。

          单击画布中的

          -

          撤回当前操作,最多可撤回10步。

          单击画布中的

          -

          恢复撤回操作,最多可恢复10步。

        • 在右侧面板中您可以进行的操作如表3所示。
          表3 触发事件的右侧面板操作

          操作

          操作描述

          单击触发事件名称右侧的

          修改触发事件名称。

          单击“查看元数据”右侧的

          查看配置信息的JSON语句。

          单击面板下方的“调测节点”

          对当前节点进行正确性测试。默认已勾选“输入样本预览”,调测成功后,会将测试的输出数据(即样本数据)及输入数据进行展示,并会在该条节点的左上角标记图标。如果提示“调测失败,请检查接口参数配置是否准确”,请检查并重新配置参数后重试。
          说明:
          • 当选择的连接器为“API流”或连接器类型为“Webhook”时,需要先单击“获取URL”,获取并复制该URL,然后进行手动调用。调用后再单击下方的“调测接口”按钮进行正确性测试。
          • 当取消勾选“输入样本预览”,调测通过后,仅会显示测试的输出数据(即样本数据)。

  4. 添加执行动作。根据业务需求在画布中单击“ > 添加执行动作”或“添加执行动作”进行添加,可添加多个执行动作。您也可以选中执行动作进行拖拽来调整执行动作位置。

    以满足触发事件的条件后发送一次关于天气实况的邮件为例进行说明。

    1. 在“选择执行动作”区域中选择“心知天气”连接器,在右侧“执行动作”中选择“获取当前天气实况”,如图5所示。
      图5 选择获取当前天气实况执行动作
    2. 在“选择执行动作”区域中选择“网易163邮箱”连接器,在右侧“执行动作”中选择“发送邮件”,如图6所示。
      图6 选择发送邮件执行动作
    • 您可以通过单击连接器图标右上方的图标收藏使用频率高的连接器,收藏的连接器会显示在“我的收藏”页签,您可以在该页签快速选择连接器。
    • 单击已收藏的连接器图标右上方的图标可取消收藏。
    • 单击图标,可以通过拖动的方式移动页签的顺序。

  5. 在界面右侧区域配置执行动作。不同执行动作的配置参数不同,本小节以满足触发事件的条件后发送一次关于天气实况的邮件为例。

    1. 配置获取当前天气实况的执行动作。

      配置城市可以通过直接输入城市名称或动态配置城市名称两种方式配置。

      • 直接输入城市名称:直接输入要获取天气的城市名称即可。
      • 动态配置城市名称:将城市名称可以看做一个变量,城市名称可以在“配置管理”页面进行动态配置。
        1. 光标移至城市输入框,界面弹出动态面板,在动态面板的“全局配置”页签界面中单击“配置管理”。

        2. 在“配置管理”列表中新建城市全局参数。
          表4 配置全局参数操作

          操作

          操作步骤

          新建全局参数

          单击“新建”,设置配置项所有参数,单击“操作”列“保存”。

          编辑全局参数

          单击“操作”列“编辑”,修改配置项参数,单击“操作”列“保存”。

          删除全局参数

          单击“操作”列“删除”即可删除该条配置参数。

          • 配置项的类型只支持字符串、整数、布尔、浮点数、日期、枚举。
          • 配置项默认值只支持用户手动输入。
          • 配置项默认值支持加密设置。
        3. 设置动态城市名称。

      如果配置的执行动作支持插入“我的函数”且“我的函数”需要更新时,您可以在动态面板“我的函数”页签单击函数后的,快速进入编辑函数界面,编辑完成后单击“更新”。更新完成后重新进入流编排页面,在动态面板“我的函数”页签单击更新“我的函数”,然后选择函数插入。

    2. 配置发送邮件的执行动作。设置收件人、邮件主题、邮件内容。

    您还可以对执行动作进行以下操作。

    • 在画布中您可以进行的操作如表5所示。
      表5 执行动作的画布操作

      操作

      子操作

      操作描述

      单击执行动作节点的

      复制节点

      复制该节点的所有配置信息。

      支持跨流复制。

      粘贴节点

      复制节点后,单击或执行动作的,选择“粘贴节点”可粘贴节点。

      剪切节点

      剪切节点后,单击或执行动作的,选择“粘贴节点”可将剪切的节点移动至指定位置。

      如果是跨流剪切,则为复制。

      禁用节点/取消禁用

      • 禁用节点后,该节点在流运行时不执行,且在节点左上角显示

        触发事件不支持禁用。

      • 取消禁用后,该节点在流运行时正常执行。

      节点名称

      修改执行动作名称。

      说明:

      修改执行动作名称后,鼠标放在连接器上系统会自动提示原来的执行动作名称,界面显示为“连接器名称-原执行动作名称”。

      查看详情

      查看该执行动作的详细信息,包括基本信息,输入参数和输出参数信息。

      设置

      • 扩展配置:单击展开扩展配置列表框。当列表为空时,可单击创建扩展配置。支持对该执行动作的输入和输出参数进行扩展配置,并支持创建多个扩展配置。扩展配置支持编辑、复制、删除。
      • 敏感信息配置
        • :表示关闭。
        • :表示开启。开启后,运行时不记录当前节点的输入和输出数据。
      • 策略配置:配置该节点重试次数、超时时间及接口超时时间。

        设置后,如果该节点运行失败,可以按设置的重试次数自动重试。

      • 数据空值策略配置:单击开启数据控制策略配置,单击“添加策略”,选择类型及默认值。
        • :表示关闭。
        • :表示开启。开启该策略,当前节点中输入的参数字段存在动态内容及函数的引用时,运行态解析输入参数字段值后会存在获取不到的情况,此时会根据该输入参数字段的类型进行默认值设置。
        说明:

        数据空值策略生效需要满足以下条件:

        1. 节点中输入参数字段存在动态引用。
        2. 已开启数据空值策略配置开关。
        3. 已添加数据空值策略。
      • 业务配置项
        • :表示关闭。
        • :表示开启。需要设置节点顺序、标题、描述。开启业务配置项后,该节点在配置管理界面展示。

      删除

      删除该执行动作。

      说明:

      流编排支持快速删除,单击进行快速删除。

      最近使用的连接

      显示最近使用的连接器。

      管理全部连接

      查看该执行动作所使用的全部连接。可以新建、编辑、复制、删除、退出连接。

      单击画布中的

      -

      撤回当前操作,最多可撤回10步。

      单击画布中的

      -

      恢复撤回操作,最多可恢复10步。

    • 在右侧面板中您可以进行的操作如表6所示。
      表6 执行动作的右侧面板操作

      操作

      操作描述

      单击执行动作名称右侧的

      修改执行动作名称。

      单击“查看元数据”右侧的

      查看配置信息的JSON语句。

      单击“智能映射”

      自动在当前执行动作配置项中填写上一个执行动作(非控制类的连接器的执行动作,但循环和遍历集合除外)相对应的响应参数。单击“智能映射”后,会在“智能映射”右侧显示映射关系,支持单击映射关系名称后的切换映射的节点,并且支持单击映射关系名称后的一键清除对应的映射关系及内容。

      说明:
      • 当输入参数与输出参数名称一致时,即可映射,名称不同,不会映射。
      • 当您在配置管理中对扩展配置进行了更新后,且满足映射条件时,系统将会对扩展配置中修改的字段自动进行智能映射。

      单击面板下方的“调测节点”

      对当前节点进行正确性测试。默认已勾选“输入样本预览”,调测成功后,会将测试的输出数据(即样本数据)及输入数据进行展示,并会在该条节点的左上角标记图标。如果提示“调测失败,请检查接口参数配置是否准确”,请检查并重新配置参数后重试。

      说明:
      • 如果添加多个执行动作,可对每条执行动作所在的节点进行正确性测试,以保证整条流可用。
      • 如果当前节点之前的某个节点未进行正确性测试,则需要对之前的每个节点测试后才可对当前节点进行正确性测试。
      • 当取消勾选“输入样本预览”,调测通过后,仅会显示测试的输出数据(即样本数据)。

    在配置执行动作时,您可以在动态面板中根据所需选择相应的函数。在“函数”页签,支持选择系统内置函数,包括数学函数、系统函数、日期函数、对象函数、操作函数、字符串函数或转换函数。在“我的函数”页签,仅可以选择自己创建的函数。关于内置函数的具体介绍请参考内置函数

  6. 添加触发事件和执行动作完成后,检查配置项。

    查看界面右上角的“检查”,如果“检查”图标右上角显示数字0,则表示配置无误;如果“检查”图标右上角显示数字为非0,则可以单击“检查”查看详细检查记录并进行修改。

    图7 检查配置项

  7. (可选)单击界面左上方的修改流名称。
  8. 流编排完成后可执行如下操作:

    • 测试作业:
      1. 单击界面右上方的“保存并测试”按钮,在右侧弹出的“基本信息”区域框中单击“运行”。
      2. 在弹出的窗口中单击“查看运行状态”查看每个节点的详细运行信息,如果运行不通过,可单击界面右上角的“编辑”修改后再次运行。
    • 保存作业:单击界面右上方的“保存”按钮,保存流的配置信息。

  9. (可选)流保存后,在“流保存成功”提示框单击“确定”,可以开启流。

    也可以在流名称右侧单击“开启”。

    开启后,也可以单击“关闭”,关闭流。

相关文档