Creating agents

You can create a basic agent in an application to help you automate tasks.

About this task

To create an agent, you must first open the application and then click Create > Agent. HCL Notes® displays the Agent Properties box and opens the Programmer's pane.


  1. In the Agent Properties box, click the Basics tab, and then enter a name for the agent in the Name field.
  2. Optional: Enter a comment in the Comment field. Comments appear in the agents list.
  3. Select Shared if this agent will be used by other users. Select Private if you want the agent to be an agent that only you can run.

    You have the option of converting a private agent to a shared agent or a shared agent to a private agent.

  4. If the agent will search for text in documents, you can specify the following settings in the Options section:
    • 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.
  5. Optional: To run agents that do not appear in the user interface, select Run in background client thread.
  6. In the Runtime section of the properties box, choose one of the following triggers for the agent. Different options appear depending on the trigger you choose.
    • Select On event, and then select the event which triggers the agent.
    • Select On schedule, and then schedule the time the agent triggers.
      Note: Depending on the trigger you choose, you may need to select which documents the agent runs on in the Target field.
  7. Click the Security tab of the Agent Properties box to set up security for the agent.
  8. Close the Agent properties box after you have completed the necessary fields.
  9. In the Programmer's pane, click Add Action to open the Add Action dialog box and specify a simple action for the agent to perform. (Choose actions in the order you want them to run.)
  10. If you want the agent to search for a document, select the Objects tab and then Document Selection. Click the Add Condition button to display the Add Condition dialog box and set up search conditions.
  11. Click File > Save to save the agent in the application.