Engine Help: Text
Filtered overview of the Engine Help documentation.
OS/2
OS/2 is a registered trademark of International Business Machines Corporation (IBM). Note : This text was machine-translated and may contain inaccuracies.
OSFILE
OSFILE indicates an OperatingSystemFile. - a file on the Notes server's hard drive,
OSPATH
Represents an absolute or relative Operating System Path (in relation to the current directory).
Parameter passing
Parameter passing for Engine Batch Commands. A parameter begins immediately after the preceding separator (":" or ",") and ends immediately before a separator ("," or ";"). A command must be terminated with a semicolon ( …
PRC Document
A PRC Document contains an Engine Script program. This is the old name for an Script Document, but it is still used in the Batch Scripts, in the commands (Commands) for compatibility reasons. Note : This text was machine …
PRG Document
A PRG Document is an Engine Time Event Document. This is the old name for an Engine Time Event Document, but it is still used in the Batch Scripts, in the commands (Commands) (as well as on the server console) for compat …
SECTION END
Last statement in an IDF document. Syntax: SECTION END;
SECTION EOF
Statement that starts the processing program in an IDF document that is to be executed after the import. All @Functions can be used. Note : This text was machine-translated and may contain inaccuracies.
SECTION IMPORT
The record to be imported is defined here. No @Functions can be used. Tabs and comments must not be used!!! Syntax: Simple field: DataType,Length,Delimiter,FieldName; List field: DataType,TotalLength,TotalDelimiter,Eleme …
SECTION INIT
A statement which starts the Processing Program, which should be run before the import process, in an IDF document. All @Functions can be used.
SECTION PROCESSING
A statement which starts the processing program, which is supposed to be run in every sentence during importation, in the IDF document
SECTION REFERENCE
In the SECTION REFERENCE fixed mappings from specific imported field values to other field values are defined. Tabs and comments must not be used!!! Syntax for a reference list: TargetDataType,ReferenceName { ImportStrin …
SECTION SYSTEM
General import parameters are defined here: Tabs and comments must not be used!!! SET SepModus: SET SepModus := @Length; The record is defined by a specific length. SET SepModus := @String; The record is defined by one o …
SET DocMultiplyer
SET DocMultiplyer: (Default value 1) Specifies how many times the document should be written.
SET MaxRecords
SET MaxRecords: Defines the maximum number of records to import. (Default value 0. This means no maximum number of records.)
SET RecordCount
SET statement in the SECTION SYSTEM in the IDF document. SET RecordCount: Number of characters to import per record.
SET RecordRepeat
SET RecordRepeat: (Default value 1) Specifies how often the delimiter string (or one of the delimiter strings) must occur before a record is actually finished.
SET SaveMain
SET SaveMain: (Default value 1) 0=Main document is not saved. 1=Main document is saved. @SaveMain in processing causes the setting to be reversed once for this main document. (If saving is generally disabled -> save. If …
SET SepModus
SET statement in the SECTION SYSTEM in the IDF document. SET SepModus: Examples: SET SepModus := @Length; The record is defined by a specific length. (see SET RecordCount.) SET SepModus := @String; The record is defined …
SET SepString
SET statement in the SECTION SYSTEM in the IDF document. SET SepString: Sets the separator string that terminates a record. The separator string (which can be built using @Char and +) can also be a list of separator stri …
SHARED
SHARED is a special variable group, which is not deleted after processing/import has ended and remains in memory even after the BATCH (AEF) has ended. This means that a variable assigned to the SHARED variable group rema …
String Exceptions (Escape Sequences)
In a string in an Engine script an escape sequence can be specified. The escape sequence is introduced by a backslash (\). This is followed by an identifier that specifies the escape sequence to be performed: Identifier …
STRUCTURAL KEYWORDS
IF: Structurally branches to a block of statements if the BOOL condition is met. (In the version with ELSE, execution branches to the ELSE block if the BOOL condition is not met.) Syntax: IF(BOOL) { } ELSE { } or IF(BOOL …
SWITCH/CASE/DEFAULT
Syntax: SWITCH(Test) { CASE("A") { } CASE("BB") { } } or SWITCH(Test) { CASE("A") { } CASE("BB") { } DEFAULT { } } The result of the SWITCH expression is compared with the res …
TELL Engine Commands
On the server console, instructions can be issued to the Engine or to individual Engine tasks using the TELL command. Command: Meaning: do compact Manually starts an API log compaction. stop TASKID Signals to the t …
Toolbox
The Toolbox is a collection of out-of-the-box applications that run on the Engine. The Toolbox database, usually SRVJOBS.NSF, contains the respective parameters for these applications.
ToolboxDB
In the "ToolboxDB" field, the Notes-FilePath of the toolbox-db has to be entered. (In most cases the same as ControlDB)
TRUE
see Data Type BOOL
UID
A UID is a number for a document that identifies it once in the universe, independently of the database. Different versions are not distinguished. Note : This text was machine-translated and may contain inaccuracies.
VARGROUP
A Pseudo-NOTEHANDLE, which isn't associated to any document. See Variable Groups.
Variable Groups
A variable group identifies a set of variables as belonging together. It (the group) is specified in square brackets after the variable name. For example, a variable group can group together all variables or fields of a …
Variable Restrictions
NUMBER: Range 0-65536. FlOAT: Range analogous to Notes. TEXT: Maximum as an Engine variable approximately 63 KB. Maximum as a Notes field approximately 15 KB. NUMBERLIST: Maximum 30,719 elements. FLOATLIST: Maximum 8,063 …
Variables
Unlike in the Notes @Functions language, variables in the Engine can be redefined any number of times. They do not have to be declared or typed. The type and value of a variable may change at any time. This means that a …
VStack
A VStack is effectively a folder in the Engine variable system and the basis of a variable group/NOTEHANDLE. It is normally specified in @Functions by its name, that is, as TEXT. Whereas a NOTEHANDLE/VARGROUP exists as a …
VStack-Path
After a non-local variable, a NOTEHANDLE/VARGROUP (variable group) is normally specified in square brackets. In the case of a VARGROUP (variable group) it is also possible to address groups of variables that are located …
Windows
Windows is a registered trademark of Microsoft Corporation. Note : This text was machine-translated and may contain inaccuracies.