ToolsRunMacro @Command (Formula Language)

Executes a specified agent.

Syntax

@Command( [ToolsRunMacro] ; agent )

Parameters

agent

Text. Optional. The name of the agent you want to run.

If you omit the agent name, Notes® displays a list of Agents in the database, where the user can select which agent to run.

Usage

This command executes after all @functions. Use @Command([RunAgent]) to execute immediately. See the "Order of evaluation for formula statements" topic for more details.

When specifying a hidden agent, include the parentheses as shown.

@Command([ToolsRunMacro];"(hiddenagentname)")

You can use this command in Web applications.

Examples

This formula runs the agent named "PurgeObsoleteRecords."
@Command([ToolsRunMacro];"PurgeObsoleteRecords")