通过网络套接字使用 BTXML 打印文档(视频时长:7分30秒)
适用于:BarTender 2019 及更高版本。
概述
本示例的目标是创建一个包含 BTXML 脚本操作的网络套接字集成。BarTender XML 脚本(BTXML Script)可以轻松实现 BarTender 的自动化,同时为第三方开发者提供了简单的方式将 BarTender 集成到他们的应用程序中。
运行 BTXML 脚本后会生成一个 XML 响应。该 XML 响应会为您提供有关打印作业的重要信息,例如用于完成作业的打印机、打印作业期间 BarTender 的设置,以及已打印标签的详细信息。
场景
某公司需要将包含 100 个序列化项目的打印作业发送到他们的 HP LaserJet 打印机的 1 号纸盒。当通过网络套接字发送数据(本例中为 BTXML 脚本),并由 BarTender 集成服务读取后,打印作业将被执行。
实施步骤
以下步骤介绍了如何为上述场景设置、部署和验证集成。
创建 BarTender 文档
- 打开 BarTender。
- 在文件菜单中,选择新建,打开新建文档向导。
- 选择空白模板,然后点击完成关闭新建文档向导。BarTender 中会出现一个新文档。
- 在文件菜单中,选择打印,打开打印对话框。
- 在名称下拉列表中,选择您要使用的打印机。请确保在 BTXML 脚本中将打印机名称更改为您在此处选择的打印机。
- 点击关闭,关闭打印对话框。
- 在文件菜单中,选择页面设置,打开页面设置对话框,根据需要配置页面。
- 页面配置完成后,点击确定关闭页面设置对话框。
- 在创建菜单中,选择模板对象,并根据需要配置您的 BarTender 文档。
- 在文件菜单中,选择另存为,将 BarTender 文档保存为 Scriptdoc.btw。
- 关闭 BarTender。
创建 BTXML 脚本触发文档
<?xml version="1.0" encoding="utf-8"?> <XMLScript Version="2.0"> <Command Name="Job1"> <Print> <Format>c:\BarTender\Scriptdoc.btw</Format> <PrintSetup> <NumberSerializedLabels>100</NumberSerializedLabels> <Printer>HP LaserJet</Printer> <PaperTray>Tray 1</PaperTray> </PrintSetup> </Print> </Command> </XMLScript>
注意:请确保路径和文件名与您为本示例创建的文档一致。
注意 2:如果您收到 BTXML 解析错误或错误 3808,请从您的 BTXML 文件中移除以下行:
<?xml version="1.0" encoding="utf-8"?>
将 BTXML 脚本粘贴到一个文本文件中,并将其保存为 BTXMLScript.txt。
创建集成文件:选择网络套接字集成
- 打开 Integration Builder。
- 点击创建新集成,打开新建集成对话框。
- 点击网络套接字,然后点击确定。
- 在网络套接字集成面板中,选择集成。
- 在属性面板中,将集成的名称填写为“Print 100”。
- 在启动集成下拉列表中,选择自动。
- 在用户帐户下,指定用户凭据。详情请参见 使用空文件打印文档。
- 在网络套接字集成面板中,选择套接字。
- 在属性面板中,设置您的协议和端口信息。
- 在网络地址下,选择监听所有网络接口。或者,选择监听指定 IP 地址,并从下拉列表中选择或手动输入 IP 地址。
- 如有需要,设置您的通信设置和连接协议。
- 在网络套接字集成面板中,选择输入数据。
- 在属性面板中,将编码属性选择为Unicode (UTF-8)。
- 在停止读取条件中,选择收到字符序列时。
- 在字符字段中输入</XMLScript>。
- 启用在输入数据内容中包含序列。
- 在输入数据格式中,选择BTXML 脚本。
- 在网络套接字集成面板中,选择响应。
- 在属性面板中,选择您的响应选项。
创建集成文件:为网络套接字集成添加操作
- 在网络套接字集成面板中,选择操作。
- 在属性面板中,将执行操作选择为顺序。
- 在重复操作中,填写“1”。
- 在网络套接字集成面板的操作下,点击 在打印文档右侧,移除默认操作。
- 选择操作,点击 添加,打开新建操作对话框。
- 在左侧导航栏的操作类型列表中选择打印,然后选择打印 BTXML 脚本
- 点击确定关闭新建操作对话框。
- 打印 BTXML 脚本操作会出现在网络套接字集成面板的操作下。
- 如果尚未选中,请在网络套接字集成面板中点击打印 BTXML 脚本。
- 在属性面板的操作下,为打印 BTXML 脚本操作输入名称和描述。
- 在脚本下,从脚本来源下拉列表中选择变量。
- 如果尚未选中,请在变量下拉列表中选择EventData。
- 点击 位于 Integration Builder 左上角,将集成文件保存为
BTXML_Integration.btin。
测试“打印 BTXML 脚本”操作(非整个集成)
要测试“打印 BTXML 脚本”操作,您需要为测试更改一些设置,测试后再恢复原设置。
- 在网络套接字集成面板的操作下,选择打印 BTXML 脚本。
- 在属性面板的脚本下,从脚本来源下拉列表中选择嵌入式脚本。
- 点击导入按钮导入您的 BTXML 文件,或直接将文件内容粘贴到提供的窗口中。
- 点击脚本窗口右侧的测试按钮。
- 如果您的“打印 BTXML 脚本”操作测试通过,在网络套接字集成面板的操作下,再次选择打印 BTXML 脚本。
- 在属性面板中,将脚本类型改回变量,并将变量类型改回%EventData%。
注意:此单元测试仅验证 BTXML 脚本是否正确,以及所选用户帐户是否有权限访问并打印 BarTender 文件到指定打印机。它不会测试触发条件。请参见下一节。
测试并部署集成文件
- 点击 测试集成,在 Integration Builder 工具栏中。
- 如果您的集成测试通过,点击 部署集成,打开新建部署对话框。
- 输入部署的名称和描述。
- 确保集成文件设置为
BTXML_Integration.btin。否则,点击浏览,找到并选择BTXML_Integration.btin。 - 在目标服务器中,添加您希望部署集成文件的服务器。
- 指定所需的错误处理设置。
- 点击确定关闭对话框并部署集成文件。
- 管理控制台会在集成节点打开,显示您的集成。
运行场景并查看集成处理
- BarTender 集成服务正在监控所选的网络套接字。请使用您喜欢的方法,将 BTXMLScript.txt 的内容通过网络套接字发送。
- 集成服务会将 BTXML 脚本传递给 BarTender。
- BarTender 会按照 BTXML 脚本中指定的操作执行,使用指定打印机的 1 号纸盒打印 Scriptdoc.btw 文档 100 份。