1. Oracle Migration Tool On Demand Guide
  2. Elements and Sections in the Workflow Rules Output File

Elements and Sections in the Workflow Rules Output File

The following table describes the elements and sections in the workflow rules XML file.

Note: Certain elements are applicable only for workflow rules that have the Scheduled Event trigger event. These elements are described in the second table in this topic.

Table Elements and Sections in the Workflow Rules XML File

Description Element or Section

<TriggerEvent> specifies the trigger event code that triggers the workflow.

 
<data:TriggerEvent>WriteRecordNew
</data:TriggerEvent>

(Optional.) <ParentRecordType> specifies the system name of the parent record type. It is specified if the trigger event is Associate or Dissociate. See Oracle CRM On Demand Online Help or the Workflow UI for the valid combination of RecordType, TriggerEvent, and ParentRecordType.

 
<data:ParentRecordType>
</data:ParentRecordType>

The <WorkflowRule> section contains the elements for one workflow rule.

 
<data:WorkflowRule>
. . .
</data:WorkflowRule>

<WorkflowName> specifies the name of the workflow rule. This field has a maximum of 50 characters.

 
<data:WorkflowRule>
. . .
  <data:WorkflowName>Opportunity Rule
  </data:WorkflowName> 
. . .
/data:WorkflowRule>

<Active> specifies whether the rule is active (true) or inactive (false).

 
<data:WorkflowRule>
. . .
  <data:Active>true</data:Active>
. . .
</data:WorkflowRule>

<Exit> specifies whether Oracle CRM On Demand exits the sequence of workflow rules after this rule is executed (true), or does not exit the sequence of workflow rules after this rule is executed (false).

Note: For workflow rules that have the Scheduled Event trigger event, the <Exit> element is always set to true and is read-only. 
<data:WorkflowRule>
. . .
  <data:Exit>false</data:Exit> 
. . .
</data:WorkflowRule>

<WorkflowRuleCondition> is a valid expression, as defined in the Oracle CRM On Demand Online Help, that defines a rule for performing workflow actions. This field has a maximum of 2048 characters. In this example, the condition specifies that the actions are performed if the Probability % field on the new opportunity is set to 90 or higher.

Note: You cannot specify a condition for a workflow rule that has the Scheduled Event trigger event. If the <WorkflowRuleCondition> element is populated when you insert or update a workflow rule that has the Scheduled Event trigger event, then the element is ignored. 
<data:WorkflowRule>
. . .
  <data:WorkflowRuleCondition>[{Primary 
    Revenue Win Probability}]>=LookupValue
   ("PROB", "90")
  </data:WorkflowRuleCondition> 
. . .
</data:WorkflowRule>

<CancelSave> is applicable only for workflow rules that have the Before Modified Record Saved trigger event. It specifies whether the Cancel Save processing is performed (true) if the condition on the workflow rule is not met, or is not performed (false). The Workflow Cancel Save privilege is required to insert or update a workflow rule set that contains the <CancelSave> element.

 
<data:WorkflowRule>
. . .
  <data:CancelSave>false</data:CancelSave>
. . .
</data:WorkflowRule>

<Order> is the order number for the workflow rule. It determines the order in which Oracle CRM On Demand invokes a sequence of workflow rules that are based on the same record type and the same trigger event, and if applicable, on the same parent record type.

Note: The <Order> element is read-only for workflow rules that have the Scheduled Event trigger event. Workflow rules that have the Scheduled Event trigger event are not performed as part of a sequence. 
<data:WorkflowRule>
. . .
  <data:Order>1</data:Order>
. . .
</data:WorkflowRule>

<DisplayMessage> is applicable only for workflow rules that have the Before Modified Record Saved trigger event. It specifies the message that is returned to the user or Web service if the condition on the rule is not met, and <CancelSave> is set to true for the rule. This field has a maximum of 1999 characters.

 
<data:WorkflowRule>
. . .
  <data:DisplayMessage></data:DisplayMessage>
. . .
</data:WorkflowRule>

<Description> contains additional information about the workflow rule.

 
<data:WorkflowRule>
. . .
  <data:Description>Workflow Rule for new 
   opportunities with probability at 90%
   or higher</data:Description>
</data:WorkflowRule>

The <ListOfWorkflowTranslations> section is applicable only for workflow rules that have the Before Modified Record Saved trigger event. It contains the translation values for the workflow Cancel Save message.

 
<data:ListOfWorkflowTranslations>
. . .
</data:ListOfWorkflowTranslations>

The <WorkflowTranslation> section is applicable only for workflow rules that have the Before Modified Record Saved trigger event. It contains the translation values of the workflow Cancel Save message for one language:

 
<data:ListOfWorkflowTranslations>
  <data:WorkflowTranslation>
    <data:LanguageCode>ENU
    </data:LanguageCode>
    <data:DisplayMessageTranslation>This 
     Record can not be updated, since 
     workflow Cancel Save (Acc_WF_2 ) is
     in Active status.
    </data:DisplayMessageTranslation>
  </data:WorkflowTranslation>
  <data:WorkflowTranslation>
    <data:LanguageCode>ENG
    </data:LanguageCode>
    <data:DisplayMessageTranslation>This 
     Record can not be updated.
    </data:DisplayMessageTranslation>
  </data:WorkflowTranslation>
. . .
</data:ListOfWorkflowTranslations>

The following table describes the elements that are applicable only for workflow rules that have the Scheduled Event trigger event.

Table Additional Elements for Scheduled Events

Description Element or Section

<StartDateTime> specifies the date and time when the first instance of the scheduled event is to be executed.

Note: If the scheduled event already exists and is active in the target environment, then <StartDateTime> is read-only. 
<data:WorkflowRule>
. . .
  <data:StartDateTime>05/10/2018 12:00:00
  </data:StartDateTime>
. . .
</data:WorkflowRule>

<EndDateTime> specifies the date and time after which no further instances of the scheduled event are to be executed.

If the <NumOccurrence> and <EndDateTime> elements both contain a value when you update or insert a scheduled event, then only the value in the <EndDateTime> element is written to the scheduled event.

Note: If the scheduled event already exists and is active in the target environment, then <EndDateTime> is read-only. 
<data:WorkflowRule>
. . .
  <data:EndDateTime>07/10/2018 12:00:00
  </data:EndDateTime>
. . .
</data:WorkflowRule>

<RecurrenceType> corresponds to the Recurring field in the UI. It specifies the interval at which the scheduled event is to repeat. Valid values are Hourly, Daily, Weekly, Monthly, and Yearly.

Note: If the scheduled event already exists and is active in the target environment, then <RecurrenceType> is read-only. 
<data:WorkflowRule>
. . .
  <data:RecurrenceType>Monthly
  </data:RecurrenceType>
. . .
</data:WorkflowRule>

<RecurrencePeriod> corresponds to the Every field in the UI. It specifies the interval period for the recurring instances of the scheduled event. Only positive integers are valid and the minimum allowed value is 1.

Note: If the scheduled event already exists and is active in the target environment, then <RecurrencePeriod> is read-only. 
<data:WorkflowRule>
. . .
  <data:RecurrencePeriod>1
  </data:RecurrencePeriod>
. . .
</data:WorkflowRule>

If the <RecurrenceType> element is set to Monthly, then the <LastDayOfMonth> element specifies whether each instance of the scheduled event is to be executed on the last day of any month in which it is executed (true), or on the day of the month specified in the <StartDateTime> element (false).

The <LastDayOfMonth> element is not applicable if the <RecurrenceType> element is set to anything other than Monthly.

Note: If the scheduled event already exists and is active in the target environment, then <LastDayOfMonth> is read-only. 
<data:WorkflowRule>
. . .
  <data:LastDayOfMonth>true
  </data:LastDayOfMonth>
. . .
</data:WorkflowRule>

<NumOccurrence> corresponds to the After field in the UI. It specifies the number of times that the scheduled event is to be executed.

The <EndDateTime> element takes precedence over the <NumOccurrence> element. If both of these elements contain a value when you update or insert a scheduled event, then only the value in the <EndDateTime> element is written to the scheduled event.

Note: If the scheduled event already exists and is active in the target environment, then <NumOccurrence> is read-only. 
<data:WorkflowRule>
. . .
  <data:NumOccurrence/>  
. . .
</data:WorkflowRule>

<ListName> specifies the filtered list that returns the records on which the workflow actions act.

If the user who activated the scheduled event has access to more than one list with the same name as the list specified on the scheduled event, then the most personalized list with that name is used. For example, if the user has a private list with a given name and also has access to a role-specific list with the same name, then the private list is used when the instance of the scheduled event is executed.

Note: If the scheduled event already exists and is active in the target environment, then <ListName> is read-only. 
<data:WorkflowRule>
. . .
  <data:ListName>All Top Accounts
  </data:ListName>
. . .
</data:WorkflowRule>

<ScheduledInstancesInitiatedByUser> corresponds to the Initiated By field in the UI. This element is read-only.

Note: Up to the time that a scheduled event is made active, the Initiated By field on the scheduled event record shows the name of the user who created the scheduled event. After the event is made active, the Initiated By field is updated to show the name of the user who made the event active. 
<data:WorkflowRule>
. . .
  <data:ScheduledInstancesInitiatedByUser>
   1QA2-HQOHK
  </data:ScheduledInstancesInitiatedByUser>
. . .
</data:WorkflowRule>

<ScheduledEventStatus> specifies the current status of the scheduled event. This element is read-only. The valid values are:

  • Not Scheduled. The scheduled event is not active and there is no pending instance of the event.

  • Scheduled. The scheduled event is active and a pending instance of the event exists.

  • Completed. All of the scheduled occurrences of the scheduled event have completed.

  • Terminated. The most recently generated instance of the scheduled event was deleted from the Workflow Wait Monitor, or the scheduled event has been deactivated.

 
<data:WorkflowRule>
. . .
  <data:ScheduledEventStatus/>
. . .
</data:WorkflowRule>

<EnableNotification> specifies whether Oracle CRM On Demand is to send an email notification to the user who activated the scheduled event when any of the following happens:

  • An instance of the scheduled event completes successfully.

  • An instance of the scheduled event fails.

  • An instance of the scheduled event is deleted from the Workflow Wait Monitor.

If this element is set to true, then an email notification is sent. If this element is set to false, then an email notification is not sent.

 
<data:WorkflowRule>
. . .
  <data:EnableNotification>false
  </data:EnableNotification> 
. . .
</data:WorkflowRule>