更新时间:2024-11-21 GMT+08:00
分享

为AstroZero服务编排添加生成文档图元

赋值图元的作用

通过配置该图元,可将应用中配置的模板生成文档。如何端到端的使用模板生成文档,请参见使用AstroZero文件模板生成合同文档

如何使用生成文档图元

  1. 新建模板场景。

    模板场景是一个业务场景的集合,支持创建多个模板,模板间共享数据结构。模板场景创建后,可在服务编排的流程中调用。
    1. 参考登录AstroZero新版应用设计器中操作,登录应用设计器。
    2. 在左侧导航栏中,选择“逻辑”
    3. “更多”中,选择“模板”,单击“添加模板场景”
      图1 选择添加模板场景
    4. 输入模板的标签和名称,单击“确定”
      图2 新建模板场景
      表1 新建模板场景参数说明

      参数

      说明

      标签

      新建模板场景的标签名,用于在页面展示。

      取值范围:1~64个字符。

      名称

      输入模板场景的名称,名称是模板场景在系统中的唯一标识,创建后不可修改。命名要求如下:

      • 长度不能超过64个字符,包括前缀命名空间的长度。
        说明:

        标识前的内容为命名空间,在AstroZero中为了避免不同租户间数据的重名,租户在首次创建应用时需要先定义一个命名空间。一个租户只能创建一个命名空间,创建后不支持修改。

      • 名称必须以英文字母开头,只能由英文字母、数字或单下划线组成,且不能以下划线结尾。

      描述

      请根据需要在文本框中,输入对该模板场景的描述信息。

      取值范围:1~255个字符。

    5. 在创建的模板场景中,选择“配置”页签,配置文件存储的位置,单击“保存”
      图3 配置文件存储信息
      表2 配置参数说明

      参数

      说明

      生成的文件名

      设置基于模板生成的文件名,支持“随机字符串”“自定义名称”两种方式。设置为“自定义名称”时,可根据自身业务需求指定生成文件的名称。

      文件存储 > 连接器类型

      文件存储的连接器类型,当前仅支持“OBS”“MINIO”两种。在AtroZero中,通过创建OBS、MINIO连接器,可将数据存储到OBS和MINIO中,详细介绍请参见对接OBS云对象存储实例对接MINIO存储AstroZero对象或资产

      文件存储 > 连接器名称

      在AstroZero中创建OBS或MINIO连接器的名称,可在集成 > 连接器 > 连接器实例 > 存储 > OBS/MINIO中查看。

      文件存储 > 连接器桶名

      创建连接器时,配置的OBS或MINIO桶名称。

      文件存储 > 文件存储位置

      指定文件在OBS或MINIO桶中的存储路径。

  2. 为模板添加参数。

    此处添加的模板参数,对应文档模板中需要替换的内容。
    1. 选择“数据”页签,单击“添加”,进入添加参数页面。
    2. 设置参数的相关信息,单击“保存”
      图4 新建模板参数
      表3 新建参数说明

      参数

      说明

      名称

      新建模板参数的名称,用于在页面展示。

      取值范围:1~64个字符。

      唯一标识

      输入模板参数的标识,是模板参数在系统中的唯一标识,创建后不可修改。命名要求如下:

      • 长度不能超过64个字符,包括前缀命名空间的长度。
        说明:

        标识前的内容为命名空间,在AstroZero中为了避免不同租户间数据的重名,租户在首次创建应用时需要先定义一个命名空间。一个租户只能创建一个命名空间,创建后不支持修改。

      • 名称必须以英文字母开头,只能由英文字母、数字或单下划线组成,且不能以下划线结尾。

      数据类型

      在下拉框中选择新建模板参数的类型,支持文本、数字、币种金额、日期和日期/时间。

      设置为“基本参数”时,才会显示该配置。

      对象

      选择所需的对象,创建后参数会继承该对象的结构,如图5所示。

      设置为“对象”时,才会显示该配置。

      描述

      请根据需要在文本框中,输入对该模板参数的描述信息。

      取值范围:1~255个字符。

      图5 对象参数

  3. 添加模板。

    在模板场景中添加多种模板,这些模板可以预置在应用中,用于发送通知或生成文档。

    1. 选择“模板”页签,单击“添加”,进入添加模板页面。
    2. 设置模板标签和名称,单击“确定”
      图6 设置模板参数
      表4 新建模板参数说明

      参数

      说明

      标签

      新建模板的标签名,用于在页面展示。

      取值范围:1~64个字符。

      名称

      输入模板的名称,名称是模板在系统中的唯一标识,创建后不可修改。命名要求如下:

      • 长度不能超过64个字符,包括前缀命名空间的长度。
        说明:

        标识前的内容为命名空间,在AstroZero中为了避免不同租户间数据的重名,租户在首次创建应用时需要先定义一个命名空间。一个租户只能创建一个命名空间,创建后不支持修改。

      • 名称必须以英文字母开头,只能由英文字母、数字或单下划线组成,且不能以下划线结尾。

      描述

      请根据需要在文本框中,输入对该模板的描述信息。

      取值范围:1~255个字符。

    3. “模板”页签,单击已创建模板后的,进入文档模板页面。
      图7 进入模板编辑页面
    4. 单击“点击上传”,选择本地待上传的word文档,查看上传后效果。
    5. 预览符合预期后,单击页面右上方的“启用”,启用文档模板。
    6. 返回文档模板场景中,单击“启用”,启用模板场景。

  4. 使用生成文档图元。

    1. 在服务编排设计页面,从基本中拖拽“生成文档”图元至画布中。
    2. 选中生成文档图元,单击,设置基本信息。
      表5 基本信息参数说明

      参数

      说明

      标签

      设置图元的标签,用于在服务编排设计页面展示。系统会自动填入该值,格式为Document序号,序号从“0”开始,表示同类型图元序号。

      名称

      设置图元的名称,名称为图元在服务编排中的标识,请确保在当前服务编排中唯一。命名要求如下:

      • 长度范围为1~80个字符。
      • 必须以英文字母开头,由英文字母,数字或单下划线组成,且不能以下划线结尾。

      描述

      请根据实际需求,在输入框中输入图元的描述信息。

      取值范围:1~255个字符。

    3. 单击,设置生成文档。
      图8 生成文档设置
      表6 生成文档图元设置说明

      参数

      说明

      请选择模板场景

      选择生成文档图元关联的模板场景,即1中创建的。

      请选择文档模板

      选择模板场景中创建的文档模板,即3中创建的。

      连接器类型

      根据选择的文档模板自动进行关联。

      连接器名称

      根据选择的文档模板自动进行关联。

      连接器桶名

      根据选择的文档模板自动进行关联。

      向模板传入数据

      向模板中传入数据,将入参变量一次赋值给对应的模板参数。

      文档保存地址

      将出参变量放入文档保存地址,用于存放生成的文档名。

相关文档