Analytics commands

A list of all Analytics commands, with brief descriptions, appears below. Click a command name for detailed information.

Import and export data

Command Description
ACCESSDATA

Imports data from a variety of ODBC-compliant data sources.

The command takes the form ACCESSDATA64 or ACCESSDATA32 depending on whether you are using a 64-bit or 32-bit ODBC driver.

DEFINE TABLE DB

Defines an Analytics server table by connecting to a database table using AX Connector. You can connect to a Microsoft SQL Server, Oracle, or DB2 database.

EXPORT

Exports data from Analytics to the specified file format, or to Results in HighBond.

IMPORT ACCESS

Creates an Analytics table by defining and importing a Microsoft Access database file.

IMPORT DELIMITED

Creates an Analytics table by defining and importing a delimited text file.

IMPORT EXCEL

Creates an Analytics table by defining and importing a Microsoft Excel worksheet or named range.

IMPORT GRCPROJECT

Creates an Analytics table by importing a HighBond Projects table.

IMPORT GRCRESULTS

Creates an Analytics table by importing a HighBond Results table or interpretation.

IMPORT MULTIEXCEL

Creates multiple Analytics tables by defining and importing multiple Microsoft Excel worksheets or named ranges.

IMPORT ODBC

Creates an Analytics table by defining and importing data from an ODBC data source.

ODBC stands for Open Database Connectivity, a standard method for accessing databases.

IMPORT PDF

Creates an Analytics table by defining and importing an Adobe PDF file.

IMPORT PRINT

Creates an Analytics table by defining and importing a Print Image (Report) file.

IMPORT SAP

Creates an Analytics table by importing data from an SAP system using Direct Link.

IMPORT XBRL

Creates an Analytics table by defining and importing an XBRL file.

IMPORT XML

Creates an Analytics table by defining and importing an XML file.

RETRIEVE

Retrieves the result of a Direct Link query submitted for background processing.

Profile and verify data

Command Description
BENFORD

Counts the number of times each leading digit (1–9) or leading digit combination occurs in a field, and compares the actual count to the expected count. The expected count is calculated using the Benford formula.

COUNT

Counts the total number of records in the current view, or only those records that meet the specified condition.

DUPLICATES

Detects whether duplicate values or entire duplicate records exist in an Analytics table.

FUZZYDUP

Detects nearly identical values (fuzzy duplicates) in a character field.

GAPS

Detects whether a numeric or datetime field in an Analytics table contains one or more gaps in sequential data.

OUTLIERS

Identifies statistical outliers in a numeric field. Outliers can be identified for the field as a whole, or for separate groups based on identical values in one or more character, numeric, or datetime key fields.

PROFILE

Generates summary statistics for one or more numeric fields, or numeric expressions, in an Analytics table.

SEQUENCE

Determines if one or more fields in an Analytics table are in sequential order, and identifies out-of-sequence items.

STATISTICS

Calculates statistics for one or more numeric or datetime fields in an Analytics table.

TOTAL

Calculates the total value of one or more fields in an Analytics table.

VERIFY

Checks for data validity errors in one or more fields in an Analytics table by verifying that the data is consistent with the field definitions in the table layout.

Sort data

Command Description
INDEX

Creates an index for an Analytics table that allows access to the records in a sequential order rather than a physical order.

SORT

Sorts records in an Analytics table into an ascending or descending sequential order, based on a specified key field or fields. The results are output to a new, physically reordered Analytics table.

Group data

Command Description
AGE

Groups records into aging periods based on values in a date or datetime field. Counts the number of records in each period, and also subtotals specified numeric fields for each period.

CLASSIFY

Groups records based on identical values in a character or numeric field. Counts the number of records in each group, and also subtotals specified numeric fields for each group.

CLUSTER

Groups records into clusters based on similar values in one or more numeric fields. Clusters can be uni-dimensional or multidimensional.

CROSSTAB

Groups records based on identical combinations of values in two or more character or numeric fields, and displays the resulting groups in a grid of rows and columns. Counts the number of records in each group, and also subtotals specified numeric fields for each group.

HISTOGRAM

Groups records based on values in a character or numeric field, counts the number of records in each group, and displays the groups and counts in a bar chart.

OUTLIERS

Identifies statistical outliers in a numeric field. Outliers can be identified for the field as a whole, or for separate groups based on identical values in one or more character, numeric, or datetime key fields.

STRATIFY

Groups records into numeric intervals based on values in a numeric field. Counts the number of records in each interval, and also subtotals specified numeric fields for each interval.

SUMMARIZE

Groups records based on identical values in one or more character, numeric, or datetime fields. Counts the number of records in each group, and also subtotals specified numeric fields for each group.

Combine data

Command Description
APPEND

Combines records from two or more Analytics tables by appending them in a new Analytics table.

DEFINE RELATION

Defines a relation between two Analytics tables.

EXTRACT

Extracts data from an Analytics table and outputs it to a new Analytics table, or appends it to an existing Analytics table. You can extract entire records or selected fields.

FUZZYJOIN

Uses fuzzy matching to combine fields from two Analytics tables into a new, single Analytics table.

JOIN

Combines fields from two Analytics tables into a new, single Analytics table.

MERGE

Combines records from two sorted Analytics tables with an identical structure into a new Analytics table that uses the same sort order as the original tables.

Sample data

Command Description
CVSPREPARE

Stratifies a population, and calculates a statistically valid sample size for each stratum, for classical variables sampling.

CVSSAMPLE

Draws a sample of records using the classical variables sampling method.

CVSEVALUATE

For classical variables sampling, provides four different methods for projecting the results of sample analysis to the entire population.

SIZE

Calculates a statistically valid sample size, and sample interval, for record sampling or monetary unit sampling.

SAMPLE

Draws a sample of records using either the record sampling or monetary unit sampling method.

EVALUATE

For record sampling or monetary unit sampling, projects errors found in sampled data to the entire population, and calculates upper limits on deviation rate, or misstatement amount.

Machine learning

Command Description
CLUSTER

Groups records into clusters based on similar values in one or more numeric fields. Clusters can be uni-dimensional or multidimensional.

TRAIN

Uses automated machine learning to create an optimum predictive model using a training data set.

PREDICT

Applies a predictive model to an unlabeled data set to predict classes or numeric values associated with individual records.

Field, record, and table

Command Description
ACTIVATE

Adds field definitions stored in an Analytics workspace to the existing set of field definitions in an Analytics table layout.

CREATE LAYOUT

Creates an empty Analytics table layout, which may be required in certain scripting situations.

DEFINE COLUMN

Creates and adds one or more columns to an existing view.

DEFINE FIELD

Defines a physical data field in an Analytics table layout.

DEFINE FIELD COMPUTED

Defines a computed field in an Analytics table layout.

DEFINE REPORT

Creates a new view or opens an existing view.

DEFINE VIEW

Defines a new view or overwrites an existing view.

EXTRACT

Extracts data from an Analytics table and outputs it to a new Analytics table, or appends it to an existing Analytics table. You can extract entire records or selected fields.

FIELDSHIFT

Shifts the start position of a field definition in a table layout.

FIND

Searches an indexed character field for the first value that matches the specified character string.

IMPORT LAYOUT

Imports an external table layout file (.layout) to an Analytics project.

LIST

Outputs the data in one or more fields in an Analytics table to a display formatted in columns.

LOCATE

Searches for the first record that matches the specified value or condition, or moves to the specified record number.

NOTES

Creates, modifies, or removes a note associated with an individual record in an Analytics table.

OPEN

Opens an Analytics table and the associated data file.

REFRESH

Updates the data in an Analytics table from its associated data source.

SAVE

Copies an Analytics table and saves it with a different name, or saves an Analytics project.

SAVE LAYOUT

Saves an Analytics table layout to an external table layout file (.layout), or saves table layout metadata to an Analytics table.

SAVE TABLELIST

Saves a list of all tables in an Analytics project to an Analytics table or a CSV file.

SAVE WORKSPACE

Creates and saves a workspace.

SEEK

Searches an indexed character field for the first value that matches the specified character expression or character string.

TOP

Moves to the first record in an Analytics table.

User interaction and general scripting

Command Description
ACCEPT

Creates a dialog box that interactively prompts users for one or more script input values. Each input value is stored in a named character variable.

ASSIGN

Creates a variable and assigns a value to the variable.

CALCULATE

Calculates the value of one or more expressions.

CLOSE

Closes an Analytics table, index file, or log file, or ends a Script Recorder session.

COMMENT

Adds an explanatory note to a script without affecting processing.

DELETE

Deletes an Analytics project item, a field from a table layout, a variable, one or more table history entries, a relation between tables, or a file in a Windows folder. Also removes a column from a view.

DIALOG

Creates a custom dialog box that interactively prompts users for one or more script input values. Each input value is stored in a named variable.

DO SCRIPT

Executes a secondary script, or an external script, from within an Analytics script.

ESCAPE

Terminates the script being processed, or all scripts, without exiting Analytics.

EXECUTE

Executes an application or process external to Analytics. Emulates the Windows Run command. Can be used to interact with the Windows command prompt.

GROUP

Executes one or more ACLScript commands on a record before moving to the next record in the table, with only one pass through the table. Command execution can be controlled by conditions.

IF

Specifies a condition that must evaluate to true in order to execute a command.

LOOP

Executes a series of ACLScript commands repeatedly on a record while a specified condition evaluates to true.

NOTIFY

Sends an email notification message.

PASSWORD

Creates a password definition, without a password value, that prompts users for a password while a script is running.

PAUSE

Pauses a script, and displays information in a dialog box for users.

RCOMMAND

Passes an Analytics table to an external R script as a data frame and creates a new table in the Analytics project using output from the external R script.

RENAME

Renames an Analytics project item or a file.

SET

Sets a configurable Analytics option.

Report

Command Description
DO REPORT

Generates the specified Analytics report.

PRINT

Prints a text file, an Analytics log file, or an Analytics project item that has been exported as an external file – a script (.aclscript), a table layout (.layout), or a workspace (.wsp). You can also print a graph that has been generated by a command.

REPORT

Formats and generates a report based on the open Analytics table.

File and system

Command Description
DIRECTORY

Generates a list of files and folders in the specified directory.

DISPLAY

Displays information about the specified Analytics item type. Can also display the result of an expression, or the output of a function.

DUMP

Displays the contents of a file, or the current record, in hexadecimal, ASCII, and EBCDIC character encodings.

HELP

Launches the Analytics Help Docs in a browser.

QUIT

Ends the current session and closes Analytics.

RANDOM

Generates a set of random numbers.

SAVE LOG

Saves the entire command log, or the log entries for the current Analytics session, to an external file.

Analytics 14.1 Help