Defining Actions

 

The following sections introduce and explain how to use BEA WebLogic Process Integrator actions:

• Working with Actions

• Adding or Updating an Action

• Deleting an Action

• Changing the Sequence of Actions

• Using Task Actions

• Using Workflow Actions

• Using Integration Actions

• Using Exception Handling Actions

• Using Miscellaneous Actions

 

---

Working with Actions

An action is a basic unit of work that is performed by BEA WebLogic Process Integrator. An action can be as simple as assigning a task to a user or as complicated as sending XML messages or invoking Enterprise JavaBean (EJB) methods. Actions are, in a sense, the primitive building blocks of a workflow because they define the actual behavior of the workflow.

Action Categories

Actions are organized into the following categories.

Type of action	Used to . . .	Actions you can specify
Task (See Using Task Actions)	Specify and control tasks	Mark Task as Done Unmark Task Done Set Task Due Date Assign Task to User Assign Task to Role Assign Task Using Routing Table Unassign Task Set Task Comment Set Task Priority Execute Task
Workflow (See Using Workflow Actions)	Manage an entire workflow	Start Workflow Mark Workflow as Done Abort Workflow Set Workflow Variable Set Workflow Comment
Integration (See Using Integration Actions)	Integrate the workflow with: External software components, such as EJBs and Java classes Applications, such as the Worklist client application or executable programs WebLogic Server functionality, such as the XSL transformation engine	Perform Business Operation Post XML Event Call Program Send XML to Client XSL Transform
Exception Handling (See Using Exception Handling Actions )	Manage an exception handler	Set Workflow Exception Handler Invoke Exception Handler Exit Exception Handler
Miscellaneous (See Using Miscellaneous Actions)	Perform additional actions not covered in the other action categories	No Operation Evaluate Condition Timed Event Cancel Workflow Event Send E-Mail Message Make Audit Entry

 

Synchronous and Asynchronous Actions

Most actions as synchronous, which means that the workflow does not proceed to the next action until the current action has completed.

Some actions, however, are asynchronous, which means that the workflow proceeds to the next action without waiting for the current action to complete. The following are asynchronous actions:

• Send XML to Client

• Start Workflow

• Timed Event

• Set Task Due Date

There are, however, a couple of exceptions to the asynchronous behavior of these actions.

If you add subactions to the Send XML to Client action (as described in the following section), this action waits for a reply from the client application before it executes the subactions.

Similarly, if you add subactions to the Start Workflow action, this action waits until the called workflow completes before it executes the subactions.

Action Placement and Subactions

You can place actions in any node in a workflow, except a Join node. The most common place is in a Task node.

You can also place actions within other actions. Such actions are executed when the conditions specific to that action are met. The following actions can have subactions defined within them:

• Evaluate Condition — add actions based on a condition in the False/True tab.

• Timed Event — add actions to be triggered in the Triggered tab.

• Send XML to Client — add callback actions that are performed when the workflow receives a reply from the client application.

• Start Workflow — add actions to be performed when the called workflow is completed.

• Set Task Due Date — add overdue actions. Set a due time on a task so that when the due time passes, the specified subactions are performed.

 

---

Adding or Updating an Action

You add and update actions in the Task Properties, Decision Properties, Event Properties, and Start Properties dialog boxes. Each dialog box has an area specific to action maintenance.

To add or update an action:

1. Double-click the Task, Event, Decision, Start, or Done node for which you want to add or update an action. The Properties dialog box for the node appears.

2. In the properties dialog box, select the appropriate action tab, and click Add or Update to display the Add Action or Update Action dialog box.

   Figure 7-1 Add Action Dialog Box

   
    

   Note: If a plug-in is defined for actions, this dialog box contains the new action. For more information about plug-ins, see Working with Plug-Ins.

3. Double-click an action type folder to expand it, select an action, and click OK.

   A dialog box specific to the selected action is displayed.

4. Complete the fields in the dialog box and click OK.

   The action is updated or added to the Properties dialog box for the node you selected.

 

---

Deleting an Action

To delete an action:

1. In the workflow diagram, double-click the shape that contains the action you want to delete.

2. Select the desired action in the Actions section of the Properties dialog box, and click Delete. A confirmation dialog box is displayed to prevent accidental deletions.

   Figure 7-2 Delete Action Dialog Box

   
    

When an action is deleted, all references to the action are removed. The action is removed from all instances of the workflow, including those currently running.

 

---

Changing the Sequence of Actions

Actions are displayed in the sequence that they will be executed. To re sequence actions, select an action from the list in the Properties dialog box and press the up or down arrow to move its position in the list.

Figure 7-3 Up and Down Arrows

 

 

---

Using Task Actions

This section defines and describes how to use the following task actions to specify and control tasks:

• Mark Task as Done

• Unmark Task Done

• Set Task Due Date

• Assign Task to User

• Assign Task to Role

• Assign Task Using Routing Table

• Unassign Task

• Set Task Comment

• Set Task Priority

• Execute Task

Mark Task as Done

Use this action to explicitly mark a task as done. This action activates the MarkedDone state of a task., and performs all the actions listed in the MarkedDone tab of the Task Properties dialog box. For details about task states, see Defining Tasks.

When a task is marked as done, the task is no longer listed as an Active task in the Worklist application. By marking a task done, the task is prevented from being executed again, unless the task properties allow it. When a task is marked as done, all successor nodes are activated (as defined in the Task Properties dialog box).

Figure 7-4 Mark Task as Done Dialog Box

 

View or enter information in the Mark Task as Done dialog box.

• Task to Mark as Done — displays all tasks in the workflow. Select the task that is to be marked done when the action is executed. Only one task at a time can be marked done.

• Notes — a free-form text box for notes on the action.

Unmark Task Done

This action marks the task as not done. Use this action when a condition arises that prevents the task from continuing in a successfully completed state. A task that is assigned this action becomes Active on the Worklist and can be executed again.

Note: A task that is marked not done does not have its activated state triggered again. To trigger the activated state for the task, the workflow must initiate the task again. For details about task states, see Defining Tasks.

Figure 7-5 Unmark Task Done Dialog Box

 

View or enter information in the Unmark Task Done dialog box.

• Task to Unmark as Done — displays all the tasks in the workflow. Select the task that is to be unmarked as done when the action is executed. Only one task at a time can be selected.

• Notes — a free-form text box for notes about the action.

Set Task Due Date

This action sets the due date for a specified task by the task must be executed. You can express the due date in minutes, hours, days, weeks, or months, or it can be the result of an expression. You can also specify subactions that are performed when the task becomes overdue.

Figure 7-6 Set Task Due Date Dialog Box

 

View or enter information in the Set Task Due Date dialog box:

• Task to set due date for — displays all the tasks in the workflow. Select the task that is to have its due date set when the action is executed. Only one task at a time can be selected.

• Due Date — enter the due date for the task. The due date can be based on the evaluation of an expression. The due date for the task is displayed in the Worklist application.

  • Set to expression — set the due date based on an expression. In the expression, use the DateAdd function with business hours and business days.

    Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

  • Business Calendar — if the due date is set using business hours or business days, a business calendar can be specified. This calendar defaults to the calendar specified for the organization, but can be changed to any other calendar. The specified calendar will be used in calculating the actual due time. Click the Business Calendar drop-down list to display a list of defined business calendars along with two additional choices: For Organization and For Assignee.

• Overdue Actions — a set of subactions to be performed when the due date is reached. This is optional.

• Notes — a free-form text box for notes about the action.

Assign Task to User

Use this action to assign a specified task to an individual user or to a user in a role. The user or role can be specified as a constant or taken from a workflow variable at run time. In the case of a user in a role, the system attempts to perform simple workload balancing in its selection of the assignee; the system determines which user defined to the role has the least number of pending tasks, then assigns the task to that user. Assigning a task to a user causes a notification to be sent to the user. The user views the task from the Worklist application.

Figure 7-7 Assign Task to User Dialog Box

 

View or enter information in the Assign Task to User dialog box.

• Task to assign — displays all tasks in the workflow. Select the task that is to be assigned when the action is executed. Only one task at a time can be selected.

• User — drop-down list from which you select the user to assign to, the role from which a user is to be chosen, or an expression to reference the user or role, depending on the other dialog settings.

• Use workflow expression — Indicates whether the new assignee name is a constant or is taken from the value of a workflow expression at run time. If selected, a workflow expression must be constructed.

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• Assign to role member — indicates whether the User control specifies a user or a role. If checked, the User drop-down list shows a list of roles. When the action is executed, the system attempts to perform workload balancing by assigning the task to the role member who has the least number of assigned tasks at that time. If not checked, the User drop-down list shows a list of individual users.

• Notes — a free-form text box for notes about the action.

Assign Task to Role

Use this action to assign a task to a role, either directly to a constant role or by taking the value of a workflow expression at run time. It is not always desirable to assign a task to a specific user. When you assign a task to a role, any user that is defined as a member of the role has access to the worklist of the role. When a task is assigned to a role, there is no workflow notification of a new task. Assign a task to a role when the task can be performed by anyone who is a member of that role and has a certain skill level.

Figure 7-8 Assign Task to Role Dialog Box

 

View or enter information in the Assign Task to Role dialog box.

• Task to assign — displays all tasks in the workflow. Select the task that is to be assigned when the action is executed. Only one task at a time can be selected.

• Role — from the drop-down list, select the role to assign to the task or a workflow expression reference to the role, depending on the Use workflow expression setting.

• Use workflow expression — indicates whether the role is a constant or is taken from the value of a workflow expression at run time. If selected, a workflow expression must be constructed, and the A+B button appears to the right of Role.

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• Notes — free-form text box for notes about the action.

Assign Task Using Routing Table

Assign a task to a user or role depending on a set of conditions. A routing table consists of a sequence of one or more routing conditions. A routing condition specifies a potential assignee (user or role) for the task, together with a specification of the conditions under which the assignment should be made. When the action is executed at run time, the system evaluates each condition in sequence until it encounters one that yields a True result. If such a condition is encountered, the task is assigned to the corresponding user or role, and any subsequent conditions are ignored.

Note: If no routing condition is satisfied, a run-time exception occurs.

Figure 7-9 Assign Task Using Routing Table Dialog Box

 

View or enter information in the Assign Task Using Routing Table dialog box.

• Task to Assign — displays all tasks in the workflow. Select the task that is to be assigned when the action is executed. Only one task at a time can be selected.

• Routing Table — table of conditions and assignees. Routing information can be added, updated, or deleted. Additionally, the sequence of conditions can be changed.

• Notes — enter notes about the action.

Clicking Add or Update displays the Define Routing Condition dialog box.

Figure 7-10 Define Routing Condition Dialog Box

 

The Define Routing Condition dialog box contains the following:

• Condition — must be a valid workflow conditional expression that yields a logical result (True or False).

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• Assign To — a list showing all possible assignees: User, User in Role, and Role. Select the required assignee from the list.

Unassign Task

Remove the current task assignment. The task is no longer assigned to the user or role.

Figure 7-11 Unassign Task Dialog Box

 

View or enter information in the Unassign Task dialog box.

• Task to unassign — displays all tasks in the workflow. Select the task that is to be unassigned when the action is executed. Only one task at a time can be selected.

• Notes — a free-form text box for notes about the action.

Set Task Comment

Display a free-form text message to the user at run time when the action is executed. The text is typically explanatory or requests the user to perform manual action(s) for which the workflow does not provide further automated support. When the action is executed, the system displays a text message in the comment column of the Worklist application.

Figure 7-12 Set Task Comment Dialog Box

 

View or enter information in the Set Task Comment dialog box.

• Task to set comment for — displays all the tasks in the workflow. Select the task that is to have its comment set when the action is executed. Only one task at a time can be selected.

• Comment — a valid workflow expression to be evaluated at run time for the task comment.

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• Notes — a free-form text box for notes about the action.

Set Task Priority

Set a task priority to Low, Medium, or High.

Figure 7-13 Set Task Priority Dialog Box

 

View or enter information in the Set Task Priority dialog box.

• Task to set priority for — displays all tasks in the workflow. Select the task to which you will assign a priority.

• Priority — select the task priority. Choices are Low, Medium, and High.

• Notes — free-form text box for notes about the action.

Execute Task

Use this action to execute a task explicitly. This action activates the executed state of a task, and performs all the actions listed in the Executed tab of the Task Properties dialog box. For details about task states, see Defining Tasks.

Figure 7-14 Execute Task Dialog Box

 

View or enter information in the Execute Task dialog box.

• Task to execute — Displays all tasks in the workflow. Select the task to execute.

• Notes — Free-form text box for notes about the action.

 

---

Using Workflow Actions

This section defines and describes how to use the following workflow actions to manage workflows:

• Mark Workflow as Done

• Abort Workflow

• Start Workflow

• Set Workflow Variable

• Set Workflow Comment

Mark Workflow as Done

This action marks the workflow as done and serves the same purpose as a workflow reaching a Done node.

Figure 7-15 Mark Workflow as Done

 

Enter notes about the action in the free-form text box, and click OK.

Abort Workflow

Abort the current workflow. Abort Workflow permanently stops a workflow that is currently in process. This action enables the system to handle a situation in which there is no reason to continue a given workflow. The BEA WebLogic Process Integrator Workflow Monitoring facility differentiates between a workflow that has aborted upon the execution of this action and a workflow that has completed by reaching a Done node. A workflow that is aborted will be deleted from the server.

Figure 7-16 Abort Workflow Dialog Box

 

View or enter information in the Abort Workflow dialog box.

• Notes — a free-form text box for notes about the workflow abortion.

Start Workflow

Use this action to start another workflow from the current one. The workflow being started is sometimes referred to as a subworkflow or a called workflow. The workflow that starts the subworkflow is called the calling workflow.

The started workflow can be tracked with a variable reference, and when it completes, you can perform an optional set of subactions.

Figure 7-17 Start Workflow Dialog Box

 

View or enter information in the Start Workflow dialog box.

• Workflow to Start — displays all workflow templates defined in the system. Select the workflow template to start when the action is executed. Only one workflow template definition within that workflow template can be started at a time, this being the most effective of the active workflow template definitions.

• Start in Organization — the organization for which the specified workflow should be triggered and executed.

  • Current organization — starts the workflow for the current organization (the organization selected from the Organization drop-down list on the BEA WebLogic Process Integrator main window).

  • Expression — starts the workflow for an organization taken from the value of a workflow expression. If selected, a workflow expression must be constructed.

    Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• Reference via — list of workflow variables available for the current workflow. When you select a workflow, the instance ID of the called subworkflow is assigned automatically to the selected variable. The instance ID is a unique identifier for the called subworkflow.

  The calling workflow can then use the instance ID in expressions using the WorkflowVariable function to retrieve variables from the called subworkflow. For details about using the instance ID in the WorkflowVariable function, see Functions.

Use the following tabs to select additional information for the action:

• Parameters — displays variables that were defined as input parameters. (See Defining Variables.) The calling workflow can set the initial values for these parameters, and pass them as input to the called subworkflow.

• Results — displays variables that were defined as output parameters (See Defining Variables.) The called subworkflow can put result values in the parameters, and return them as output to the calling workflow.

• Actions — specify optional subactions to be performed when the called workflow is completed. It can be used to mark the current task as done.

• Notes — a free-form text box for notes about the action.

Set Workflow Variable

Use this action to assign a value to an existing workflow variable you defined using the Variable Properties dialog box. For details about defining variables, see Defining Variables.

The value you assign to the variable can be an expression or a literal. This action evaluates the expression or literal, and assigns the result to a workflow variable when the action is executed.

If you assign a value to an XML type variable, you can use this action to compose an XML document and store the content in the XML type variable. You can then send the XML type variable as an internal or external XML message using the Post XML Event action (see Post XML Event).

Figure 7-18 Set Workflow Variable Dialog Box

 

The Set Workflow Variable dialog box contains the following:

• Variable to be set — choose an existing, defined variable to which you will assign a value, or type one in. (For details, see Defining Variables.)

• From Expression — set the value for the variable by constructing an expression or by entering a literal in double quotes (for example, a string type variable).

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• By Composing — set the value for an XML or string type variable by composing an XML document containing elements and attributes.

  Note: An XML document that is stored in a string type variable will first be converted to a string.

  To compose an XML document, perform the actions listed in the following table. The XML document you define is stored in the workflow template definition.

  To . . .	Perform This Action
  Retrieve an existing XML document for editing	Click the Import button to open the XML Finder dialog box. Use the XML Finder to retrieve an existing XML document that you can edit. For details about the XML Finder, see Locating XML Entities Using the XML Finder.
  Add the first element of the XML message	Click the Add Child button.
  Change the default element name	Click the element and wait, or triple-click the element. The element name becomes an entry field. Change the element name as appropriate, then press Enter. To cancel the change, press Esc.
  Add a sub-element to an element	Select the element, then click the Add Child button.
  Add an element at the same level as another element	Select the element, then click the Add Sibling button.
  Add an attribute to an element	Select the element, then click the Add Attribute button.
  Change the default attribute name	Select the attribute, then double-click the attribute. The attribute name becomes an entry field. Change the attribute name as appropriate, then press Enter. To cancel the change, press Esc.
  Change the order of the elements	Select the element you want to move, and use the arrow keys as follows: To move the element up or down a level, click the Move Left or Move Right arrow. To move the element up or down within a level, click the Move Up or Move Down arrow
  Change the content of a leaf element or attribute	In the right panel, double-click the line next to the element or attribute for which you want to change the content. The line becomes an entry field. Type the content. To cancel the change, press Esc. Note: The syntax for the content of a leaf element or an attribute must follow the same rules that are used for workflow expressions. For example, string literals must be enclosed in single or double quotes. If the syntax is incorrect, a red X appears next to the entry. For details about defining workflow expressions, see Using Expressions and Conditions.
  Delete an element or attribute	In the left panel, select the element or attribute you want to delete, and click the Delete button.
  Save the XML message	Click the Export button to open the XML Finder dialog box. Use the XML Finder to save the XML message. For details about the XML Finder, see Locating XML Entities Using the XML Finder.

  
   

• Notes — a free-form text box for notes about the action.

Set Workflow Comment

Set the comment for a workflow instance. Use this action to specify a valid workflow expression to be displayed to the user at run time when the action is executed. The text is typically informative or requests the user to perform manual action(s) for which the workflow does not provide further automated support.

Figure 7-19 Set Workflow Comment Dialog Box

 

View or enter information in the Set Workflow Comment dialog box.

• Comment — a valid workflow expression, evaluated at run time.

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• Notes — a free-form text box for notes about the workflow comment.

 

---

Using Integration Actions

To integrate a workflow with software components (such as EJBs, Java classes, and executable programs), external applications (such as the Worklist client application or an executable program), and WebLogic Server functionality (such as the XSL transformation engine), BEA WebLogic Process Integrator provides the following actions:

• Post XML Event

• Send XML to Client

• Call Program

• Perform Business Operation

• XSL Transform

The following sections describe how to use these actions.

Post XML Event

This action sends an XML message to a specified destination to trigger an event. This action can trigger two kinds of events:

• An internal event in BEA WebLogic Process Integrator. As an internal event, the Post XML Event action can:

  • Trigger an Event node in the current workflow or another one. For details about triggering events, see Defining Events.

  • Start another workflow for which the Start node is triggered by an event. For details about event triggers in Start nodes, see Defining a Start Node Using an Event Trigger.

• An external event in a JMS topic or JMS queue. As an external event, the Post XML Event can communicate with an external application that subscribes to the JMS topic you specify, or with a specific application that is the JMS queue receiver.

To post an XML event:

1. Access the Add Action dialog box. This dialog box can be accessed from the various Properties dialog boxes in BEA WebLogic Process Integrator. For example, in the workflow drawing area, right-click a task and choose Properties. The Task Properties dialog box is displayed.

2. In the Task Properties dialog box, click Add to display the Add Action dialog box.

   Figure 7-20 Add Action Dialog Box

   
    

   Note: If a plug-in is defined for actions, this dialog box contains the new action. For more information about plug-ins, see Working with Plug-Ins.

3. Under Integration Actions, select Post XML Event and click OK to display the Post XML Event dialog box.

   Figure 7-21 Post XML Event Dialog Box

   
    

4. Select the XML Message tab to define the XML message you want this action to send. The XML message you define is stored in the workflow template definition.

   If the XML document is stored in an XML type variable, select the variable from the From XML Variable drop-down list. For details about XML type variables, see Understanding Variables.

   If you want to compose the XML message, you can do so by performing the following actions:

   To . . .	Perform This Action
   Retrieve an existing XML document for editing	Click the Import button to open the XML Finder dialog box. Use the XML Finder to retrieve an existing XML document that you can edit. For details about the XML Finder, see Locating XML Entities Using the XML Finder.
   Add the first element of the XML message	Click the Add Child button.
   Change the default element name	Click the element and wait, or triple-click the element. The element name becomes an entry field. Change the element name as appropriate, then press Enter. To cancel the change, press Esc.
   Add a sub-element to an element	Select the element, then click the Add Child button.
   Add an element at the same level as another element	Select the element, then click the Add Sibling button.
   Add an attribute to an element	Select the element, then click the Add Attribute button.
   Change the default attribute name	Select the attribute, then double-click the attribute. The attribute name becomes an entry field. Change the attribute name as appropriate, then press Enter. To cancel the change, press Esc.
   Change the order of the elements	Select the element you want to move, and use the arrow keys as follows: To move the element up or down a level, click the Move Left or Move Right arrow. To move the element up or down within a level, click the Move Up or Move Down arrow
   Change the content of a leaf element or attribute	In the right panel, double-click the line next to the element or attribute for which you want to change the content. The line becomes an entry field. Type the content. To cancel the change, press Esc. Note: The syntax for the content of a leaf element or an attribute must follow the same rules that are used for workflow expressions. For example, string literals must be enclosed in single or double quotes. If the syntax is incorrect, a red X appears next to the entry. For details about defining workflow expressions, see Using Expressions and Conditions.
   Delete an element or attribute	In the left panel, select the element or attribute you want to delete, and click the Delete button.
   Save the XML message	Click the Export button to open the XML Finder dialog box. Use the XML Finder to save the XML message. For details about the XML Finder, see Locating XML Entities Using the XML Finder.

   
    

5. Select the Destination tab to specify where you want to post the XML message.

   Figure 7-22 Destination Tab

   
    

   If the destination is internal, the XML message is sent to an internal JMS queue maintained by BEA WebLogic Process Integrator. The JNDI name of the internal JMS queue is com.bea.wlpi.EventQueue.

   If the destination is external, specify the JNDI name of the JMS topic or JMS queue to which you want to post the message.

   For an external destination, you can enter the JNDI name of the JMS topic or JMS queue directly into the expression field, or you can define an expression that is evaluated at run time to produce the JNDI name.

   Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

   If the XML message is part of a transaction, you can send the message immediately, or only if the transaction completes successfully. Select one of the following:

   • When transaction commits — ensures that the message is sent only if the transaction completes successfully and a commit is issued. If the transaction is unsuccessful and is rolled back, the message is not sent.

   • Immediately — sends the message immediately without waiting for the transaction to complete.

6. Optionally, select the Message Header tab to specify any JMS message properties you want to add to the message, and to set values for standard JMS headers.

   Figure 7-23 Message Header Tab

   
    

   JMS messages contain a standard set of header fields that are always transmitted with the message. JMS messages also include property fields in which you can specify application-specific information.

   For example, you can use the property field to specify information in the message that is not appropriate for the body of the message. The receiving workflow then uses the EventAttribute function in an event key expression to retrieve the information you specified in the property field. For details about the EventAttribute function, see Using Expression Components.

   JMS message properties are name-value pairs. The name can be almost any string that is a valid identifier in the Java language. The value can be any one of the following types: boolean, byte, short, int, long, float, double, or string.

   To define JMS message properties, click Add to display the Set JMS Properties dialog box. In the dialog box, specify the following:

   1. In the JMS Property field, specify the property name.

   2. In the JMS Property Value field, enter the property value. Enter the value directly or enter an expression that is evaluated at run time to produce the value.

   3. Click OK.

      You can also specify values for the following standard JMS headers:

   • Delivery Mode — specifies one of two modes: persistent and nonpersistent.

     Persistent messages are not lost even if the JMS server fails. The message is delivered again after the server recovers.

     Nonpersistent messages can be lost if the JMS server fails. The message is not delivered again after the server recovers.

   • Priority — assigns a priority level to the message. Levels 0-4 are normal priority. Levels 5-9 are expedited priority. Messages with an expedited priority are delivered ahead of messages with a normal priority.

     You can select a value from the drop-down list, or you can define an expression that is evaluated at run time to produce the value. To use the Expression Builder to define an expression, select the Use Expression check box first.

   • Time to live (milliseconds) — specifies how long the message is available before it expires. For example, if you want the message to be available for 1 hour, you specify a value of 3600000 (1000 milliseconds x 60 seconds x 60 minutes). The default value of 0 (zero) indicates that the message will not expire.

     You can enter the value directly, or you can define an expression that is evaluated at run time to produce the value. To use the Expression Builder to define an expression, select the Use Expression check box first.

7. Optionally, select the Addressing tab to indicate that you want to persist an XML message for one or more workflow instances, and to specify an order key.

   Figure 7-24 Addressing Tab

   
    

   Specify the following:

   • Addressed message — indicates that you want to persist a message for one or more workflow instances. If a workflow instance with the ID you specify is not activated when you send the message, BEA WebLogic Process Integrator persists the message until a workflow that matches the ID is activated.

     Note: If you specify a Time to live in the Message Header area, the message persists only for the time you specified.

   • Instance ID — enter the ID of the workflow for which you want to persist the message, or enter an expression that is evaluated at run time to produce the ID.

     If you want to persist the message for more than one workflow instance, separate the IDs with commas.

   • Order key — guarantees that if more than one event is posted at the same time, the events are processed by the same event listener in the order in which they are received.

     An order key must be an integer value, and the value must be the same for each event that you want processed in the order in which it is received. For example, if two events are posted at the same time, and you want them processed in the order in which they are received, enter the same order key value, such as the integer value of 8, for each event.

     Enter the order key directly, or enter an expression that is evaluated at run time to produce the order key.

8. Select the Notes tab to enter any notes about this action.

9. Click OK.

Send XML to Client

Use this action to communicate between a workflow and a client application by sending an XML document to the client. The client application must be programmed to identify the XML document, perform the appropriate action, and return an XML document in response to the workflow.

For examples of using this action with the Worklist client application, see Using the Send XML to Client Action with the Worklist Application.

To send an XML document to a client:

1. Access the Add Action dialog box. This dialog box can be accessed from the various Properties dialog boxes in BEA WebLogic Process Integrator. For example, in the workflow drawing area, right-click a task and choose Properties. This displays the Task Properties dialog box.

2. In the Task Properties dialog box, click Add to display the Add Action dialog box.

   Figure 7-25 Add Action Dialog Box

   
    

   Note: If a plug-in is defined for actions, this dialog box contains the new action. For more information about plug-ins, see Working with Plug-Ins.

3. Under Integration Actions, select Send XML to Client, and click OK to display the Send XML to Client dialog box.

   Figure 7-26 Send XML to Client Dialog Box

   
    

4. Define the XML document you want to send by performing the actions listed in the following table. The XML document you define is stored in the workflow template definition.

   To . . .	Perform This Action
   Retrieve an existing XML document for editing	Click the Import button to open the XML Finder dialog box. Use the XML Finder to retrieve an existing XML document that you can edit. For details about the XML Finder, see Locating XML Entities Using the XML Finder.
   Add the first element of the XML message	Click the Add Child button
   Change the default element name	Click the element and wait, or triple-click the element. The element name becomes an entry field. Change the element name as appropriate, then press Enter. To cancel the change, press Esc.
   Add a sub-element to an element	Select the element, then click the Add Child button.
   Add an element at the same level as another element	Select the element, then click the Add Sibling button.
   Add an attribute to an element	Select the element, then click the Add Attribute button.
   Change the default attribute name	Select the attribute, then double-click the attribute. The attribute name becomes an entry field. Change the attribute name as appropriate, then press Enter. To cancel the change, press Esc.
   Change the order of the elements	Select the element you want to move, and use the arrow keys as follows: To move the element up or down a level, click the Move Left or Move Right arrow. To move the element up or down within a level, click the Move Up or Move Down arrow
   Change the content of a leaf element or attribute	In the right panel, double-click the line next to the element or attribute for which you want to change the content. The line becomes an entry field. Type the content. To cancel the change, press Esc. Note: The syntax for the content of a leaf element or an attribute must follow the same rules that are used for workflow expressions. For example, string literals must be enclosed in single or double quotes. If the syntax is incorrect, a red X appears next to the entry. For details about defining workflow expressions, see Using Expressions and Conditions.
   Delete an element or attribute	In the left panel, select the element or attribute you want to delete, and click the Delete button.
   Save the XML message	Click the Export button to open the XML Finder dialog box. Use the XML Finder to save the XML message. For details about the XML Finder, see Locating XML Entities Using the XML Finder.

   
    

   Note: The system-generated actionid element and its value are used at run time to identify the Send XML to Client action. The actionid element must be the first child element of the root element. Do not move, delete or edit the actionid element, and do not add any subelements to it.

   If you change, move, or delete the actionid element, a warning message is displayed when you click OK in the Send XML to Client dialog box. The Studio then resets the actionid element and its value to the system-generated value and location.

5. Use the Callback Variables tab to specify the variables that will receive the response from the client. Specify a variable for each anticipated response from the client.

   Clicking Add displays the Workflow Variable Assignment dialog box. The variables in the pull-down list are those defined in the Variables Properties dialog box. (For details, see Defining Variables.) The XML expression can be the name of an element in the XML message returned by the client the value of which you want to assign to the selected variable, or it is an XPath function that extracts a value from the XML message from the client, and then assigns that value to the selected variable.

   Figure 7-27 Workflow Variable Assignment Dialog Box

   
    

6. Use the Callback Actions tab to specify any actions that should be performed when the reply is received from the client.

   Clicking Add opens the Add Action dialog box where you can select the actions you want to specify. Typically, you would specify the Mark Task as Done action. The Mark Task as Done action indicates that the client has returned a response, and control can return to the Send XML to Client action.

7. Use the Notes area to add free-form text notes about this action.

8. Click OK.

Using the Send XML to Client Action with the Worklist Application

The Worklist client application is designed to perform some action when it receives an XML document that conforms to a predefined DTD file. The predefined DTD files are shipped with BEA WebLogic Process Integrator, and are in the following directory where BEA WebLogic Process Integrator is installed:

...docs\javadocs\com\bea\wlpi\common\doc-files

There are four pairs of predefined DTD files. Each pair has one DTD file for a request to the Worklist client, and another DTD file for a response from the Worklist client. The root element of the DTD file indicates the action the Worklist client performs when it receives a request XML document.

The following table lists the predefined DTD files, and the actions performed by the Worklist application when it receives an XML document that conforms to one of the request DTD files.

Table 7-1 Predefined DTD Files

Request DTD	Root Element	Action Performed by Worklist Client	Response DTD
ClientMsgBoxReq.dtd	message-box	Displays a message dialog box in which the user responds to a message or query. Reply = ok/yes/no/cancel	ClientMsgBoxResp.dtd
ClientSetVarsReq.dtd	set-variables	Displays a prompt dialog box with entry fields in which the user enters some values. Reply = name/value pairs	ClientSetVarsResp.dtd
ClientCallPgmReq.dtd	call-program	Executes a program on the client machine.	ClientCallPgmResp.dtd
ClientCallAddInReq.dtd	call-addin	Invokes a custom extension to the Worklist client application.	ClientCallAddInResp.dtd

 

This following sections show you how to define XML documents that cause the Worklist client application to display two types of dialog boxes:

• Prompt dialog box where a user can enter values

• Message dialog box where a user responds to a message

Defining a Prompt Dialog Box

To define a prompt dialog box, the entries in the Send XML to Client dialog box should look like those shown in the following figure.

Figure 7-28 Send XML to Client Dialog Box

 

The XML document structure shown in the dialog box conforms to the ClientSetVarsReq.dtd file. The contents of the DTD file are shown below.

Listing 7-1 Contents of the ClientSetVarsReq.dtd File

<!ELEMENT set-variables (actionid, variable+)>
<!ATTLIST set-variables title CDATA #IMPLIED>
<!ELEMENT actionid (#PCDATA)>
<!ELEMENT variable (#PCDATA)>
<!ATTLIST variable name NMTOKEN #REQUIRED
                   prompt NMTOKEN #IMPLIED>

To define the prompt dialog box:

1. Enter the following name for the root element of the XML document: set-variables (all in lowercase).

   Note: The system-generated actionid element and its value are used at run time to identify the Send XML to Client action. The actionid element must be the first child element of the root element. Do not move, delete or edit the actionid element, and do not add any subelements to it.

   If you change, move, or delete the actionid element, a warning message is displayed when you click OK in the Send XML to Client dialog box. The Studio then resets the actionid element and its value to the system-generated value and location.

2. Define title as an attribute of the root element

3. The title attribute takes the title value of the dialog box that is displayed by the Worklist client. Enter the following value for the title attribute: Enter Your Name.

4. Define two variable subelements, each with the following two attributes:

   Name 

   Prompt

5. For the first Prompt attribute, specify the following value: Enter first name.

6. For the second Prompt attribute, specify the following value: Enter last name.

7. For the first Name attribute, specify a variable that will hold the first name the user enters in the prompt dialog box, such as FirstName.

8. For the second Name attribute, specify a variable that will hold the last name the user enters in the prompt dialog box, such as LastName.

9. To complete the dialog box, you need to specify the Callback variables that will hold the first and last name the user enters, and the XPath statements that will extract the first and last name from the response XML document the Worklist client returns to the workflow. The response XML document conforms to the ClientSetVarsResp.dtd file.

   The following table shows the Callback variables and the XPath statements you can use. You can create the XPath statements by typing them manually, or you can use the XPath wizard to create them from the ClientSetVarsResp.dtd file.

   Note: To access the XPath wizard, click Add in the Send XML to Client dialog box. From the Workflow Variable Assignment dialog box, click the A+B button to open the Expression Builder, then click XPath Wizard. For details about using the XPath wizard, see Creating XPath Expressions and Functions Using the XPath Wizard in Using Expressions and Conditions.

   Table 7-2 Callback Variables and XPath Statements

   Callback Variable	XPath Statement
   FirstName	XPath("/set-variables/variable[1]/text()")
   LastName	XPath("/set-variables/variable[2]/text()")

   
    

When the the Worklist client receives an XML document with this structure, it displays the following dialog box to the user.

Figure 7-29 Enter Your Name Dialog Box

 
 

After the user enters the values for the first name and last name, the Worklist client returns the values in an XML document that conforms to the ClientSetVarsResp.dtd file. The XPath statements you defined are used by the workflow to extract the first and last name from the XML document, and to put those values into the Callback variables. The workflow can then use the values in the Callback variables for further processing.

Defining a Message Dialog Box

To define a prompt dialog box, the entries in the Send XML to Client dialog box should look like those shown in the following figure.

Figure 7-30 Send XML to Client Dialog Box

 

The XML document structure shown in the dialog box conforms to the ClientMsgBoxReq.dtd file. The contents of the DTD file are shown below.

Listing 7-2 Contents of the ClientMsgBoxReq.dtd File

<!ELEMENT message-box (#PCDATA, actionid)>
<!ATTLIST message-box title CDATA #IMPLIED
      style (plain|information|question|warning|error) "plain" 
      options (ok|ok_cancel|yes_no|yes_no_cancel) "ok">
<!ELEMENT actionid (#PCDATA)>

To define the message box:

1. Enter the following name for the root element of the XML document: message-box (all in lowercase, include the hyphen).

   Note: The system-generated actionid element and its value are used at run time to identify the Send XML to Client action. The actionid element must be the first child element of the root element. Do not move, delete or edit the actionid element, and do not add any subelements to it.

   If you change, move, or delete the actionid element, a warning message is displayed when you click OK in the Send XML to Client dialog box. The Studio then resets the actionid element and its value to the system-generated value and location.

2. Define title as an attribute of the root element.

3. The title takes the title value of the message-box that is displayed by the Worklist client. Enter the following value for the title attribute: Hello, Joe Smith.

4. Define style as an attribute of the root element, with a value of information.

5. Define options as an attribute of the root element, with a value of yes_no.

6. To complete the dialog box, you need to specify the Callback variable that will hold the response the user selects, and the XPath statements that will extract the value from the response XML document the Worklist client returns to the workflow. The response XML document conforms to the ClientMsgBoxResp.dtd file.

   The following table shows the Callback variable and the XPath statement you can use. You can create the XPath statement by typing it manually, or you can use the XPath wizard to create them from the ClientMsgBoxResp.dtd file.

   Note: To access the XPath wizard, click Add in the Send XML to Client dialog box. From the Workflow Variable Assignment dialog box, click the A+B button to open the Expression Builder, then click XPath Wizard. For details about using the XPath wizard, see Creating XPath Expressions and Functions Using the XPath Wizard in Using Expressions and Conditions.

   Table 7-3 Callback Variable and XPath Statement

   Callback Variable	XPath Statement
   option	XPath("message-box/attribute::option")

   
    

When the the Worklist client receives an XML document with this structure, it displays the following dialog box to the user.

Figure 7-31 Example Message-Box

 

After the user responds, the Worklist client returns the answer in an XML document that conforms to the ClientMsgBoxResp.dtd file. The XPath statement you defined is use by the workflow to extract the user's answer from the XML document, and to put the value into the Callback variable. The workflow can then use the value in the Callback variable for further processing.

Call Program

Use this action to call an executable program on the workflow server.

Figure 7-32 Call Program Dialog Box

 

View or enter information in the Call Program dialog box.

• Program — the fully qualified path to an executable program to execute at run time.

• Arguments — a valid workflow expression to be evaluated at run time and passed to the called program.

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• Notes — a free-form text box for notes about the action.

This action is executed asynchronously, meaning that any actions following this action in the action list are executed immediately, without waiting for the called program to complete.

Perform Business Operation

Use this action to invoke a software component, such as an EJB or Java class, to perform a business activity.

The business operation you want to invoke must already be defined. Additionally, any Java Object, Session EJB, and Entity EJB variables referenced by the business operation must also be defined. Ideally, technical personnel with detailed knowledge about the software components define the business operation, and they can assist you in making the correct selections for this action.

For details about defining business operations, see Understanding Business Operations. For details about defining variables, see Defining Variables.

Figure 7-33 Perform Business Operation Dialog Box

 

View or enter the following information in the Perform Business Operation dialog box.

• Operation — select the predefined business operation to invoke.

• Instance Variable — select the variable that contains the reference to the Java object or EJB that the business operation invokes. This option is available if the business operation invokes one of the following types of methods:

  • EJB remote method

  • Java class non-static, non-constructor method

    For these types of methods, the instance variable drop-down list displays the following types of variables: Java Object, Session EJB, and Entity EJB.

• Add — create a new instance variable not shown in the list using the Variable Properties dialog box. For details about the Variable Properties dialog box, see Defining Variables.

• Parameters — the business operation you select might have parameters that require values. If it does, you must enter values for the parameters. To add a parameter value to a listed parameter, highlight it, click Update, and use the invoked Expression Builder dialog box to define this value. (See Using the Expression Builder.)

• Assign Result To — assign the business operation result (for example, a calculated average) to a workflow variable. The drop-down list shows the available variables. When the business operation is invoked through the Perform Business Operation action, the method call assigns the result of its call to this variable.

• Add — create a new variable not shown in the list using the Variable Properties dialog box. For details about the Variable Properties dialog box, see Defining Variables.

• Notes — a free-form text box for notes about the action.

XSL Transform

XSLT is a specialized XML language that defines rules for translating an XML document into another XML or non-XML document. An XSL template document specifies which elements in the input XML document are to be transformed, and how they are to be transformed.

The XSL Transform action provides a way for you to specify an input XML document that is to be transformed, the XSL template document that specifies the details of the transformation, and a output variable that will contain the transformed document.

The actual transformation occurs at run time, and is performed by the XSL transformation engine bundled with WebLogic Server.

The input document can contain workflow expressions. If it does, BEA WebLogic Process Integrator resolves the expressions, and replaces the expression with the result before the transformation occurs.

Similarly, the XSL template document can contain references to workflow variables. If it does, BEA WebLogic Process Integrator resolves the references, and replaces the reference with the appropriate value before the transformation occurs.

To define the XSL Transform action:

1. Access the Add Action dialog box. This dialog box can be accessed from the various Properties dialog boxes in BEA WebLogic Process Integrator. For example, in the workflow drawing area, right-click a task and choose Properties. This displays the Task Properties dialog box.

2. In the Task Properties dialog box, click Add to display the Add Action dialog box.

3. Under Integration Actions, select XSL Transform, and click OK to display the XSL Transform dialog box.

   Figure 7-34 XSL Transform Dialog Box

   
    

4. In the Input Document field, enter an expression that represents the XML document you want to transform. The expression is evaluated at run time to obtain the XML document.

   Note: Expressions are built using WebLogic Process Integrator expression syntax. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

5. In one of the Transform Document fields, specify the XSL template document that is used to transform the input document. Specify the XSL template document in one of following ways:

   • Expression — represents the XSL template document. The expression is evaluated at run time to obtain the XSL template document. Enter the expression directly, or use the Expression Builder to construct the expression.

   • Repository — contains the name of an XSL template document stored in the XML repository. Enter the name of the document directly, or click the XML button to display the XML Finder dialog box. The name of the XSL template document is stored in the workflow template definition.

     The XML Finder dialog box helps you find XML objects stored in the XML repository, the local file system, or at a URL. For more information about using the XML Finder, see Locating XML Entities Using the XML Finder.

6. From the Output Variable drop-down list, select the variable that will contain the transformed XML document. The variable must be an XML type variable. You can also type the name of a variable. If it does not exist, you will be prompted to create it. For details about defining variables, see Understanding Variables.

7. In the Notes field, enter any notes about this action.

8. Click OK.

 

---

Using Exception Handling Actions

For instructions on using exception handling actions, see Using Exception Handling Actions.

 

---

Using Miscellaneous Actions

This section defines and describes how to use the following miscellaneous actions:

• No Operation

• Send E-Mail Message

• Evaluate Condition

• Timed Event

• Cancel Workflow Event

• Make Audit Entry

No Operation

The No Operation action has no function; it simply acts as a placeholder to remind an analyst to add an action at a later time.

Figure 7-35 No Operation Dialog Box

 
 

View or enter information in the No Operation dialog box.

• Description — enter a descriptive name for the No Operation action (preferably a name that will remind you to add an action at a later time).

• Notes — a free-form text box for notes about the action.

Send E-Mail Message

Send an e-mail message to a user of the BEA WebLogic Process Integrator system or even to an outside party. Internet standard SMTP protocol is used to transmit the message.

Note: This action requires configuration in the config.xml file. For details, see Installing and Configuring BEA WebLogic Process Integrator.

Figure 7-36 Send E-Mail Message Dialog Box

 

View or enter information in the Send E-Mail Message dialog box.

• Subject — a valid workflow expression or a literal entered in double quotes that will be evaluated at run time for the subject text of the e-mail.

• Message — a valid workflow expression or a literal entered in double quotes that will be evaluated at run time for the message text of the e-mail.

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• TO, CC, and BCC — determine how the e-mail should be addressed.

• Notes — a free-form text box for notes about the action.

Click OK to display the Mail Recipient dialog box.

Figure 7-37 Mail Recipient Dialog Box

 

• Address — if selected, an edit field displays the e-mail address.

• User — if selected, a drop-down list displays a list of all the users. The e-mail address is obtained from the user's profile.

• Role — if selected, a drop-down list displays a list of all roles. The e-mail message will be sent to all users assigned to that role.

• Expression — the e-mail address is derived from an expression value.

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• Notes — a free-form text box for notes about the action.

Evaluate Condition

Evaluate a conditional expression at run time and perform alternative sequences of subactions depending on the result. If the condition evaluates to True, one sequence of actions is performed, and if it is False, a different sequence of actions is performed instead. For example, a manager may be authorized to make purchases with a total value that is less than a specified amount, requiring higher approval if the amount exceeds this threshold. When a manager starts a purchase requisition workflow, the workflow can use an Evaluate Condition action to check whether this threshold would be exceeded, and to assign the task of approving the requisition either to the authorized person or to the manager.

Figure 7-38 Evaluate Condition Dialog Box

 

View or enter information in the Evaluate Condition dialog box.

• Condition — a valid workflow condition, evaluated at run time to determine which set of subactions to perform.

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• Actions to execute by condition result — a tabbed display showing two sets of subactions. Either the True or the False set of subactions will be executed, depending on the result of the condition evaluation.

• Notes — a free-form text box for notes about the action.

Timed Event

Create a timed even that will be triggered at an exact time and date according to a specified execution schedule.

Figure 7-39 Timed Event: Trigger Event Tab

 

View or enter information in the Trigger Event tab.

• From action execution — perform the trigger upon action execution, based on a specified unit of time. Use the drop-down list to the right to select the unit of time, and in the field to the left, enter a number to be associated with the unit of time. For example, if you choose "4 Minutes," the event will be triggered four minutes after the preceding event is executed.

• To Expression — timed event will be triggered according to a date expression.

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• Business Calendar -— if you select the interval Business Hours or Business Days, the business calendar is used.

  • For Organization — use the business calendar assigned to the organization for which the workflow template definition instance will be executed.

  • For Assignee — use the calendar that belongs to the user or role owning the task that precedes the event to be triggered.

The Execution Schedule tab of the Timed Event dialog box allows you to specify that the event will be repeated according to a specified unit of time until the task is marked done or the workflow template definition is done.

Figure 7-40 Timed Event: Execution Schedule Tab

 

View or enter information in the Execution Schedule tab.

• Reschedule every — repeat the trigger upon task execution, based on a specified unit of time. Use the drop-down list to the right to select the unit of time, and in the field to the left, enter a number to be associated with the unit of time. For example, if you choose "4 Minutes," the event will be triggered every four minutes until the task is marked done or the workflow template definition is done.

• Stop execution when — specify when the trigger should stop, either when the current task is completed or when the entire workflow is completed.

  • Task is done — the trigger will stop when the preceding task in which this action is specified is marked as done.

  • Workflow is done — the trigger will stop when the entire workflow is completed.

    Figure 7-41 Timed Event: Actions When Triggered Tab

    
     

View or enter information in the Actions when triggered tab.

• Add — invokes the Add Action dialog box. Select the action(s) to be triggered by the timed event.

• Update — updates the selected action to be triggered by the timed event. Highlight the action to be updated to invoke the relevant Action dialog box, where you can make updates to the action.

• Delete — deletes the selected action from the timed event.

  Figure 7-42 Timed Event: Notes Tab

  
   

Use the Notes tab of the Timed Event dialog box to make notes about the action.

Cancel Workflow Event

This action cancels an event that has been defined within a workflow.

Figure 7-43 Cancel Workflow Event Dialog Box

 

View or enter information in the Cancel Workflow Event dialog box.

• Event to Cancel — displays all events defined in the workflow. Highlight the workflow event to be canceled. (Hold down the CTRL key to highlight more than one event.) Click OK to proceed with the cancellation.

• Notes — a free-form text box for notes about the action.

Make Audit Entry

This action allows you to specify an additional audit entry expression. This audit entry will be published to a Java Message Service (JMS) topic for further retrieval. The audit entry can be an expression built with functions and workflow variables, but it can also be a string of text.

Note: The JMS topic is specified in the Template Definition Properties dialog box. For further information, refer to Creating a New Workflow Template Definition.

BEA WebLogic Process Integrator provides a default audit facility whereby all major user interactions and changes are published to the JMS topic. The Make Audit Entry action allows you to add an additional specific audit entry; such an audit entry might be used, for example, to track the value of a variable.

Figure 7-44 Make Audit Entry Dialog Box

 

The Make Audit Entry dialog box contains the following:

• Audit entry expression — enter an audit entry expression to be set out to the audit listener for further retrieval at run time.

  Note: Expressions are built using WebLogic Process Integrator expression syntax and typically use the syntax of XPath function to extract values out of XML documents. If you know the syntax of the expression you want to use, you can type the expression directly in the field. Alternatively, click the A+B button to display the Expression Builder dialog box. The Expression Builder helps you construct an expression, which is made up of functions, operators, literals, and variables. For more information on constructing expressions, see Using Expressions and Conditions.

• Notes — a free-form text box for notes about the action.