Engine Help: Text
Filtered overview of the Engine Help documentation.
DBProperties Replication History
@GetDBReplicaHistory @DeleteDBReplicaHistory Note : This text was machine-translated and may contain inaccuracies.
DBProperties Replication Settings Advanced
@GetDBARConnections @GetDBARConnection @SetDBARConnection @DeleteDBARConnection
DBProperties Replication Settings Other
@GetDBReplicaInfo/@SetDBReplicaInfo FLAGS3:: BIT DEC HEX MEANING if set 03 00004 0004 Replication off (user-changeable) @GetDBReplicaInfo/@SetDBReplicaInfo FLAGS3:: BIT DEC HEX …
DBProperties Replication Settings Send
@GetDBReplicaInfo/@SetDBReplicaInfo FLAGS3: BIT DEC HEX MEANING if set 05 00016 0010 Do not replicate deleted documents. @GetDBOptions/@SetDBOptions FNEXTOPTIONS: BIT DEC HEX ME …
DBProperties Replication Settings Space Savers
@GetDBReplicaInfo/@SetDBReplicaInfo CUTOFFINTERVAL4 and CUTOFFTD5 @GetDBReplicaInfo/@SetDBReplicaInfo FLAGS3: BIT DEC HEX MEANING if set 10 00512 0200 File attachments are not replicated. @ …
DBProperties User Activity
@GetDBActivity @DeleteDBActivity/@CreateDBActivity @GetDBOptions/@SetDBOptions Options: BIT DEC HEX BEDEUTUNG wenn gesetzt 18 131072 20000 User Activity für diese DB ist confidential @GetDBActi …
DEBUG
DEBUG("ON"); DEBUG("OFF"); DEBUG("SIMPLE"); DEBUG("ALL"); DEBUG("FOLLOW"); DEBUG("FOLLOW2"); Enables or disables debug mode. In "FOLLOW" mode, the @functions @DebugFollowFun and @DebugFollowVar are taken into account. Th …
DEFFN
See STRUCTURAL KEYWORDS
DEFINE,UNDEFINE,IFDEF,IFUNDEF
As of version 4.50 B180: Conditional compilation (DEFINE,UNDEFINE,IFDEF,IFUNDEF): DEFINE: Syntax: DEFINE(Test); DEFINE can be used to define a "term" as existing. WARNING: A "term" must not contain spaces (" ") or specia …
DEFINED Symbols
The following defines are made by default and can be used as a way to distinguish in scripts that are evaluated at compile time: Engine V3.x: Engine_Version_300 Engine V4.5: Engine_Version_450 Engine V4.6: Engine_V …
DELFN
See STRUCTURAL KEYWORDS
Engine
The Engine is a tool with which objects of one (or more) Notes server(s) can be programmatically modified, created, or deleted. The Engine is controlled through the Notes database APICTRL.NSF. The activities of the Engin …
Engine Batch
Example of an Engine Batch document: Batch Name: The batch name is entered here; the syntax is SERVER_NAME!!BATCH_NAME. For batches that should be available on all servers, the server name is omitted (e.g. !!BATCH_N …
Engine Control Database
The database used to control the Engine is APICtrl.NSF, or LOAPI.NSF in older installations. This database, together with the other Engine system databases, should be located in a separate subdirectory within the Domino …
Engine Import Script
Example of an Engine Import Script Document: This is an old method for enabling imports. For compatibility reasons, it is still supported, but it should no longer be used for new imports (deprecated!). New imports should …
Engine Script
Example of an Engine Script Document: Script Name: The script name is entered here. The syntax is SERVER_NAME!!SCRIPT_NAME. For batches that should be available on all servers, the server name is omitted, for example !!B …
Engine-ID
The Engine-ID in developer and self-developer versions of the Engine is created based on the server ID number of the Notes server on which the Engine is to run. RUNTIME ID versions of the Engine can be created by develop …
Event Document
Event documents in the Engine control database define the events to which the Engine should respond by executing a script. There are Time, File, and Database events. The Time Event Document: Explanation: Batch Name: The …
Examples
Further examples found in the API-Engine Demo Version V1.90: Example #1: The Creation of 2 Documents in a Database and the Introduction of the Fields: FORM, SUBJECT, and BODY: DBHANDLE:=@OpenDB("TEST.NSF"); IF (@GetDataT …
FALSE
see Data Type BOOL
FUNCTIONS
As of version 2.00: Functions: A function is defined as GLOBAL or LOCAL. A GLOBAL function is not deleted from memory after the program that defined the GLOBAL function has ended, and is therefore also available to subse …
GLOBAL
GLOBAL is a special variable group that is not deleted after a processing/import has ended. This means that a variable assigned to the GLOBAL variable group remains in memory even after the process that set it has ended …
HOOK Installation
Windows: Copy NAEHOOK.DLL to the NOTES program directory Add to NOTES.INI: EXTMGR_ADDINS=NAEHOOK OS/2: Copy IAEHOOK.DLL to the NOTES program directory Add to NOTES.INI: EXTMGR_ADDINS=IAEHOOK Note : This text was machine- …
HOOK: CreateNote
HookCreateNote[GLOBAL](DBHandle;UserName;DBPath;NoteHandle;Status;*Return) Note : This text was machine-translated and may contain inaccuracies.
HOOK: DeleteNote
HookDeleteNote[GLOBAL](DBHandle;UserName;DBPath;NoteID;Flags;Status;*Return) Note : This text was machine-translated and may contain inaccuracies.
HOOK: GetPassword
HookGetPassword[GLOBAL](MaxPWLen;*AktPWLen;*Password;IDFileName;IDFileOwnerName; DataLen;Data;MaxNewData;NewDataLen;NewData;Status;*Return) Note : This text was machine-translated and may contain inaccuracies.
HOOK: OpenDBExtended
HookOpenDBExtended[GLOBAL](*DBPath;Options;UnusedHandle;*RetDBModified;*RetDBHandle;UserName; *RetDataMod;*RetNonDataMod;Status;*Return) Note : This text was machine-translated and may contain inaccuracies.
HOOK: OpenNote
HookOpenNote[GLOBAL](DBHandle;UserName;DBPath;NoteID;Options;NoteHandle;Status;*Return) Note : This text was machine-translated and may contain inaccuracies.
HOOK: OpenNoteByUNID
HookOpenNoteByUNID[GLOBAL](DBHandle;UserName;DBPath;NoteUNID;Options;NoteHandle;Status;*Return) Note : This text was machine-translated and may contain inaccuracies.
HOOK: UpdateNote
HookUpdateNote[GLOBAL](DBHandle;UserName;DBPath;Options;NoteHandle;Status;*Return) Note : This text was machine-translated and may contain inaccuracies.
HOOKs
HOOKs make it possible to intervene in certain internal processes of server tasks (Replica, Router, Server, Engine, etc.). Several things are required for this: 1. Installation of HOOK.DLL: (see Hook installation) 2. Glo …
IDF Document
An IDF Document contains an Engine Import Script program. This is the old name for an Import Script Document, but Batch Scriptsis still used in Batch Scripts and in commands (Commands), for compatibility reasons. Note : …
IENGINE.EXE / NENGINE.EXE
The Engine program files. these are contained within the NOTES PROGRAM ROOT directory. See: NOTES.INI NOTES PROGRAM ROOT NOTES DATA ROOT APICTRL.NSF APILOG PRG Document AEF Document PRC Document IDF Document Notes Server
INCLUDE
As of version 4.50 B169: Include: Syntax: INCLUDE("INCLUDE_SUB_SCRIPT"); INCLUDE can be used to include the code of an Engine Script Document in another Engine Script. Nested includes are also possible. Local DEFFN funct …
Installation of the Engine
Shut down the Notes server (Exit) on which you want to install the Engine. Add the following entries to the NOTES.INI: APILogFileName=(NAME OF YOUR API LOG FILE, e.g. SYSTEM\APILOG.NSF) APILogFileEntries=130,8000 APIKeyF …
Limits in Demo Version
Maximum of 2 open documents/views/DBs. (These open documents, views and databases also include documents, views and databases that were opened in another PRC/IDF Document or AEF Document but, for whatever reason, were no …
Limits in Lite-Version
No remote access to other servers. The keywords CALL,CALLFAST,CALLSAFE,DEFFN and DELFN are not available.
LOAPI.NSF
Old name for the Engine Control DB. Note : This text was machine-translated and may contain inaccuracies.
Local Variables
Local variables are variables specified without a variable group or NOTEHANDLE specified. Examples: Test:="ABCDEF"; Zahl:=1234; Float:=1.1212; Test, Zahl and Float are local variables. Note : This text was machine-transl …
Lotus Notes
Lotus Notes is a registered product manufactured by Lotus Development Corporation. See: Notes Server OS/2 AP IEngine
MAIN
MAIN is a special NOTEHANDLE (a special variable group) that, in an Import Script, contains the fields (variables) of the imported record. WARNING: MAIN cannot be used in @Functions that explicitly require a NOTEHANDLE a …
NOTECLASSES
The NOTECLASS of a document indicates its type. This document can be a data document, a pictogram document or an ACL document, etc. The following table displays the different NOTECLASSES. NOTECLASSES: DEC BIT Meaning …
NOTEHANDLE
A NOTEHANDLE uniquely identifies a document. It is used to address a field in a document, an entire document, or a variable group in a processing. Addressing a field in an Engine Script or Import Script program: Test[not …
NOTES-DATA-ROOT
See Lotus Notes Documentation (Administration).
NOTES-PROGRAM-ROOT
See Lotus Notes Documentation - Administration
Notes-Server
The Engine is an add-in task for a Domino server (formerly Notes server). Therefore, a Domino server is required to run the Engine. Note : This text was machine-translated and may contain inaccuracies.
NOTES.INI
The NOTES.INI is located by default in the Domino program path. When the Engine is started for the first time, all required entries are automatically added to or supplemented in the NOTES.INI as part of the installation …
NOTESPATH
Denotes a path that is interpreted relative to the NOTES-DATA-ROOT and may contain directory or database links, as well as reside on another server. Examples: TEST_SERVER!!NAMES.NSF NAMES.NSF TEST_SERVER!!HELP\APIHELP.NS …
OID
An OID is a number for a document that uniquely identifies it in the universe in one version, independently of any database. Note : This text was machine-translated and may contain inaccuracies.
OPP Document
A OPP Document is an Engine File Event Document. This is the old name for an Engine File Event Document, but it continues to be used in Batch Scripts, in commands (Commands) (as well as on the server console), for compat …