General LotusScript agent guidelines

Before getting into the details of coding agents, here are a few suggestions that apply to all agents:

• Give agents meaningful names and aliases

• Structure and document agents appropriately

• Use agent subroutines and libraries

• Harvest ideas from Designer Help

Give agents meaningful names and aliases

By now, it should be second nature to name design elements, including agents, so that future developers can grasp the essential purpose of those elements right away. For instance, the general intention of an agent named Repair Status Fields (Dev Tool) is relatively easy to understand even without looking at the code.

Since an agent can be invoked with a URL, you may want to avoid problems with spaces (and special characters) either by giving an agent a name with no spaces or by adding an alias with no spaces:

Repair Status Fields (Dev Tool) | RepairStatusFields

If permitted in Agent Properties, the primary name of an agent displays in the Notes Actions menu.

You can...