BarTender 2016 How to Build a GET
Web Service Integration
A presentation on the features and functionalities in the newly
released version of BarTender.
Proprietary and confidential. Do not copy or disseminate. 1
Web Service Integrations Steps
Create and configure a BarTender document.
Launch the Integration Builder and create a new
web service integration.
Configure event settings including integration
variables.
Configure actions to execute.
Test the Integration.
Use a REST client app to generate a trigger event
for testing purposes.
Deploy integration to production server.
Manage and monitor the integration.
Proprietary and confidential. Do not copy or disseminate. 2
Build Integrations, Test, Deploy, and Print in Production
BarTender Print
Server
Web App
Integration
Service
Print Scheduler
Service
BarTender Print
Engine Collection
Proprietary and confidential. Do not copy or disseminate. 3
Create a New BarTender Document
Launch the BarTender designer application, create a new document, and add text, barcode
and any other design objects onto the template as is required.
Proprietary and confidential. Do not copy or disseminate. 4
Name each Variable Data Source in the Document
Open the properties of each object that will contain variable data. Set a unique name for each data
source in your BarTender document that you then wish to set at print time via the web service
integration message.
Proprietary and confidential. Do not copy or disseminate. 5
Build the Integration
6
Integration Builder Create a Web Service Event
Launch the Integration Builder and create a new web service integration.
Proprietary and confidential. Do not copy or disseminate. 7
Integration Name and Web Service URL
In the main Integration Builder window give your integration a unique name as this will be used in the URL
path of your web service.
Proprietary and confidential. Do not copy or disseminate. 8
Set Input Data Type, Response to Origin, and Integration Variables
Proprietary and confidential. Do not copy or disseminate. 9
Importance of Custom Integration Variables
Specifying the Custom Integration Variables is particularly important as this is what allows your application to
pass parameter values entered into the GET web service request in order to select the document and printer
to use, and to set data for named data sources in the label design.
Proprietary and confidential. Do not copy or disseminate. 10
Create a New Print Document Action
By default a Print Document action is auto-created for each new integration, but a new action can be
added by clicking the + icon to the right of the Actions item.
Proprietary and confidential. Do not copy or disseminate. 11
Configure the Print Document Action
Configure the Print Document action using the custom variables to specify the document and printer to
use, along with setting named data sources in the document design.
Proprietary and confidential. Do not copy or disseminate. 12
Test the Integration in the Integration Builder Sandbox
Before deploying your completed integration test it in the Integration Builder sandbox on your workstation.
Select the Test tab and Start the integration so that it is actively listening for a trigger event to occur.
Proprietary and confidential. Do not copy or disseminate. 13
Construct a URL, with Parameters, to Send to the Web Service
Use a REST client app to construct a URL with parameters, in order to send an event message to the web
service on the Integrations server. Alternatively, enter the URL into the address bar of your browser.
http://localhost:80/Integration/MyIntegration/Execute?Document=Test.btw&Printer=ThermalPrinter1&fld
Text=Hello World&fldBarcode=ABC123
Proprietary and confidential. Do not copy or disseminate. 14
XML Response Status - 200 OK
If all is well then an HTTP status 200 OK is returned along with the BarTender XML response message.
Proprietary and confidential. Do not copy or disseminate. 15
Deploy the Integration
16
Deploy your Integration to your BarTender Production Server
In the Administration Console, define a new deployment giving it a name and description. Choose the
source integration file, remove the local computer target and add your production server, schedule the
date/time, and deploy.
Proprietary and confidential. Do not copy or disseminate. 17
Managing Integration Deployments and Messages
In the Administration Console monitor your actively running integrations, drilling down into each for
verbose details on any errors, warnings, messages, and events generated. Messages can be exported for
import and analysis in external tools.
Proprietary and confidential. Do not copy or disseminate. 18
BarTender 2016
Powerful document design combined with comprehensive integration.
Proprietary and confidential. Do not copy or disseminate. 19
Thank You!
20
