One Copy Per Application

jms-client-id

ejb-name

One Copy Per Server

{jms-client-id}_{DomainName}_{ServerName}

ejb-name

Compatibility

{jms-client-id}_{DomainName}_{ServerName}_{UniqueKey}

Same as client ID

Correlation ID Pattern

All responses go to the same fixed queue(s).

The server copies the request Correlation ID to the response Correlation ID.

Message ID Pattern

The responses dynamically go to the queue indicated by the JMSReplyTo property.

The server copies the request Message ID to the response Correlation ID.

Destination Type

Select one of the following:

• Queue (for a point-to-point destination)

• Topic (for a publish/subscribe destination)

Is Response Required

Select this option to specify that a response is expected after an outbound message is sent.

This option is available only when the Destination Type is Queue.

Response Pattern

Select one of the following to specify the design pattern for the response:

• JMSMessageID: For JAX-RPC services running on WebLogic Server.

• JMSCorrelationID: For all other services. When you select this option, you must also enter a Response URI.

This option is available only when the Is Response Required check box is selected.

Response Message Type

Select one of the following types for the response messages:

• Bytes (for a stream of uninterpreted bytes)

• Text (for text messages)

This option is disabled if you select a Message Type of Java for the response. It is available only when the Is Response Required check box is selected.

Client Jar

Select the client JAR to be used for dequeueing messages that contain Java Objects. Selecting the client JAR ensures it is on the classpath. This option is available when the service is a Messaging Service with a request type of Java.

For more information, see Sending and Receiving Java Objects in Messages.

Dispatch Policy

Select the instance of WebLogic Server Work Manager that you want to use for the dispatch policy for this endpoint. The default Work Manager is used if no other Work Manager exists.

For information about Work Managers, see:

• Using Work Managers with Service Bus

• "Using Work Managers to Optimize Scheduled Work" in Administering Server Environments for Oracle WebLogic Server

Request Encoding

Enter the character set for encoding requests. The default is UTF-8.

Response Encoding

Enter the character set for encoding responses. The default is UTF-8.

This option is available only when the Is Response Required check box is selected.

Client Response Timeout

Enter the number of seconds to wait for a server response before dropping the connection. This only applies if the client is another proxy service in the same domain.

This option is available only when the Is Response Required check box is selected.

Response URI

Enter a response URI in one of the formats described below. This option is available only when JMSCorrelationID is selected for the Response Pattern.

jms://host:port/connection_factory/jndi_destination

To target multiple servers, use the following format:

jms://host1:port,host2:port/connection_factory/jndi_destination

You can also omit the host and port in the response URI. For example:

jms:///connection_factory/jndi_destination

When you omit host and port, the connection factory/destination lookup occurs on the local server. This is useful, for example, if the request URI goes to a foreign connection factory/destination, but you want the response sent to the local server.

Note: While WebLogic Server allows forward slashes in JNDI names, such as "myqueues/myqueue", JNDI names with forward slashes interfere with the URI format required by Service Bus, and you cannot use those names. To work around this issue, define a JMS foreign server and reference that foreign server in the URI. For more information, see Configure Foreign Servers in Oracle WebLogic Remote Console Online Help.

Response Connection Factory

Enter a response connection factory URI. This option is available only when JMSMessageID is selected for the Response Pattern.

If a connection factory is not specified, the connection factory for the request is used for the response.

JMS Service Account

Select a service account to use for the JMS resource managed by the JMS server. A service account is an alias resource for a user ID and password, used for both the request and response. The same service account is used for both JMS and JNDI purposes.

For more information, see Working with Service Accounts.

Use SSL

Select this check box only if the requests are made over a TLS/SSL connection.

TLS/SSL (Secure Sockets Layer) provides secure connections by allowing two applications connecting over a network to authenticate the other's identity and by encrypting the data exchanged between the applications. Authentication allows a server, and optionally a client, to verify the identity of the application on the other end of a network connection. Additionally, if the administrator has restricted access to individual JMS destinations (queues or topics) by setting access control on the JNDI entry for the destination, the service must authenticate when looking up the entry in the JNDI tree.

Note: The JMS transport does not support two-way SSL.

Message Selector

Enter a message selector expression. Only messages with properties matching the expression are processed.

Client ID

For topics only, enter the client ID to use for the subscriber. If no value is entered, a client ID is automatically generated. Assigning a custom ID helps you identify this component when monitoring the service. Note that this is only effective for durable subscribers.

The JMS Client ID is one of several MDB descriptors that are used to generate subscriber names and the ClientID value for the topic's subscribers. Defining a JMS client ID makes it easier to identify and view subscribers for a specific topic by looking at the subscriber name or client ID.

For more information, see JMS Client ID in Proxy Services.

Durable Subscription

Select this check box if the subscription is durable or leave it empty if the subscription is not durable. If a subscription is durable, it receives all messages published on a topic, even if the subscription was inactive at the time the messages were published.

This option is available only if Topic is selected for the Destination Type.

Retry Non XA Connection

Select this check box to retry non-XA connections using the given retry count and interval specified below. If this check box is not selected, Service Bus only retries XA connections and the retry count and interval only apply only to XA connections.

This check box only applies to JMS proxy services that have a non-XA connection factory in the service URI.

Retry Count

Enter the number of delivery retries a message can have before it is moved to the error destination. This field only applies to WebLogic Server JMS destinations.

Retry Interval

Enter the amount of time, in milliseconds, before rolled back or recovered messages are redelivered. This field only applies to WebLogic Server JMS destinations.

Error Destination

Enter the name of the target destination for messages that have reached their redelivery limit. This field only applies to WebLogic Server JMS destinations.

Expiration Policy

Select a policy that defines how to process an expired message encountered on a destination. You can specify to either discard or redirect the message. Redirecting a message moves it to the error destination specified above.

This field only applies to WebLogic Server JMS destinations.

Is XA Required

Select this check box if your connection factory is XA.

This option takes into account when the remote connection factory is unavailable. If your connection factory is available and this option is enabled, make sure that the connection factory is defined as transactional.

Transaction Timeout

Enter the amount of time in seconds for the JMS proxy service to wait for a transaction to be processed. This option only applies to services using an XA connection factory. The default is 600 seconds.

No MDB on Response Queue

Select this option if you do not want to generate a default message-driven bean (MDB) on the inbound response queue. Use this option to improve performance. When this option is selected, a proxy to proxy routing format is not supported.

JNDI Timeout

The JNDI connection timeout (in seconds) used while looking up the destination or connection factory in the JNDI tree.

Topic Messages Distribution

Select one of the following properties to determine how message-driven beans handle incoming JMS messages and high-availability and failover:

• One Copy Per Application: Select this option to provide high availability and scalability when the JMS proxy service is deployed to a cluster. This ensures that an inbound JMS message is processed on only one of the available servers in a cluster. This is the default value.

• One Copy Per Server: Select this option if you want inbound JMS messages published to a topic to be received by the proxy service on every member of the cluster.

• Compatibility: Select this option if you want inbound JMS messages to be processed on a specific Managed Server or all Managed Servers in a cluster. If you select this property, select a Target server.

This option is available when you select Topic for the Destination Type.

Note: When using compatibility mode in a cluster, you might receive duplicate messages. To prevent this, use one of the other options.

The "One Copy" options override the Subscription Sharing Policy and Client ID Policy configured on the JMS Connection Factory.

Target

Select the target server that will handle incoming JMS messages. If you select one of the "One Copy" options for Topic Messages Distribution, this field displays the name of the cluster. This option is available only in a Service Bus cluster when you select Compatibility for the Topic Messages Distribution option.

If you do not set a target, the JMS proxy service instance reading messages off the Topic on each Managed Server in the cluster gets a copy of the message.

JMSCorrelation ID

An identifier used to link one message with another. For example to link a request message with a response message.

JMSDeliveryMode

The delivery mode specified when the message was sent.

JMSExpiration

The expiration time of the message, which is an absolute value that indicates the specific date and time the message should expire. You can use an XQuery expression to calculate the precise expiration date and time for each message.

JMSMessageID

A value that uniquely identifies the message sent by a provider.

JMSPriority

The processing priority of the message. When a message is sent, this field is ignored. After the send operation is complete, the field holds the value that is specified by the method sending the message.

JMSType

The message type identifier that is specified by a client when a message is sent.

JMSXAppID

This is one of the JMS defined properties that specifies the identity of the application that sends the message. This is set by the JMS provider

JMSXGroupID

This one of the properties defined by JMS that specifies the group id of the message group to which the message belongs. This is set by the client

JMSXGroupSeq

This one of the properties defined by JMS that specifies the sequence of the message inside the message group.

JMS_IBM_Format

The nature of the application data. For more information, refer to the IBM WebSphere documentation.

JMS_IBM_Report_Exception

Request exception reports. This also specifies how much of the application data from the message must be retained in the report message. For more information, refer to the IBM WebSphere documentation.

JMS_IBM_Report_Expiration

Request expiration reports. This also specifies how much of the application data from the message must be retained in the report message. For more information, refer to the IBM WebSphere documentation.

JMS_IBM_Report_COA

Request a confirm on arrival reports. This also specifies how much of the application data from the message must be retained in the report message. For more information, refer to the IBM WebSphere documentation.

JMS_IBM_Report_COD

Request a confirm on delivery reports. This also specifies how much of the application data from the message must be retained in the report message. For more information, refer to the IBM WebSphere documentation.

JMS_IBM_Report_PAN

Request a positive action notification reports. For more information, refer to the IBM WebSphere documentation.

JMS_IBM_Report_NAN

Request a positive action notification reports. For more information, see For more information, refer to the IBM WebSphere documentation.

JMS_IBM_Report_Pass_Msg_ID

Request that the message identifier of any report or reply message is the same as that of the original message. For more information, refer to the IBM WebSphere documentation.

JMS_IBM_Report_Pass_Correl_ID

Request that the correlation identifier of any report or reply message is the same as that of the original message. For more information, refer to the IBM WebSphere documentation.

JMS_IBM_Report_Discard_Msg

Request that the message is discarded if it cannot be delivered to its intended destination. For more information, refer to the IBM WebSphere documentation.

JMS_IBM_MsgType

The type of a message. For more information, refer to the IBM WebSphere documentation.

JMS_IBM_Feedback

An indicator of the nature of a report message. For more information, refer to the IBM WebSphere documentation.

JMS_IBM_Last_Msg_In_Group

An indicator of whether the message is the last message in a message group. For more information, refer to the IBM WebSphere documentation.

JMS_BEA_UnitOfOrder

This header is valid for the request and response.

Destination Type

Select one of the following JMS destination types:

• Queue (for a point-to-point destination)

• Topic (for a publish/subscribe destination)

Message Type

Select one of the following message types:

• Bytes (for a stream of uninterpreted bytes)

• Text (for text messages)

This option is disabled if you select a message type of Java for the response.

Response Queues

Select one of the following options to specify how to handle responses:

• None: No response is expected. Select this option for one-way operations.

• One for all Request URIs: Lets you enter a single URI to handle the response, as well as set other response configuration details such as encoding and timeout, and optionally select a JMS Service Account for passing JMS/JNDI credentials.

• One per Request URI: This option provides response failover, letting you enter a response URI or destination for each request URI. You can optionally select a service account for JMS/JNDI credentials on each request/response pairing.

This option is available only when the Destination Type is Queue.

Response Pattern

Select one of the following to specify the design pattern for the response:

• Select JMSCorrelationID for all services other than JAX-RPC services running on WebLogic Server.

• Select JMSMessageID for JAX-RPC services running on WebLogic Server.

This option is available only when you select a response option in the Response Queue field. For more information, see Message ID and Correlation ID Patterns for JMS Request/Response.

Dispatch Policy

Select the instance of WebLogic Server Work Manager that you want to use for the dispatch policy for this endpoint. The default Work Manager is used if no other Work Manager exists.

For example, if the business service has a JMS transport protocol, the business service endpoint is an MDB (message-driven bean) JAR file that you can associate with the specific dispatch policy.

For information about Work Managers, see:

• Using Work Managers with Service Bus

• "Using Work Managers to Optimize Scheduled Work" in Administering Server Environments for Oracle WebLogic Server

Request Encoding

Enter the character set for encoding requests. The default is UTF-8.

Response Encoding

Enter the character set for encoding responses. The default is UTF-8.

This option is available only when one of the response options is selected in the Response Queues field.

Response Timeout

Enter the amount of time, in seconds, to wait for the response before dropping the connection. The default, zero (0), means the response never times out.

This option is available only when one of the response options is selected in the Response Queues field.

Client Jar

Select the client JAR to be used for dequeueing messages that contain Java Objects. Selecting the client JAR ensures it is on the classpath. This option is available when the service is a Messaging Service with a response type of Java.

For more information, see Sending and Receiving Java Objects in Messages.

Response URI

Enter a response URI in one of the formats described below. This option is available when you select the One for all Request URIs response option and the JMSCorrelationID response pattern.

jms://host:port/connection_factory/jndi_destination

To target multiple servers, use the following format:

jms://host1:port,host2:port/connection_factory/jndi_destination

You can also omit the host and port in the response URI. For example:

jms:///connection_factory/jndi_destination

When you omit host and port, the connection factory/destination lookup occurs on the local server. This is useful, for example, if the request URI goes to a foreign connection factory/destination, but you want the response sent to the local server.

Note: While WebLogic Server allows forward slashes in JNDI names, such as "myqueues/myqueue", JNDI names with forward slashes interfere with the URI format required by Service Bus, and you cannot use those names. To work around this issue, define a JMS foreign server and reference that foreign server in the URI. For more information, see Configure Foreign Servers in Oracle WebLogic Remote Console Online Help.

Request Responses

Enter a Response URI for each request URI entered on the generic Transport page. Use the formatting and guidelines described for the Response URI field, above.

For each URI, you can select an optional service account for JMS/JNDI credentials that the service uses for both the request and response queues.

This option is available when you select the One per Request URI response option for the JMSCorrelationID pattern to provide response failover.

Target - Responses

Enter the name of the Target server that is to receive responses, and enter a Response URI, as described in the Response URI field.

This option is available when you select the One for all Request URIs response option for the JMSMessageID pattern.

Request Connections

Enter a JMS Connection Factory name for each request URI, identified sequentially by number in the Seq. No field. If you do not enter a name, the JMS transport uses the connection factory from the request URI.

You can select an optional service account for JMS/JNDI credentials that the service uses for both the request and response queues.

This option is available when you select the One per Request URI response option for the JMSMessageID pattern to provide response failover.

Target - Destinations

Enter the destination queue on each target server that receives responses for each request URI on each target. Each Target server in the list (determined by the servers in the current domain, such as Managed Servers in a cluster) lists the request URIs by Seq.No, which correspond to those in the Request Connections field.

This option is available when you select the One per Request URI response option for the JMSMessageID pattern to provide response failover. Use this field in conjunction with Request Connections.

Note: Because the Service Bus development environment supports only a one-server environment, only one Target is listed. To configure this field in a multi-server environment, deploy this service to the runtime environment and complete the service configuration in the Oracle Service Bus Console.

JMS Service Account

Enter a service account to use for the JMS resource managed by the JMS server. A service account is an alias resource for a user ID and password, used for both the request and response. The same service account is used for both JMS and JNDI purposes.

This option is available when you use the None or One for all Request URIs option in the Response Queues field. This field is mutually exclusive with the Pass Caller's Subject option. Use one or the other for JMS/JNDI authentication.

For more information, see Working with Service Accounts.

Use SSL

Select this check box only if the requests are made over a TLS/SSL connection.

TLS/SSL (Secure Sockets Layer) provides secure connections by allowing two applications connecting over a network to authenticate the other's identity and by encrypting the data exchanged between the applications. Authentication allows a server, and optionally a client, to verify the identity of the application on the other end of a network connection. Additionally, if the administrator has restricted access to individual JMS destinations (queues or topics) by setting access control on the JNDI entry for the destination, the service must authenticate when looking up the entry in the JNDI tree. Authenticate using a Service Account or the Pass Caller's Subject option.

Note: The JMS transport does not support two-way SSL

Expiration

The time interval in milliseconds after which the message expires. Default value is 0, which means that the message never expires.

Enable Message Persistence

Select this check box for guaranteed message delivery. Clear this check box to improve throughput if an occasional lost message is tolerable. The JMS message delivery mode lets you balance reliability with throughput.

Unit of Order

Enter a message unit-of-order, which enables message producers to group messages into a single unit with respect to the processing order. This single unit-of-order requires that all messages in that unit be processed sequentially in the order they were created.

For more information about using unit-of-order, see "Using Message Unit-of-Order" in Developing JMS Applications for Oracle WebLogic Server.

Pass Caller's Subject

Select this check box to have Service Bus pass the authenticated subject when sending a message.

When you enable this field and the business service targets JMS resources in a different domain, enable global trust on both domains. See "Configuring Security for a WebLogic Domain" in Administering Security for Oracle WebLogic Server.

This field is mutually exclusive with the Service Account option. Use one or the other for JMS/JNDI authentication.

JNDI Timeout

Enter the period (in seconds) to use when looking up the destination or connection factory in the JNDI tree before the JNDI connection times out.

The default, zero (0), means the connection never times out.