agent (Domino DTD)
Represents a Domino agent as a named design element. An agent is a program that runs a series of automated tasks according to a set schedule or at the request of a user. An agent consists of three components: the trigger (when it acts), the search (what documents it acts on), and the action (what it does).
Containment Hierarchy
Contained by: %design.elements;
Contains: %named.design.note.prolog;, <designchange>, <trigger>, <documentset>, <code>, <rundata>, %note.epilog;
Syntax
<!ELEMENT agent ( %named.design.note.prolog; , designchange?, trigger , documentset? , code* , rundata?, %note.epilog; )>Content
%named.design.note.prolog; , designchange? , trigger , documentset? , code* , rundata? , %note.epilog;Contains any number of the contents of the %named.design.note.prolog; entity, followed by an optional <designchange> element, a <trigger> element, an optional <documentset> element, and any number of <code> element, followed by an optional <rundata> element, and any number of the contents of the %note.epilog; entity.
Attributes
<!ATTLIST agent|
%named.design.note.attrs; |
||
|---|---|---|
|
enabled |
%boolean; |
"true" |
|
showinsearch |
%boolean; |
"false" |
|
runaswebuser |
%boolean; |
"false" |
|
runonbehalfof |
%string; |
#IMPLIED |
|
activatable |
%boolean; |
#IMPLIED |
|
clientbackgroundthread |
%boolean; |
"false" |
|
allowremotedebugging |
%boolean; |
"false" |
|
storehighlights |
%boolean; |
"false" |
|
formulatype |
(%formula.types;) |
"modifydocs" |
|
restrictions |
(%agent.restrictions;) |
"restricted" |
>activatable
If true, enables users with editor access or higher to a database per its ACL, to enable or disable scheduled agents. This allows for a scheduled agent on the server to be enabled or disabled without resigning the agent.
allowremotedebugging
If true, permits remote debugging of the LotusScript in an agent script and permits you to monitor the execution of agents written in Java.
clientbackgroundthread
If true, enables you to access the agent without having to wait for it to complete. If you set this attribute to true and the agent references any front-end classes, a run-time error is generated.
enabled
If true (the default), enables or "turns on" the scheduled agent.
formulatype
The type of formula selected, as defined by the %formula.types; entity.
runaswebuser
If true, runs the agent as a Web user, which means it limits its security access to that appropriate to a user accessing the database via the Internet. Default is false.
runonbehalfof
Name of the person for whom the agent is being run. Restricted signers can run agents only under the same authority as their own. Unrestricted signers can run agents on behalf of anyone.
showinsearch
If true, displays the search query string in the search bar. Default is false.
storehighlights
If true, highlights the text in the retrieved documents that matches the search query. Default is false.
Defined entities for <agent> element
The %agent.restrictions; entity defines the security settings for the agent.
Syntax:
<!ENTITY % agent.restrictions "restricted | unrestricted | fulladminunrestricted ">fulladminunrestricted
The agent can perform restricted operations and can do so with full administration rights. This option is more powerful than unrestricted.
restricted
The agent is not allowed to perform restricted operations. This is the most secure choice.
unrestricted
The agent can perform restricted operations because it has been granted unrestricted rights.