跳到主要内容

不预览直连打印插件

概述​

目前打印报表需要先通过浏览器预览页面后才能打印，通过此接口可以实现静默打印，不需要提前预览报表。

积木报表提供无预览直连打印插件，分为 v2（推荐）和 v1 两个版本；v2 功能是新版并持续维护，v1 将不再维护。

  • v1版本

    • 版本号：1.7.5+
    • 依赖环境：需要谷歌浏览器环境支持
    • 维护状态：后续不再维护

  • v2版本

    • 版本号：2.1.0+
    • 依赖环境：不依赖谷歌浏览器，直接使用Java导出方案
    • 推荐使用，功能更完善且持续维护

前置条件​

  1. 客户端支持的操作系统:
    1. windows 8+ x86_64
    2. Mac Os arm64 & x64
    3. Centos 7.9
  1. 客户端电脑需要提前设置好打印机并将打印机设置为默认打印机
  2. windows系统下需要安装Adobe Reader并将pdf的默认应用程序设置成Adobe Reader
  3. v1版本需要客户端电脑安装谷歌浏览器（linux安装google-chrome和chromedriver），使用新版v2接口不需要谷歌浏览器环境

windows系统下设置默认打印机方法：控制面板->设备和打印机->右键点击你要设置的打印机->选择设为默认打印机 参考文档 macos系统下设置默认打印机方法:系统设置->打印机与扫描仪->右键点击你要设置的打印机->选择设为默认 参考文档

使用方式​

1、下载直连打印客户端插件​

点击下载一年许可的打印插件： v2.1新版本、 v2.0之前版本，解压到本地，提供了window、Linux、mac三个版本，选择你对应的系统版本。

2、运行积木打印插件​

启动命令​

运行与当前系统匹配的应用程序

./jimu-auto-printer-macos-arm64

当出现下面提示时，代表打印程序已经准备就绪

*INFO: Started server process [52132]INFO: Waiting for application startup.INFO: Application startup complete.INFO: Uvicorn running on http://0.0.0.0:16065 (Press CTRL+C to quit)> 本插件需要占用系统16065端口.*

3、调用接口(v1)​

请求示例:

  curl --location 'http://<domain>/export/report' \
  --header 'Tenantid: null' \
  --header 'X-Tenant-Id: null' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "export_type": "PDF", 
    "report_ids": [
      "???","???"
    ],
    "report_params": [
        {
            "id": "???",
            "params": {
                "???": "???"
            },
            "export_type": "excel"
        }
    ],
    "jimu_view_url":"http://<JimuReport-Domain>/jmreport/view/",
    "token": "???"
    "print_report": true
  }'

请求参数说明:

参数类型描述必填示例/说明
export_typeString导出类型必填PDF/Excel/Word 三选一，如果需要打印固定为PDF
report_idsList<String>报表idreport_params二选一必填["123123123","123123123"]
report_paramsArray报表查询参数集合report_ids二选一必填[{"id":"123","params":{"name":"张三"}}]
└ idString报表id必填"123"
└ paramsMap查询参数选填{"name":"张三"}
└ export_typeString导出类型选填PDF/Excel/Word 三选一 ，优先使用该选项
jimu_view_urlString积木报表预览页面基础地址必填"http://<JimuReport-Domain>/jmreport/view/"
tokenString当前用户Token非必填-
printReportbool是否打印必填true

响应示例:

{
  "success": true,
  "message": "导出成功",
  "result": {
    "report_count": 1,
    "downloaded_count": 1,
    "failure_rids": [],
    "download_path": "/opt/xxx/17116260945c6xOm",
    "batch_no": "17116260945c6xOm"
  }
}

响应参数说明:

参数类型描述示例/说明
report_countint报表总数-
downloaded_countint下载成功总数-
failure_ridsArray失败报表id集合["123123123","123123123"]
download_pathstring存储路径"/opt/xxx/17116260945c6xOm"
batch_nostring批次号-

测试效果​

提示​

软件运行时会自动下载与当前电脑上安装的chrome对应版本的chrome-driver，若出现网络原因导致的无法下载, 请手动下载驱动并放到程序运行目录下的drivers目录下.

115及以下版本：https://registry.npmmirror.com/binary.html?path=chromedriver
115以上版本：https://googlechromelabs.github.io/chrome-for-testing/

3、调用接口(v2)​

版本支持 version 2.0.1+ date 20240618 v2版本不再依赖谷歌浏览器环境，直接使用java导出方案。

请求示例:

curl --request POST \
--url http://<domain>/export/report/v2 \
--header 'Content-Type: application/json' \
--data '{
    "jimu_domain": "http://<jimuDomain>:8085",
    "print_report": true,
    "base_download_path": "/Users/xxx/xxx",
    "token": "xxx",
    "report_params": [
        {
            "id": "1331503965770223616",
            "params": {},
            "export_type": "PDF"
        }
    ]
}'

请求参数说明:

参数类型描述必填示例/说明
report_paramsArray报表查询参数集合必填[{"id":"123","params":{"name":"张三"}}]
└ idString报表id必填"123"
└ paramsMap查询参数选填{"name":"张三"}
└ export_typeString导出类型选填PDF/Excel/Word 三选一 ，优先使用该选项
jimu_domainString积木报表域名必填"http://<JimuReport-Domain>"
tokenString当前用户Token必填-
print_reportbool是否打印必填true
base_download_pathString下载目录选填/Users/xxx/xxx

响应示例:

{
  "success": true,
  "message": "打印成功",
  "result": {
    "download_path": "/Users/chenrui/Downloads/20250618203559fHBkgU"
  }
}

响应参数说明:

参数类型描述示例/说明
download_pathstring存储路径"/opt/xxx/17116260945c6xOm"

测试效果​