Text Search

This function searches for the specified text in print data, and if it detects this text it executes the specified actions (such as logo printing and audio output) after the receipt is cut. If you are using a printer driver, the actions are performed on each page if you enable the page-cut operation and on each document if you enable the document-cut operation. To use this function on data that is printed from the printer driver, the printer driver’s print mode must be set to 'Line' in the device settings tab of in printer's properties.

Getting Started

  1. Select the 'Enable Text Search feature' option
    Select 'Enable Text Search feature' at the top of the window.
  2. Set the feature options
    Set the 'Repeat' and 'Print the Trigger' options.
  3. Set the trigger text and the action to perform after printing
    In the 'Trigger Text and Action' area, select the trigger text and the action to perform after printing.
  4. Store the settings on the printer
    Click 'Store above settings' to store the settings on the printer.
    The settings whose 'Enabled' check boxes are check in the 'Trigger Text and Action' area are stored on the printer.
Back to Top

Detailed Usage


Feature Options

The 'Repeat' and 'Print the Trigger' options are described below.

Repeat:
Once per receipt The action is performed once per receipt even if the same trigger text is detected multiple times in a receipt.
On every match If the same trigger text is detected multiple times in a receipt, the action is performed the number of times the text was detected.

Print the Trigger:
Print The trigger text is printed as-is.
Do not print The trigger text is not printed.
Replace with spaces The trigger text is printed as spaces.

 

Trigger Text and Action Area

One line represents a combination of settings. You can set up to 100 combinations. You can assign multiple actions to the same trigger text. Actions are performed in the order that the text is detected in. For examples of search results for different print-data and trigger-text combinations, see here.
Descriptions of how to edit trigger text and the action list are below.

To select a line Click the line number on the left.
To add a line The last line is always a new line. If you edit any of the items in the last line, that line is added.
To delete a line Select the line you want to delete, right-click the line to show a shortcut menu, and select 'Delete'.
You can also select the line to delete, and then press DELETE. You can delete multiple lines using this method.
To move a line Select the line you want to move, right-click the line to show a shortcut menu, and select 'Up' or 'Down'.
To duplicate a line Select the line you want to duplicate, right-click the line to show a shortcut menu, and select 'Duplicate'.

The items in each line are described below.

Enabled Lines whose check boxes are checked are enabled.
Only the settings of the lines whose 'Enabled' check boxes are checked will be stored on the printer. When the settings are exported, all the items are saved, including the state of the 'Enabled' check box.
Trigger Text Set a text string that is 1 to 32 single byte characters (1 to 16 double byte characters) in length.
Action Set the action to perform after the receipt is printed.
If you want the action to contain the printing of text and the execution of control codes, specify the control codes in hexadecimal.
For details, please refer to Setting Actions and Action Parameters.
Action Parameter The input format varies depending on what you specified for 'Action'.
For details, please refer to Setting Actions and Action Parameters.

 

Setting Actions and Action Parameters

'Action parameters' vary depending on what you specify for the 'Action' setting.
Precaution must be exercised when you set actions because the various commands that are specified in the print data before the actions are performed will be applied to those actions.

The settings for each action are described below.

Text + LF, Text + Cut

Enter the text to output.
You can enter text in hexadecimal. To enter text in hexadecimal, insert '\x' or '\0x' before every byte of hexadecimal code. You can enter up to 7680 bytes.

Note: Use lowercase 'x' in '\x' and '\0x', which indicates hexadecimal input.
If you use uppercase 'X', it will not be interpreted to mean hexadecimal input.

Below is an example of a command written in hexadecimal.

Input and Output Example:
Input characters \x1b\x69\x03\x03ShopName\x0a\x1b\x69\x00\x00TEL:000-000-0000\x0aFAX:999-999-9999\x0a
or
\0x1b\0x69\0x3\0x3ShopName\0x0a\0x1b\0x69\0x0\0x0TEL:000-000-0000\0x0aFAX:999-999-9999\x0a
Meaning ESC i 3 3 ShopName LF ESC i 0 0 TEL:000-000-0000 LF FAX:999-999-9999
Output result

 

Logo, Logo after cut (Logo + Cut), Logo before cut (TSP654II)

On FVP10, select the number (1 to 255) of the logo you want to output.
On TSP654II, input the Key Code of the logo you want to output.
With Logo after cut, the logo is output and cut after the receipt cut. With Logo before cut, the logo is output and cut before the receipt cut.


Sound (FVP10)

Select the number (1 to 255) of the audio file you want to output.


Cash Drawer 1, Cash Drawer 2

Set the pulse width for the cash drawer you want to open.


Buzzer 1, Buzzer 2

Set the length of time to sound the buzzers.


Binary File

Put the cursor into the action parameter box to show the 'Select Binary File' window. Here, you can select a file that contains print data.
The maximum size of the file that you can choose is 7680 bytes.


 

Testing a Selected Action

Select the line you want to test, and click 'Test Actions' to execute a test of the selected action and action parameters. You may select multiple lines to test them consecutively.

Memo: This test is for checking actions; it cannot be used to test the text search function.

 

Storing Settings on the Printer

Click 'Store above settings' to store the settings of the lines whose 'Enabled' check boxes are selected in the 'Trigger Text and Action' area.
The maximum amount of data, the settings of all the lines that are being written, that can be stored to the printer is a total of 7680 bytes.

 

Printing the current settings stored on the printer

Click 'Print the current settings stored in the printer' to print the printer's text-search settings.

 

Exporting and Importing Settings

You can save the audio files list to a XML file for use again later or to apply the same settings to another printer of the same model.

Click 'Export' to show the 'Save As' window. Enter the file name, and save the file as an XML file (.xml) or a printer binary file (.prn).
You can use this function to import XML files, into the printer.
Printer configuration files (binary files) can be sent directly to the printer to configure it, without the use of this function. They cannot be imported.

You can import the XML files that you have exported.
Click 'Import' to show the 'Open' window. You can select an XML file that you exported before. Select the file you want to import, and then click 'Open' to display the contents of the imported file in the 'Trigger Text and Action' area. To store these settings on the printer, click 'Store above settings'.

Back to Top

Supplementary Explanation


Examples of Search Results for Different Print-Data and Trigger-Text Combinations

1. Text strings that partially match the trigger text are detected.
Print data pineapple
Trigger text 1 "apple"
Search result "apple" is detected.

2. Searches are performed from the beginning of the print data.
Print data apple banana
Trigger text 1 "banana"
Trigger text 2 "apple"
Search result "apple" is detected, and then "banana" is detected.

3. If a trigger text string includes another trigger text string, only the longer text string is detected.
Print data apple pie
Trigger text 1 "apple"
Trigger text 2 "apple pie"
Search result "apple pie" is detected.

Back to Top

Legal Information

Copyright © 2014 Star Micronics Co., Ltd. All rights reserved.