NotesAgent
Properties
| Name | Description |
|---|---|
| Comment (NotesAgent) | Read-only. The comment that describes an agent, as entered by the agent's designer. |
| CommonOwner | Read-only. The name of the person who last modified and saved an agent (the owner of the agent). If the owner has a hierarchical name, only the common… |
| HasRunSinceModified | Read-only. Indicates whether an agent has run since it was created or last modified. |
| HttpURL (NotesAgent) | Read-only. The Domino® URL of an agent when HTTP protocols are in effect. |
| IsActivatable | Read-only. Indicates whether user activation is in effect when enabling or disabling a scheduled agent. |
| IsEnabled | Read-write. Indicates whether an agent is able to run or not. |
| IsNotesAgent | Read-only. Indicates whether an agent can run in the Notes® client environment. |
| IsPublic | Read-only. Indicates whether an agent is shared or private. |
| IsWebAgent | Read-only. Indicates whether an agent can run in a Web browser environment. |
| LastRun (NotesAgent) | Read-only. The date that an agent last ran. |
| LockHolders (NotesAgent) | Read-only. The names of the holders of a lock. |
| Name (NotesAgent) | Read-only. The name of an agent. Within a database, the name of an agent may not be unique. |
| NotesURL (NotesAgent) | Read-only. The Domino® URL of an agent when Notes® protocols are in effect. |
| OnBehalfOf | Read-only. Name of the user under whose identity the agent runs. |
| Owner | Read-only. The name of the person who last modified and saved an agent (the owner of the agent). |
| ParameterDocID | Read-only. Returns the note ID of a document passed to the agent by Run or RunOnServer. |
| Parent (NotesAgent) | Read-only. The database that contains an agent. |
| ProhibitDesignUpdate | Read-write. Indicates whether an agent is updated when the application design is refreshed or replaced. |
| Query (NotesAgent) | Read-only. The text of the query used by an agent to select documents. For information about selecting documents in an agent, see "Creating an agent." |
| ServerName (NotesAgent) | Read-write. The name of the server on which an agent is set to run. This is a property of the design element, not of the current run of the agent. |
| Target (NotesAgent) | Read-only. Indicates which documents on which this agent acts. |
| Trigger | Read-only. Indicates when this agent runs. |
Methods
| Name | Description |
|---|---|
| GetPerformanceDocument | Returns the latest profiling results for an agent. |
| Lock (NotesAgent) | Locks an agent. |
| LockProvisional (NotesAgent) | Locks an agent provisionally. |
| Remove (NotesAgent) | Permanently deletes an agent from a database. |
| Run | Runs the agent. |
| RunOnServer | Runs the agent on the computer containing the database. |
| Save (NotesAgent) | Saves the agent. |
| UnLock (NotesAgent) | Unlocks an agent. |
Examples
| Name | Description |
|---|---|
| Examples: Comment property (NotesAgent) | 1. This script gets the comment for the agent that's currently running. For example, if this script were part of the "Archive" agent, the Comment… |
| Examples: IsActivatable property | This agent checks the activatable status of an agent. |
| Examples: IsEnabled property | This agent toggles IsEnabled for the "Sort incoming mail" agent. |
| Examples: IsPublic property | This script counts the number of shared and private agents in the current database. |
| Examples: LastRun property (NotesAgent) | 1. This script gets the date that the current agent was last run. For example, if the agent last ran on August 15, 1996 at 11:09:20 AM, the LastRun… |
| Examples: Lock method (NotesAgent) | This view action attempts to lock the agent named "Main Agent" for all members of the "Guys" group. Locking is successful if the agent is not yet locked,… |
| Examples: LockHolders property (NotesAgent) | This view agent displays the lock holders for the agent named "Main Agent." |
| Examples: LockProvisional method (NotesAgent) | This view action attempts to lock the agent named "Main Agent" for all members of the "Guys" group. Locking is successful if the agent is not yet locked,… |
| Examples: Name property (NotesAgent) | This script gets the name of the current agent. For example, if this script is a part of the Token agent, the Name property returns "Token." |
| Examples: OnBehalfOf property | This agent sends mail with ownership and user information, including on whose behalf the agent runs. |
| Examples: Parent property (NotesAgent) | This script gets the parent database of the current agent. For example, if this agent is running in the database WHOAMI.NSF, then the db object… |
| Examples: Query property (NotesAgent) | This script gets the query for the Cleansing Agent in the current database and puts it into the variable selection. |
| Examples: Remove method (NotesAgent) | 1. This script removes the CalculateTotals agent from the current database. |
| Examples: ServerName property (NotesAgent) | This script gets the name of the server that the current agent is running on. For example, if this agent is scheduled to run once a week on the server… |