Transaction definitions (properties)

The settings for transaction definitions are described in the table.

Name

Description

Name

Type a name.

Encoding

Select the character set used by the transaction source, for example the cash register. This helps XProtect Transact convert the transaction data to understandable text that you can work with when configuring the definition.

If you select the wrong encoding, the data may appear as non-sense text.

Start collecting data

Collect transaction data from the connected transaction source. You can use the data to configure a transaction definition.

Wait for at least one, but preferably more, transactions to complete.

Stop collecting data

When you have collected sufficient data to configure the definition, click this button.

Load from file

If you want to import data from an already existing file, click this button. Typically this is a file that you have created previously in the file format .capture. It can be other file formats. What is important here is that the encoding of the import file matches the encoding selected for the current definition.

Save to file

If you want to save the collected raw data to a file, click this button. You can reuse it later.

Match type

Select the match type to use to search for the start mask and the stop mask in the collected raw data:

  • Use exact match: The search identifies strings that contain exactly what you have entered in the Start mask and Stop mask fields.
  • Use wildcards: The search identifies strings that contain what you have entered in the Start mask and Stop mask fields in combination with a wild card symbol (*, #, ?).
    * matches any number of characters. For example, if you have entered "Start tra*tion", the search identifies strings that contain "Start transaction".
    # matches exactly 1 digit. For example, if you have entered "# watermelon", the search identifies strings that contain, for example, "1 watermelon".
    ? matches exactly 1 character. For example, you may use the search expression "Start trans?ction" to identify strings that contain "Start transaction".
  • Use regular expression: Use this match type to identify strings that contain specific notation methods or conventions, for example a date format or credit card number. For more information, see the Microsoft website.

Raw data

Transaction data strings from the connected transaction source are displayed in this section.

Start mask

Specify a start mask to indicate where a transaction begins. Horizontal lines are inserted in the Preview field to visualize where the transaction starts and ends, and will help to keep individual transactions separated.

Stop mask

Specify a stop mask to indicate where a transaction ends. A stop mask is not mandatory, but is useful if the received data contains irrelevant information, such as information about opening hours or special offers, between actual transactions.

If you do not specify a stop mask, the end of the receipt is defined in terms of where the next receipt starts. The start is determined by what is entered in the Start mask field.

Add filter

Use the Add filters button to point out the characters that you want to be omitted in XProtect Smart Client or replaced by other characters or a line break.

Replacing characters is useful when the transaction source string contains control characters for non-printing purposes. Adding lines breaks is necessary to make receipts in XProtect Smart Client resemble the original receipts.

Filter text

Displays the characters currently selected in the Raw data section. If you are aware of characters that you want to be omitted or replaced, but they do not occur in the collected raw data string, you can enter the characters manually in the Character field.

If the character is a control character, you need to enter its hexadecimal byte value. Use this format for the byte value: {XX} and {XX,XX,...} if a characters consists of more bytes.

Action

For each filter you add, you should specify how the characters you have selected are handled:

  • Omit: the characters you select are filtered out.
  • Substitute: the characters you select are replaced with the characters you specify.
  • Add line break: the characters you select are replaced by a line break.

Substitution

Type the text to replace the characters selected. Only relevant if you have selected the action Substitute.

Preview

Use the Preview section to verify that you have identified and filtered out unwanted characters. The output you see here resembles what the real-life receipt looks like in XProtect Smart Client.

See also

Add transaction definitions

© 2019 Milestone Systems A/S