Engine Help: Text
Filtered overview of the Engine Help documentation.
***UNIVERSAL***
If, in an Event document, the server ***UNIVERSAL*** is specified, this program runs on every server regardless of the server name. ATTENTION: A new or modified Event document may not be registered on another server in t …
AEF-Document
An AEF Document contains an Engine Batch Script program. This is the old name for an Engine Batch document, but it is still used in batch scripts and commands for compatibility reasons. Example image of an AEF Document: …
APIAddEngineToServerTasks
Entry in Notes.ini. This entry determines whether the Engine task name should be added to the Notes.ini entry ServerTasks. 0 = Do not add 1 = Add when the Engine is started for the first time 2 = Add each time the Engine …
APIAELicenseID
The entry in the NOTES.INI which contains the License ID created by @CrtAELicID. Only in the BETA-Version of the V1.90. Not valid from Release V1.90 on.
APICacheLogReport
Entry in the Notes.ini. When 1 is entered the API Log statements are buffered. Default:0.
APICompilerMaxIncludeDepth
Entry in NOTES.INI. This specifies the maximum nesting depth for INCLUDE (compiler keyword). Default:10.
APIConsoleReport
Entry in Notes.ini. If 1 is specified here, APILog statements are also output to the console; otherwise, only errors and the starting of new tasks are displayed. Default:1.
APIControlDB
Entry in the NOTES.INI. The Notes path of the APICTRL-DB (The Control Database of the APIEngine) on the server is entered here. This entry is required when APINoEngineINI=1.
APICreateTemplateAPIControlDB
Entry in NOTES.INI. This entry defines whether a template should be created from the APIControlDB when the Engine is booted (=1 default), or not (=0).
APICryptPreference
Entry in Notes.ini. If both an encrypted (crypted) PRC/IDF and an unencrypted PRC/IDF exist under the same name, this entry determines which PRC/IDF should be preferred. 0 = prefer unencrypted PRC/IDF. 1 = prefer encrypt …
APICTRL.NSF
The APICTRL.NSF is the Engine control database. The following documents: Event document Script document Import Script Document Batch document Specify to the Engine what should run when and where. WARNING: Any change to t …
APIDelayedMailAdr
Entry in the NOTES.INI. Specifies the default Delayed Tasks (PRG/OPP/DBP) warning mail address. If no address is specified, which is the default, no mail is sent. Default: No mail address.
APIDoSchedulerTasksInterval
Entry in the Notes.ini. Specifies the interval, in seconds, at which various scheduler tasks (OPP/DBP...) are executed. Default:10 (sec).
APIELReinitInterval
Entry in the Notes.ini. The interval for the initialisation of the API Control Database is entered here in seconds. (This only applies to ***UNIVERSAL*** PRG/DBP documents.) Default:21600 (=6 hours).
APIELUpdateInterval
Entry in the Notes.ini. The interval in which the API Control DB is searched, is entered in seconds here. Default:30.
APIFunctionDLLs
Entry in the Notes.ini. The DLLs in which the @Functions are entered are defined here. The first character of DLL's name identifies the platform: $=OS/2 16Bit I=OS/2 32Bit N=Windows 32Bit Default:$AEFUN1. (Example for OS …
APIHierarchicalNames
Entry in the Notes.ini. If 1 is entered the [CN] of the server is only noted and no @Uppercase is run. Default:0.
APIIDDisplayInfo
Entry in the Notes.ini. ID-Info Display Flags. 2 Show extended information (ID number/date/flags); 4 Show the ID mode in each API log entry; (To combine multiple flags, the values must be added). Default:1.
APIInitCtrlDocCache
Entry in the Notes.ini. Defines whether PRC, IDF, and AEF documents are stored as references on a VSTACK when the Engine starts. If one of these documents is required, a reference to this document is automatically create …
APIIsAliveInterval
Entry in Notes.ini. Number of seconds between two updates of the APIIsAlive entry. This variable in Notes.ini allows remote control of whether the Engine task is running correctly. Default:900.
APIJOB System Fields
TEXT AefName The title of an AEF document in APICTRL.NSF / this document is started. TEXT PrcName The title of a PRC document in APICTRL.NSF / this document is started. TEXT/RT AefFile An executable AEF program / the AEF …
APIJobDB
Entry in the NOTES.INI. The Notes path for the APIJOB DB on the server is given here.
APIJobDBAllow
OBSOLETE !!! SEE MailInAllow... Entry in the NOTES.INI. The groups in the server's address book which contain members who are supposed to have the rights to carry out program-Starts using Dokument-Mail-In in the APIJOB-D …
APIJobDBJobDel
Entry in the NOTES.INI. This confirms whether a document in the APIJOB-DB which is sent after execution should be generally deleted (1) or assigned "DONE" (2). Examples: APIJobDBJobDel=1 (always delete) APIJobDBJobDel=2 …
APIKeyFileName
Entry in the NOTES.INI. The path of the server's APIEngine ID is entered here.
APILOG
The API-Log is a database in the API-Engine that records and reports user activities. All exported data using the @LogReport, etc. are arranged in a lower order in the API-Log. The API-Engine Starting and Ending Reports …
APILogDailyCompactTime
Entry in NOTES.INI. Specifies the time of day (24-hour format with ":" as the separator) at which the APILog is to be compacted every day. If no compaction should take place, no time is specified. (APILogDailyCompactTime …
APILogDefaultStyleColor
Entry in NOTES.INI. Specifies the default font color for LogReport lines. Default:0 (black) Font colors: 0 Black 1 White 2 Red 3 Light green 4 Blue 5 Magenta 6 Yellow 7 Cyan 8 Brown 9 Dark green 10 …
APILogDefaultStyleFont
Entry in NOTES.INI. Specifies the default font for LogReport lines. Default:4 (Courier) Fonts: 0 Times Roman 1 Helvetica 4 Courier Example (for the default size): APILogDefaultStyleFont=4 Note : This text was machi …
APILogDefaultStyleOptions
Entry in the NOTES.INI. This setting defines the default font style options for LogReport lines. Default:0 (normal) Options (add values to combine): 0 Normal 1 Bold 2 Italic 4 Underlined 8 Strikethrough 16 Su …
APILogDefaultStyleSize
Entry in the NOTES.INI. This setting defines the default font size for LogReport lines. Default:10 Font size: 0-255 Example (for the default size): APILogDefaultStyleSize=10 Note : This text was machine-translated and ma …
APILogFileEntries
Entry in the NOTES.INI. The maximum number and size in bytes of the entries are included in an APILOG entry. Default:130 entries e.g. 8000 Bytes Example (for the default sizes:
APILogFileName
Entry in the NOTES.INI. This setting defines the name of the APILOG file. Default:apilog.nsf.
APILogFilePurge
Entry in the NOTES.INI. This determines when the APILOG entries ahould be deleted - after how many days. The default is 10.
APILogMaxLineBreak
Entry in the NOTES.INI. This setting defines the maximum number of characters per LogReport line. Default:265 Example (for the default size):
APILogPurgeOnCompact
Entry in the NOTES.INI. This setting specifies whether deletion stubs are to be removed before compacting the APILOG. 1 = Remove 0 = Do not remove. Default:1.
APILogTmpFileName
Entry in the NOTES.INI. This specifies the name of the temporary APILOG file (used while compacting the APILog is used). Default: tmpalog.nsf.
APIMailInAllowAEFFile
Entry in the Notes.ini. Determines whether AEF file mails received in the APIJOB.NSF are executed. 0 = Do not execute 1 = Execute GroupName = Execute if the mail is signed (valid and verified) and the signer …
APIMailInAllowAEFName
Entry in the Notes.ini. Determines whether AEF name mails received in the APIJOB.NSF are executed. 0 = Do not execute 1 = Execute GroupName = Execute if the mail is signed (valid and verified) and the signer …
APIMailInAllowPRCFile
Entry in the Notes.ini. Determines whether PRC file mails received in the APIJOB.NSF are executed. 0 = Do not execute 1 = Execute GroupName = Execute if the mail is signed (valid and verified) and the signer …
APIMailInAllowPRCName
Entry in the Notes.ini. Determines whether PRC name mails received in the APIJOB.NSF are executed. 0 = Do not execute 1 = Execute GroupName = Execute if the mail is signed (valid and verified) and the signer …
APIMailInErrorMailAdr
Entry in the NOTES.INI. This specifies the MailIn error mail address. Default: APIMailInErrorMessages.
APIMaxTasks
Entry in the NOTES.INI. Maximum number of Engine tasks that may run at the same time. Default: 0.
APIMissingSysViewMailAdr
Entry in the NOTES.INI. This specifies the default missing-system-view warning mail address. If no address is specified (default), no mail is sent. Default: No Mail Address.
APINoEngineINI
Entry in the NOTES.INI. This is used to determine whether a tloapi1.ini is to be taken into account berücksichtigt If the entry is 1, tloapi1.ini is ignored. If the entry is 0, tloapi1.ini is examined or taken into accou …
APINotesServerVersion
Entry in the NOTES.INI. This entry is required only if the Notes server version cannot be determined automatically (for example, if the Engine is operated as a ClientEngine). It then defines the Notes server version to u …
APIOpenDBOptionsCloseSession
Entry in the NOTES.INI. This can be used to define a default value for the Close Session on Error option for @OpenDB and @MainDatabase when a Version parameter is used. 0= Close Session on Error is not performed (defau …
APIOpenDBOptionsClusterFailover
Entry in the NOTES.INI. For @OpenDB and @MainDatabase, a default value for the Cluster Failover option can be specified here for the Version parameter. 0= No cluster failover is performed (default) 1= The DB is first …
APIReinitInterval
Entry in the Notes.ini. This entry specifies the interval, in seconds, at which the Universal PRG documents are internally synchronized with the APICTRL.NSF. Default:21600.
APIRestartDelay
Entry in the Notes.ini. When the Engine is restarted, startup waits for the number of seconds specified by APIRestartDelay. If 0 is specified, the restart function is disabled. Default:10.