Runs a specified back-end agent on the server. You can specify agents that run on the server, such as agents that send mail or create a folder. You cannot specify an agent that displays information in the browser to the user. For example, you cannot run an agent that contains a LotusScript print statement using this tag. If you want to capture data using this tag to run an agent, you must write the agent's results to a document and access the document to recover the data.

To use this tag to run an agent, set up the basics tab of the Agent Properties box for the agent as follows:

1. In the Trigger section, select the On event radio button.

2. Choose Action menu selection in the drop-down box.

3. In the Target drop-down box, choose None.

Contexts

Valid in:

None required; db, session

<domino:runagent
name="agent name"
dbname="database name"
dbserver="server name"
user="login information"
password="password for user"
host="name of CORBA server"
unid="universal id of document to pass to agent"
debug="true|false"
onfailure="inline|exception"
time="true|false">

dbname

Name of the database containing the agent. Optional.

Name of the server hosting the database. Optional.

Name of the Domino CORBA (Common Object Request Broker Architecture) server to use to host the back-end classes. If specified, forces a CORBA session. If not specified, all the tags check for the existence of this environment property to initialize the session; a Domino server must be running locally on the same machine that is running the JSP Web container. Default is null which creates a local, non-CORBA, session. Optional.

Name of the agent to run. Required.

Password associated with the specified user. Optional.

Universal id of a document that is passed to the agent run command to provide a document context for the agent. If not specified and used within the context of a document tag, the current document is provided to the agent. Otherwise, no document is provided to the agent. You can retrieve the document ID of the passed document using the Agent.getParameterDocID() method. You can then retrieve documents using the Database.getDocumentByID() method. Optional.

Login information for the session. In the context of a session tag, this attribute is ignored. Optional.

Example
See Also

The Domtags tag library

Glossary