Connecting Security Center to a CSV parser - Transaction Finder

Transaction Finder Integration Guide for a CSV Parser

Product
Transaction Finder
Content type
Guides > Integration guides
ft:locale
en-US
Last updated
2023-10-10

To use .CSV files to import transaction data from your point-of-sale (POS) system, you must configure a CSV parser in Security Center.

What you should know

  • The parser is managed locally and resides on the same server as the plugin. Its default port is 12000.
  • There are two different ways to map a CSV file to obtain transaction data:

Procedure

  1. From the Config Tool home page, open the Plugins task.
  2. Expand the Transaction Finder plugin role, select the CSV parser from the entity browser, and then click the Properties tab.
    Transaction Finder plugin role - Properties tab for the CSV parser showing the Authentication page.
  3. Log in to the parser configuration page using the username and password you defined during the parser installation.
    NOTE: If this is your first time logging in, your credentials will be accepted, encrypted, and saved.
  4. In the Server configuration section, enter the following:
    Authentication key
    For a local parser, the authentication key is automatically provided by the plugin. For a remote parser, click the Generate new button to generate an authentication key.
    Host
    The IP address or host name of the system that receives transactions.
    Port
    The port used by the plugin to receive data from the parser. Port 443 is used by default.
  5. In the Global configuration section, enter the following:
    Tenant ID
    Identifies the site of the deployment.
    Location ID
    The code used to define the location of the point-of-sale system.
    Include location in terminal ID
    Ensures that terminals across multiple stores are uniquely identified. Turn on Include location in terminal ID for the parser to add the location of the terminal to the transaction. This setting is required when the identifiers for terminals are reused across multiple locations. Example: Store01 has terminal01 and terminal02, and Store02 has terminal01 and teminal02.
    Timezone
    The time zone in which the point-of-sale system is located.
    Culture name
    The region and language used by the point-of-sale system.
    Server and Global configuration sections on the Properties tab of the CSV parser.
  6. (Optional) To import a parser configuration from a .json file, click the Import () button in the header of the Parser configuration section.
    Properties tab of the CSV parser - Importing a .json file in the Parser configuration section.
  7. In Parser configuration > Properties section, enter the following:
    Parsing name
    Name the parsing configuration.
    Parsing cadence
    Provides the option to disable parsing, or have parsing occur on a schedule.
    Start date
    Start date and time of the first parsing session, when parsing cadence is enabled.
    Recurrence
    Time interval between two parsing sessions, when parsing cadence is enabled. The time interval can be defined in minutes, hours, or days.
    Properties tab of the CSV parser - Parser configuration section showing the parser Properties.
  8. In the Parser configuration > Source section, enter the following:
    Input folder
    Enter the file path where the .CSV files reside.
    Column delimiter
    Enter the characters used to separate values in .CSV files.
    Skip line count
    Enter the number of rows to skip before reading the next line. For example, if the skip line value is 2, but your first row is a header, parsing will begin at line 4 of your .CSV file. If your first row is not a header, parsing will begin at line 3.
    First row as header
    This slider indicates if the first row of your .CSV file uses the first row as a header.
  9. In the Fields section, click the Detect file format button.
    Properties tab of the CSV parser - Parser configuration section showing the .CSV file Source information.
    The parser automatically creates a source field of each column detected in the first .CSV file of the input folder. A preview of the source field selection is available by clicking on the refresh button. It reads the first .CSV files in alphabetical order of the input folder. If more fields are required, click Add field.
  10. In Destination > Mappings, do the following:
      1. Choose between basic mapping and advanced mapping.

        Properties tab of the CSV parser - Destination section showing the mapping information.

      2. Map your fields to the columns in your .CSV file.
  11. In the Settings section, enter the following:
    Move file on error
    When enabled, the file is moved to the folder specified below when parsing of the .CSV file fails. If disabled, the file is deleted.
    Folder path on error
    Enter the folder path for failed parsed files.
    Move file on success
    When enabled, the file is moved to the folder specified below when parsing of the .CSV file is successful. If disabled, the file is deleted.
    Folder path on success
    Enter the folder path for successfully parsed files.
  12. Click Save.