Skip to main content

Creating and Configuring Connections

BarTender provides many ways to integrate with other business systems. This module supports the following integration formats:

ConnectionDescription
Web ServicesRuns actions by posting a web service request to a URL.
TCP SocketRuns actions by sending data over a TCP socket connection.

For more detailed information about BarTender integrations, consult Integrating with BarTender Integration Builder.

Connecting to a BarTender Server

  1. On the Gateway Webpage, go to the Gateway Config tab. Scroll down to the Bartender > Connections section.
  2. On the BarTender Connections page, click on the Create new BarTender Connection... link at the bottom of the table.
  3. The next step is to choose a BarTender Connection Driver. The connection driver used must match the integration type configured on the BarTender server. Pick the driver for your integration, and click on the Next button.

Configure the Connection

After selecting the driver, you'll configure the settings for the connection. Some settings are specific to the driver that you're using.

PropertyDescription
NameEach BarTender connection needs a unique name, which consists of letters, numbers and underscores.
DescriptionA brief description of the connection.
EnabledLets you to enable or disable a BarTender connection.
Data FormatData format used by the BarTender integration. This should match the Input Data Format configured in your BarTender integration.

Web Service Connections

PropertyDescription
URL PathA string that instructs the driver how to connect to BarTender. This string is the server address including the port and integration endpoint.
UsernameThe username to use when connecting.
Change PasswordCheck the box to change the existing password.
PasswordEnter password.
PasswordRe-type password for verification.
Maximum ConnectionsThe maximum number of concurrent connections allowed to the BarTender server. Requests are added to a queue once the maximum number of connections is reached. Setting the this value to 0 disables the connection limits.
danger

Overloading of the BarTender server may occur under high loads if no connection limit is set.

TCP Socket Connections

.TCP Socket Connection Properties [%header, cols="1, 3"] |=== |Property |Description

|Hostname |The hostname or IP address of the BarTender server.

|Port |The port configured for the BarTender integration.

|Maximum Connections |The maximum number of concurrent connections allowed to the BarTender server. Requests are added to a queue once the maximum number of connections is reached. Setting this value to 0 removes the maximum connection limit.

|===