Analytic headers and tags

An analytic header is a series of tags enclosed in a comment block at the start of an analytic script. The analytic tags specify input parameters that a user populates in advance of scheduling or running an analytic script, and output parameters.

An analytic header is required for any analytic script that you intend to run in Robots.

For a visual overview of analytic script inputs and outputs, and associated analytic tags, see Script inputs and outputs – the big picture.

Adding or modifying an analytic header

The easiest way to add or modify an analytic header is to use the Analytic Header Designer. The Designer provides automated error checking and embedded guidance to help ensure that the header you build is valid and works correctly. For more information, see Working with analytic headers.

You can also build an analytic header by manually entering the required analytic tags. Or you can use a combination of manual entry and the Designer.

Basic analytic header requirements

Analytic headers must be defined in a comment block that starts on the first line of the script. Tags can be in any order in the analytic header, except for:

• the ANALYTIC tag, which must be first
• FIELD tags, which must immediately follow their associated TABLE tag

COMMENT
//ANALYTIC Identify missing checks
  This analytic script identifies missing check numbers
//TABLE v_table_payments Payments Table
  Select a table that lists payments and includes a check number column
//FIELD v_check_num CN Check Number
  Select the field that contains the check numbers
//PARAM v_start_date D OPTIONAL Start Date (Optional)
  Enter the start date for the analysis
END

Tag format

Each tag in the header uses the following format:

//tag_name attributes
  optional_descriptive_text

The // tag indicator must be the first non-whitespace character on the script line. The tag name must immediately follow the tag indicator, without any space or characters in between.

The optional descriptive text must be entered on the next line after the tag. The text can be multiline, but it cannot skip lines. Line breaks are not preserved when the descriptive text is displayed in Robots.

Tag conventions

Specifying test input values in Analytics

You can use a special assignment operator ( := ) to specify test input values for any analytic tag that requires definition:

• FILE
• PARAM
• TABLE
• FIELD

Use this syntax to test analytic scripts in Analytics:

//TABLE v_AnalysisTable "Table to classify" := "Trans_May"

When the script runs in Analytics, the parameter takes the value specified in the assignment. When the analytic script runs in Robots, the test value is ignored and the user-defined input parameters are used.

You must leave a space between the assignment operator and the tag syntax preceding it. Assignment values must use the correct qualifier for the data type as required throughout Analytics. For more information, see Data types.

Full list of available analytic tags