REPORT HEADING

Specifies the report heading.

Syntax

REPORT HEADING [TEMPLATE name] reportitem [:format:]

Parameters

TEMPLATE name

For graphical reports, the name of an optional template to define the layout of the report.

reportitem

Any valid expression. Complex expressions must be enclosed in parentheses. When you specify more than one expression, each must be separated from the next by at least one space.

format

A set of instructions defining the format for the associated reportitem. Format is enclosed in : (colons) and can consist of any valid combination of format options.

Comments

Generates a line-oriented heading at the start of a report, regardless of whether the report itself is line-oriented or column-oriented. To generate column-oriented headings, use the BREAK (Reports) command with a constant expression.

Typically, the items specified are text (for titles), blank lines, dates, and so on. The heading can include individual data values only from the first member of the REPORT FROM set.

 

See Also

How to Use The Report Generator

PAGE FOOTING

REPORT FOOTING

Report Item Format Options

PREVIOUS

Moves the current member pointer one or more records “up” in a result set.

Syntax

PREVIOUS [num] [setname]

Parameters

num

 

The number of members “further up” into setname that the current member pointer is to be moved. Num can be:
an integer constant (15, 200);
a variable, form field, or parameter that evaluates to an integer;
the word ALL.
The default value for num is 1. If num is negative, PREVIOUS num actually moves the current member pointer “down” in the set.

 

setname

 

The name of a result set. If setname is omitted, the current set is used.

 

Comments

UP is a synonym for PREVIOUS.

Example

previous 10

Moves the current member pointer 10 members “up” towards the start of the set.

previous 5 MySet

list 5 MySet

Moves the current member pointer “up” five members, then lists five members (starting with the new current member).

 

See Also

$currentmember

BOTTOM

DOWN

LOCATE

NEXT

TOP

CURSOR

Positions the text cursor in the current window.

 

Note: This command has been deprecated in Zim 8.50.
It is still accepted for backwards compatibility, but it is ignored.

Syntax

CURSOR expression1 expression2

Parameters

expression1A number or an expression that evaluates to a number. If the expression is complex, it must be enclosed in parentheses.
Indicates the character row in which the cursor is to be positioned. It should be a number from 1 to the maximum number of rows in the current window.
expression2A number or an expression that evaluates to a number. If the expression is complex, it must be enclosed in parentheses.
Indicates the character column in which the cursor is to be positioned. It should be a number from 1 to the maximum number of columns in the current window.

Comments

The text cursor is placed at the specified row (expression1) and column (expression2) coordinates.

Examples

cursor 10 (60/2)

output “Press Enter to continue” ;

input

Positions the cursor at row 10 and column 30, and displays a message.

 

input $CursorRow $CursorCol

cursor $CursorRow $CursorCol

Prompts for a new cursor position, and moves the cursor.

LOGIN

Identifies the current user to Zim for security purposes.

Syntax

LOGIN username [password]

Parameters

username

A character string, or an expression that evaluates to a character string.
The character string is checked against the list of valid user names (as defined in the Users EntitySet). User names are case-sensitive.
Complex expressions must be enclosed in parentheses.

password

A character string, or an expression that evaluates a character string.
If username does not have a defined password, any password entered is ignored.
Complex expressions must be enclosed in parentheses.

Comments

The LOGIN command can be entered at any time during an application session.

When the software is started, it automatically tries to log the user as the default user ZIM. If ZIM is not a defined user in the Users entity set, access to any EntitySets or relationships is denied.

Example

If your user name is Boss and your password is $profits, to log in use

login “Boss” “$profits”

If you do not have a password, all you need to login is

login newuser

This example can be used if the application uses a log-in form

login fLogin.Username fLogin.Password

 

See Also

PASSWORD

PERMISSION

Securing Data Inside an Application

REPORT FOOTING

Specifies the report footing.

Syntax

REPORT FOOTING [TEMPLATE name] reportitem [:format:]

Parameters

TEMPLATE nameFor graphical reports, the name of an optional template to define the layout of the report.
reportitemAny valid expression. Complex expressions must be enclosed in parentheses. When you specify more than one expression, each must be separated from the next by at least one space.
formatA set of instructions defining the format for the associated reportitem. Format is enclosed in : (colons) and can consist of any valid combination of format options.

Comments

Generates a line-oriented footing at the very end of the report, regardless of whether the report itself is line-oriented or column-oriented. To generate column-oriented footings, use the BREAK (Reports) command with a constant expression.

The footing can include individual data values only from the last member of the REPORT FROM set. However, summary data computed over all records in the set (using aggregate functions) can appear in the footing.

See Also

How to Use The Report Generator

PAGE FOOTING

REPORT HEADING

Report Item Format Options

COMPILE

Compiles an application program.

Syntax

COMPILE progdocname

Parameters

progdocname

The name of the application document that contains the application program to be compiled.

Comments

The COMPILE command reads the program compiles it, and stores the compiled version in a separate disk file. The source program is then marked as being compiled. Thereafter, the compiled version of the program is used when that program is called.

As the Compiler processes an application program, it reports any errors that it finds in the command statements. The syntactic and semantic checks performed during compilation are identical to those performed when the program is parsed using the PARSE command or when the source program is run interpretively.

If no fatal errors are detected, the Compiler completes the compilation. If a fatal error is detected, the compilation terminates.

The PARSE command should be used before compiling a program to ensure the program is syntactically correct.

The application program is identified as compiled even if errors are encountered during compilation.

The UNCOMPILE command can be used to mark a compile program as “not compiled”. The SET RUNTIME OFF command forces the software to execute all application programs interpretively.

Example

compile MyProg

 

See Also

$COMPILESTATUS

GENERATE

PARSE

SET COMPILEMODE

SET RUNTIME

SET SQLCOMPILE

OUTPUT

Outputs the results of one or more expressions.

Syntax

OUTPUT [expression] [;]

Parameters

expressionAny valid expression. Complex expressions must be enclosed in parentheses. When you specify more than one expression, each must be separated from the next by at least one space.

Comments

OUTPUT evaluates expression and sends the result to the current output device. If expression uses fields from the current set, the values are taken from the current member in that set.
OUTPUT sends one line of characters to the current output destination (application document). The software automatically terminates the output line with a carriage return/line feed combination. You can suppress the carriage return/line feed combination by placing a semicolon (;) at the end of the OUTPUT command.
You can redirect output from the terminal using a SET OUTPUT command.
To specify the number of spaces to appear between output values, use a SET COLUMNSPACING command.

Example

To send the values of the variable TestVar and the form field fEmpform.

output TestVar fEmpform.LastName

To send the values from two OUTPUT commands to one line of the application documents MyDoc, enter

set output MyDoc

output TestVar;

output fEmpform.LastName

The following commands cause the character string following OUTPUT to display on the current output device:

output “Please enter your first and last names: “;

input FirstName LastName

Important

If it is needed the issue the INPUT command in the same line as its corresponding text, the colon “:” must be present at the end of the text, just like the example above.

See Also

INPUT

TRANSFORM

Transfers control to another procedure.

Syntax

TRANSFORM procedurename [(]expression[)]

Parameters

procedurenameThe name of the procedure to which execution control is to be transferred.
expressionParameters or macros for procedurename (formatted as when calling the procedure).

Comments

TRANSFORM transfers execution control to the specified procedure, but does not return control to the calling procedure once procedurename has finished executing. Control returns instead to the “parent” of the calling procedure.

Example

Consider the following sequence of procedures:

01 procedure Proc1 ( )

02  Proc2 ( )       (Control goes to line 12)

:   … more commands …

10 endprocedure

11 %————————

12 procedure Proc2 ( )

13   transform Proc3 ( )   (Control goes to line 23)

:   … more commands …

21 endprocedure

22 %———————–

23 procedure Proc3 ( )

24  … more commands …

25 endprocedure      (Control goes to line 03)

The normal flow (without TRANSFORM) is Proc1 to Proc2 to Proc3 to Proc2 to Proc1.

The flow for calling with TRANSFORM is Proc1 to Proc2 to Proc3 to Proc1.

See Also

How To Call Procedures

RETURN

STOP

PAGE HEADING

Specifies the page heading for a report.

Syntax

PAGE HEADING [BREAK HEADING indicator] reportitem [:format:]

Parameters

indicatorIndicator can be
OFF
Suppresses all break headings at the top of each new report page.
LEVEL n
Causes the break heading for break level n and below to be displayed at the top of each report page. N is a positive integer.
The default value is LEVEL 1 (i.e., all break headings are displayed at the top of each report page).
reportitemAny valid expression. Complex expressions must be enclosed in parentheses. When you specify more than one expression, each must be separated from the next by at least one space.
formatA set of instructions defining the format for the associated reportitem. Format is enclosed in : (colons) and can consist of any valid combination of format options.

Comments

The PAGE HEADING command causes a heading to be displayed at the top of every page of a report. It also controls the display of break headings at the top of each report page. Report items in this command can include individual data values only from the first record to be processed on the current report page.

See Also

BREAK (Reports)

How to Use The Report Generator

PAGE FOOTING

REPORT HEADING

Report Item Format Options

PASSWORD

Changes or assigns a password to the current Zim user ID.

Syntax

PASSWORD newpassword [oldpassword]

Parameters

newpasswordThe new password, up to 18 characters. Any characters are valid (i.e., letters, digits, punctuation). $Null is also valid; its effect is to remove a password.
Can also be an expression. If necessary, the expression is converted to character format. Complex expressions must be enclosed in parentheses.
If the value given for newpassword is longer than 18 characters, only the first 18 characters are used.
oldpasswordThe current password. When there is no current password, omit oldpassword, or use $Null.
Can also be an expression. If necessary, the expression is converted to character format. Complex expressions must be enclosed in parentheses.
If the value given for oldpassword is longer than 18 characters, only the first 18 characters are used.

Comments

The new password takes effect immediately. To remove a password, use a value for newpassword that is $Null.

Password checking is case-sensitive. They must be changed during a read/write transaction because passwords are stored in encrypted form. An attempt to change a password during a read-only transaction fails.

Example

Transaction (Explicit Read Write transaction)

password “$moreprofits” “$profits”

Changes the current user’s password from $profits to $moreprofits.

See Also

Data Types

Case Sensitivity

LOGIN

en_CAEnglish