Engine Help: E
Filtered overview of the Engine Help documentation.
@Elements
Returns the number of elements of FNLIST/TEXTLIST/TDLIST/IDLIST FNLIST1/TEXTLIST1/TDLIST1/IDLIST. If no list is passed to the @Function as an argument, the @Function result is 1.
@EngineDown
Terminates the APIEngine task on the server.
@Environment
Returns the value of the environment variable TEXT/TEXTLIST TEXT1/TEXTLIST1.
@Execute
Starts an OS/2 EXE program OSPATH OSPATH1 with the parameters TEXT TEXT2 in mode FN MODE3 as a child process of the API Engine. MODE3: 0 = Starts the child process and continues the API Engine program in parallel. 1 = St …
@ExecuteAgent
This @Function executes the agent with the AGENTHANDLE AGENTHANDLE1 either against all documents (without the parameter NOTEHANDLE NOTEHANDLE3) of the DB in which the agent is located, or against a single document, with …
@ExpandGroups
In TEXT/TEXTLIST TEXT1/TEXTLIST1, all specified group names are replaced by their members. Unknown group names are retained, and the resulting list is returned as the @Function result. TEXTLIST TEXTLIST2 additionally ret …
@Explode
Splits the TEXT/TEXTLIST TEXT1/TEXTLIST1 into a TEXTLIST. At each occurrence of a space, the TEXT1 or each element of TEXTLIST1 is separated and made into its own element. TEXT SEPTEXT2 can be used to specify a different …
@ExtractOSFileFromNote
Copies one or more file attachments, whose names or positions (see @AttachmentInfo) in TEXT/TEXTLIST/FN/FNLIST TEXT1/TEXTLIST1/FN1/FNLIST1 are specified, from the document with the NOTEHANDLE NOTEHANDLE1 as files to a dr …
ENCRYPT IDF
ENCRYPT IDF encrypts the IDF document idf_file and creates a new IDF document, new_idf_file, which contains the encrypted information. The comment field can contain info about encrypted servers. Only encrypted IDF docume …
ENCRYPT PRC
ENCRYPT PRC encrypts the PRC document prc_file and creates a new PRC document, new_prc_file, which contains the encrypted information. The comment field can contain info about encrypted servers. Only encrypted PRC docume …
END
END marks the end of an AEF program.
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 …