Web Service Integrations Page 1 of 8

Web Service Integrations

Web service integrations define a web service that the Integration Service monitors for a REST web
request. When the web request is received, the Integration Service processes the data message and runs
the integration's actions.

Web service integrations support only GET and POST requests. Other requests, such as DELETE,
HEAD, and PUT, are rejected. The Send Web Service Request action, however, supports all five
request types: GET, POST, DELETE, HEAD, and PUT.

For more information about how to create actions for your integration, refer to Adding an Action to an
Integration.

In This Section
l Integration Property Page

The Integration property page is a standard page that applies to all integration types. Use this page
to configure the integration, user account, error handling, and diagnostics properties for the
selected integration.

l Service Property Page

Use the Service property page to configure the web service and authentication properties for your
web service integration.

l Input Data Property Page

Use the Input Data property page to configure options that help actions identify how to process
the input event data that is triggered by a web service integration.

l Response Property Page

Use the Response property page to configure settings that direct the Integration Service to send a
response for the web service integration.

l Variables Property Page

The Variables property page is a standard page that applies to all integration types. It provides a
list of the predefined integration variables that any of the integration's actions can reference. By
using this page, you can also create your own custom integration variables for the actions of the
selected integration.

Related Example

l Print Document Using a Web Service (links to the BarTender Support Center)

file:///C:/Users/sisen/AppData/Local/Temp/~hh2A95.htm 11/26/2024
Web Service Integrations Page 2 of 8

Integration Property Page (Web Service

Integration)
Use the Integration property page to configure the following properties for your integration.

Integration

l Name: Specifies a meaningful name for the integration.

l Description: Provides a detailed description of the integration.

l Start Integration: Specifies when the integration runs, as follows:

¡ Automatic: Specifies that the integration runs automatically when the trigger is detected.

¡ Manual: Specifies that the integration must be started manually. You can do this on the
Administration Console Integrations Page.

¡ Disabled: Specifies that the integration is unavailable and cannot be run either automatically
or manually until this setting is changed.

l Stop integration after {#} executions: Specifies the number of times that you want the integration
to run.

Action Execution

These options specify how the integration manages consecutive trigger events. The following options are
available:

l Immediately execute actions and process next integration event: Specifies that as each trigger
event occurs, the integration actions are run immediately in their own event thread. When this
option is selected, the actions that are triggered by each event run simultaneously.

l Immediately execute actions but first verify print jobs are processed in order before
processing next integration event: Specifies that as each trigger event occurs, the trigger is
accepted, but the integration actions are run only after the print jobs from the previous trigger event
are processed.

l Always verify that actions complete before processing next integration event: Specifies that as
each trigger event occurs, the trigger is accepted, but the integration actions are run only after all
actions from the previous trigger event are complete.

User Account

The user account that is specified here is used by the integration and its actions when they search for files

file:///C:/Users/sisen/AppData/Local/Temp/~hh2A95.htm 11/26/2024
Web Service Integrations Page 3 of 8

on the system or in a folder, access printers, display BarTender prompts on the interactive desktop, and so
on, as follows:

l Inherit from service: Specifies that the integration and actions use the credentials of the
BarTender Integration Windows Service. This service typically is set to run as “Local System
Account.”

l Specify user credentials: Specifies that the integration and actions use the user name and
password that you provide.

Error Handling and Diagnostics

l Stop integration after {#} failures: Specifies that the Integration Service stops the integration
after it has failed the specified number of times. If this option is not selected, the integration
continues to run after a failure has occurred unless you manually stop it by using the Integrations
Page of Administration Console.

Related Topics

l Web Service Integrations

Service Property Page

Use the Service property page to configure the following properties for your integration.

Web Service URL

l Service Name: Specifies the service name that is used as part of the web request URL path.
Alternatively, you can add a variable that specifies the service name or add a special character to
the value that you enter.

l Port: Specifies the port that is used as part of the web request URL path.

l Protocol: Specifies the protocol type: HTTP or HTTPS.

¡ Add SSL server certificate binding for the specified port: Enables automatic Secure
Socket Layer (SSL) server certificate binding for the specified port. Available when HTTPS
is selected.

When you select this check box and then enter the SSL server certificate's thumbprint
in the Thumbprint field, the certificate binding occurs automatically. If you do not
select this check box, or if you select the check box and then do not enter a thumbprint,
you must bind the certificate manually by running a Netsh command. For more
information, refer to Binding a Certificate to a Port.

¡ Thumbprint: Specifies the SSL server certificate's thumbprint. You can copy the thumbprint

file:///C:/Users/sisen/AppData/Local/Temp/~hh2A95.htm 11/26/2024
Web Service Integrations Page 4 of 8

into this field from an existing certificate file or by using the Certificate Manager feature, as
follows. Available when Add SSL server certificate binding for the specified port is
selected.

n Copy from a Certificate File: Opens the Open File dialog so that you can browse to
the certificate file that you want.

n Open Certificate Manager: Starts the Microsoft Management Console and displays
the Certificates - Local Computer root folder so that you can browse to the
certificate that you want and then copy its thumbprint to paste into the Thumbprint
field.

l URL Path: Displays the URL path that the Integration Service connects to for receiving and
sending data.

Communication Settings

l Maximum Connections: Specifies the maximum number of web request connections.

Authentication Method

Specifies the authentication method that the Integration Service uses when it runs the integration's
actions. The following options are available:

l Use Anonymous authentication: Specifies that any user can access any public content without
providing credentials (user name and password) to the client browser.

l Use Windows credentials from the web service request: Specifies that the Windows credentials
that the web service passes are used for authentication.

l Use Basic authentication using the web service request identity: Specifies that the Basic
credentials that the web service passes are used for authentication.

Related Topics

l Web Service Integrations

Use the Input Data property page to configure options that help actions identify how to process the input
event data that is triggered by your integration and to configure sample data that can be used to test your
integration.

Input Data Property Page (Web Service

Integration)

file:///C:/Users/sisen/AppData/Local/Temp/~hh2A95.htm 11/26/2024
Web Service Integrations Page 5 of 8

Use the Input Data property page to configure options that help actions identify how to process the input
event data that is triggered by a web service integration and to configure sample data that can be used to
test your integration.

Integration input data is placed into the %EventData% variable.

Input Data Format

l Input Data Format: Specifies the data content type. When the trigger is detected, the Integration
Service processes the contents according to this format before it runs any actions.

l Data is contained in a SOAP message: Specifies that the action looks for the data to be contained
in a SOAP message.

Samples

l New Sample: Opens the Sample Data wizard so that you can add a new sample to the input
data property. Use the wizard to select a sample data source, name the sample, capture an
integration event to use as a sample, and review and edit the sample variables. Available when no
samples have been added.

l Samples: Available when one or more samples have been added.

¡ : Copies the selected sample and places it on the Clipboard.

¡ : Cuts the selected sample and places it on the Clipboard.

¡ : Pastes the sample from the Clipboard.

¡ : Opens the Save File dialog so that you can export the selected sample to a file.

¡ : Opens the Open File dialog so that you can import a sample file.

¡ Add: Opens the Sample Data wizard so that you can add and configure a new sample.

¡ Sample list: Lists the samples in alphabetical order.

¡ Name: Specifies the name of the sample. You can edit the name that is in this field.

¡ Sample Variables: Lists the names and values of the sample variables. You can double-click
a value to edit it, click in the Value field to display the Edit variable value and Delete
icons, or right-click a variable name or value to display the following options:

n New Variable: Adds a new variable to the sample.

file:///C:/Users/sisen/AppData/Local/Temp/~hh2A95.htm 11/26/2024
Web Service Integrations Page 6 of 8

n Copy: Copies the variable to the Clipboard.

n Cut: Cuts the variable and places it on the Clipboard.

n Paste: Pastes the variable from the Clipboard.

n Delete: Deletes the variable.

¡ Add: Adds a new variable.

For more information, refer to Using Sample Data Sources.

Related Topics

l Web Service Integrations

Response Property Page (Web Service

Integration)
Use the Response property page to configure settings that direct the Integration Service to send a
response for your integration.

Response

l Send response to client: Specifies that a response is sent to the client.

l Wait for actions to complete before sending response to client: Specifies that the response is not
sent to the client until the integration actions are completed.

l The HTTP response status code that is returned when an action fails: Specifies the three-digit
HTTP response status code that you want to be returned if an action fails. The default value is 200.

l Content-type: Specifies the data format that is used to send the response.

l Source: Specifies the source for the data that is to be used for the response, as follows:

¡ Embedded Template

¡ Value: Use this input box to enter the data that you want the integration to use for the
response. Alternatively, you can add a variable or add a special character to the value
that you enter.

¡ Import: Click this option to open the Open File dialog so that you can browse to and
select a file that contains the data that you want. The contents of the file are imported
into the Value input box.

file:///C:/Users/sisen/AppData/Local/Temp/~hh2A95.htm 11/26/2024
Web Service Integrations Page 7 of 8

¡ Export: Click this option to open the Save File dialog so that you can save the
contents of the Value input box as an external file. You can save the value as a new
file or replace the contents of an existing file.

¡ Variable

¡ Variable: Enter the variable that you want to use for the response source.
Alternatively, expand the list and then click a recently used variable or click More
Variables to add a variable.

¡ External File

¡ Location: Specifies the file system where the source file resides that you want to use
for the response. File systems or locations can include a path that is relative to the
folder that contains the integration file, a temporary storage folder, local file systems
or network shares, Librarian, or a supported cloud storage location. For more
information about supported cloud storage locations, refer to the Administration
Console Cloud Storage Page.

¡ File Name: You can enter the folder location and file name or click Browse to locate
and then select the file that you want (the Browse option is not available when
Location is set to Relative to Integration or Temporary Storage). Alternatively, you
can add a variable to specify the file that you want or add a special character to the
value that you enter.

¡ File Encoding: Specifies the encoding that is used by the source file.

¡ Action Summary: Specifies that the action summary is used as the response source. The
data format of the action summary is either JSON or XML, depending on the value of the
Content-type field.

Response Header

By using the Name and Value input boxes in the table, you can specify custom response header
properties (name/value pairs) to be returned in the response.

Related Topics

l Web Service Integrations

Variables Property Page (Web Service

Integration)
The Variables property page is a standard page that applies to all integration types. It provides a list of
the predefined integration variables that any of the integration's actions can reference. By using this page,

file:///C:/Users/sisen/AppData/Local/Temp/~hh2A95.htm 11/26/2024
Web Service Integrations Page 8 of 8

you can also create your own custom integration variables for the actions of the selected integration.

Predefined Integration Variables

This table lists the predefined integration variables for the currently selected integration. These variables
can be referenced by any action in the integration.

Custom Integration Variables

This area lists any custom integration variables that you have defined for the currently selected
integration. These variables can be referenced by any action in the integration. Click a variable in the list
to display its value.

l Add Variable: Click Add Variable to define the first variable that you want. Available only when
no variables were previously added.

l Add: Click Add to define another variable. Available only after at least one variable is added.

l Variables: Displays each variable that has been added. Click a variable in the list to view its Name
and Value properties.

l Name: Displays the name of the variable that is currently selected in the Variables list. You can
enter a new name in the text box. Alternatively, you can add a variable to specify the name that you
want.

l Value: Specifies the value for the variable that is currently selected in the Variables list. You can
enter a new value in the text box. Alternatively, you can add a variable to specify the value that you
want or add a special character to the value that you enter.

l Import: Opens the Open File dialog so that you can browse to and open a file that contains the
values that you want to be assigned to the variable. When you open the file, its contents are
imported into the Value field.

l Export: Opens the Save File dialog so that you can save the contents of the Value field as an
external file. You can save the value as a new file or replace the contents of an existing file.

l Edit variable value : Opens the Value for dialog, where you can edit the value of the variable.

Related Topics

l Using Variables

l Web Service Integrations

file:///C:/Users/sisen/AppData/Local/Temp/~hh2A95.htm 11/26/2024