Copyright © Cloud Software Group, Inc. All Rights Reserved

Enabling JMS Channel for Central Logger

The Central Logger component of the TIBCO API Exchange Gateway receives the messages from the Core Engine and logs the transaction data records to a database. It write the records in bulk after a fixed interval. The Central Logger runs as a separate engine than the Core Engine.

By default, the messages from the Core Engine are sent to the Central Logger using Rendezvous transport. You can also enable the JMS transport for the Central Logger to send the messages from the Core Engine to Central Logger.

When the Rendezvous transport is used by the Core Engine, the messages are not guaranteed to be received by the Central Logger. If the Central Logger instance is not running, the messages sent by the Core Engine are lost. To improve the reliability and guaranteed delivery of the messages, API Exchange Gateway supports the JMS transport as a communication channel between the Core Engine and the Central Logger.

Configuration Setup for JMS Channel

This section explains the configuration steps required to use JMS transport for the Core Engine and the Central Logger.

How to Enable JMS Channel for Central Logger

By default, the JMS channel for the Central Logger is disabled using the property defined in the asg_core.cdd and asg_cl.cdd files.

To enable the JMS channel for the Central Logger, follow these steps:

1.	Navigate to the ASG_HOME/bin directory.

2.	Open the asg_core.cdd file in a text editor and edit it as follows:

a.	Locate the be.channel.deactivate property as follows:

---

 

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

<property name="be.channel.deactivate" value="/Common/Channel/AS,/DefaultImplementation/Channels/OAuthWebappsHTTPSChannel,/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,/Common/Channel/CentralLoggerJMS"/>

---

 

b.	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-group comment="" name="Channel">

<property name="be.channel.deactivate.backup" value="/Common/Channel/AS,/DefaultImplementation/Channels/OAuthWebappsHTTPSChannel,/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,/Common/Channel/CentralLoggerJMS"/>

---

 

c.	Remove the following entry from the be.channel.deactivate property value:

      /Common/Channel/CentralLoggerJMS

d.	Ensure that the value of be.channel.deactivate property is as follows:

---

 

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

<property name="be.channel.deactivate" value="/Common/Channel/AS,/DefaultImplementation/Channels/OAuthWebappsHTTPSChannel,/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"/>

---

 

e.	Save the changes to the file.

3.	Open the asg_cl.cdd file in a text editor and edit it as follows:

a.	Locate the be.channel.deactivate property as follows:

---

 

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

<property name="be.channel.deactivate" value="/Common/Channel/AS,/ASG/Channels/RvMappingChannel,/ASG/Channels/RvCacheableChannel,/ASG/Channels/modRV_Channel,/Common/Channel/Channel,/DefaultImplementation/Channels/SouthboundEsb0Channel,/DefaultImplementation/Channels/SouthboundEsb1Channel,/DefaultImplementation/Channels/SouthboundEsb2Channel,/DefaultImplementation/Channels/North_ESBChannel,/DefaultImplementation/Channels/North_HTTPChannel,/ASG/Channels/SOAPJMSChannel,/ASG/Channels/SOAPJMSChannel_North,/ASG/Channels/SOAPJMSChannel_South,/Common/Channel/CentralLoggerJMS,/DefaultImplementation/Channels/OAuthWebappsChannel,/DefaultImplementation/Channels/OAuthWebappsHTTPSChannel"/>

---

 

b.	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-group comment="" name="Channel">

<property name="be.channel.deactivate.backup" value="/Common/Channel/AS,/ASG/Channels/RvMappingChannel,/ASG/Channels/RvCacheableChannel,/ASG/Channels/modRV_Channel,/Common/Channel/Channel,/DefaultImplementation/Channels/SouthboundEsb0Channel,/DefaultImplementation/Channels/SouthboundEsb1Channel,/DefaultImplementation/Channels/SouthboundEsb2Channel,/DefaultImplementation/Channels/North_ESBChannel,/DefaultImplementation/Channels/North_HTTPChannel,/ASG/Channels/SOAPJMSChannel,/ASG/Channels/SOAPJMSChannel_North,/ASG/Channels/SOAPJMSChannel_South,/Common/Channel/CentralLoggerJMS,/DefaultImplementation/Channels/OAuthWebappsChannel,/DefaultImplementation/Channels/OAuthWebappsHTTPSChannel"/>

---

 

c.	Remove the following entry from the be.channel.deactivate property value:

      /Common/Channel/CentralLoggerJMS

d.	Ensure that the be.channel.deactivate property value looks as follows:

---

 

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

<property name="be.channel.deactivate" value="/Common/Channel/AS,/ASG/Channels/RvMappingChannel,/ASG/Channels/RvCacheableChannel,/ASG/Channels/modRV_Channel,/Common/Channel/Channel,/DefaultImplementation/Channels/SouthboundEsb0Channel,/DefaultImplementation/Channels/SouthboundEsb1Channel,/DefaultImplementation/Channels/SouthboundEsb2Channel,/DefaultImplementation/Channels/North_ESBChannel,/DefaultImplementation/Channels/North_HTTPChannel,/ASG/Channels/SOAPJMSChannel,/ASG/Channels/SOAPJMSChannel_North,/ASG/Channels/SOAPJMSChannel_South,/DefaultImplementation/Channels/OAuthWebappsChannel,/DefaultImplementation/Channels/OAuthWebappsHTTPSChannel"/>

---

 

e.	Save the changes to the file.

Set JMS Transport for Central Logger

Set the JMS transport for the Central Logger in the asg.properties file as follows:

1.	Navigate to the ASG_CONFIG_HOME directory.

2.	Open the asg.properties file in a text editor.

3.	Set the value of following property to JMS:

   tibco.clientVar.ASG/Logging/transport=JMS

4.	Save changes to the file.

5.	Open the asg_cl.properties file in a text editor.

6.	Enable the JMS transport as follows:

   tibco.clientVar.ASG/Logging/transport=JMS

7.	Save changes to the file.

The default value of logging transport is RV which means that Rendezvous is used for communication between the Core Engine and Central Logger. Setting the value to JMS specifies that JMS transport is used for communication between the Core Engine and the Central Logger.

Configuring JMS Transport Properties

The JMS Transport Properties table shows the properties you must define to use the JMS transport for the Central Logger. The JMS transport properties are defined in the Core Engine properties asg.properties file as well as in the Central Logger properties asg_cl.properties file.

To set the JMS transport properties, do following steps:

1.	Navigate to the ASG_CONFIG_HOME directory.

2.	Open the asg.properties file in a text editor.

3.	Set the properties defined in the JMS Transport Properties table.

4.	Save the changes to the file.

5.	Open the asg_cl.properties file in a text editor.

6.	Set the properties defined in the JMS Transport Properties table.

7.	Save the changes to the file.

Table 151 JMS Transport Properties

Property	Description
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JMSProviderURL	Specifies the URL to connect to the Enterprise Message Service (EMS) or a JMS server. Example: tcp://localhost:7222
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JNDIContextURL	Specifies a JNDI connection URL to look up a JMS server. Example: tibjmsnaming://localhost:7222
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TopicConnectionFactoryName	Specifies the name of TopicConnectionFactory object stored in JNDI. This object is used to create a topic connection with JMS server for the Central Logger. The default value is TopicConnectionFactory
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/QueueConnectionFactoryName	Specifies the name of QueueConnectionFactory object stored in JNDI. This object is used to create a queue connection with JMS server for the Central Logger. The default value is QueueConnectionFactory
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JNDIUsername	Specifies the user name to use when logging into the JNDI server. If the JNDI provider does not require access control, this field can be empty. Example, admin
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JNDIPassword	Specifies the password for logging into the JNDI server. If the JNDI provider does not require access control, this field can be empty.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JMSUsername	Specifies the user name to use to authenticate to the JMS server.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/JMSPassword	Specifies the password to use to authenticate to the JMS server.
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TransactionReportDestinationName	Specifies the name of the JMS destination to which the transaction reports are sent to the Central Logger by the Core Engine. For example, asg.cl.transaction.queue
tibco.clientVar.Common/Connections/JMS/CL_JMSConnection/TransactionReportDestinationType	Specifies the type of the JMS destination to which the transaction reports are sent to the Central Logger by the Core Engine. Possible values are queue or topic. The default value is queue The Central Logger always listens on a queue. If the value of destination type set to topic, the JMS administrator must configure a bridge between the topic and the queue.

You must restart the Core Engine and Central Logger instance after setting the properties in the asg.properties and asg_cl.properties file, if they are running.

Copyright © Cloud Software Group, Inc. All Rights Reserved