Read-write. The name of the server on which an agent runs.

Defined in

NotesAgent

Data type

String

Syntax

To get: server$ = notesAgent.ServerName

To set: notesAgent.ServerName = server$

Usage

The value of the ServerName property depends upon whether or not the agent is scheduled. For information about scheduling agents, see "Triggering an agent on a schedule."

• If the agent is scheduled, the property returns the name of the server that the scheduled agent runs on. Since scheduled agents can only run on a single replica of a database, you designate a server name for the agent in the Agent Properties box. Therefore, the ServerName property may represent the parent database server, or it may represent a replica server.
• If the agent is not scheduled, this property returns an empty string.

If you want the agent to run on all servers, use an asterisk (*) for the server name.

Language cross-reference

ServerName in Java Agent class

ToolsCall @command in formula language

Example
See Also

Accessing agents

Glossary