Extract Step Properties

The Extract step takes information from the Data Sample and places it in the Extracted Record within the Record Set.

Description

This subsection is collapsed by default in the interface, to allow more screen space be given to other important parts.

Name: The name of the step. This name will be displayed on top of the step's icon in the Steps pane.

Comments: The text entered here gives more details on the step and will be displayed in the tooltip appearing when hovering over the step in the Steps pane.

Extraction Definition

  • Data Table: Defines where the data will be placed in the Extracted Record. The root table is record, any other table becomes a detail table. For more information see detail tables.
  • Append values to current record: When the Extract Step is within a loop, check this to ensure that the extraction will be done in the same detail line as any previous extractions within the same loop. This ensures that, if multiple extracts are present, only one detail line is created.

Field Definition

This sub-section explains how the currently selected Extract Field in the Field List is defined.

ClosedText File
  • Field List: The Field List displays each of the single fields that are being extracted in a drop-down. Fields can be re-ordered and re-named within the Ordering and Renaming Fields dialog.
  • Add Unique ID to extraction field: Check to add a unique numerical set of characters to the end of the extracted value. This ensures no two values are identical in the Record Set.
  • Mode: Determines the origin of the extracted data.
    • Location: The contents of the data selection set below will determine the value of the extracted field.
      • Left: Defines the start of the data selection to extract.
      • Right: Defines the end of the data selection to extract.
      • Top offset: The vertical offset from the current pointer location in the Data Sample (Viewer).
      • Height: The height of the selection box.
      • Use selection: Click to use the value (Left, Right and Height) of the current data selection (in the Viewer) for the extraction.
        If the selection contains multiple lines, only the first line is selected.
      • Post Function: Enter a JavaScript expression to be run after the extraction. For example replace("-","") would replace a single dash character inside the extracted string.
        • Use JavaScript Editor: Click to display the Script Editor dialog.
      • Trim: Select to trim empty characters at the beginning or the end of the field.
      • Concatenation string:
      • Split: Separate the selection into individual fields based on the Concatenation string defined above.
    • JavaScript : The result of the JavaScript Expression written below the drop-down will be the value of the extracted field. If the expression contains multiple lines, the last value attribution (variable = "value";) will be the value. See DataMapper API.
  • Type: The data type of the selected data. Please refer to ...(link to come) for more information.
ClosedPDF File
  • Field List: The Field List displays each of the single fields that are being extracted in a drop-down. Fields can be re-ordered and re-named within the Ordering and Renaming Fields dialog.
    • Add JavaScript Field: Click to add a new extract field. By default, the field will be a JavaScript -defined field rather than a data extraction, of String data type.
    • Remove Extract Field: Click to delete the selected extract field from the list.
    • Order and rename fields: Click to openOrdering and Renaming Fields.
  • Add Unique ID to extraction field: Check to add a unique numerical set of characters to the end of the extracted value. This ensures no two values are identical in the Record Set.
  • Mode: Determines the origin of the data.
    • Location: The contents of the data selection set below will be the value of the extracted field. The data selection settings are different depending on the data sample type.
      • Left: Defines the start of the data selection to extract.
      • Right: Defines the end of the data selection to extract.
      • Top offset: The vertical offset from the current pointer location in the Data Sample (Viewer).
      • Height: The height of the selection box.
      • Use selection: Click to use the value (Left, Right and Height) of the current data selection for the extraction.
        If the selection contains multiple lines, only the first line is selected.
      • Post Function: Enter a JavaScript expression to be run after the extraction. For example replace("-","") would replace a single dash character inside the extracted string.
      • Trim: Select to trim empty characters at the beginning or the end of the field.
      • Type: The data type of the selected data. Please refer to ...(link to come) for more information.
      • Concatenation string:
      • Split: Separate the selection into individual fields based on the Concatenation string defined above.
      • Sub-Fields:
    • JavaScript : The result of the JavaScript Expression written below the drop-down will be the value of the extracted field. If the expression contains multiple lines, the last value attribution (variable = "value";) will be the value. See DataMapper API.
      • Use JavaScript Editor: Click to display the Script Editor dialog.
      • Use selected text: Inserts the text in the current data selection in the JavaScript Expression. If multiple lines or elements are selected, only the first one is used.
      • Use selection: Click to use the value of the current data selection for the extraction.
        If the selection contains multiple lines, only the first line is selected.
      • Type: The data type of the selected data. Please refer to ...(link to come) for more information.
ClosedCSV and Database Files
  • Field List: The Field List displays each of the single fields that are being extracted in a drop-down. Fields can be re-ordered and re-named within the Ordering and Renaming Fields dialog.
    • Add JavaScript Field: Click to add a new extract field. By default, the field will be a JavaScript -defined field rather than a data extraction, of String data type.
    • Remove Extract Field: Click to delete the selected extract field from the list.
    • Order and rename fields: Click to openOrdering and Renaming Fields.
  • Add Unique ID to extraction field: Check to add a unique numerical set of characters to the end of the extracted value. This ensures no two values are identical in the Record Set.
  • Mode: Determines the origin of the data.
    • Location: The contents of the data selection set below will be the value of the extracted field. The data selection settings are different depending on the data sample type.
      • Column: Drop-down listing all fields in the Data Sample, of which the value will be used.
      • Top offset: The vertical offset from the current pointer location in the Data Sample (Viewer).
        • Use selection: Click to use the value of the current data selection for the extraction.
          If the selection contains multiple lines, only the first line is selected.
      • Post Function: Enter a JavaScript expression to be run after the extraction. For example replace("-","") would replace a single dash character inside the extracted string.
        • Use JavaScript Editor: Click to display the Script Editor dialog.
      • Trim: Select to trim empty characters at the beginning or the end of the field.
      • Type: The data type of the selected data. Please refer to ...(link to come) for more information.
    • JavaScript : The result of the JavaScript Expression written below the drop-down will be the value of the extracted field. If the expression contains multiple lines, the last value attribution (variable = "value";) will be the value. See DataMapper API.
      • Expression: 
        • Use JavaScript Editor: Click to display the Script Editor dialog.
        • Use selected text: Inserts the text in the current data selection in the JavaScript Expression. If multiple lines or elements are selected, only the first one is used.
        • Use selection: Click to use the value of the current data selection for the extraction.
          If the selection contains multiple lines, only the first line is selected.
      • Type: The data type of the selected data. Please refer to ...(link to come) for more information.
ClosedXML File
  • Field List: The Field List displays each of the single fields that are being extracted in a drop-down. Fields can be re-ordered and re-named within the Ordering and Renaming Fields dialog.
    • Add JavaScript Field: Click to add a new extract field. By default, the field will be a JavaScript -defined field rather than a data extraction, of String data type.
    • Remove Extract Field: Click to delete the selected extract field from the list.
    • Order and rename fields: Click to openOrdering and Renaming Fields.
  • Add Unique ID to extraction field: Check to add a unique numerical set of characters to the end of the extracted value. This ensures no two values are identical in the Record Set.
  • Based on: Determines the origin of the data.
    • Location: The contents of the data selection set below will be the value of the extracted field. The data selection settings are different depending on the data sample type.
      • XPath: The path to the XML field that is extracted.
        • Use selection: Click to use the value of the current data selection for the extraction.
          If the selection contains multiple lines, only the first line is selected.
      • Post Function: Enter a JavaScript expression to be run after the extraction. For example replace("-","") would replace a single dash character inside the extracted string.
        • Use JavaScript Editor: Click to display the Script Editor dialog.
      • Trim: Select to trim empty characters at the beginning or the end of the field.
      • Type: The data type of the selected data. Please refer to ...(link to come) for more information.
    • JavaScript : The result of the JavaScript Expression written below the drop-down will be the value of the extracted field. If the expression contains multiple lines, the last value attribution (variable = "value";) will be the value. See DataMapper API.
      • Expression: 
        • Use JavaScript Editor: Click to display the Script Editor dialog.
        • Use selected text: Inserts the text in the current data selection in the JavaScript Expression. If multiple lines or elements are selected, only the first one is used.
        • Use selection: Click to use the value of the current data selection for the extraction.
          If the selection contains multiple lines, only the first line is selected.
      • Type: The data type of the selected data. Please refer to ...(link to come) for more information.

Data Format

The data format defines the precise format for some of the variable types, such as dates and currencies.

  • Boolean
  • String
  • HTML String
  • Integer
    • Negative Sign Before: Adds a negative (-) sign before negative values in the Extracted Record.
    • Thousand Separator: Adds the selected character between each thousand position (for example, "1,000,000")
    • Treat empty as 0: Considers empty spaces as 0.
  • Float
    • Negative Sign Before: Adds a negative (-) sign before negative values in the Extracted Record.
    • Decimal Separator: Determines the character to use for decimal values, generally a dot (.).
    • Thousand Separator: Adds the selected character between each thousand position (for example, "1,000,000")
    • Treat empty as 0: Considers empty spaces as 0.
  • Currency
    • Negative Sign Before: Adds a negative (-) sign before negative values in the Extracted Record.
    • Decimal Separator: Determines the character to use for decimal values, generally a dot (.).
    • Thousand Separator: Adds the selected character between each thousand position (for example, "1,000,000")
    • Currency Sign: Determines the character to add before the value in the Extracted Record.
    • Treat empty as 0: Considers empty spaces as 0.
  • Date
    • Date/Time Format: Determines how the date is read. The format written here needs to correspond with the format in the data selection.
    • Language: The language in which the date is written, when relevant. Useful when months or days are written alphabetically.
Default Format Settings can be defined at the user level, at the Datamapper configuration level and/or at the field level. (see Datamapper Default Data Format for more information).
  
  • Last Topic Update: 24/01/2017 09:32
  • Last Published: 7/6/2017 : 9:48 AM