ANALYTIC

Designates an Analytics script as an analytic that can run in Robots, on AX Server, or in the Analysis App window.

Syntax

//ANALYTIC <TYPE IMPORT|PREPARE|ANALYSIS> name
  <description>

Parameters

Name	Description
TYPE optional	Identifies the kind of analytic script as one of the following three types: IMPORT – retrieves data from a data source. The output of an import analytic is a raw data table. PREPARE – transforms raw data in whatever way is necessary to make it suitable for analysis. The output of a preparation analytic is an analysis table. ANALYSIS – performs tests on data in analysis tables. The output of an analysis analytic is one or more results tables. Analytics with a specified TYPE are organized in the corresponding Import, Preparation, or Analysis areas in Robots, AX Web Client, and the Analysis App window. This placement guides the user in the appropriate sequence for running the analytics. The sequence is not enforced, nor is the type of functionality within the analytic. If you omit TYPE, the analytic appears in the Analysis section.
name	The name of the analytic. The name identifies the analytic in client applications. The analytic name is separate from the script name that you specify in Analytics when you initially create the script. Note Analytics in the same project or analysis app must be uniquely named. If the same name is used in two or more analytics, an error occurs when you try to commit the analytic scripts, or import or open the analysis app. Characters that cannot be used in Windows filenames (< > : " / \ \| ? *) should not be used in analytic names, because they will cause an error that prevents the export of analytic results. Do not use the value TYPE as the name. In client applications, names are listed in alphanumeric order. To guide users in the correct sequence for running multiple analytics in a single robot or analysis app, you can add a prefix to order the analytic names within each area. For example: 01_analyze_POs, 02_analyze_invoices, and so on. The sequence implied by the order of the names is not enforced.
description optional	A description of the analytic or other information that the user might need to run the analytic successfully. The description appears with the analytic in client applications. The description can be multiline, but it cannot skip lines. The description must be entered on the line below the associated ANALYTIC tag.

Name

Description

TYPE

optional

Identifies the kind of analytic script as one of the following three types:

IMPORT – retrieves data from a data source. The output of an import analytic is a raw data table.
PREPARE – transforms raw data in whatever way is necessary to make it suitable for analysis. The output of a preparation analytic is an analysis table.
ANALYSIS – performs tests on data in analysis tables. The output of an analysis analytic is one or more results tables.

Analytics with a specified TYPE are organized in the corresponding Import, Preparation, or Analysis areas in Robots, AX Web Client, and the Analysis App window. This placement guides the user in the appropriate sequence for running the analytics. The sequence is not enforced, nor is the type of functionality within the analytic.

If you omit TYPE, the analytic appears in the Analysis section.

name

The name of the analytic.

The name identifies the analytic in client applications. The analytic name is separate from the script name that you specify in Analytics when you initially create the script.

Note

Analytics in the same project or analysis app must be uniquely named. If the same name is used in two or more analytics, an error occurs when you try to commit the analytic scripts, or import or open the analysis app.

Characters that cannot be used in Windows filenames (< > : " / \ | ? *) should not be used in analytic names, because they will cause an error that prevents the export of analytic results. Do not use the value TYPE as the name.

In client applications, names are listed in alphanumeric order. To guide users in the correct sequence for running multiple analytics in a single robot or analysis app, you can add a prefix to order the analytic names within each area. For example: 01_analyze_POs, 02_analyze_invoices, and so on. The sequence implied by the order of the names is not enforced.

description

optional

A description of the analytic or other information that the user might need to run the analytic successfully.

The description appears with the analytic in client applications. The description can be multiline, but it cannot skip lines. The description must be entered on the line below the associated ANALYTIC tag.

Examples

Basic analytic header

The following analytic header contains a name and a description of the analytic:

COMMENT 
//ANALYTIC Identify missing checks
  This analytic identifies missing check numbers.
END

Analytic header with type

The following analytic header specifies a preparation analytic with a description of what the script does:

COMMENT 
//ANALYTIC TYPE PREPARE Standardize address data
  This analytic cleans and standardizes the address field in preparation for duplicates analysis.
END

Remarks

An ACLScript COMMENT command must be entered on the first line in the script, followed by the ANALYTIC tag on the second line. If the ANALYTIC tag is used in any other location it is ignored.

One or more scripts in an Analytics project can include an ANALYTIC tag.

[ Back to top ]

ACL Scripting Guide 14.1