ACLScript command reference

The topics in this section document the ACLScript commands and their syntax.

For information about the command syntax conventions used in this guide, see ACLScript command syntax conventions.

ACLScript commands by category

ACLScript commands are listed below in ten categories that identify their purpose.

ACL table commands

ACTIVATE

Used to add a set of field definitions stored in an ACL workspace to the existing set of fields for the active ACL table.

DEFINE FIELD

Used to define physical data fields in ACL table layouts.

DEFINE FIELD...COMPUTED

Used to define computed fields in ACL table layouts.

DEFINE RELATION

Used to define a relation between two or more ACL tables.

EXTRACT

Used to extract data from an ACL table and output it to a new ACL table, or append it to an existing ACL table. You can extract entire records or selected fields.

FIELDSHIFT

Used to shift the starting position of a field definition in the table layout.

INDEX

Used to create an index for an ACL table that allows direct access to the records in a sequential rather than a physical order.

JOIN

Used to combine fields from two ACL tables into a new ACL table.

MERGE

Used to combine two sorted ACL tables with identical record structures into a new ACL table that uses the same sort order as the original tables.

NOTES

Used to create, modify, or remove notes associated with individual records in ACL tables.

OPEN

Used to open an ACL table and the associated data file.

REFRESH

Used to update the data in an ACL table from its associated data source.

SAVE LAYOUT TABLE

Used to save table layout metadata to an ACL table.

SAVE WORKSPACE

Used to create and save workspaces.

SORT

Used to sort records in ACL table into ascending or descending order based on specified key fields and writes the results to a new table.

VERIFY

Used to check for data validity errors in the current ACL table by verifying that the data in the ACL table is consistent with the field definitions in the table layout.

ACL table definition commands

DEFINE TABLE DB

Used to define ACL server tables by connecting to ACL Analytics Exchange Connector.

IMPORT ACCESS

Used to define ACL tables from Microsoft Access database files.

IMPORT DELIMITED

Used to define ACL tables from delimited text files.

IMPORT EXCEL

Used to define ACL tables from Microsoft Excel worksheets or named ranges.

IMPORT ODBC

Used to define ACL tables from ODBC (Open Database Connectivity) data sources.

IMPORT PDF

Used to define ACL tables from Adobe Acrobat (PDF) files.

IMPORT PRINT

Used to define ACL tables from Print Image (Report) files.

IMPORT SAP

Used to define ACL tables from SAP ERP systems using Direct Link.

IMPORT XBRL

Used to define ACL tables from Extensible Business Reporting Language (XBRL) data files.

IMPORT XML

Used to define ACL tables from XML data files.

RETRIEVE

Used to retrieve the results of Direct Link queries submitted for background processing.

Analysis commands

AGE

Used to create aged summary reports.

BENFORD

Used to count the number of times each leading digit or digit combination occurs in a field, and compares the actual count to the expected count. The expected count is calculated using the Benford formula.

CLASSIFY

Used to group records into classes based on unique values in a character field. Counts the number of records in each class, and also subtotals specified numeric fields for each class.

COUNT

Used to count the total number of records in the current view, or only those records that meet the specified test conditions.

CROSSTAB

Used to count the number of records and subtotal numeric fields based on a combination of character fields.

DUPLICATES

Used to detect whether duplicate values or entire duplicate records exist in an ACL table.

FUZZYDUP

Used to detect nearly identical values (fuzzy duplicates) in a character field.

GAPS

Used to detect whether key numeric or datetime fields in the current ACL table contain one or more gaps in their sequences.

HISTOGRAM

Used to produce a graphical representation of the distribution of values in a numeric or character field or expression.

PROFILE

Used to generate summary statistics for one or more numeric fields, or expressions, in the active ACL table.

RANDOM

Used to generate a list of random numbers.

SEQUENCE

Used to determine if one or more fields in the active table are in sequential order, and identify out-of-sequence items.

SIZE

Used to determine the appropriate sampling size.

STATISTICS

Used to calculate statistics for one or more numeric or datetime fields in the current ACL table.

STRATIFY

Used to count the number of records falling into specified intervals or key fields, and totals one or more numeric fields for each stratum.

SUMMARIZE

Used to group records and produce record counts based on values in one or more character or datetime fields, and subtotal on specified numeric fields.

TOTAL

Used to calculate the total value of the specified fields in an ACL table.

Application and file system commands

DIRECTORY

Used to display a list of files and folders in the specified directory.

DISPLAY

Used to display information about ACL projects or the computer ACL is running on.

EXECUTE

Used to execute an application or process external to ACL. Emulates the Windows Run command. Can be used to interact with the Windows command prompt.

OPEN

Used to open an ACL table and the associated data file.

SAVE

Used to create and save ACL tables and save ACL projects.

SET

Used to specify values for configurable ACL options.

Locate record commands

FIND

Used to search an indexed field for an exact match for a specified character or set of characters.

LOCATE

Used to search for the first record that meets a specified condition, or moves to a specified record number.

SEEK

Used to search an indexed field for an exact match for a specified character expression.

TOP

Used to move to the first record in the current ACL table.

Miscellaneous commands

DELETE

Used to delete ACL project items, fields from table layouts, variables, table history entries, relations between tables, and physical files in Windows folders. Also used to remove columns from views.

DUMP

Used to display the contents of a file, or the current record, in hexadecimal, ASCII, EBCDIC, and Unicode (if using the Unicode edition of ACL) character encodings.

HELP

Used to launch the ACL help system in a new window.

QUIT

Used to end the current session and exit ACL.

RENAME

Used to change the names of ACL project items, fields, or text files.

SAVE LOG

Used to save the entire command log or the current session.

Reporting commands

DEFINE COLUMN

Used to create and add columns to existing views.

DEFINE REPORT

Used to create a new report or modify an existing report.

DEFINE VIEW

Used to define a new view or overwrite an existing view.

DO REPORT

Used to generate the specified ACL report.

DO REPORT CRYSTAL

Used to generate reports using the specified a Crystal Reports template and the active ACL table.

EXPORT

Used to export data from ACL in the specified file format.

LIST

Used to output data from an ACL table as a list formatted in columns.

PRINT

Used to print text files, ACL log files, or other ACL project items that have been exported as ACL Server files (i.e., scripts (.bat), tables (.fmt), or workspaces (.wsp)) using the default printer. You can also print graphs generated as the output of commands.

REPORT

Used to format and generate ACL reports.

Sampling commands

EVALUATE

Used to determine the impact of detected sampling errors on a population for a specified confidence level and sets out a “worst case scenario”, returning an upper error limit frequency for record sampling and an upper error limit for monetary sampling.

SAMPLE

Used to select records or monetary unit samples from a population in a data file.

SIZE

Used to determine the appropriate sampling size.

Script-specific commands

ASSIGN

Used to create variables and assign values to variables.

CLOSE

Used to close ACL tables, index files, or log files, or to end Script Recorder sessions.

COMMENT

Used to add explanatory notes to your scripts without affecting processing.

DO SCRIPT

Used to execute a secondary script from within your script.

ESCAPE

Used to terminate the script being processed, or all scripts, without exiting ACL.

GROUP

Used to execute a series of ACLScript commands on each record that matches the specified conditions with only one pass through the ACL table.

IF

Used to conditionally execute a command if the specified test condition evaluates to true.

LOOP

Used inside the GROUP command to process one or more commands repeatedly while a test condition is true.

User interaction commands

ACCEPT

Used to prompt users for information, which is then stored in a named variable, while the script is running.

CALCULATE

Used to calculate the value of one or more expressions.

DIALOG

Used to create custom dialog boxes that interactively prompt users for information.

NOTIFY

Used to send email notification messages.

PASSWORD

Used to create a password definition, without a password value, that prompts users for a password while a script is running.

PAUSE

Used to display information for users in a dialog box while a script is running.

Related concepts
ACLScript command syntax conventions
Related reference
ACLScript function reference


(C) 2013 ACL Services Ltd. All Rights Reserved. | Send feedback