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 program is executed.

TEXT/RT PrcFile
An executable PRC program / the PRC program is executed.

TEXT PrcFileRT
"1" / This field must be specified if the PrcFile field is of data type RT . Otherwise, it must not be specified.

TEXT PostExe
"1" / If this field is specified this way in a document, after execution it is only set to DONE but not deleted. Otherwise, a document is deleted after it has been executed.
(see APIJobDBJobDel)

TEXT ExeDone
"1" / If this field is specified this way in a document, it is no longer considered by the APIEngine .

TEXT ExeDoneFirst
"1" / If this field is present in a document, the field ExeDone (if required by other conditions) is set at the beginning of execution, and the document is no longer modified after execution.

TEXT Sort
Any TEXT / sorting is performed by this field. This means that this field can be used to control the processing order of the documents when several documents are present.

TEXT Requestor
Contains the name of the initiator of this document. / If a NOTES.INI entry APIJobDBAllow is specified, a document is executed only if the name in the Requestor field occurs in the group specified under APIJobDBAllow.
(see APIJobDBAllow)

Instead of AefName, a Subject field (data type TEXT) can also be used whose content
begins with "AN:" and is immediately followed by the name of the AEF document in the control database.

Instead of PrcName, a Subject field (data type TEXT) can also be used whose content
begins with "PN:" and is immediately followed by the name of the PRC document in the control database.

Additional Subject (data type TEXT) functions (V2.99b):

"SV:" sets a global variable.
Example:
"SV:Name:=Content"
Sets a global variable with the name Name and the content Content.

"SF:" sets global variables.
After "SF:", the name of the field (data type TEXT/TEXTLIST) is specified
that contains the field names of the fields in the ApiJob document that are to be set as global
variables.
Example:
"SV:Fields"
Fields contains "Field1":"Field2" for this example.
The content of Field1 is "Content1" for this example.
The content of Field2 is "Content2" for this example.
A global variable with the name Field1 and the content Content1 is set, and
and a global variable with the name Field2 and the content Content2 is set.

Note : This text was machine-translated and may contain inaccuracies.