Useful agent procedures

To view a list of agents

Procedure

  1. In the Applications Navigator, double-click Agents under Code.
  2. A list of agents appears in the Work pane.

Results

When you view a list of agents in the Work pane, an icon may appear next to the name of a scheduled agent. The icons are:

  • Check mark with a 6 next to it - the scheduled agent is enabled and runs only on Domino® 6 or later (or on Notes/Domino R5.08 or later).
  • Check mark with a 5 next to it - the scheduled agent is disabled for Domino® release 5.08 or later, but will be considered enabled on Notes® Domino® R5.07 or earlier which does not recognize this functionality.
  • Check mark - the scheduled agent is enabled and runs on any version of Notes®.
  • A yellow X - the scheduled agent is disabled.

The list of agents also gives you important information about each agent. You can easily view such information as the agent name, its alias, trigger, modification date, the person who modified it last, and whether the agent works in Notes® and on the Web.

To copy an agent

Procedure

  1. In the Applications Navigator, double-click Agents under Code.
  2. Select the agent.
  3. Choose Edit - Copy.

To delete an agent

Procedure

  1. In the Applications Navigator, double-click Agents under Code.
  2. Select the agent.
  3. Choose Edit - Cut.

To select multiple agents

Procedure

  1. In the Applications Navigator, double-click Agents under Code.
  2. Click the first agent and do one of the following:
    • Press CTRL and hold while you click the next agent.
    • If selecting more than two agents, press CTRL while you click the next agent.
    • To select a range of consecutive agents, press SHIFT while you select the first and last agent in the range.

Results

If you have Designer access or higher, you can disable shared scheduled agents to prevent servers from running them. This is useful for debugging a problem with an agent. Designers can still run disabled agents by choosing View - Agents, selecting an agent, and choosing Actions - Run. After you re-enable them, scheduled agents resume their schedule.

To disable individual agents

Procedure

  1. In the Applications Navigator, double-click Agents under Code.
  2. Select the agent and click the Disable button. Note that the agent is re-signed.

    The check mark icon next to the agent name disappears and an X icon appears in its place.

To disable all agents in a database

Procedure

  1. In the Applications Navigator, double-click Application Properties.
  2. On the Basics tab, check "Disable background agents for this database."

Results

Note: If you disable agents through the Database Properties box, the agents are not re-signed and the Enable/Disable state of each agent is not changed. Unchecking this box does not necessarily enable all agents. It only allows those already enabled to run.

To enable a disabled agent

Procedure

  1. In the Applications Navigator, double-click Agents under Code.
  2. Select the disabled agent.
  3. Click Enable.

    The X icon disappears and a check mark icon appears next to the name of the agent. Note that the agent is re-signed.

Results

By default, Web agents run under the identity of the agent author (the person who saved the agent). To run agents under the identity of the Web user, double click the name of the agent in the Work pane. On the Security tab of the Agent Properties box, check "Run as Web user."

To sign an agent

Procedure

  1. In the Applications Navigator, double-click Agents under Code.
  2. Click Sign.