9 66 DOM_EXECUTE_AGENT

9.66 DOM_EXECUTE_AGENT

Þ Note: Built-In Function Rules.

Executes an Agent . The Note ID of the specified agent will be obtained  and the Agent will be then be opened and an Agent runtime context will be created before running the Agent.

Agents are design notes that perform custom operations on documents in a database. Agents usually contain formulas that select which documents to process, and calculate values to store in the documents. You may execute any agent that does not depend on Notes user interface functionality.

For use with

LANSA for i YES Visual LANSA for Windows YES Visual LANSA for Linux NO

 

Arguments

No Type Req/ Opt Description Min Len Max Len Min Dec Max Dec 1 A Req Database handle 4 4     2 A Req Agent name 1 128

 

Return Values

No Type Req/ Opt Description Min Len Max Len Min Dec Max Dec 1 A Req Return code OK = Agent ran successfully. ER = Agent did not run successfully. 2 2

 

Example

Refer to these Domino Built-In Function Examples:

Example 3: Executing an Agent in a Database

Technical Notes

This Built-In Function uses the standard Lotus Notes APIs NIFFindDesignNote, NIFFindPrivateDesignNote, AgentOpen, AgentCreateRunContext, AgentRedirectStdout, AgentRun, AgentDestroyRunContext and AgentClose. All security and integrity issues related to the use of this Built-In Function are according to normal Lotus Notes API use for the current platform.