Command Table

Your application commands, processes and macro commands

Command Table

The table below shows all commands and the drop down menu from which they can be called. The table also shows the quick key that can be used.

All commands are hyper-linked to their respective context Help file.

Note that this Help content will provide availability status for all Datamine Studio products; some commands are only available in specific applications. If you wish to discuss expanding your Datamine software suite, please contact your local Datamine representative who will be able to assist you.

Use the Find option supplied by your browser to search for commands or quick keys. Use the links below to navigate to the correct table:

Using the tables

A green tick indicates that the module is part of the core system licensing for the specified product - no additional module is required

X A red cross indicates the module is not part of the listed system and any commands held within it cannot be run (a separate product will be required)
A blue diamond indicates the module is an optional extra for the specified system

Design and Visualization Commands

The command tables are categorized alphabetically, and contain a list of commands available in all Datamine products, and you will find this information in all Datamine Studio help files.

Select a link below, or use the Table of Contents to access a particular command table:

A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z

What's the difference between a "command" and a "process"?  

Datamine Studio applications use the term command to indicated a function that works on or with a data object already loaded into memory (e.g. 'new-string', 'edit-attributes') whereas a process indicates that a file-in-file-out operation is being performed; data does not have to be present in memory, and where an input file is required, it is selected from disk. Similarly a file is output to disk if it is relevant.
What is a "Superprocess"   Similar to a macro, a Superprocess is a series of in-built processes that can be performed sequentially to achieve a more complex outcome than is possible for a single command. Superprocesses appear identical to other processes (e.g. they are run using a single files-fields-parameters dialog). TONGRAD, for example, is a superprocess.

Macro Commands - All Products

Command Name

Application

Description

BACKTO

ALL

Unconditionally branches to a specified screen name or label within a macro or menu.

ECHO

ALL

Display a message in the Command control bar.

ELSE

ALL

Evaluate one or more logical expressions involving substitution variables and constants in a macro or menu (macro/menu use only).

ELSEIF

ALL

Evaluate one or more logical expressions involving substitution variables and constants in a macro or menu (macro/menu use only).

END

ALL

End a macro or menu within a macro file (macro/menu use only).

ENDIF

ALL

Terminate one or more logical expressions involving substitution variables and constants in a macro or menu (macro/menu use only).

FIELD

ALL

Detects the existence of a database field from within a menu or macro (macro/menu use only).

FILE

ALL

Detects the existence of a database file from within a menu or macro, and, optionally, the number of records in the file (macro/menu use only).

GOSUB

ALL

Stores the current macro position and branches to a specified command label within a macro or menu (macro/menu use only).

GOTO

ALL

Unconditionally branches to a specified command label within a macro or menu (macro/menu use only).

HOLD

ALL

Stop exit from macro or menu on fatal error (macro/menu use only).

IF

ALL

Evaluate one or more logical expressions involving substitution variables and constants in a macro or menu (macro/menu use only).

INCLUDE

ALL

Enable records from a Datamine file to be incorporated as normal data and/or statement lines within a Macro or Menu (macro/menu use only).

KBOFF

ALL

Toggle OFF the keyboard after using KBON (macro/menu use only).

KBON

ALL

Toggle ON the use of the keyboard as a means of data entry into a running macro or menu (macro/menu use only).

LET

ALL

Set values of substitution variables. Arithmetic and functions are provided (macro/menu use only).

LOADCF

ALL

Load a macro file (*.mac) into a menu file (*.men) for faster execution.

MACEND

ALL

Terminates the storage of interactive input in a character format system file.

MACST

ALL

Starts the storage of all subsequent interactive input in a character format system macro file.

MDEBUG

ALL

Interactively debug macros and menus.

MENU

ALL

Initiate the currently established menu. The menu name is requested. This must be the name of a binary random access menu file loaded by the !LOADCF command.

NOHOLD

ALL

Exit from a macro or menu when a fatal error is encountered or if '!' is entered by the user (macro/menu use only).

NOMENU

ALL

Check the syntax of the currently established menu. !NOMENU works in the same way as !MENU, except that the menu is not executed.

NOXRUN

ALL

Check a macro for syntax.

ONERR

ALL

Transfer control to a specified label in the menu or macro if a fatal error occurs (macro/menu use only).

OPSYS

ALL

Transfer control to a specified label in the menu or macro if a fatal error occurs (macro/menu use only).

PAUSE

ALL

Pause a macro for a time proportional to the @DELAY parameter (macro/menu use only).

PROMPT

ALL

Display prompts and messages on screen (macro/menu use only).

REM

ALL

Record comments in a macro or menu file (macro/menu use only).

RETURN

ALL

Transfer control back to the next statement following a GOSUB statement in a macro or menu (macro/menu use only).

RUNPROG

ALL

Run any external process from a macro, such as a batch file or executable

SCROFF

ALL

Divert text screen output into a system file during macro execution (macro/menu use only).

SCRON

ALL

Restore screen output previously diverted by a !SCROFF command (macro/menu use only).

START

ALL

Start a macro or menu (macro/menu use only).

STKPAR

ALL

Retrieve substitution variables and their values from a system character format file (macro/menu use only).

STKSAV

ALL

Write substitution variables and their values to a system character format file (macro/menu use only).

SYSFILE

ALL

Check if a system file exists (macro/menu use only).

VARINIT

ALL

Initialize the number of substitution variables to zero for the current macro level (macro/menu use only).

VARLOAD

ALL

Read substitution variables from a system text file (macro/menu use only).

VARSAVE

ALL

Save or merge substitution variables into a system text file (macro/menu use only).

XRUN

ALL

Run a macro or menu.