Business Process alerts can be added to business processes. These alert messages are generated directly from Unwired Orchestrator based on user-defined conditions for a business process. The alert message format and target destination are also user-defined. For example, if a business process contains an activity to check inventory, a business process alert can be configured to generate an alert message if inventory is insufficient.
A business process alert is created in a business process as a messaging service and uses the PersonalAlerts.xsd schema. The alert uses the messaging service to send the alert message.
To add an alert to a business process:
Note: The following procedure provides general guidelines for adding an alert to a business process, and follows the tutorial, Adding an Alert to a Business Process. The conditions for which alerts are generated do vary from business process to business process, therefore, the procedure may need to be adapted accordingly to your business process and alert conditions.
In the Unwired Orchestrator tooling:
In the Endpoint Manager, create a JMS Session, giving the session a name such as AlertSession, and a JMS Transport, giving the transport the name AMS_IN_QUEUE. AMS_IN_QUEUE is a pre-configured JMS transport installed with Unwired ORchestrator.
Use the following properties:
Session Property |
Suggested Value |
Classpath |
<server install directory>/EAServer/java/lib/easclient.jar;<server install directory>/EAServer/java/lib/easj2ee.jar;<server install directory>/bin/dvjms41jni.jar; |
Connection Factory |
javax.jms.QueueFactoryConnection |
Initial Context Factory |
com.Sybase.jms.InitialContextFactory |
JMS Properties |
leave empty |
Password |
leave empty |
Server URL |
iiop:<UO server machine name>:<port> The default port is 9000. Check the <server install directory>/EAServer/eas_install.props to verify the port number used. |
Transacted Session |
Client_Acknowledge |
User Name |
leave empty |
Transport Property |
Suggested Value |
AUDIT Transport Name |
leave empty |
AUDIT Put Transport Name |
leave emptry |
Blocking Timeout |
2000 |
Default JMS Body Type |
JMS_TEXT |
JMS Selective Get |
leave empty |
Message Option Headers |
leave empty |
Session |
AlertSession |
Target Encoding |
leave empty |
Transport Name |
AMS_IN_QUEUE |
Create the messaging service using the New Service Wizard.
On the Message Schema pane, specify the PersonalAlerts.xsd by browsing to locate it in the <server install directory>/almansys directory on the server machine.
One the Message Options pane, add the following name/value pair:
AMS_MSG_ENCODING utf-8 (or other appropriate encoding)
Add a port to the messaging service
Open the wsdl for the messaging service
Right-click on the port node and select Add Port
Name the port
Select the transport to which the alert message is to be sent (AMS_IN_QUEUE)
Add the alert to the activity in the business process
Open the business process
Open the activity to which the alert is to be added
Drill down to the level where the messaging service is to be added and drag the messaging service to the editor.
Connect the messaging service to the other parts of the business process
Extract the schema for PersonalAlerts.xsd
Right-click on the iface for the messaging service
Select Extract Schema.
Browse to select the PersonalAlerts.xsd file
Create a map that prepares the contents of the alert message.
An element in the PersonalAlerts schema allows you to set an optional AlertID in the message. The AlertID gives the alert message a unique tracking element. The AlertID value can be set by mapping a value from the original message, by defining a literal, or by defining a context variable.
Set the text for the message using the Long Text or Short Text elements under the Contents element. For each message field you want to be used to create the alerts message, click and drag the field to either the Long Text or Short Text element. Use the Transformation Rule Builder to create an expression to use the fields to build a rule to create the message.
Set the Channel for the alert by using one of the following:
A literal in a map. Define the literal; for the literal value, enter the name of the channel to be used to, or
An Assign activity. Set the Target Context Reference property for the Assign activity to the name of the channel. The channel name must match a configured channel known to the alert management system.
Complete the business process. Package, deliver, and deploy the business process.
In the BizTracker Management Console:
Connect to the BizTracker Management Console.
Open a web browser, Internet Explorer or Netscape.
Type the following in the address (8080 is the default number):
http://<UO server machine name>:<8080 or other port number>/BT
The BizTracker Management Console login screen displays.
Notes:
A Java plug-in is required. If the plug-in is not detected, the browser
will automatically take you to the download site.
If a connection to the Management Console cannot be made, check to verify
that the UO_server_machine_name is correct and verify which port is being
used. The default port is 8080.
To verify the port being used, locate the eas_install.props file in <server
install directory>/EAServer directory. Open the eas_install.props in
an editor. Check the port value for com.Sybase.jaguar.install.listeners.http
to identify the port. Modify the address to use the port number identified.
http://<UO_server_machine_name>:<port>/BT
Log in to the BizTracker Management Console by entering the user id.
If a security window opens, click OK, then OK on the Connection Succeeded window, and finally Close on the Security Configuration window.
Define a Channel. This step is optional; alerts can use the pre-configured channel named Unwired Orchestrator System Management.
Select Alerts > Configuration. The Alerts Configuration window displays.
In the Channels panel, click Add. The Channel Editor window displays.
Type the name of the channel to add. This channel name must match the channel named in the business process alert. Permissions and Transformation XSL are typically not required for alert messages.
Click OK.
Create a subscription for the alert messages.
Select Alerts > Channel Subscription. The Channel Subscription window appears.
Click Edit in the Channel Subscription window. Enter the following in the fields to generate an email alert message using Long Text.
Channel |
<channel name> This channel name must match the name defined in step 6 of the Unwired Orchestrator tooling steps. |
Target |
JavaMailDriver This value defines email as the target for the alert message. |
Address |
The email address that is to receive the alert message |
Target Text Type |
Long Text or Short Text as defined in Unwired Orchestrator tooling |
For additional types of subscriptions, see the online help available from the Channel Subscription window in the Management Console.
Click OK.
The Channel Subscription list should show an entry for the appropriate channel, Unwired Orchestrator System Management or other channel, with the appropriate email address.
Click Close to close the Channel Subscription window.
You can exit the BizTracker Management Console or leave it open.
Business Process Alerts configuration is complete and ready to be tested.
To test the alert messages:
Start the runtime instance.
Put a message to the transport. The message initiates the business process.
Check the subscribing email address for the alert email message.