Defines the title of the row element
Syntax
set xml rowelement constant
Parameters
constant | A character string or an expression that evaluates to a character string |
Comments
SET XML ROWELEMENT defines the identification of the row element for each row data that is printed whenever the set output format xml or xmlsimple is set. By default, ZIM prints the pair …
.
Example
set save
set output format xmlsimple
set xml rowelement /p>
set output MyDoc
list 1 Docs
set restore
See Also
SET OUTPUT FORMAT
SET XMLHEADER
Controls lexical tracing.
Syntax
SET [LOCAL] LEXTRACE ON|OFF
Parameters
LOCAL | Indicates that lexical tracing is to be switched ON or OFF only at the “local” level. |
Comments
The LEXTRACE option is set OFF by default.
When LEXTRACE is ON, each line of a procedure is displayed on the terminal, one character at a time, as it is parsed. Each line is preceded by the procedure name and document line number. If an error occurs, the resulting error message appears immediately following the character that caused the error.
Comment lines are traced. Carriage returns are inserted into the output when continuation characters (backslashes) are encountered. Statements are shown after macro substitution (if any) is complete.
Each output line starts with the procedure name and the application document line number as shown in the following example:
pCustReport[19] report from Customers
The SET LEXTRACE command has no effect on compiled procedures.
The SET LEXTRACE command is not affected by the SET RESET and SET RESTORE commands.
See Also
SET COMMANDTIMING
SET TRACE
SET TRACEOUTPUT
Controls how long a FORM or MENU INPUT command waits for user interaction.
Syntax
SET INPUT TIMEOUT [num]
Parameters
num | The number of seconds to wait for user input. Can be an integer constant (e.g., 15, 200); a variable, form field, or parameter that evaluates to an integer. Valid values for num range from -1 to 32000. Specifying a value of -1 instructs the software to wait indefinitely for user interaction. |
Comments
The INPUT TIMEOUT option is set to -1 by default, instructing the software to wait indefinitely for user interaction after an input request.
If user interaction does not occur before the timeout period expires, the input request terminates and program execution resumes at the next command.
When a timeout period expires, the following system variables are affected:
- Event.EventName is assigned the value “Timeout”
- Event.EventType is assigned the value “System”
Note that the SET INPUT TIMEOUT value is not restored on a SET RESTORE.
See Also
FORM INPUT
MENU INPUT
SET TIMEOUT
Establishes the format for data input.
Syntax
SET INPUT FORMAT NORMAL|COMMADELIMITED
Comments
The INPUT FORMAT option is NORMAL by default.
Normally, the ADD and CHANGE commands look for input whose format is a simple data stream, separated by delimiter characters. SET INPUT FORMAT enables these commands to read data in “comma delimited” format from unstructured application documents.
When using the comma-delimited format, data base fields are separated from one another by the delimiter character. This is normally a comma, but it can be changed using the SET DELIMITER command. Character-type fields have trailing blanks removed and are enclosed by the text delimiter. This is normally double quotation marks, but can be changed using the SET TEXTDELIMITER command. Numeric fields have leading blanks removed.
Fields that match the current NULLVALUE string (without text delimiters) are evaluated as $Null. Fields comprising of two text delimiters are evaluated as $Null or zero, depending on the field being assigned.
Example
set save
set input format commadelimited
set nullvalue “$null”
add Customers from UnstructuredDoc
set restore
See Also
ADD
SET DELIMITER
SET NULLVALUE
SET OUTPUT FORMAT
SET TEXTDELIMITER
Specifies the current text delimiter for comma-delimited format.
Syntax
SET TEXTDELIMITER character
Parameters
character | Any valid character, or a variable containing a valid character. Reserved characters (e.g., space, backslash, etc.) must be enclosed in quotation marks. |
Comments
The TEXTDELIMITER option is set to the double quotation mark (“) by default.
The specified character is used as the delimiter, marking the boundaries of character-type fields in the comma-delimited format. The delimiter is used by the INPUT command (input from the terminal), by the ADD and CHANGE commands (input from an unstructured application document), and by the LIST and OUTPUT commands (output to the terminal or an unstructured application document) in COMMADELIMITED format.
If TEXTDELIMITER is set to the space character, the double quotation mark is used as the text delimiter for both input and output.
Example
set textdelimiter “/”
See Also
ADD
CHANGE
INPUT
LIST
OUTPUT
SET DELIMITER
SET INPUT FORMAT
SET OUTPUT FORMAT
SET SPECIALSCAN
Controls the way Automatic Sequence Numbers operate.
Syntax
SET SEQUENCENUMBER {object | ALL} {number | variable | ON | OFF}.
where
object | The name of an Entity-Set Relationship with fields that contains an ASN defined |
ALL | Refer to all Entity-Sets and Relationships with fields that contain ASNs defined |
number | a positive number from 1 up to 15-digit number |
variable | a variable containing a positive number from 1 up to a 15-digit number. If the contents of the variable is $null, the number is assumed to be 1. |
Comments
The command sets an initial number, enables or disables automatic sequential numbers to the mentioned object or to ALL the objects that contain ASN.
Examples
SET SEQUENCENUMBER ALL 1
Resets all existing ASN to 1.
LET MyVar = 1000
SET SEQUENCENUMBER Customer MyVar
Initializes the ASN for Customer to the value of 1000.
SET SEQUENCENUMBER ALL OFF
Disables all ASN.
SET SEQUENCENUMBER Customer ON
Enables the ASN for the Customer object and $ZimSeqNum returns the current sequence number available for Customer
Specifies the current output.
Syntax
SET OUTPUT docname [APPEND] [FILEPATH file://<file full path>]
Parameters
docname | The name of the application document to which all output is to be sent. Can also be one of the two pre-defined application documents, terminal or printer. |
APPEND | Specifies that new output to docname is to be appended to the output already existing in the application document (if any). |
FILEPATH file://<file full path> | Specifies that output will be written to the file declared in the file option. |
Comments
The SET OUTPUT command specifies the application document that is to receive the output from all subsequent FORM REPORT, GENERATE, LIST, OUTPUT, PRINT, REPORT FROM, and SELECT commands. The setting remains in effect until changed by a subsequent SET OUTPUT command.
The software provides two pre-defined application documents, terminal and printer, that correspond to your terminal screen and default printer, respectively. OUTPUT is set to Terminal by default. If set to printer, the SET OUTPUT command has no impact on the format in which the report prints; use $setproperty to change print properties for a report.
Example
set output MyDoc append
set output printer
report from ...
... other commands ...
endreport
set output terminal
This example shows how to write a document anywhere in the system. The first SET OUTPUT sets the output to “c:\myDir\FirstFile.txt” while the second sets it to “c:\myDir\SecondFile.txt”.
set output MyDoc filepath "file://c:\\myDir\\FirstFile.txt"
list 20 zimprof
set output MyDoc filepath "file://c:\\myDir\\SecondFile.txt"
list all AnotherDoc
set output terminal
Changes the runtime file name of a connector document
Syntax
SET CONNECTOR DOCUMENT connector document TO filename
Parameters
connector document | The name of the connector document. |
filename | The file name to which the connector document will be referencing. |
Comments
The SET CONNECTOR DOCUMENT changes the run-time value for the filename field on a connector document. The new filename is used for all subsequent opens on the document. The filename of a connector document describes the type of the connection and the host and port where the connector resides. There are two connection types ™S™ which is used for connectors that are used for simple command-response operations or are shared single-threaded processes and F™ for connectors that provide a data feed and are either multi-threaded or used exclusively by a single ZIM instance.
A ™S™ type connection is automatically closed after the command completes and the connector issues a PROMPT. The ™F™ type connection never closes.
Example
To set the filename for the connector document SMS_SEND to be a command-response connection where the connector is running on the host ™zimdatabases.com™ at TCP port 9000:
set connector document SMS_SEND to !zimdatabases.com!9000
To set the filename on the connector SMS_RECEIVE to be a data feed where the connector is running on the host ™zimdatabases.com™ at TCP port 9001:
set connector document SMS_RECEIVE to ™F!zimdatabases.com!9001™
Specifies if quotation marks are required for character strings.
Syntax
SET QUOTING ON|OFF
Comments
The QUOTING option is set OFF by default.
Setting QUOTING ON causes the software to issue a warning message each time it encounters a non-numeric character string not enclosed in quotation marks (i.e., unquoted character strings that are valid numbers do not elicit warnings).
The SET QUOTING ON command can be used to reinforce the distinction between character strings and object names (reserved words and the names of objects in your application). While you are reminded to enclose character strings in quotation marks, you are not forced to comply. The software continues to accept unquoted character strings, because the messages being issued are warnings, not errors. Warning messages can be turned off with SET WARNINGS OFF or a SET MESSAGES OFF command.
The SET QUOTING command is not affected by the SET RESET and SET RESTORE commands.
Example
set quoting on
let Name = Smith
When the LET command is encountered, a warning message is issued because Smith is not enclosed in quotation marks.
set quoting on
find employees
let Name = “Smith”
let Name = FirstName
let Salary = 20000
No warnings are issued: Smith is enclosed in quotation marks; FirstName is a field name; and 20000 is a valid number.
See Also
COMPILE
PAUSE
Quotation Marks
Controls the call tracing of procedures.
Syntax
SET [LOCAL] FLOW ON|OFF
Parameters
LOCAL | The command is to take effect only within the current procedure. |
Comments
Call tracing messages show shifts in execution control from one procedure to another. The SET FLOW command controls call tracing.
FLOW is OFF by default.
When FLOW is ON, the call tracing feature issues messages when the software enters or exits a procedure.
When entering procedurename, the message takes the form:
[nn ]–> procedurename
When exiting procedurename, the message takes the form:
[nn ]<– procedurename
where nn indicates the level of nesting represented by procedurename.
When procedurename is entered from a compiled procedure, the message is modified to read:
[nn ]–> procedurename
SET FLOW is not affected by the SET RESET and SET RESTORE commands.
Example
procedure DoCusts
set local flow on
The preceding command traces procedure calls only when those calls are made from procedure DoCusts.
set flow on
The preceding command causes the software to trace all procedure calls until otherwise notified.
See Also
RETURN
SET TRACEOUTPUT