Overview

When automating your label printing using the BarTender REST API, it is possible to override the a database connection for your label with custom data using text files without the need to modify your BTW file.

Using the TransformTextToRecordSetAction function during your API call converts the data in your text file into data records which then populate your label at print time.

This article will show you how to call this function using YAML.

For a general overview on how the REST API works you can have a look at this article. 

Applicable to 

BarTender 2022 and later

Automation edition and higher 

Information

Create Your BarTender Document

1. Create a database text file with the following format: 

   Field 1, Field 2, Field 3
   Value 1, Value 2, Value 3
   Value 4, Value 5, Value 6

2. Save the file as dbfile.txt.
3. Open BarTender Designer and create a new document.
4. Add a text database connection for dbfile.txt.(Check this article for more information)
5. Make sure your database connection is named dbfile:

1. Add 3 text objects to the label and connect them to the database fields.  
2. Save the file under C:\Docs\APITest.btw.

Setup Your Environment

1. Export your database connection setup: 

1. Save the file under C:\Docs\dbfolder\ConnectionSetup.xml.
2. Create a data file with the following content:

   Field 1, Field 2, Field 3
   Value 7, Value 8, Value 9
   Value 10, Value 11, Value 12

3. Save it under C:\Docs\dbfolder\datafile.txt.
4. Create a folder called Output under C:\Docs\.

Make Your API Call

1. Open the following link in your browser:
   

   http://localhost:5159/swagger/index.html

2. At the top of the page click the Try it out button: 

1. Make sure the File parameter is empty.
2. For Request body select text/vnd.yaml.
3. In your request body, add the following two actions: 
   1. TransformTextToRecordSetAction with parameters: 
      1. ConnctionSetup: the xml file exported from your btw Connection setup. 
      2. Text: the text file which contains the data to be inserted into your labels at print time. 
   2. PrintBTWAction with paramters:
      1. DocumentFile: the path to your btw file to be printed.
      2. Printer: the printer to be used.
      3. PrintToFileFolder & PrintToFileFileName: the output location and filename used by the PDF printer.
      4. DatabaseOverrides: the database override settings. In this case, the database connection dbfile is overriden from the datum variable.  

ActionGroup:
   Actions:
      - TransformTextToRecordSetAction:
         ConnectionSetup: 
            File: C:\Docs\dbfolder\ConnectionSetup.xml
         Text:
            File: C:\Docs\dbfolder\datafile.txt
         RecordSetVariableName: datum 
      - PrintBTWAction:
         DocumentFile: C:\Docs\APITest.btw
         Printer: PDF
         PrintToFileFolder: C:\Docs\Output
         PrintToFileFileName: test.pdf
         DatabaseOverrides: 
            - Name: dbfile
            - Type: VariableName
            - DataSourceVariableName: datum 

If the call was successful you should see the below message: 

Additional Resources

TransformTextToRecordSetAction Class Reference

PrintBTWAction Class Reference