Copyright © Cloud Software Group, Inc. All Rights Reserved

Configuring SOAP JMS Transport

This section explains the configuration setup required for TIBCO API Exchange Gateway to use the SOAP JMS transport.

Enable SOAP JMS Channels

By default, SOAP JMS channels are disabled. To enable the SOAP JMS channels, follow these steps:

1.	Open the ASG_HOME/bin/asg_core.cdd file for editing in a text editor.

2.	Search the following property:

---

 

<property-group comment="" name="Channel">

<property name="be.channel.deactivate" value="/DefaultImplementation/Channels/SouthboundEsb0Channel,/DefaultImplementation/Channels/SouthboundEsb1Channel,/DefaultImplementation/Channels/SouthboundEsb2Channel,/DefaultImplementation/Channels/North_ESBChannel,/DefaultImplementation/Channels/North_HTTPChannel,/ASG/Channels/SOAPJMSChannel_North,/ASG/Channels/SOAPJMSChannel_South,/ASG/Channels/modAS_Channel,/Common/Channel/PSMChannel,/Common/Channel/CentralLoggerJMS"/>

---

 

3.	If you have not taken the backup of the be.channel.deactivate property, copy the be.channel.deactivate property to be.channel.deactivate.backup, as follows:

---

 

<property name="be.channel.deactivate.backup" value="/DefaultImplementation/Channels/SouthboundEsb0Channel,/DefaultImplementation/Channels/SouthboundEsb1Channel,/DefaultImplementation/Channels/SouthboundEsb2Channel,/DefaultImplementation/Channels/North_ESBChannel,/DefaultImplementation/Channels/North_HTTPChannel,/ASG/Channels/SOAPJMSChannel_North,/ASG/Channels/SOAPJMSChannel_South,/ASG/Channels/modAS_Channel,/Common/Channel/PSMChannel,/Common/Channel/CentralLoggerJMS"/>

---

 

4.	To enable the SOAPJMS channels, remove the /ASG/Channels/SOAPJMSChannel_North and /ASG/Channels/SOAPJMSChannel_South from the value of the be.channel.deactivate property. The modified value of the property is as follows:

---

 

<property name="be.channel.deactivate" value="/DefaultImplementation/Channels/SouthboundEsb0Channel,/DefaultImplementation/Channels/SouthboundEsb1Channel,/DefaultImplementation/Channels/SouthboundEsb2Channel,/DefaultImplementation/Channels/North_ESBChannel,/DefaultImplementation/Channels/North_HTTPChannel,/ASG/Channels/modAS_Channel,/Common/Channel/PSMChannel,/Common/Channel/CentralLoggerJMS"/>

---

 

5.	Save the changes to the file.

Edit asg.properties File

The ASG_CONFIG_HOME/asg.properties file defines JMS server connections, queue names, and the user details for SOAP JMS transport.

JMS Server Connection Parameters

JMS server connection parameters are defined by the following properties. Edit the property as per your JMS server connection details.

JMS Server Connection Parameters at facade Side

The following properties define the JMS sever connection parameters used at the facade (northbound) side. Edit the property values as per your JMS server settings.

Table 26: JMS Server Connection Parameters(Facade Side)

Property Name	Default Value
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JMSProviderURL	tcp://localhost:7222
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JNDIContextURL	tibjmsnaming://localhost:7222
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/TopicConnectionFactoryName	TopicConnectionFactory
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/QueueConnectionFactoryName	QueueConnectionFactory
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JNDIUsername	admin
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JNDIPassword
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JMSUsername	admin
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Facade/JMSPassword

JMS Server Connection Parameters at Target Side

The following properties define the JMS sever connection parameters used at the target (southbound) side. Edit the properties values as per your JMS Server settings:

Table 27: JMS Server Connection Parameters (Target Side)

Property Name	Default Value
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JMSProviderURL	tcp://localhost:7222
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JNDIContextURL	tibjmsnaming://localhost:7222
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/TopicConnectionFactoryName	TopicConnectionFactory
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/QueueConnectionFactoryName	QueueConnectionFactory
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JNDIUsername	admin
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JNDIPassword
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JMSUsername	admin
tibco.clientVar.Common/Connections/JMS/SOAPConnection_Target/JMSPassword

JMS Server Queue Names

By default, the queue names are defined by the global variables in the ASG_CONFIG_HOME/asg.properties file. You can override the default values, if needed.

Facade Queue Names for SOAPJMS Transport

The default queue names are defined by the following properties. Edit the default values, if needed.

Table 28: facade Queue Names (SOAPJMS)

Global Variable	Default Value
tibco.clientVar.ASG/facade/SOAPJMS/requestQueue	asg.soap.in.request
tibco.clientVar.ASG/facade/SOAPJMS/replyQueue	asg.soap.in.request.reply.0

Target Queue Names for SOAPJMS Transport

The queue names are defined by the following properties. Edit the default values, if needed:

Table 29: Target Queue Names (SOAPJMS)

Global Variable	Default Value
tibco.clientVar.ASG/Endpoint/SOAPJMS/DefaultTargetRequestQueue	asg.soap.forward
tibco.clientVar.ASG/Endpoint/SOAPJMS/TargetResponseQueue	asg.soap.forward.reply.0

Ensure that all queue names are created on the JMS server before the Core Engine is started. See Create queues on EMS Server.

Create queues on EMS Server

By default, the TIBCO API Exchange Gateway uses the queue names for SOAP JMS transport as defined in the ASG_CONFIG_HOME/asg.properties file. After the SOAP JMS transport is enabled, create the queues on the EMS server.

Create the following queues on the EMS server:

asg.soap.in.request

asg.soap.in.request.reply.0

asg.soap.forward

asg.soap.forward.reply.0

• The queue names can be overwritten by editing the values of global variables as defined in the ASG_CONFIG_HOME/asg.properties file. If you change the default values as mentioned in Facade Queue Names for SOAPJMS Transport and Target Queue Names for SOAPJMS Transport, create the queue names defined by the global variables. • You can edit the global variable values as follows: − By using the Config UI. See Set Runtime Properties. − By editing the ASG_CONFIG_HOME/asg.properties file using a text editor.

Create Users On JMS Server

Ask the JMS server administrator to create a normal user without administrator privileges. TIBCO API Exchange Gateway uses this user to connect to the JMS server when the JMS transport is used at the facade and target side. The administrator should grant the following privileges to this user:

•

Send

•

Receive

•

Browse

This user is specified by the global variable property in the ASG_CONFIG_HOME/asg.properties file. See JMS Server Connection Parameters.

Set JMS Jars in ClassPath

To include the JMS jar files in the classpath of the Core Engine, do any of the following:

•	Copy JMS jars

Manually copy the JMS jar files in the following location:

ASG_HOME/lib/ext/tpcl

•	Edit the asg-engine.tra file to set the EMS_HOME variable.

Set the tibco.env.EMS_HOME property as defined in the ASG_HOME/bin/asg-engine.tra file. Set this to the TIBCO Enterprise Message Service installation home.

For example,

tibco.env.EMS_HOME=c:/tibco/ems/5.1

Config UI Configuration

This section describes the configuration required to process the SOAP JMS requests using the Config UI.

Configuring New Partner

Define a new partner to process the requests from this partner using the SOAP JMS transport.

Follow these steps to define a new partner:

1.	Start the gateway configuration interface. See Starting GUI.

2.	Select an existing project configuration or add a new project configuration. See Manage a Gateway Project Configuration.

3.	Define a new partner. See Partners to add the partner data.

The following is the sample value for the required field:

Table 30 Partner Sample Configuration

Parameter	Sample Value
Partner Name	anon_JMS

Define the partner name anon_JMS must be defined by the following property in the ASG_CONFIG_HOME/asg.properties file:    tibco.clientVar.ASG/anonymous/PartnerName/Authenticated=anon_JMS

4.	Save the changes.

Configuring Facade Operation

Define a new operation to process the request from the client using the SOAP JMS transport. See Facade Operations.

The following are sample values for the required fields:

Table 31 Facade Operation Sample Configuration

Parameter	Sample Value
Operation Name	GetBooks1
SOAP Action	"/QueryBooksByAuthor"
Operation URI
Status Code on Error	500

The operation and SOAP Action must match the client request.

Configuring Partner Operation

Define a partner operation for a partner. See Facade Access.

The following are sample values for the required fields:

Table 32 Partner Operation Sample Configuration

Parameter	Sample Value
Partner	anon_JMS
Partner Operation	GetBooks1
Partner Timeout	20000
Forward Mapping	Pass-Through
Reverse Mapping	Pass-Through

Configuring Target Operation

Define a new service configuration to forward the client requests to a back-end service using the SOAP JMS transport. See Add a New Target Operation to add a new service.

The following are the sample values for the required fields::

Table 33 Target Operation Sample Configuration

Parameter	Sample Value
Operation Name	getByAuthorService
Type	SOAP JMS
Timeout	30000
SOAP Action	"/QueryBooksByAuthor"
Destination Name	sample
Destination Type	Queue

5.	Save the configuration changes.

Copyright © Cloud Software Group, Inc. All Rights Reserved