Before you begin, plan your agent carefully. For example, decide what type of agent you want (simple action, formula, LotusScript, imported Java, or Java), what it will act upon, where it will run, how it will be invoked, whether it will perform restricted or unrestricted operations, and under whose ID it should run (run on behalf of).

1. In the Applications Navigator, double-click Agents under Code. Click New Agent. Alternatively you can choose Create - Design - Agent.

2. In the New Agent dialog box, enter a name for the agent and optionally the name of the application.

Note that names and aliases should be unique within an application. (Agents that call other agents look for the first instance of a name and will attempt to run that agent. If more than one agent has the same name, you may run into problems.)

4. Optionally, enter a comment in the Comment field. The comment appears when you view the list of agents.

5. Click Shared if this agent will be used by other users. A shared agent is one that other users have access to. Note that ownership of a shared agent can be reassigned to another user who saves or re-signs the agent.

Click Private if you want the agent to be an agent that only you can run. In IBMR LotusR NotesR, private agent are not available on the Actions menu. In Domino Designer, anyone with Designer level access or higher can see and run a private agent.

Beginning with Lotus Domino Designer 6, you have the option of converting a private agent to a shared agent or a shared agent to a private agent.

• Check "Store search in search bar menu" to display your search query in the search bar.
• Check "Store highlights in document" so that your search matches are highlighted in the searched documents.

Note that you should check this option only if the agent (or the top-level agent that calls this agent) is triggered by "On event - Action menu selection."

To get the full benefit of this feature, the database should reside on a server and the agent must be invoked via the client.

If you check this box and the agent references front end classes, the user receives a run-time error.

• On event - see the topic "Triggering an agent on an event" for more information on the event options.
• On schedule - see the topic "Triggering an agent on a schedule" for more information on the schedule options.

10. Close the Agent Properties box after you have filled in the necessary fields.

11. From the Run list in the Programmer's pane, choose one of the following to define the agentfs automated components:

• Simple actions

If you choose Simple actions, click the "Add Action" button to add a simple action.
• Formula
• LotusScript
• Java
• Imported Java

Note that this way of creating a search replaces the Search button found in earlier versions of Designer.

Note that the agent is being saved and signed with your current ID.

For additional information on using the Enable, Disable, and Sign buttons, see Useful agent procedures.

For additional information on agent security, see Security for agents on servers and the Web.

For troubleshooting information, see Troubleshooting agents.

Example
See Also

Adding automation to applications
Agents
Triggering an agent on an event
Triggering an agent on a schedule
Security for agents on servers and the Web
Setting up agent security using the Security tab
Troubleshooting agents
Actions and agents names

Glossary