简体中文
Fx.template
约 535 字大约 2 分钟
2026-01-09
摘要
本文档的概要说明如下: 本文档介绍 Fx.template 的API定义、使用方式及相关说明。
1. print 使用对象打印模板输出打印文件
Fx.template.print(<boolean error>, <Email data>, <String errorMessage>)
参数说明
入参格式
| 参数名称 | object | 描述 | 是否必填 |
|---|---|---|---|
| error | boolean | 是否执行异常 | 是 |
| data | 返回结果 | 是 | |
| errorMessage | String | 异常提示信息 | 是 |
| data | 返回结果 | 是否必填 | |
|---|---|---|---|
| path | String | NPath | 是 |
| fileSize | Integer | 文件大小 | 是 |
| name | String | 文件名称 | 是 |
| fileType | String | 文件类型 | 是 |
出参格式
| 参数名称 | APIResult | 参数列表 |
|---|---|---|
| error | boolean | 是否执行异常 |
| data | 返回结果 | |
| errorMessage | String | 异常提示信息 |
出参样例
{
"error": false,
"data": {},
"errorMessage": ""
}Groovy 举例
// 打印数据的对象APIName
String objectAPIName = "object_kFc8w__c"
// 打印数据Id
String objectId = "6209cfbcdac8a0000127187f"
// 模板Id
String templateId = "64d5dae417eb092ee3bbd9b1"
// 流程实例Id
String instanceId = null
// 文档输出方向
String orientation = "Landscape"
// 语言tag
String locale = "zh-CN"
def(Boolean error, Map data, String errorMessage) = Fx.template.print(objectAPIName, objectId, templateId, instanceId, orientation, locale)
if (error) {
Fx.log.info("打印错误 : " + errorMessage)
} else {
Fx.log.info(Fx.json.toJson(data))
}注意事项
- 打印调耗时会比较长,请尽量放在流程后动作,或者异步函数中,避免页面执行超时
版本记录
| 版本 | 日期 | 变更内容 | 负责人 |
|---|---|---|---|
| v1.0 | 2026-05-19 | 初始版本 |
背景说明
本文档详细描述 Fx.template 的相关接口功能和使用方法,帮助开发者快速集成相关能力。
适用场景
具体适用场景由实际业务需求决定,开发者可根据需要选择相应的接口进行集成。
前置条件
- 已接入纷享销客开放平台
- 已完成应用授权与配置
- 了解相关业务领域基础知识
操作步骤
具体操作步骤请参考各接口的详细说明。
注意事项
- 调用接口前请确保满足前置条件
- 注意接口调用频率限制
- 异常情况请参考错误码说明进行处理
兼容性说明:当前版本暂无可用的废弃或兼容性说明。
