Skip to main content
Deutsch Español Français 日本語 简体中文 繁體中文

Search

Articles in this section

See more

How to Prevent Integration Messages From Being Logged to the BarTender System Database

Fernando Ramos Miracle

BarTender Content Team

  • Updated

Overview

For troubleshooting or to keep the database size down, you may wish to avoid logging integration messages into the BarTender System database, or even delete those already logged.This can be useful for high volume integration printing, smaller databases, or issues where the logging gets behind. Each print job can log up to 5-7 Integration related messages to the BarTender system database which can take up a lot of space and potentially network resources.

Situations where the logging of integration messages might cause a problem are:

  • You have reached the maximum size of your database. SQL Express edition has a maximum size of 10GB. If you have reached that limit, you may see a message like the following:

  • The size of the database has grown out of hand.
  • The messages are consuming too many resources

Whichever the case is, you can turn the messages off. Please use the dropdown above to choose your version for how to turn off or control the messages.

Applicable to

BarTender 2022 and later

Integration Platform

Information

Disable System Database Logging

In BarTender 2022 and later, you can control the integration message logging directly in the Administration Console.

integration_messages.png

Please see the help file, System Database Page, for more information on what each setting controls or use the help button on the Administration Console itself.

There are two types of messages that can be logged when an Integration is executed.

  1. Integration messages
  2. BarTender System Database messages.

The settings under Administration Console>System Database>Integration Message Logging only apply to the first message type. In order to disable the second message type you will also need to disable Log messages to System Database under Administration Console>System Database>Message Logging. 

Disabling Log messages to System Database will affect logging beyond just Integrations. 

Clear System Database Message Logs

If you need to completely clear out any existing Integration messages from the BarTender system database that has filled up, you can run the following SQL statement from MS SQL Management Studio. All the related Integration messages are store in the IntegrationMessages table.

  1. Open SQL Server Management Studio and connect to the SQL server with the BarTender system database.
  2. In the left pane, expand Databases, right click on the BarTender system database and select New Query.
  3. Paste in the query: 
    drop view dbo.IntegrationMessagaesView
  4. Click execute in the toolbar or press F5 on your keyboard to run.
  5. Repeat steps 2-4 for the following query: 
    truncate table dbo.IntegrationMessages
  6. Finally, open the Services app and restart BarTender Integration Service. This will recreate the view dbo.IntegrationMessagesView.

Applicable to

BarTender 2021

Integration Platform

Information

Disable System Database Logging

In BarTender 2021, you can control the integration message logging directly in the Administration Console.

integration_messages.png

Please see the help file, System Database Page, for more information on what each setting controls or use the help button on the Administration Console itself.

There are two types of messages that can be logged when an Integration is executed.

  1. Integration messages
  2. BarTender System Database messages.

The settings under Administration Console>System Database>Integration Message Logging only apply to the first message type. In order to disable the second message type you will also need to disable Log messages to System Database under Administration Console>System Database>Message Logging. 

Disabling Log messages to System Database will affect logging beyond just Integrations. 

Clear System Database Message Logs

If you need to completely clear out any existing Integration messages from the BarTender system database that has filled up, you can run the following SQL statement from MS SQL Management Studio. All the related Integration messages are store in the IntegrationMessages table.

  1. Open SQL Server Management Studio and connect to the SQL server with the BarTender system database.
  2. In the left pane, expand Databases, right click on the BarTender system database and select New Query.
  3. Paste in the query: 
    truncate table dbo.IntegrationMessages
  4. Click execute in the toolbar or press F5 on your keyboard to run.

Applicable to

BarTender 2016 - 2019

Integration platform

Information

Disable System Database Logging

You can do the following to prevent Integration related messages from being logged to the BarTender system database (Note that this only changes how integration messaging is stored and does not affect how the BarTender application stores data using the Administer -> Log Setup options.):

  1. Stop the BarTender System Service.
  2. Navigate to the directory where you installed BarTender (eg. C:\Program Files\Seagull\BarTender Suite) and open the BtSystem.Service.exe.config file.
  3. In the BtSystem.Service.exe.config file, find the XML tag and section where it begins with <appSettings>. You will want to add the following to the <appSettings> section:

    <!-- Set whether or not to enable logging of integration messages to the BarTender System Database. -->
    <add key="Integration.Messaging.SystemDatabase.LogEnabled" value="false" />
    <!-- Set integration playback log frequency. Valid values are All, EventsOnly, and None -->
    <add key="Integration.Messaging.PlaybackStateLogFrequency" value="None" />
    <!-- Set whether or not to enable logging of integration messages to the BarTender System Database application message store. -->
    <add key="Integration.Messaging.SystemDatabase.MessageStoreLogEnabled" value="false" />

    The above settings turns off logging for all Integration platform messages to the BarTender System Database. It will reduce the potential size of the system database but comes with the limitation of not being able to browse the integration platform message history using the Administration Console or seeing any integration messages in History Explorer. If only integration related application messages are desired to be seen in History Explorer then tweak the settings as follows:

    <!-- Set whether or not to enable logging of integration messages to the BarTender System Database.  These messages show up in the Admin Console-->
    <add key="Integration.Messaging.SystemDatabase.LogEnabled" value="false" />
    <!-- Set integration playback log frequency. Valid values are All, EventsOnly, and None -->
    <add key="Integration.Messaging.PlaybackStateLogFrequency" value="None" />
    <!-- Set whether or not to enable logging of integration messages to the BarTender System Database application message store. These messages show up in History Explorer -->
    <add key="Integration.Messaging.SystemDatabase.MessageStoreLogEnabled" value="true" />
  4. Save the BtSystem.Service.exe.config file changes.
  5. Restart the BarTender System Service.

Clear System Database Message Logs

If you need to completely clear out any existing Integration messages from the BarTender system database that has filled up, you can run the following SQL statement from MS SQL Management Studio. All the related Integration messages are store in the IntegrationMessages table.

  1. Open SQL Server Management Studio and connect to the SQL server with the BarTender system database.
  2. In the left pane, expand Databases, right click on the BarTender system database and select New Query.
  3. Paste in the query: 
    truncate table dbo.IntegrationMessages
  4. Click execute in the toolbar or press F5 on your keyboard to run.

Additional Resources

Related articles