Configuring Label Printing with BarTender Integration Builder

Labelling is a critical safety, compliance, and efficiency aspect of laboratory operations. There are international and regional regulations and standards that govern labelling requirements for safety reasons, as well as laboratory-dependent preferences for maintaining productivity and interoperability with various data management and instrument systems. Veeva LIMS supports integration with third party applications such as BarTender for generating and printing labels. Veeva provides a template for BarTender to streamline configuring this integration.

Configuring Integration Files

Prior to beginning the configuration, you must do the following:

  • Acquire a license and download the BarTender 2022 Automation Suite from Seagull Scientific. BarTender is only available for Microsoft Windows.
  • Download and extract the Vault Bartender Template provided to you by Veeva Services.

To set up BarTender integration with Veeva LIMS:

  1. Install BarTender, then navigate to the folder containing it. The default location is Program Files > Seagull > BarTender 2022.
  2. Double-click IntegrationBuilder.exe to launch the program. You can use the Search bar to search for this file if necessary.
  3. Select Open Integration File.
  4. In the Open File dialog, navigate to the folder where you extracted the Vault Bartender Template. From there, navigate to IntegrationBuilder_template_[number] > IntegrationBuilder > IntegrationBuilder and select Vault_Bartender_Template.btin. [number] should be replaced by a four digit number representing the date when the template was created.
  5. Select Open.
  6. In the resulting window, select the BarTender Icon icon in the upper left corner to open the menu.
  7. Select Options.
  8. In the Custom Global Variables section, the following variables are listed:
    1. VaultAPIVersion: This variable is automatically set correctly by the template.
    2. VaultDNS: Enter the URL of your Vault.
    3. VaultPassword: Enter your Vault password.
    4. VaultUsername: Enter the email address of your Vault account.
  9. Select the Create tab.
  10. In the Vault sidebar, select Integration > Service.
  11. Enter the Port that will be used for the integration.
  12. Select a Protocol. HTTPS is recommended.
  13. Optional: If you choose HTTPS, you may select Add SSL server certificate binding for the specified port. If you do, you must also enter a Thumbprint.
  14. In the Vault sidebar, select Actions > Print labels - myTemplateName.
  15. By default, the File Name field points to an example file included in the template. You can add your own custom file to IntegrationBuilder_template_[number] > IntegrationBuilder > IntegrationBuilder > Vault_Labels and then select it using the Browse… button.

If you need to configure multiple integrations, do the following:

  1. Navigate to IntegrationBuilder_template_[number] > IntegrationBuilder.
  2. Make a copy of the IntegrationBuilder folder. Rename the copied folder and its enclosed Vault_Bartender_Template.btin file so that they are distinct from the first integration file.
  3. Double-click your renamed .btin file to open it. It will open in a new instance of BarTender Integration Builder.
  4. Repeat steps 6-15 above for the new integration.

Once you have finished configuring the integration(s), you have the option to test before deploying. To do so, select the Test tab and click Start. The Messages pane will show any errors, warnings, or messages regarding the integration.

To deploy the integration file:

  1. Select the Deploy tab.
  2. Select Deploy.
  3. In the Schedule Deployment dialog, select when to deploy the integration file.
  4. Select Finish. When the file is deployed, the BarTender Administration Console automatically opens and shows your active integrations.