ANALYTIC

The ANALYTIC tag designates an ACL script as an analytic that can run in AX Client, AX Web Client, or the Analysis App window. 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 ACL project can include an ANALYTIC tag.

Syntax

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

Optional. You can specify the TYPE parameter to identify the function performed by a particular analytic:

  • TYPE IMPORT – Import analytics retrieve data from a data source. The output of an import analytic is a raw data table.

  • TYPE PREPARE – Preparation analytics transform raw data in whatever way is necessary to make it suitable for analysis. The output of a preparation analytic is an analysis table.

  • TYPE ANALYSIS – Analysis analytics perform tests on data in analysis tables. The output of an analysis analytic is one or more results tables.

The TYPE parameter must use one of the three options, spelled exactly as it appears here, and not abbreviated: IMPORT, PREPARE, ANALYSIS

Analysis apps can include all three types of analytics, which are typically run by the user in the following sequence: import, prepare, analysis.

If you identify an analytic as one of the three types, it is placed in the corresponding Import, Preparation, or Analysis areas of AX Web Client or the Analysis App window. This placement guides the user in the appropriate sequence for running the analytics. The sequence is not enforced programmatically, and the three areas do not have any functionality beyond serving as an organizing mechanism.

You can use the ANALYTIC tag without specifying a TYPE. Analytics without a specified type are automatically placed in the Analysis area of AX Web Client or the Analysis App window.

AX Client ignores TYPE when displaying analytics in the Server Explorer treeview.

name

Specifies the name of the analytic. The name identifies the analytic in AX Client, AX Web Client, and the Analysis App window, and is separate from the script name you specify when you initially create the analytic script. 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.

In the Import, Preparation, and Analysis areas of AX Web Client or the Analysis App window analytic names are listed in alphanumeric order. As an additional way of guiding users in the correct sequence for running multiple analytics in a single 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 programmatically.

Avoid using the name “Type” for an analytic because it can conflict with the TYPE parameter.

Note

Analytics must be uniquely named within an analysis app. If the same name value is used in two or more analytics in an analysis app, you will encounter an error when you try to import or open the analysis app.

description

Optional. Descriptive text that specifies the purpose of the analytic or other information that the user might need to run the analytic successfully. The description appears with the analytic in AX Client, AX Web Client, and the Analysis App window. The description can be multiline, but it cannot skip lines. The description must be entered on the line below the associated ANALYTIC tag.

Examples

The first example shows a basic analytic header with a name and a description of the purpose of the analytic.

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

The second example shows an analytic header for a preparation analytic with a description of the preparation function performed by the analytic.

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


(C) 2015 ACL Services Ltd. All Rights Reserved.