Event Document
Description
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 name of the Engine Batch Document to be executed is specified here.
Only Engine Batch Documents can be started. To start an Engine Script Document, an Engine Batch Document must be started that contains a PROCESS command with a reference to the Engine Script Document.
Batch Name (Error):
The name of the Engine Batch Document to be executed in case of an error is specified here.
Only Engine Batch Documents can be started. To start an Engine Script Document, an Engine Batch Document must be started that contains a PROCESS command with a reference to the Engine Script Document.
Category:
The category under which this document should be found again is specified here.
At Server:
The Notes server (with Engine) on which this Event Document is valid is specified here (this is the executing server).
On Break:
If an Event Document is not terminated properly due to a server crash or another event, when the server is restarted it is
START AGAIN added back to the list of Event Document to be executed.
OFF not added back to the list of Event Document to be executed (Status:ABORTED)
On/Off:
This Event Document is active (ON) or inactive (OFF).
Start date&time:
The point in time from which this Time Event should be executed.
For Mode: INTERVAL the next execution time is calculated from this point in interval steps.
End date&time:
If an end time is specified, the Time Event Document loses its validity from that point and changes to Status:DONE.
Interval: min
For Mode: INTERVAL the interval in minutes is specified here.
For 0 minutes, the interval is 24 hours.
Status:
The status of the Event Document is displayed here.
ABORTED The Event Document was removed from the
task list because it did not terminate properly.
DONE The Event Document has been executed and has now been removed from the task list.
QUEUED The Event Document is queued for execution.
UNQUEUED The Event Document has been disabled.
RUNNING The Event Document is currently being executed.
DOWN The executing Engine has been shut down.
NEW The Event Document has been newly created and has not yet been registered by the Engine.
MODIFIED The Event Document has been modified and has not yet been registered by the Engine.
Comment:
Any comment.
Update History:
Who modified this document and when.
To set an Event Document back to start (for Mode: INTERVAL), it is sufficient to open this
Event Document with CTRL+B and then press the following keys (in this
order): F9 ESC Return.
The File Event Document:
Explanation:
Batch Name:
The name of the Engine Batch Document to be executed is specified here.
Only Engine Batch Documents can be started. To start an Engine Script Document, an Engine Batch Document must be started that contains a PROCESS command with a reference to the Engine Script Document.
Batch Name (Error):
The name of the Engine Batch Document to be executed in case of an error is specified here.
Only Engine Batch Documents can be started. To start an Engine Script Document, an Engine Batch Document must be started that contains a PROCESS command with a reference to the Engine Script Document.
Category:
The category under which this document should be found again is specified here.
At Server:
The Notes server (with Engine) on which this Event Document is valid is specified here (this is the executing server).
On Break:
If an Event Document is not terminated properly due to a server crash or another event, when the server is restarted it is
START AGAIN added back to the list of Event Document to be executed.
OFF not added back to the list of Event Document to be executed (Status:ABORTED)
OS File (Pattern):
The search pattern that the Engine uses to detect the occurrence of the event specified here is defined here.
Therefore, when a file matching this pattern is found, the associated BATCH document is started.
The respective script should ensure that, after it has run, the search pattern is not matched again by the same file; otherwise, the event will be executed again.
Start delay:
An execution delay in seconds (X) can be specified here.
The associated BATCH is therefore executed only X seconds after the event is actually triggered.
On/Off:
This Event Document is active (ON) or inactive (OFF).
Status:
The status of the Event Document is displayed here.
ABORTED The Event Document was removed from the
task list because it did not terminate properly.
DONE The Event Document has been executed and has now been removed from the task list.
QUEUED The Event Document is queued for execution.
UNQUEUED The Event Document has been disabled.
RUNNING The Event Document is currently being executed.
DOWN The executing Engine has been shut down.
NEW The Event Document has been newly created and has not yet been registered by the Engine.
MODIFIED The Event Document has been modified and has not yet been registered by the Engine.
Comment:
Any comment.
Update History:
Who modified this document and when.
The Database Event Document:
Explanation:
Batch Name:
The name of the Engine Batch Document to be executed is specified here.
Only Engine Batch Documents can be started. To start an Engine Script Document, an Engine Batch Document must be started that contains a PROCESS command with a reference to the Engine Script Document.
Batch Name (Error):
The name of the Engine Batch Document to be executed in case of an error is specified here.
Only Engine Batch Documents can be started. To start an Engine Script Document, an Engine Batch Document must be started that contains a PROCESS command with a reference to the Engine Script Document.
Category:
The category under which this document should be found again is specified here.
At Server:
The Notes server (with Engine) on which this Event Document is valid is specified here (this is the executing server).
On Break:
If an Event Document is not terminated properly due to a server crash or another event, when the server is restarted it is
START AGAIN added back to the list of Event Document to be executed.
OFF not added back to the list of Event Document to be executed (Status:ABORTED)
Database:
The database that should serve as the event trigger is specified here.
When the modified date of this database changes, the event is triggered and the associated BATCH is executed.
Start delay:
An execution delay in seconds (X) can be specified here.
The associated BATCH is therefore executed only X seconds after the event is actually triggered.
On/Off:
This Event Document is active (ON) or inactive (OFF).
Status:
The status of the Event Document is displayed here.
ABORTED The Event Document was removed from the
task list because it did not terminate properly.
DONE The Event Document has been executed and has now been removed from the task list.
QUEUED The Event Document is queued for execution.
UNQUEUED The Event Document has been disabled.
RUNNING The Event Document is currently being executed.
DOWN The executing Engine has been shut down.
NEW The Event Document has been newly created and has not yet been registered by the Engine.
MODIFIED The Event Document has been modified and has not yet been registered by the Engine.
Comment:
Any comment.
Update History:
Who modified this document and when.
Note : This text was machine-translated and may contain inaccuracies.