Modeling and Implementation Guide for Oracle Business Process Management
View PDF

8 Handling Information in Your Process Design

This chapter describes how to handle the information in your process using data objects and project data objects. It also shows you how to pass that information along the process and how to transform it when necessary.

This chapter includes the following sections:

8.1 Introduction to Handling the Information in Your Process Design

Generally processes access and store information. Often the process flow is based on the value of this information. In other cases this information is the result of running the tasks in the process.

Oracle BPM supports the following data structures to keep track of this information:

Additionally, you can pass information between the different elements of a process using data associations.

8.2 Introduction to Data Objects

The main elements that compose a business process are a workflow and information related to that workflow. The information of a process may change as you run the process. This information defines the state of a process at a given time.

This information determines how the process behaves for a particular instance. According to the value of this information the instance may take one path or another. You may monitor this information or store it to an external system.

The main elements that compose a business process are a workflow and information related to that workflow. The information of a process may change as the process runs. This information defines the state of a process at a given time.

The purchase order process uses the following information:

Oracle BPM uses data objects to store the information related to the process. The value of these variables may or may not change as you run the process.

Oracle BPM data objects have the following characteristics:

Data objects store information related to each process instance you create. The value of these data objects is different for every instance in the process.

When you define a process you must define the data object to store information. You must also define in which part of the process you assign a value to these data objects. The value of data objects may come from the user input, from external systems or might be calculated based on other data objects.

When you create an instance, the Process Engine assings Null as the default value for all the data objects defined for that process. Later on the activities in the process assign values to these variables.

In the purchase order process each order has its own total amount, payment type and customer ID. You can model this data data by defining data objects that store this process information.

8.2.1 Supported Data Types for Data Objects

You can set the type of a data object to the following data types:

8.3 Working with Process Data Objects

You can add new process data objects to the process you are working on. If necessary you can edit or remove them after you create them.

Typically the services in your process modify the value of the data objects in your process, but you might assign them an initial value, or change their value during the process.

8.3.1 How to Add a Process Data Object

To add a process data object:

  1. In the Project Navigator window, select the process where you want to add the data object.

  2. In the Structure window, right-click the Process Data Objects node.

  3. Select New.

  4. Enter a name to identify the data object.

    See

  5. Select a type from the Type list or click the Browse More Types button to select a type that is not included in the list.

  6. Click OK.

8.3.2 How to Edit a Process Data Object

To edit a process data object:

  1. In the Project Navigator window, select the process that contains the data object you want to edit.

  2. In the Structure window, expand the Process Data Objects node.

  3. Right-click the data object you wan to edit.

  4. Select Edit.

    A dialog to edit the data object name and type appears.

  5. Make the changes you want.

  6. Click OK.

8.3.3 How to Delete a Data Object

To delete a data object:

  1. In the Project Navigator window, select the process that contains the data object you want to edit.

  2. In the Structure window, expand the Process Data Objects node.

  3. Right-click the data object you want to edit.

  4. Select Delete.

    A confirmation message appears.

  5. Click OK.

8.3.4 How to Assign a Value to a Process Data Object

To assign a value to a process data object:

  1. In the Process Editor, add a script task to the process.

  2. Edit the implementation properties of the script task.

  3. Define the data association or transformation to assign the value to the process data object.

    See Section 8.13, "Introduction to Data Associations" for information on how to define a data association.

    See Section 8.14, "Introduction to Transformations" for information on how to define a transformation.

8.4 Introduction to Predefined Data Objects

There is certain data, like the status of the process, that applies to all the process you defined. You can use this data to trigger an event based on its value, or to provide it as input to a service. In both cases the process flow depends on the value of this data.

Oracle BPM tracks this data using a predefined set of data objects. You can access this data objects in the same way you access regular data objects, but you cannot assign them new values.

Table 8-1 provides detailed information about the predefined data objects available for the different elements of a process.

Table 8-1 Predefined Data Objects

Name Type Description Availability

state

String

Possible values are:

  • inactive

  • ready

  • withdrawn

  • active

  • terminated

  • failed

  • completing

  • completed

  • compensated

  • compensating

  • closed

At process level.

state

String

Specifies the state of the instance sitting in this activity.

Possible values are:

  • none

  • ready

  • active

  • canceled

  • aborted

  • completing

  • completed

In user tasks.

actualOwner

String

Specifies the user assigned to the instance sitting in this activity.

In user tasks.

taskPriority

Int

Specifies the priority of the that the end user sees. This priority helps the user identify the importance of the task.

Possible values are:

In user tasks.

loopCounter

Int

Specifies the number of times the engine ran this activity. The Process Engine updates this variable each time it runs a new loop.

In activities with loop marker.

loopCounter

Int

Specifies the sequence number that identifies each of the activations of this activity. The BPMN Engine assigns this number to each activation when it runs the activity.

In activities with multi-instance marker.

numberOfInstances

Int

.Specifies the number of activations created for a multi-instance activity. You can only access this value from the main instance.

In activities with multi-instance marker.

numberOfActiveInstances

Int

Specifies the number of active inner instances for a multi-instance activity. You can only access this value from the main instance.

For sequential multi-instance activities this value is either 1 or 0.

For parallel multi-instance activities this value is smaller or equal to the value specified by the predefined data object numberOfInstances.

In activities with multi-instance marker.

numberOfCompletedInstances

Int

Specifies the number of completed inner instances for a a multi-instance activity. You can only access this value from the main instance.

In activities with multi-instance marker.

numberOfTerminatedInstances

Int

Specifies the number of terminated inner instances for a a multi-instance activity. You can only access this value from the main instance.

In activities with multi-instance marker.

activationCount

Int

Specifies the number of tokens in the incoming sequence flow of the gateway.

In complex gateways.

numParticipants

Int

Specifies the number of roles that a participant has in the collaborations defined in the BPM Project.

In process elements marked as participants of a collaboration.


8.5 Working with Predefined Data Objects

Some process elements support predefined data objects. You can use these predefined data objects to control the flow of a process. Generally the Process Engine assigns the values of predefined data objects, however some of them require you to assign them a value.

8.6 Introduction to Sub-Process Data Objects

You can define data objects for a certain sub-process. These data objects are available only when the sub-process is running. When the instance leaves the sub-process the value of sub-process data objects is lost.

Using sub-process data objects is a good practice because:

From within a sub-process you can access process data objects and sub-process data objects. If the name of a sub-process data object matches the name of a process data object, then when you access the data object you obtain the value of the sub-process data object. CAT-TODO: Find out if you can access a process data object from within a sub-process.

8.7 Working with Sub-Process Data Objects

You can add new project data objects to the project you are working on. If necessary you can edit or remove them.

8.7.1 Adding a Data Object to a Sub-Process

To add a data object to a sub-process:

  1. In the Project Navigator window, select the process that contains the sub-process where you want to add a data object.

  2. In the Structure window, expand the Activities node.

  3. Expand the node that corresponds to the sub-process.

  4. Right-click the Data Objects node located under the sub-process node.

  5. Select New.

  6. Provide a name to identify the new data object.

  7. Select a type or click the Browse More Types button to select a type that is not included in the list..

  8. Click OK.

8.7.2 Editing a Data Object in a Sub-Process

To edit a data object in a sub-process:

  1. In the Project Navigator window, select the process that contains the sub-process with the data object you want to edit.

  2. In the Structure window, expand the Activities node.

  3. In the Structure window, expand the Activities node.

  4. Expand the node that corresponds to the sub-process.

  5. Expand the Data Objects node located under the sub-process node.

  6. Right-click the data object you want to edit.

  7. Select Edit.

    A dialog to edit the data object name and type appears.

  8. Make the changes you want.

  9. Click OK.

8.7.3 Removing a Data Object from a Sub-Process

To remove a data object from a sub-process:

  1. In the Project Navigator window, select the process that contains the sub-process with the data object you want to remove.

  2. In the Structure window, expand the Activities node.

  3. In the Structure window, expand the Activities node.

  4. Expand the node that corresponds to the sub-process.

  5. Expand the Data Objects node located under the sub-process node.

  6. Right-click the data object you want to remove.

  7. Select Delete.

    A confirmation dialog appears.

  8. Click OK.

8.8 Introduction to Project Data Objects

The processes in a BPM project often have a set of data they share. For example, the Purchase Order process and the Request Approval process may both track the value of the employee that created the request, or the priority of the request. The value of this data is different for every instance in each of those processes, they only share the necessity to keep track of that data.

Project data objects allow you to ensure that all the processes in a certain project keep track of a set of data. Then each process has to assign and update the value of this data.

The main benefit of defining project data objects is that after publishing your project you can configure WorkSpace views to show the values of those variables. This is only possible if you use project data objects.

Another benefit is that if you change the definition of a data object then you only have to do it one time, as opposed to having to make those changes in all the processes in the project that define the same data object.


Note:
It is not advisable to change the data type of a project data object after deploying a BPM Project. This can cause problems when the Process WorkSpace tries to render the value of the instances created before changing the data type.

8.8.1 Business Indicators

When you mark a project data object as a business indicator the Process Engine stores its value in the BAM and DataMart databases. You can use this information to monitor the process activity.

For more information about Business Activity Monitoring, see Chapter 11, "Using Process Analytics".

8.8.2 Supported Data Types for Project Data Objects

You can set the type of a project data object to the following data types:

8.9 Working with Project Data Objects

You can add new project data objects to the project you are working on. If necessary you can edit or remove them.

8.9.1 How to Add a Project Data Object

To add a project data object:

  1. In the BPM Project Navigator, select a project.

  2. In the Structure window, right-click the Project Data Objects node.

  3. Select New.

  4. Provide a name to identify the new project data object.

    Note: You cannot use the name of existing process data objects.

  5. Select a type.

    Some types allow you to define their lenght or decimal places.

  6. Click OK.

8.9.2 How to Edit a Project Data Object

To edit a project data object:

  1. In the BPM Project Navigator window, select a project.

  2. In the Structure window, expand the Project Data Objects node.

  3. Right-click the project data object you want to edit.

  4. Select Edit.

    A dialog to edit the project data object properties appears.

  5. Make the changes you want.

  6. Click OK.

8.9.3 How to Delete a Project Data Object

How to delete a project data object:

  1. In the BPM Project Navigator window, select a project.

  2. In the Structure windows, expand the Project Data Objects node.

  3. Right-click the project data object you want to delete.

    A confirmation message appears.

  4. Click OK.

8.9.4 How to Assign a Value to a Project Data Object

To assign a value to a project data object:

  1. In the Process Editor, add a script task to the process.

  2. Edit the implementation properties of the script task.

  3. Define the data association or transformation to assign the value to the project data object.

    See Section 8.13, "Introduction to Data Associations" for information on how to define a data association.

    See Section 8.14, "Introduction to Transformations" for information on how to define a transformation.

8.10 Introduction to Arguments

You can use arguments to pass data between the different components in a process.

A component may require you to provide certain data when you invoke it. To pass this data you use input arguments.

When you run a component, it provides it results through its output arguments.

The process components that may have arguments are:

8.11 Naming Conventions

When you name a data object, a project data object or an argument, you should respect the following rules:

8.12 Scope and Access

The scope an acess varies according to the structure used to store information:

Figure 8-1 Scope of the Data Structures in a Process

CAT-TODO: Add alternative text.

Figure 8-2 Scope and Life Span of Project Data Objects

CAT-TODO: Add alt text

8.13 Introduction to Data Associations

Data associations are used to pass the information stored in data objects in the following contexts:

Table Figure 8-2 lists the flow objects where you can define data associations. It also lists the objects implemented.

Table 8-2 Flow Objects that Accept Data Associations

Flow Objects Implementation

Message start and end events

Services and other BPMN processes

Message throw and catch events

Services and other BPMN processes

Send and receive tasks

Services and other BPMN processes

Script tasks

Do not contain an implementation, are used to pass data objects through data associations.

User tasks

Oracle Human Tasks

Business rule tasks

Oracle Business Rules

Service Tasks

Services and BPMN processes


You can use data associations to define the input and output from a flow object to an external service or process.

It is important to note that although the inputs and outputs are defined in the data associations for a flow object, the defined values are passed to the implemented systems and services.

You can use expressions to evaluate and change the input and output values

8.13.1 Introduction to the Data Association Editor

The data associations editor enables you to configure the input and output values passed between a flow object and a its implementation.

Figure 8-3 shows the data association for the Enter Quote user task in the Sales Quote example.

Figure 8-3 The Data Association Editor


Table 8-3 describes the different areas of the data association editor.

Table 8-3 The Data Association Editor User Interface

UI Area Description

Inputs

Contains text boxes that display the data objects assigned as inputs to the service or process implemented in the flow object. Next to each text box is an icon that launches the expression editor

Flow Object Interface

Lists the expected input arguments for the service or process implemented. The flow object interface also contains an expandable list of the data objects supplied as input and output. Within the flow object area, you can expand complex data objects to map to specific basic data objects within a complex data object.

Outputs

Contains text boxes that display the data objects assigned as outputs from the service or process implemented in the flow object.

Data Objects

Displays a list of all the data objects. This list is divided between process and project data objects.


8.14 Introduction to Transformations

You can use XSL tranformations to tranform:

You can combine the use of transformations with the use of data associations only if you apply them over different arguments.


Note:
You must not use transformations and data associations to map the value of an argument simultaneously.

When you define the transformation you can only use as sources data objects that are based on an business object created using an XML schema or type.

8.15 Defining Tranformations

You can modify the values you use assign to input arguments and output arguments in the implementation of a flow object using XSL tranformations.

8.15.1 How to Define a Transformation

You can define an XSLT tranformation to tranform the data you pass to and from the implementation of a flow object.

To Define a transformation:

  1. Edit the flow object implementation properties.

  2. Select Use Transformation.

  3. Click the Edit XSL Transformation button.

    The Tranformation dialog appears.

  4. Click the input or ouput according to the argument value to transform.

  5. Click Add.

    The Transformation dialog appears.

  6. From the Sources List, select a source.

    The sources list only contains data objects that are based on on a business object created using an XML schema or type.

  7. Click Add.

    The source appears in the Selected Elements list.

  8. From the Target list, select a target to assign the result of the transformation.

  9. In the Tranformation section select a way to define the transformation:

    • Create: creates a new transformation and opens the SOA transformation editor for you to define the transformation.

    • Use Existing: enables you to select an exisiting transformation that you copied to the project XSL directory.

8.15.2 What Happens When You Define a Transformation

The BPMN Service Engine uses the specified XSL transformation to assign the values of the input an output arguments of a flow object. The XSL transformation modifies the values before assigning them.