WorkflowActionSetReadForRuleSet

Extracts workflow action configuration data for a workflow rule set.

Usage

Use the WorkflowActionSetReadForRuleSet method to extract all the workflow action sets for a workflow rule set for a particular record type and trigger event.

The workflow rule set is specified with the following elements of <WorkflowActionForRuleSet>:

  • RecordType. The record type (required).

  • TriggerEvent. The event that triggers the workflow rule (required). The possible values and the associated trigger events are as follows:

Trigger Event TriggerEvent LIC

When New Record Saved

WriteRecordNew

When Modified Record Saved

WriteRecordUpdated

Before Modified Record Saved

PreWriteRecord

Before Record Is Deleted

PreDeleteRecord

After Association With Parent

Associate

After Dissociation From Parent

Dissociate

When Record Is restored

RestoreRecord

When Records are merged

MergeRecords

  • ParentRecordType. The parent record type. This is specified if the trigger event is After Association With Parent or After Dissociation From Parent. These trigger events are supported only for the Account, Contact, and Opportunity record types.

  • Version. The release of Oracle CRM On Demand for which configuration data is extracted. The default value is 30, so to extract Release 31 or later functionality, you must specify a higher value than 30.

If the value of the <Version> element is 31 or higher:

  • The child elements of <WorkflowEmailTranslation> containing translations of the email subject and message body for the Send Email workflow action, for each language activated for your company are returned, if available. For more information about the Send Email action, see Oracle CRM On Demand Online Help.

  • The <BookExpr> and <ReplaceBookExpr> child elements of WorkflowAssignBookAction specifying books assigned using the Assign a Book workflow action are returned.

  • The <Order> element is returned for each workflow action.

See WorkflowActionSetUpsert for information about the workflow action data specified in apQuery:WorkflowActionSet.

Arguments

The following table describes the arguments taken by the WorkflowActionSetReadForRuleSet method.

Table Arguments Taken by the WorkflowActionSetReadForRuleSet Method

Name Description Required Default I/O

apQuery:WorkflowActionForRuleSet

The workflow action query criteria.

Yes

Not applicable

Input

apData:ListOfWorkflowActionSet

The extracted workflow action data.

Not applicable

Not applicable

Output

Return Value of the Call

The workflow action sets are returned.