17 Using the Notification Service

When you drag the Email icon from the Components window, the Email dialog appears. Figure 17-2 shows the required email notification parameters.

Figure 17-2 Email Dialog

Description of "Figure 17-2 Email Dialog"

1. Enter information for each field as described in Table 17-3.

   Note:

   For the To, CC, and Bcc fields, separate multiple addresses with a semicolon (;).

   Table 17-3 Email Notification Parameters

   Name	Description
   Name	Enter a name or accept the default name of EmailNumber.
   From Account	The name of the account used to send this message. The default account is named Default and is editable from the Mailer tab of the Workflow Notification Properties page in Oracle Enterprise Manager Fusion Middleware Control. To add additional accounts, you must use the System MBean Browser in Oracle Enterprise Manager Fusion Middleware Control. For information on editing this property in Oracle Enterprise Manager Fusion Middleware Control, see Administering Oracle SOA Suite and Oracle Business Process Management Suite.
   To	The email address to which to deliver the message. This can be one of the following: A static email address entered at the time the message is created An email address retrieved using the identity service A dynamic address from the payload The XPath Expression Builder can get the dynamic email address from the input. See How to Select Email Addresses and Telephone Numbers Dynamically.
   CC and Bcc	The email addresses to which the message is copied and blind copied. This can also be a static or dynamic address, as described for the To address.
   Reply To	The email address to use for replies. This can also be a static or dynamic address, as described for the To address.
   Subject	The subject of the email message. This can be plain text or dynamic text. The XPath Expression Builder can set dynamic text based on data from process variables that you specify.
   Body	The message body of the email message. This can also be plain text, HTML, or dynamic text, as described for the Subject parameter.

2. Click OK.

   The BPEL fragment that invokes the notification service to send the email message is created.

3. See Table 17-1 of Introduction to Notification Channel Setup for additional configuration procedures to perform outside of Oracle JDeveloper.

   The following example uses an email activity in a scope named Scope_NotifyCustomerofCompletion. The Oracle User Messaging Service sends the email to a customer when an order is fulfilled. The following details are specified in the Email dialog:

   • An XPath expression specifies the customer's email address.

     bpws:getVariableData('gCustomerInfoVariable','parameters','/ns3:findCustome
     rInfoVO1CustomerInfoVOCriteriaResponse/ns3:result/ns2:ConfirmedEmail')
     

   • A combination of manually-entered text and an XPath expression specifies the ID of the order:

     Order with id
     <%bpws:getVariableData('gOrderInfoVariable','/ns2:orderInfoVOSDO/ns2:OrderI
     d')%> shipped!
     

   • A combination of manually-entered text and an XPath expression specifies the body of the email message:

     Dear<%bpws:getVariableData('gCustomerInfoVariable','parameters','/ns6:findCusto
     merInfoVO1CustomerInfoVOCriteriaResponse/ns6:result/ns4:FirstName')%>,
     your order has been shipped.
     

   Figure 17-3 provides details.

   Figure 17-3 Email Dialog

   
   Description of "Figure 17-3 Email Dialog"

When you drag the IM icon from the Components window, the IM dialog appears. Figure 17-6 shows the required IM notification parameters.

Figure 17-6 IM Dialog

Description of "Figure 17-6 IM Dialog"

1. Enter information for each field as described in Table 17-4.

   Table 17-4 IM Notification Parameters

   Name	Description
   Name	Enter a name or accept the default name of IMNumber.
   To	The IM address to which to deliver the message. Enter the address manually or click the XPath Expression Builder icon to display the Expression Builder dialog to dynamically enter an account.
   Body	The IM message body. This can be plain text or dynamic text. The XPath Expression Builder can set dynamic text based on data from process variables that you specify.

2. Click OK.

   The BPEL fragment that invokes the notification service for IM notification is created.

3. See Table 17-1 of Introduction to Notification Channel Setup for additional configuration procedures to perform outside of Oracle JDeveloper.

When you drag the SMS icon from the Components window, the SMS dialog appears. Figure 17-7 shows the required SMS notification parameters.

Figure 17-7 SMS Dialog

Description of "Figure 17-7 SMS Dialog"

1. Enter information for each field as described in Table 17-5.

   Table 17-5 SMS Notification Parameters

   Name	Description
   Name	Enter a name or accept the default name of SMSNumber.
   From #	The telephone number from which to send the SMS notification. This can be a static telephone number entered at the time the message is created or a dynamic telephone number from the payload. The XPath Expression Builder can get the dynamic telephone number from the input. See How to Select Email Addresses and Telephone Numbers Dynamically.
   Telephone #	Select a method for specifying the telephone number to which to deliver the message: A static telephone number entered at the time the message is created. A telephone number retrieved using the identity service. A dynamic telephone number from the payload. The XPath Expression Builder can get the dynamic telephone number from the input.
   Subject	The subject of the SMS message. This can be plain text or dynamic text. The XPath Expression Builder can set dynamic text based on data from process variables that you specify.
   Body	The SMS message body. This must be plain text. This can be plain text or dynamic text as described for the Subject parameter.

2. Click OK.

   The BPEL fragment that invokes the notification service for SMS notification is created.

3. See Table 17-1 of Introduction to Notification Channel Setup for additional configuration procedures to perform outside of Oracle JDeveloper.

When you drag the Voice icon from the Components window, the Voice dialog appears. Figure 17-8 shows the required voice notification parameters.

Figure 17-8 Voice Dialog

Description of "Figure 17-8 Voice Dialog"

1. Enter information for each field as described in Table 17-6.

   Table 17-6 Voice Notification Parameters

   Name	Description
   Name	Enter a name or accept the default name of VoiceNumber.
   Telephone #	The telephone number to which to deliver the message. Specify the number through one of the following methods: A static telephone number entered at the time the message is created A telephone number retrieved using the identity service A dynamic telephone number from the payload The XPath Expression Builder can retrieve the dynamic telephone number from the input.
   Body	The message body. This can be plain text, XML, or dynamic text. The XPath Expression Builder can set dynamic text based on data from process variables that you specify.

2. Click OK.

   The BPEL fragment that invokes the notification service for voice notification is created.

3. See Table 17-1 of Introduction to Notification Channel Setup for additional configuration procedures to perform outside of Oracle JDeveloper.

You can set email addresses or telephone numbers dynamically based on certain process variables. You can also look up contact information for a specific user using the built-in XPath functions for the identity service:

• To get the email address or telephone number directly from the payload, use the following XPath expression:

  bpws:getVariableData('<variable name>', '<part>','input_xpath_to_get_an_address')
  

  For example, to get the email address from variable inputVariable and part payload based on XPath /client/BPELProcessRequest/client/mail:

  <%bpws:getVariableData('inputVariable','payload','/client:BPELProcessRequest/
  client:email')%>
  

  You can use the XPath Expression Builder to select the function and enter the XPath expression to get an address from the input variable.

• To get the email address or telephone number dynamically from the underlying identity store (LDAP) use the following XPath expression:

  ids:getUserProperty(userName, attributeName[, realmName])
  

  The first argument evaluates to the user ID. The second argument is the property name. The third argument is the realm name. Table 17-7 lists the property names that can be used with this XPath function.

  Table 17-7 Properties for the Dynamic User XPath Function

  Property Name	Description
  mail	Look up a user's email address.
  telephoneNumber	Look up a user's telephone number.
  mobile	Look up a user's mobile telephone number.
  homephone	Look up a user's home telephone number.

  The following example gets the email address of the user identified by the variable inputVariable, part payload, and queries /client:BPELProcessRequest/client:userID:

  ids:getUserProperty(bpws:getVariableData(‘inputVariable',
  ‘payload',‘/client:BPELProcessRequest/client:userid'), ‘mail')
  

  If realmName is not specified, then the default realm name is used. For example, if the default realm name is jazn.com, the following XPath expression searches for the user in the jazn.com realm:

  ids:getUserProperty('jcooper', 'mail');
  

  The following XPath expression provides the same functionality as the one above. In this case, however, the realm name of jazn.com is explicitly specified:

  ids:getUserProperty('jcooper', 'mail', 'jazn.com');
  

You can select users or groups in Oracle JDeveloper to whom you want to send notifications by browsing the user directory (for example, Oracle Internet Directory) that is configured for use with Oracle BPEL Process Manager. Click the Search icon to the right of the following fields to open the Identity Lookup dialog:

• To field on the Email and IM dialogs

• Telephone # field on the SMS and Voice dialogs

For more information about using the Identity Lookup dialog, see Introduction to Human Workflow Services.

1. From the Components window list, expand Oracle Extensions.
2. From the Notification section, drag the User Notification activity into the designer. Figure 17-9 shows the required user notification parameters.

   Figure 17-9 User Notification Dialog

   
   Description of "Figure 17-9 User Notification Dialog"
3. Enter information for each field as described in Table 17-8.

   Table 17-8 User Notification Parameters

   Name	Description
   Name	Enter a name or accept the default name of UserNotificationNumber.
   To	Enter a valid user for the recipient of this notification message through one of the following methods: Enter the user manually. Click the Search icon to display a dialog for selecting a user configured through the identity service. The identity service enables the lookup of user properties, roles, and group memberships. Click the XPath Expression Builder icon to display the Expression Builder dialog to dynamically enter a user. Note: You must specify a user name (for example, jcooper) instead of an address.
   Subject	Enter a message name or click the XPath Expression Builder icon to display the Expression Builder dialog to dynamically enter a subject. If notification is sent through email, this field is used during runtime. This field is ignored if notifications are sent through the voice, SMS, or IM channels.
   Notification Message	Enter the notification message or click the XPath Expression Builder icon to display the Expression Builder dialog to dynamically enter a message to send.

4. Click Apply.