Action Type

On the Event Handler Revisions form, this field is display-only and indicates the value set for this field on the Event Actions form.

On the Event Actions form and Event Handlers form, select from the drop-down list the type of action you want the handler to perform. Options include:

Event action What it does See
Achieve Milestone Tells the system to change the visual state of the event when a specified condition has been met. Event Action Achieve Milestone form
Attach Specifies a document (file) to be attached to a record. Event Action Attach form
Audit Tells the system to add an entry to the audit log. Event Action Audit form
Branch Allows the system to take different actions, depending on whether a specified condition has been met. If the condition evaluates to TRUE, the system takes one action. If the condition evaluates to FALSE, the system takes a different action. Event Action Branch form
Call Database Method Tells the system to run a specified stored procedure, passing any parameters that the stored procedure requires and accepting any return values. Event Action Call Database Method form
Call IDO Method Tells the system to invoke a specified IDO method, passing any parameters that the method requires and accepting any return values.
Note: Standard (.NET) IDO Method that is invoked from a Call IDO Method action should be declared with int type and return 0 for success or non-zero for failure.
Event Action Call IDO Method form
Call Web Service Tells the system to invoke and run a specified Web service, passing any parameters that the Web service requires and accepting any return values. Event Action Call Web Service form
Discover File

Tells the system to watch for named files in specified locations and then take prescribed actions when these files are discovered. Files can be named using wildcards. You can specify a single folder or a folder and all of its subfolders.

Use of this event action forces the handler to be asynchronous.

Event Action Discover File form
Dispatch IDO Method Invokes the IDO method on a remote system. Event Action Dispatch IDO Method form
Dispatch IDO Request

Sends an IDO request to retrieve or update data, or perform some action on a system to which the user is not currently connected or logged on.

The result can be parsed using the Transform XML action type.

Event Action Dispatch IDO Request form
Dispatch Load Collection Executes the Load Collection request on a remote system. Event Action Dispatch Load Collection form
Dispatch Load IDO Row Executes the underlying Load IDO Row request on a remote system. Event Action Dispatch Load IDO Row form
Dispatch Update Collection Executes the update collection request on a remote system Event Action Dispatch Update Collection form
Execute IDO Request

Executes an IDO request to retrieve or update data, or perform some action.

The result can be parsed using the Transform XML action type.

Event Action Execute IDO Request form
Extract XML Collection Tells the system to generate a collection of rows and properties from a specified XML string, and store it in a named result-set. This collection can be further adjusted through the Update Collection action type, its properties retrieved through expression functions, and converted back to XML. Event Action Extract XML Collection form
Fail Tells the system, when a specified condition has been met, that an error has been encountered and discontinues the event handler execution with a status of Failure. Event Action Fail form
Finish

Tells the system, when a specified condition has been met, that the event handler is finished with a status of Success.

Optionally, sets a result message to be displayed on the Event Status form when the event is finished running.

Event Action Finish form
Generate Event Tells the system to generate an event when a specified condition has been met. Event Action Generate Event form
Goto Tells the system to proceed to a particular action in the sequence. Event Action Goto form
Load Collection Tells the system to retrieve data from a specified IDO collection and place it into a named result set. Event Action Load Collection form
Load IDO Row Tells the system to retrieve a specified row of data from an IDO collection. Event Action Load IDO Row form
Notify Sends an informational message to selected recipients. This message does not require a response from the recipients. Event Action Notify form
Prompt

Sends a message that prompts recipients to take some action and then awaits a response.

Also sends an email to recipients for whom Send Email Prompts is specified in the Users form, if the system is set up for SMTP relaying of email. The recipient can click a link in the email to respond.

Can be set to count response votes according to a specified voting rule.

Can also be set so that, if no response or an insufficient response is received within a certain time limit, an alternate action is performed.

Use of this event action forces the handler to be asynchronous.

Event Action Prompt form
Run Background Task Places a specified task on the background queue, to be run in its turn. Event Action Run Background Task form
Send BOD Sends a Business Object Document (BOD) to the replication document outbox. Event Action Send BOD form
Send Email Tells the system to send an email to designated recipients when a specified condition has been met. Event Action Send Email form
Set Attributes Sets the title of the event as it displays in the Event Status form, when the event is running or finished. Event Action Set Attributes form
Set Values Tells the system to set event variables or parameters to given values or expressions when a specified condition has been met. Event Action Set Values form
Sleep

Tells the system to wait for a specified period of time (in seconds) before moving on.

Use of this event action forces the handler to be asynchronous.

Event Action Sleep form
Transform XML Tells the system to perform an XSL transformation on specified XML content and place the result in an event variable or parameter. Event Action Transform XML form
Update Collection Has the system perform an INSERT, UPDATE, or DELETE operation on specified records in a designated IDO collection or named result-set. Event Action Update Collection form
Wait

Tells the system to wait until a specified condition has been met.

Optionally, can be set to retest for the condition periodically and, if the condition has not been met within a certain time limit (in seconds), an alternate action is performed.

Use of this event action forces the handler to be asynchronous.

Event Action Wait form