Read-write. Indicates whether an agent is able to run or not.

Defined in

NotesAgent

Data type

Boolean

Syntax

To get: flag = notesAgent.IsEnabled

To set: notesAgent.IsEnabled = flag

Legal values

• True indicates that the agent can run.
• False indicates that the agent cannot run.

This property, intended for use with scheduled agents, always returns True for hidden agents and agents run from a menu.

If you change the run status in an agent, you must call Save to commit the change. You must have the appropriate access privileges to both the database and to the agent.

Access privileges and agent signing depend on whether user or designer activation is in effect. See IsActivatable.

Language cross-reference

IsEnabled in Java Agent class

@IsAgentEnabled function in formula language

AgentEnableDisable @command in formula language

Example
See Also

Accessing agents

Glossary