Running agents in the Notes® client

You can call an agent from an XPage. On Domino® Server, security is based on the Agent security properties set for the agent. On the Notes® Client, security is based on the client ECL settings for the signer of the agent.

The following NotesAgent methods of the JavaScript Domino® library are supported:

NotesAgent.run() : void
NotesAgent.run(noteID:string) : void
Runs the agent on the computer running the current XPages application in the Notes® client, optionally passing the note ID of a document to the ParameterDocID property of the called agent. This value can be accessed, for example, in a Java agent, by calling the Agent.getParameterDocID() method.
NotesAgent.runWithDocumentContext(doc:NotesDocument) : void
NotesAgent.runWithDocumentContext(doc:NotesDocument, noteID:string) : void
Runs the agent on the computer running the current XPages application in the Notes® client, passing a saved or unsaved in-memory document to the DocumentContext property of the called agent. This value can be accessed, for example, in a Java agent, by calling the AgentContext.getDocumentContext() method. The document can be updated in the agent and when control returns to the XPage, the updated values can be read from the document. The noteIDnoteID parameter is the same as for run.
NotesAgent.runOnServer() : int
NotesAgent.runOnServer(noteID:string) : int
Runs the agent on the computer containing the application returning the status of the operation where 0 indicates success. The noteID parameter is the same as for run.