Skip to content

Notes agent

A Notes agent is a piece of code in a Notes database that runs automatically at a set time, on an event or on the user's command, typically written in LotusScript.

A Notes agent is a piece of code in a Notes database that runs automatically. It can start at a set time, when a document is created or changed, when mail arrives, or when a user presses a button. Agents are the engine behind automation in HCL Notes.

Types of agents

  • Scheduled agents run every minute, hourly, daily or weekly on the Domino server. Typically for reports, clean up, synchronisation and reminders.
  • Event agents run when documents are created or changed, or when new mail arrives. Used for workflows and automatic replies.
  • Manual agents are started by the user from a menu or button, for example export to Excel or bulk updates.
  • Web agents are called over HTTP and used as simple APIs, today mostly replaced by Domino REST API.

What are agents written in?

Most are written in LotusScript. Simple agents use the formula language, and some are written in Java. Agents are built in Domino Designer and run with the rights of a particular user, typically the server or whoever last saved the agent. That is a classic security pitfall, because an agent saved by an administrator runs with the administrator's access.

Typical problems with agents

  • The agent does not run, because the person who saved it has left the company and their ID is blocked.
  • The agent manager is overloaded, because too many agents run every minute.
  • The agent sends mail, and mail has moved to Microsoft 365. See Notes migration.
  • Nobody knows what the agent does, because the code is undocumented. We are happy to do a review.

Common questions

How do I see which agents are running?

The server command tell amgr schedule shows scheduled agents. The log shows errors. We set up monitoring, so failing agents raise an alert.

Can an agent call an external API?

Yes. LotusScript can call HTTP endpoints and read JSON. That is how ChatGPT integration for Notes is built.

What replaces agents after migration?

Power Automate, Azure Functions or scheduled jobs in the new system.

Help with agents

We troubleshoot, document and rewrite agents. Read about Notes development.

All terms in the glossary