更新时间:2026-05-19 GMT+08:00
分享

为流程元模板定义与管理流程插件

流程插件管理为流程元模板提供标准化的插件定义与管理能力。用户可通过自定义JS(JavaScript)脚本插件,在用户任务或服务任务的关键生命周期节点(进入前、进入后、离开前、离开后)插入自定义动作(如发送邮件、发送短信等),从而实现业务流程能力的无缝延伸。

流程引擎支持流程插件的创建、发布、另存、查看及删除全生命周期管理。

约束与限制

  • 仅支持删除非“发布”状态的流程插件。如果“插件状态”“发布”,则不支持删除。
  • 同一逻辑租户下,流程插件的创建总数上限为200个,超出上限后无法新增创建。
  • 批量删除流程插件时,单次最多可删除20个。

前提条件

已登录流程引擎。

创建流程插件

  1. 在左侧导航栏中,选择流程编排服务 > 流程插件管理,进入“流程插件管理”页面。
  2. 单击“创建”,展开“创建插件”页面。
  3. 填写如下信息,单击“保存”

    图1 创建流程插件
    表1 流程插件参数信息

    参数名称

    参数说明

    英文名称

    当前流程插件的英文名称。

    • 需以大写字母开头,只能包含字母、数字和下划线(_),长度不能超过200个字符。
    • 创建后不可修改。

    中文名称

    当前流程插件的中文名称。

    • 只能包含中文、英文字母、数字和下划线(_),长度不能超过200个字符。
    • 创建后不可修改。

    描述

    插件的简要说明,可用于介绍其用途、场景等,便于团队理解与使用。

    长度不能超过1000个字符。

    JS脚本

    自定义业务逻辑脚本,长度不能超过4000个字符。

    编辑完成后,可单击编辑器右上方的“格式化”,一键美化代码排版,提示可读性。

    固定调用方法

    • 读取流程变量:用于获取流程上下文中的变量或外部传入参数。
      process.getVariable('key', 'defaultValue')
      • key:变量名称。指定需要读取的流程变量键名。
      • defaultValue:默认值。当指定变量不存在或为空时,返回此默认值。
      • inputParam:特殊变量。可直接使用该变量获取流程外部传入的参数对象。
    • 写入流程变量/返回执行结果:用于将数据写回流程上下文,或向外部返回执行结果。
      process.setVariable('key', 'value')
      • key:变量名称。指定需要写入或更新的过程变量键名。
      • value:变量值,必须为JSON对象。该对象中的所有键值对(Key-Value)将同步存入外部流程变量中。
      • resultData:特殊变量。可将此变量赋值,作为脚本的执行结果返回给流程外部调用方。

发布流程插件

流程插件创建后默认为“草稿”状态。只有完成发布并经过审核通过后,流程插件才能在流程元模板中被引用和执行。

  1. 在左侧导航栏中,选择流程编排服务 > 流程插件管理,进入“流程插件管理”页面。
  2. 在目标插件所在行,单击

    图2 发布流程插件

  3. 在弹出的提示框中,单击“确定”

    根据当前操作用户的角色,流程插件的发布流程如下:

    • 普通用户发布:发布后,“插件状态”变更为“审核中”,需由运行服务管理员进行审核处理,具体操作请参见审核流程编排服务的任务
    • 运行服务管理员发布:无需走审核流程,直接发布生效。

另存流程插件

“另存为”功能适用于基于现有插件快速复用配置、衍生创建新流程插件的场景。系统将复制原插件的配置信息(如脚本、描述等),生成一个新的插件副本,您可在副本基础上进行修改,无需从头编写,从而显著提升配置效率。

  1. 在左侧导航栏中,选择流程编排服务 > 流程插件管理,进入“流程插件管理”页面。
  2. 在插件列表中找到目标插件,根据插件当前状态执行对应操作:

    图3 另存流程插件
    • “插件状态”“发布”:单击
    • “插件状态”“草稿”:选择“ > 另存为”。

  3. 系统自动展开“另存为”配置页面,并预填充原插件的信息,按需确认或修改插件相关信息后,单击“保存”

    系统将生成一个新的流程插件副本,其初始状态为“草稿”。您可对该副本进行后续的编辑、发布操作。

删除流程插件

支持对无用或废弃的流程插件进行单个或批量删除,以便统一维护插件资源,清理冗余配置。

  • 插件删除后数据无法恢复,请谨慎操作。
  • 仅支持删除非“发布”状态的流程插件。如果“插件状态”“发布”,则不支持删除。
  • 批量删除流程插件时,单次最多可删除20个。
  1. 在左侧导航栏中,选择流程编排服务 > 流程插件管理,进入“流程插件管理”页面。
  2. 根据实际业务需求,选择以下任一方式进行删除。

    • 单个删除:找到目标流程插件,根据插件当前状态执行对应操作:
      图4 单个删除插件
      • “插件状态”“草稿”:单击
      • “插件状态”“审核中”:选择“ > 删除”。
    • 批量删除:勾选1个或多个待删除的流程插件,单击“删除”
      图5 批量删除插件

  3. 在弹出的提示框中,单击“确定”,即可完成删除。

修改流程插件

  1. 在左侧导航栏中,选择流程编排服务 > 流程插件管理,进入“流程插件管理”页面。
  2. 在插件列表中找到目标插件,单击其所在行的,展开该插件的编辑页面。

    图6 修改流程插件

  3. 根据实际业务需求,调整插件的描述或JS脚本。
  4. 修改完成后,单击“保存”

查询流程插件

支持通过多维度条件快速检索和定位目标流程插件,帮助用户在大量插件中高效查找所需资源。

默认情况下,“流程插件管理”页面将展示所有已创建的流程插件。用户可在“条件筛选”区域,自定义设置筛选条件进行精准筛选。

图7 流程插件的条件筛选

筛选条件说明:

  • 插件编号:输入流程插件的编号进行模糊匹配。
  • 英文名称:输入流程插件的英文名称进行模糊匹配。
  • 中文名称:输入流程插件的中文名称进行模糊匹配。
  • 插件状态:选择“草稿”“审核中”“发布”

查看流程插件

  • 查看所有流程插件的信息

    “流程插件管理”页面,可查看所有流程插件的基本信息列表。

    图8 流程插件列表
  • 查看某个流程插件的详细信息

    单击目标流程插件的“插件编号”超链接,进入流程插件详情页,即可查看某个流程插件的详细信息。

    图9 流程插件详情

相关文档