Action Step Properties

The Action step can run multiple specific actions one after the other in order. More actions will be available in the future.

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.

Actions

This subsection lists all actions executed by the step, and their types:

  • Name: A name by which to refer to the action. This name has no impact on functionality.
  • Type:
    • Set property: Sets the value of a Source Record property which was created in the Preprocessor Step.
    • Run JavaScript : Runs a JavaScript expression, giving much more flexibility over the extraction process.

Set Property

ClosedText and PDF Files
  • Property: Displays a list of Source Record properties set in the Preprocessor Step.
  • Type: Displays the type of the Source Record property. Read only field.
  • 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.
      • 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 of the current data selection for the extraction.
        • If the selection contains multiple lines, only the first line is selected.
      • Trim: Select to trim empty characters at the beginning or the end of the field
    • 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: The JavaScript expression to run.
      • Use JavaScript Editor: Click to display the Edit Script dialog.
        • Running a JavaScript expression offers many possibilities, for example:
        • Setting Properties and Record Field values using advanced expressions
        • Do complex mathematical operations and calculations
        • More features to come in future versions. For more information, see JavaScript in DataMapper.
      • 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.
  • 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).
ClosedCSV and Database Files
  • Property: Displays a list of Source Record properties set in the Preprocessor Step.
  • Type: Displays the type of the Source Record property. Read only field.
  • 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.
      • 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.
      • Trim: Select to trim empty characters at the beginning or the end of the field
    • 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: The JavaScript expression to run.
      • Use JavaScript Editor: Click to display the Edit Script dialog.

        • Running a JavaScript expression offers many possibilities, for example:
        • Setting Properties and Record Field values using advanced expressions
        • Do complex mathematical operations and calculations
        • More features to come in future versions. For more information, see JavaScript in DataMapper.
      • 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.
  • 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).
ClosedXML File
  • Property: Displays a list of Source Record properties set in the Preprocessor Step.
  • Type: Displays the type of the Source Record property. Read only field.
  • 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.
        • Trim: Select to trim empty characters at the beginning or the end of the field
    • 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: The JavaScript expression to run.
      • Use JavaScript Editor: Click to display the Edit Script dialog.

        • Running a JavaScript expression offers many possibilities, for example:
        • Setting Properties and Record Field values using advanced expressions
        • Do complex mathematical operations and calculations
        • More features to come in future versions. For more information, see JavaScript in DataMapper.
      • 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.
  • 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).

Run JavaScript

  • Expression: The JavaScript expression to run.
  • Use JavaScript Editor: Click to display the Edit Script dialog.
    • Running a JavaScript expression offers many possibilities, for example:
    • Setting Properties and Record Field values using advanced expressions
    • Do complex mathematical operations and calculations
    • More features to come in future versions. For more information, see JavaScript in DataMapper.
  • 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.
  
  • Last Topic Update: 24/01/2017 09:32
  • Last Published: 7/6/2017 : 9:48 AM