Ponents

Download as pdf or txt
Download as pdf or txt
You are on page 1of 6

Oracle APPS Workflow Builder Chapter 02:Workflow Builder Components

AAST/AZZA SHOUKR

Chapter02
Work Flow Builder Components

• Attributes
• Lookups
• Notifications
• Messages

Page 1 of 6
Oracle APPS Workflow Builder Chapter 02:Workflow Builder Components
AAST/AZZA SHOUKR

1. Attributes
• An item type attribute is a property associated with a given item type.
• It acts as a global variable that can be referenced or updated by any activity within a
process.
• You must define an item type before you can define the item attributes associated with it.
– Use the Quick Start Wizard to quickly create a new process framework, including
an item type
– Define item types manually in the navigator tree

Attribute Data Types


• Text: A string of text of specified character length.
• Number: A number with an optional format mask.
• Date: A date with an optional format mask.
• Lookup: A lookup code value from a specified lookup type.
• Role: A role name from the list of roles defined in the directory service.
• Attribute: The internal name of another existing item type attribute to which you
want to maintain references in a process.
• URL: A Universal Resource Locator (URL) to a network location.
• Form: The internal function name and any optional form parameters of an Oracle
E-Business Suite form function.
• Document: An attached document, as specified by the document type. PL/SQL,
PL/SQL CLOB, and PL/SQL BLOB documents are files representing data from the
database as a character string, a character large object (CLOB), or a binary large
object (BLOB), respectively. A document attribute can also be defined as a JSP
call to an Oracle Application Framework region for inclusion in a notification
message.
Event: A Business Event System event message in the standard WF_EVENT_T structure.

Deleting Item Attributes


• Use the Oracle Workflow Builder to delete item attributes from a workflow definition in a
database.
• You must be connected to the database to actually delete an attribute from that
database. Deleting the attribute from a flat file and uploading the flat file will not delete
the attribute from the database.

Page 2 of 6
Oracle APPS Workflow Builder Chapter 02:Workflow Builder Components
AAST/AZZA SHOUKR

2. Defining Lookup Types


a. A lookup type is a static list of values.
b. These lists can be referenced by activities and by item type, message, or activity
attributes. For example:
i. An activity can reference a lookup type for its possible result values.
ii. A message attribute can reference a lookup type to provide a list of possible
responses to the performer of a notification.
c. Lookup types are defined in the navigator
tree beneath the Lookup Types branch of an item type.

d. Lookup codes represent the actual values in a lookup type.

e. The lookup codes for a lookup type are defined in the navigator tree beneath the lookup
type.

3. Notifications
a. A notification activity is a step in a workflow process used to communicate with a human
being.
b. A notification activity sends a message to a user containing the information needed to
complete the work.
c. The notification may or may not require a response from the recipient.

Notification activities must be associated with an item type and are created in the navigator tree
beneath the Notifications branch of the item type.
In Oracle Workflow Builder,

1.select the item type that you want in the navigator tree. Then select New Notification from the Edit
menu.

2. On the Activity property page, enter an internal name for the activity. The internal name must be
all uppercase without any colons or leading or trailing spaces.

3. Enter a display name for the activity.


4. Enter a description of the activity.
5. Select an icon that identifies the activity.

6. Optionally specify a PL/SQL stored procedure in the Function field. The procedure is known as
a post-notification function and can be used to couple processing logic to the notification activity.

Page 3 of 6
Oracle APPS Workflow Builder Chapter 02:Workflow Builder Components
AAST/AZZA SHOUKR

7. Specify the result type that contains the possible results that the notification can return. If the
message for the notification includes a result, then the result type of the notification activity must be
the same as the lookup type that the message result references.

8. Select the message that this notification sends.


9. Select the Expand Roles check box if you want to send this notification to a multiuser role and
ensure that each user receives an individual copy of the notification. You should always select the
Expand Roles check box for FYI-type notifications.

10. Choose Apply to save your changes.


11. Optionally select the Details tab to display and modify additional activity details.
12. Optionally select the Access tab to set the access levels allowed to modify this activity.

Defining a Notification Activity Node

• When you add a notification activity node to a workflow process, define the properties for
that individual instance of the activity in the Node tab of the activity property pages.
• Important properties for a notification activity node include:
– Timeout
– Performer

Defining a Timeout for a Notification

The timeout value for a notification activity node specifies whether the notification response must be
received by a certain time.
• No Timeout
• Relative Time
• Item Attribute

Defining a Performer for a Notification

• The performer is the role to whom the notification is sent.


• You can select either a constant role name or an item type attribute that dynamically
determines the role at run time.
• Note that you must first create an item attribute of type role or text to store the dynamic
role name before you can reference that item attribute in the Performer field.

Page 4 of 6
Oracle APPS Workflow Builder Chapter 02:Workflow Builder Components
AAST/AZZA SHOUKR

4. Messages
a. A message specifies the information that is sent to a user by a notification activity.
b. Messages must be associated with an item type and are created in the navigator tree
under the Messages branch of the item type.
c.
To create a new message:
1. In the Oracle Workflow Builder, select the item type you want in the navigator tree. Then
select New Message from the Edit menu.
2. On the Message property page, enter an internal name for the message. The internal
name must be all uppercase without any colons or leading or trailing spaces.
3. Enter a display name for the message.
4. Enter a description of the message.
5. Select the priority for the message (High, Normal, or Low). Message recipients can sort
their notifications based on the priority.
6. Click Apply to save your changes.

• After creating a new message, you must define the subject and body of the message.
• You can optionally include message attributes in the subject or body.
– In the subject or body of the message, specify the internal name of the message
attribute and precede that internal name with an ampersand (“&”).
– Message attributes are token substituted with a run-time value when the message
is sent.

To define the body for a message:

1. In the message property pages, select the Body tab.


2. Enter the subject line for the message.
3. Enter the plain text message body in the Text Body tab.
4. Enter the HTML-formatted message body in the HTML Body tab.
5. Choose Apply to save your changes.

Page 5 of 6
Oracle APPS Workflow Builder Chapter 02:Workflow Builder Components
AAST/AZZA SHOUKR

Defining a Message Attribute

• A message attribute is a variable that you define for a particular message to either
provide information or prompt for a response when the message is sent in a notification.
• Message attributes must be associated with a message and are defined in the navigator
tree beneath that message.

To define a message attribute:


1. In the Oracle Workflow Builder, select the message you want in the navigator tree. Then
select New Attribute from the Edit menu.
2. On the Attribute property page, enter an internal name for the attribute. The internal
name must be all uppercase without any colons or leading or trailing spaces.
3. Enter a display name for the attribute.
4. Enter a description of the attribute.
5. In the Type field, select the data type for the attribute.
6. Depending on the data type, enter format information, if applicable.
7. Specify either Send or Respond in the Source field to indicate whether the attribute
should send information to the recipient or prompt the recipient for a response, respectively.
You should set the source to Send for any message attributes that you include in the message
subject and message body for token substitution.
8. Set the default value of a Send attribute to reference either a constant or the run-time
value of an item type attribute. You can optionally set a default value for a Respond attribute as
well.
9. Choose Apply to save your changes.

Defining a Respond Attribute


• If you want the message to prompt for a response from the recipient, then define a
message attribute with the source set to Respond.
• The Notification System uses a message's Respond attributes to generate the response
section of the notification.
• A message can have multiple Respond attributes.
• If you define a result for a message, the result is automatically defined as a special
Respond attribute with the internal name RESULT.
• The icon for a Respond attribute in the navigator tree includes a red question mark in its lower
left corner to distinguish it from Send attributes.
• The Notification System uses the Respond attributes defined for the message to generate the
response section of the notification sent to the recipient. The response section is composed
differently depending on whether the recipient receives the notification as a plain text e-mail
notification, as an HTML-formatted e-mail notification, or through the Notification Details Web
page. For plain text e-mail notifications, the response section is also composed differently
depending on whether your organization uses the direct response method or the templated
response method. (HTML e-mail notifications always use the templated response method.)

Page 6 of 6

You might also like