Message tool

Message Tool

Version:
Current
Last modified: January 03, 2020

The Message tool allows you to report messages about a specific process to the Results window.

When to send a message

Select at which time the message is written and sent to the results window.

Use this option to capture the row count with the Message tool.

Use this option to generate a message after an output has completed.

  • Before First Record
    1. The Message tool receives the first record to its input connection.
    2. The Message tool writes the message.
    3. The Message tool passes the record to its output connection.
  • Before Rows Where Expression is True

    All records are passed through regardless if the expression is true or false.

    1. The Message tool receives a record to its input connection.
    2. The Message tool evaluates the given expression, which may depend on fields in that record.
      • If the expression evaluates as true, the Message tool writes the message before passing that record to its output connection. See Expression Editor.
      • If the expression evaluates as false, the Message tool does not write the message.
  • After Last Record
    1. The Message tool passes all records to its output connection.
    2. The Message tool writes the message.
  • After All Down Stream Tools Have Completed
    1. All downstream tools have finished processing the passed records.
    2. The Message tool writes the message.

Set the message type

Message Type: Select the type of message the tool writes. For more information, see the Results window.

Set the message priority

Message Priority: Determine the behavior of the tool when it is used inside Macros.

  • Normal: The message is only written when:

    • the Message tool is included in the workflow which is being run.
    • Show All Macro Messages is checked.  If the message tool is inside a macro which is contained in the running workflow, then it isn't written.
  • Medium: The message will only be written when the tool is included in the workflow which is being run OR inside a macro in the workflow. So it will output if it is up to one level deep in a macro.

  • High: The message will always be written regardless of how many levels of macros it is contained in. Conversion Errors and Errors message types are always High Priority.

Transient: When checked, the message replaces an existing message issued by the same tool. This is useful for messages which report tool progress, such as reporting the number of rows that have been processed.

Message expression

Type the message that you want to display. This message can be fixed text or built up from data fields.

Example

"Age:" + [AgeField] + "is outside the allowed limits."

Because this tool includes an expression editor, an additional input anchor displays when the tool is used in an app or macro workflow. Use the Interface tools to connect to a Question anchor. See Interface tools.

[_RecordNumber_] variable

  • Before First Record: [_RecordNumber_] always equals 1.
  • Before Rows Where Expression Is True: [_RecordNumber_] equals the row number of the expression being calculated. 
  • After Last Record and After All Down Stream Tools Have Completed: [_RecordNumber_] equals the total number of records passed through the tool.

    Example: "Amount of records generated by Text to columns tool: " + TOSTRING([_RecordNumber_])

Was This Helpful?

Need something else? Visit the Alteryx Community or contact support.