simpleaction (Domino DTD)

Containment Hierarchy

Contained by: %code.types;

Contains: %simple.actions;

Syntax

<!ELEMENT simpleaction ( (%simple.actions;)? ) >

Content

(%simple.actions;)?

Optionally contains any number of the contents of the %simple.actions; entity.

Attributes

<!ATTLIST simpleaction

>

action

Type of action. See the %simpleaction.types; entity for a list of options.

agent

Translatable name of the agent when the action attribute is runagent.

appendvalue

Specifies the value to be appended to the text in the value attribute when the action attribute equals modifyfield.

field

Name of the field when the action attribute equals modifyfield.

file

Name of the file when the action attribute equals copytodatabase.

folder

Name of the folder when the action attribute equals copytofolder, movetofolder, or removefromfolder.

formulatype

Specifies how the action affects the documents. See the %formula.types; entity for a list of options.

server

Name of the server when the action attribute equals copytodatabase.

value

Value string when the action attribute equals modifyfield. This is a text value regardless of the data type of the field being modified.

Defined entities for <simpleaction> element

The %simple.actions; entity lists the elements that can be defined in a simpleaction.

Syntax:

<!ENTITY % simple.actions "modifybyformaction | sendreplyaction | sendmailaction | sendnewsletteraction | formula ">

The %simpleaction.types; entity defines the options for the action attribute.

Syntax:

<!ENTITY % simpleaction.types "copytodatabase | copytofolder | delete | markread | markunread | modifyfield | modifybyform | movetofolder | removefromfolder | runagent | runformula | send | sendmail | sendnewletter | sendreply ">

copytodatabase

Copies documents to a specified database. Specify the server and file of the database to copy to in the server and file attributes of <simpleaction>.

copytofolder

Copies documents to a specified folder. Specify the folder to copy to in the folder attribute of <simpleaction>.

delete

Deletes documents.

markread

Marks documents as read.

markunread

Marks documents as unread.

modifybyform

Modifies the documents to use a different form. Specify the form using the <modifybyformaction> element.

modifyfield

Modifies the specified field. Specify the field name, the value to replace the current field value with, or the value to append the current field value with, using the field, value, and appendvalue attributes of <simpleaction>.

movetofolder

Moves documents to a specified folder. Specify the folder to move the documents to in the folder attribute of <simpleaction>.

removefromfolder

Removes documents from a specified folder. Specify the folder to remove the documents from in the folder attribute of <simpleaction>.

runagent

Modifies the documents using the specified agent. Specify the agent in the agent attribute of <simpleaction>.

runformula

Modifies documents using a formula. Specify the formula using the <formula> element, and specify how the formula should affect the documents according to the specified %formula.types; entity option.

send

Sends documents.

sendmail

Sends a mail message. You must specify the recipient, subject, body, and whether to include the original message, or a link to the original message using the <sendmailaction> element.

sendnewsletter

Sends a newsletter. You must specify the recipient, subject, body, and a view name if you want to use a view to display a summary of each document using the <sendnewletteraction> element.

sendreply

Replies to a mail message. You must specify whether to return to the sender only or all recipients copied on original message, provide the message body, and choose whether to include the original message using the <sendreplyaction> element.