Creating a Custom Lockbox File Import Template

Description of Issue

The import file does not match any existing lockbox file template

Context
  • Enterprise ERP

  • Accounts Receivable

  • Process Lockbox File

  • (arpmtimp)

Cause

Providers of import files do not adhere to the existing templates 

Resolution

Path: Enterprise ERP > General Revenues > Payment Processing > Process Lockbox File

The layout of the file needs to be defined for the import to work. There can be as many layouts added as needed.

  1. Access Custom Templates:

    • Within the program for which you are importing, click Custom Format in the ribbon bar

  2. Open Template Editor:

    • When the Template Editor program opens, it displays the list of custom import templates available for the current program. If no templates exist, it displays the New Template option.

  3. Create a New Template:

    • Click New Template on the screen or click Create Template on the toolbar to display the New Template dialog box.

  4. Define Template Layout:

    • Flat: Creates a flat text file holding one record per line, with fields separated by delimiters such as commas or tabs.

    • Using the New Template dialog box, define the file format template to create. Hover your pointer over the information button for each field for more details

    • Template Layout: Defines the basic layout of the files to be imported using this template. The layout options available vary depending on the program for which you are creating an import format. Common import file layouts available include the following:

  5. Template Name:

    • Enter a name in the Name field (this is required).

    • Name: Assigns a name to the template. This should be a name that is easily recognizable to users of the program in which the imports are performed.

  6. File Type and Delimiter:

    • None: No delimiter

    • Tab: Tab-delimited

    • Other: Opens a text box where you can define the delimiter, for example, a comma (,) or the pipe symbol (|).

    • If importing a file with a plain text extension such as .txt or .csv, choose a delimiter corresponding to the type of file.

    • File Delimiter: Identifies how the data is separated in the file:

    • Notes: Options are Comma ( , ), Semicolon ( ; ), Tab, Pipe ( | ). For the CSV File Type, no pipe symbols can be included in the data.

  7. Example File:

    • Provide an example of the file to be imported.

    • Input File: Specifies the file to be imported when creating a template. This should be a sample file or copy rather than the actual file to be imported.

    • If the file contains headers, check the box for First line contains headers.

    • First Line Contains Headers: If selected, indicates that the input file contains a header row as the first row. Selecting this option hides the first row (the header row) of the file when it is viewed in the Template Editor.

  8. Field Matching:

    • Attempt to field match based on headers to help the program create a template if the file you provide has headers and data.

    • Attempt Field Matching Based on Headers: If selected, the program verifies that the header captions match the field names; if yes, the field locations are automatically matched.

  9. Upload File:

    • Click Upload. The program imports the file and displays the import file field definition screen for the program from which you opened the Template Editor.

  10. Edit Template: 

    • For .csv files:

      • Click the dropdown on the header in each section of the template to choose the exact header name that is in the import file.

      • Ensure headers in the example import file match the options in the dropdown exactly.

    • For .txt files:

      • Define the first column by clicking the dropdown for the Line Field to set the first column’s header.

      • Click the dropdown in each section to define the header for that column and specify the positions as they should appear in a text file.

    • Use the editing features to add available fields, defining the begin and end locations for each. You can increase or decrease the size of the field by dragging the field edge with your cursor.

    • The boxes at the top of the screen display a confirmation of the details about each field as you define it.

  11. Save Template:

    • Click Save when done. If you entered a field but have not defined it correctly, the Editor provides an error message. You must correct errors before continuing.

  12. Template Availability:

    • The template is now saved and listed in the File Format dropdown of the Define screen in the Process Lockbox File program.


Additional Information