Text File Settings

Delimiters

  • Encoding: Defines what encoding is used to read the Data Source ( US-ASCII, ISO-8859-1, UTF-8, UTF-16, UTF-16BE or UTF-16LE ).
  • Add/Remove Characters: Defines the number of characters to add to, or remove from, the head of the data stream. The spin buttons can also increment or decrement the value. Positive values add blank characters while negative values remove characters.
  • Add/Remove Lines: Defines the number of lines to add to, or remove from, the head of the data stream. The spin buttons can also increment or decrement the value. Positive values add blank lines while negative values remove lines.
  • Maximum Line Length: Define the number of columns in a data page. The spin buttons can also increment or decrement the value. The maximum value for this option is 65,535 characters. The default value is 80 characters. You should tune this value to the longest line in your input data. Setting a maximum data line length that greatly exceeds the length of the longest line in your input data may increase execution time.
  • Page Delimiter Type: Defines the delimiter between each page of data. Multiple such pages can be part of a Source Record, as defined by the Boundaries.
    • On lines: Triggers a new page in the Data Sample after a static number of lines (called Lines per Page), or using a FormFeed character.
    • On text: Triggers a new page in the Data Sample when a specific string is found in a certain location.
      • Word to find: The text value to compare with the value in the Source Record.
      • Match case: Activates case-sensitive text comparison.
      • Use Selected Text: Click to use the value of the current data selection as the Text Value.
      • Column From - To: Defines the location, in the row, of the location where to find the Text Value.
      • Complete Line: Activates the search on the whole line instead of the specified location.
      • Use Selection: Click to set the start and stop columns to the current data selection in the Source Record.
      • Lines before/after: Defines the delimiter a certain number of lines before or after the current line. This is useful if the text triggering the delimiter is not on the first line of each page.

Boundaries

  • Record Limit: Defines how many Source Records are displayed in the Data Viewer. To disable the limit, use the value "0".
  • Type of rule: Defines the type of rule that defines when a boundary is created, establishing a new record in the Data Sample (called a Source Record).
  • On delimiter: Defines a boundary on a static number of pages.
  • On text: Defines a boundary on a specific text comparison in the Source Record.
    • Operator: Selects the type of comparison that is done (for example, "contains").
    • Text Value: The text value to compare with the value in the Source Record.
    • Match case: Makes the text comparison case-sensitive.
    • Use Selected Text: Click to use the value of the current data selection as the Text Value.
    • Line From - To: Defines the start and end row of the data selection to compare with the Text Value.
    • Complete Page: Compare the Text Value on the whole page. Only available with contains, not contains, is empty and is not empty operators.
    • Column From - To: Defines the location, in the row, of the location where to find the Text Value.
    • Complete Line: Ignores the column values and compares using the whole line.
    • Use Selection: Click to set the lines and columns to the current data selection in the Source Record.
    • Times condition found:
    • Delimiters before/after: Defines the boundary a certain number of pages before or after the current page. This is useful if the text triggering the document is not located on the first page of each Source Record.
  • On Script: Defines the boundaries using a custom user-defined JavaScript. For more information see JavaScript API.

Data Samples

The Data Samples box displays all the data sources that have been imported into the data mapping configuration. Right-clicking in the box brings up a control menu:

  • Add: Used to add a new Data Sample from an external Data Source. The new Data Sample will need to be of the same data type as the current one. For example, you can only add PDF files to a PDF data mapping configuration. In version 1.3 and higher, multiple files can be added simultaneously through the Add dialog.
  • Remove: Removes the current Data Sample from the data mapping configuration.
  • Replace: Opens a new Data Sample and replaces it with the contents of a different data source.
  • Reload: Click to reload the currently selected Data Sample and get any changes that have been made to it.
  • Set as Active: Activates the selected Data Sample. The active data sample is shown in the Data Viewer after it has gone through the Preprocessor Step as well as the Delimiter and Boundary settings.

External JS Libraries

External JS libraries included in the Settings Pane can add more JavaScript functionality to your data mapping configuration. Any functions included in the JS library will be available in Preprocessor scripts, as well as Action tasks, Post Functions and JavaScript-based extraction steps.

For example let's take the following JavaScript file, for example:

function myAddFunction(p1, p2) {
    return p1 + p2;
};              

If this is saved as myFunction.js and imported, then the following would work anywhere in the configuration:

var result = myAddFunction(25, 12); // returns 37!

The External JS Libraries box displays all the libraries that have been imported into the data mapping configuration. Right-clicking in the box brings up a control menu, also available through the buttons on the right:

  • Add: Used to add a new external library. Opens the standard Open dialog to browse and open the .js file.
  • Remove: Removes the currently selected library from the data mapping configuration.
  • Replace: Opens a new library and replaces it with the contents of a different js file.
  • Reload: Click to reload the currently selected library and get any changes that have been made to it.

Table of Contents

Index

Glossary

-Search-

Back