For z/OS platforms
WebSphere WebSphere Application Server Version 6.1.x Feature Pack for Web Services Operating Systems: AIX, HP-UX, i5/OS, Linux, Solaris, Windows, z/OS

Workload classification for service integration work

This topic describes the syntax for z/OS workload manager classification for inbound message-driven bean and mediation work for service integration technologies.

Usage notes

You use the syntax described in this topic to classify service integration work in the workload classification document for the z/OS workload manager. This topic provides a service integration subset of the workload classification document syntax, which is provided in Workload classification file. For more information about using this syntax to create a workload classification document, see Classifying z/OS workload when you use the workload classification document.

Required elements

<?xml version="1.0" encoding="UTF-8">
Indicates that the workload classification document must be saved in ASCII to be processed by the application server. This statement is required.
<!DOCTYPE Classification SYSTEM "Classification.dtd">
Gives the XML parser with the name of the DTD document provided by WebSphere Application Server for z/OS that validates the workload classification document. The workload classification document that you write must follow the rules that are described in this DTD. You must add this statement to the workload classification document.
Classification
<Classification schema_version="1.0">

Indicates the root of the workload classification document. Every workload classification document must begin and end with this element. The schema_version attribute is required. The only supported schema_version is 1.0. For inbound service integration work, the Classification element can contain up to two SibClassification elements, as described in this topic. The Classification element can also contain one or more InboundClassification elements for IIOP, HTTP, or EJB 2.0 message-driven bean work. For more information about InboundClassification elements, see Workload classification file.

SibClassification
<SibClassification type="jmsra | destinationmediation" schema_version="1.0" default_transaction_class="value">

Use the following rules when using the SibClassification element:

  • The type attribute is required. The value must be jmsra or destinationmediation. There can be at most one SibClassification element in the document for each type. The types do not have to be specified in a certain order in your classification document.
  • The schema_version attribute is required. The value must be set to 1.0.
  • The default_transaction_class attribute must be specified, and defines the default transaction class for work flows of the specified type. The string value must be a valid WLM transaction class, a null string (such as "") or a string that contains eight or fewer blanks (such as " ").
  • The SibClassification elements cannot be nested. Each SibClassification element must end before the next InboundClassification element or SibClassification element can begin.
  • If a message does not match any sib_classification_info element in an enclosing SibClassification element, the message is assigned the default classification from the SibClassification element.

    If a message does not match any sib_classification_info element in any SibClassification element, or if no SibClassification elements are defined, all work receives a built-in default classification with the value "SIBUS". You must perform z/OS Workload Manager actions that are required to use the TCLASS value "SIBUS", as described in Classifying z/OS workload.

The rules and XML statements for classifying different types of work are very similar, but there is slightly different syntax for each type. For more information about the syntax for each type of work, see the following sections:

JMS RA classification

The SibClassification element with the attribute type="jmsra" defines the section of the document that applies to work for message-driven beans (MDBs) deployed against J2EE Connector Architecture (JCA) 1.5-compliant resources for use with the JCA resource adapter (RA) of the default messaging provider. An example of this element follows:
<SibClassification  type="jmsra"
                        schema_version="1.0"
                        default_transaction_class="a">
Each SibClassification element can contain one or more sib_classification_info elements. An example of a classification entry element follows:
<sib_classification_info  selector="&apos;East&apos;"
                      transaction_class="sibb"
                      selector="user.Location=&apos;East&apos;"
                      bus="bigrred"
                      destination="abusqueue"
                      description="Some words" />
selector
Use the selector attribute of the sib_classification_info element to assign a transaction class to a message-driven bean that has a selector clause in its deployment descriptor. Use the following rules when defining your sib_classification_info elements:
  • The value of the selector attribute must match exactly to the selector clause in the MDB deployment descriptor. It is an SQL expression that selects a message according to the values of the message properties. The syntax is that of a message selector in the JMS 1.1 specification, but it can operate on SIMessage messages (more than JMS messages). The syntax can select on system properties (including JMS headers, JMSX properties, and JMS_IBM_properties) and user properties (which must be prefixed by ".user" - for example, for the user property "Location", the selector would specify "user.Location" as shown in the preceding example). For more information, see Working with the message properties.
  • The value of the selector attribute must have the correct syntax for an XML document. You must replace the < and > symbols with the entity references &lt; and &gt;, respectively. Similarly, if you use an apostrophe or quotation mark, use the &apos; and &quot; entity references.
bus
The name of the service integration bus on which the target destination is assigned. The classification applies to the bus named by this property, or to any bus if you do not specify this property. The destinations to which the classification applies depends on your use of the destination property.
destination
The name of the target bus destination to which the message has been delivered. This is the name of a queue or topic space. The classification applies to the destination named by this property, or any destination if you do not specify this property. The service integration buses to which the classification applies depends on your use of the bus property.
discriminator
The property applies only when the destination property names a topic space. This discriminator value is then an XPath expression that selects one or more topics within the topic space.
description
Although the description field is optional, you should use it on all the sib_classification_info elements. The description is displayed when you monitor the transaction classes in the MVS console.

Each sib_classification_info element can contain one or more of these properties as needed to classify the work for a message. A sib_classification_info element cannot contain more than one instance of each property.

If a message matches several sib_classification_info elements, the element that appears first is used. For example, consider the following specifications:
<sib_classification_info bus="MyBus" transaction_class="a" />
<sib_classification_info destination="MyDest" transaction_class="b" />
A message that arrives at destination MyDest from the service integration bus MyBus is assigned the classification "a". A message that arrives at MyDest from another bus is assigned the classification "b".

Mediation classification

The SibClassification element with the attribute type="destinationmediation" defines the section of the document that applies to work for mediations assigned to destinations on a service integration bus. An example of this element follows:
    <SibClassification type="destinationmediation"
                        schema_version="1.0"
                        default_transaction_class="b">
Each SibClassification element can contain one or more sib_classification_info elements. An example of a classification entry element follows:
<sib_classification_info
                      transaction_class="e"
                      selector="user.Location=&apos;East&apos;"
                      destination="themoon"
                      discriminator="sides/dark" 
                      description="n" />
selector
Use the selector attribute of the sib_classification_info element to assign a transaction class to a mediation that has a selector clause in its deployment descriptor. Use the following rules when defining your sib_classification_info elements:
  • The value of the selector attribute must match exactly to the selector clause in the mediation deployment descriptor. It is an SQL expression that selects a message according to the values of the message properties. The syntax is that of a message selector in the JMS 1.1 specification, but it can operate on SIMessage messages (more than JMS messages). The syntax can select on system properties (including JMS headers, JMSX properties, and JMS_IBM_properties) and user properties (which must be prefixed by ".user" - for example, for the user property "Location", the selector would specify "user.Location" as shown in the preceding example). For more information, see Working with the message properties.
  • The value of the selector attribute must have the correct syntax for an XML document. You must replace the < and > symbols with the entity references &lt; and &gt;, respectively. Similarly, if you use an apostrophe or quotation mark, use the &apos; and &quot; entity references.
bus
The name of the service integration bus within which the mediation is running.
destination
The name of a bus destination to which the message has been delivered. This is the name of a queue or topic space (on the service integration bus named by the bus property).
discriminator
The property applies only when the destination property names a topic space. This discriminator value is then an XPath expression that selects one or more topics within the topic space.
description
Although the description field is optional, you should use it on all the sib_classification_info elements. The description is displayed when you monitor the transaction classes in the MVS console.

Each sib_classification_info element can contain one or more of these properties as needed to classify the work for a message. A sib_classification_info element cannot contain more than one instance of each property.

If a message matches several sib_classification_info elements, the element that appears first is used. For example, consider the following specifications:
<sib_classification_info transaction_class="e" destination="themoon" description="n" />
<sib_classification_info transaction_class="f" description="n" />
A message that arrives at the mediated destination themoon is assigned the classification "e". A message that arrives at another mediated destination is assigned the classification "f".

If a message does not match any sib_classification_info element, the message is assigned the default classification from the enclosing SibClassification element. If no SibClassification elements are defined, all work receives a built-in default classification with the value "SIBUS". You must perform z/OS Workload Manager actions that are required to use the TCLASS value "SIBUS", as described in Classifying z/OS workload.

Related concepts
For z/OS platforms MDB throttle support
Related tasks
Setting tuning properties of a messaging engine
Controlling the memory buffers used by a messaging engine
Tuning the JDBC data source of a messaging engine
Setting tuning properties by editing the sib.properties file
For z/OS platforms Tuning service integration technologies
For z/OS platforms Mediations

Reference topic

Terms of use | Feedback


Timestamp icon Last updated: 27 November 2008
http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/index.jsp?topic=/com.ibm.websphere.pmc.wsfep.multiplatform.doc/ref/rjn0041_.html

Copyright IBM Corporation 2004, 2008. All Rights Reserved.
This information center is powered by Eclipse technology. (http://www.eclipse.org)