Configuring the JMS monitor adapter


Adapter type: ro-adapter-jms-monitor_vv.rr.nn

The following table describes the configuration elements of the JMS monitor adapter.

Warning

Note

The JMS monitor adapter does not support form based adapter configuration at all. You would have to configure this adapter using the XML view. To configure the adapter, see Configuring base adapters.

JMS monitor adapter configuration node elements

 

The following figure shows an XML template for the JMS monitor adapter configuration.

XML template of the JMS monitor adapter configuration

<config>
<jndi>
<property name 1></property name 1>
<property name 2></property name 2>
...
</jndi>
<connection-factory></connection-factory>
<user-name></user-name>
<password></password>
<number-of-retries></number-of-retries>
<retry-wait></retry-wait>
<client-id></client-id>
<queues>
<queue>
<destination-context-name></destination-context-name>
<maximum-messages-per-second></maximum-messages-per-second>
<message-class></message-class>
<character-set>UTF-8</character-set>
</queue>
...
</queues>
<topics>
<topic>
<destination-context-name></destination-context-name>
<message-class></message-class>
<durable-subscriber-name></durable-subscriber-name>
<character-set>ISO-8859-1</character-set>
</topic>
...
</topics>
</config>

The following figure shows an XML sample of the JMS monitor adapter configuration.

XML sample of the JMS monitor adapter configuration

<config>
<jndi>
 <java.naming.factory.initial>org.apache.activemq.jndi.ActiveMQInitialContextFactory
 </java.naming.factory.initial>
 <java.naming.provider.url>tcp://10.254.1.113:61616
 </java.naming.provider.url>
</jndi>
 <connection-factory>ConnectionFactory</connection-factory>
 <number-of-retries>3</number-of-retries>
 <retry-wait>2000</retry-wait>
 <queues>
   <queue>
     <destination-context-name>dynamicQueues/queue1.activemq.queue
     </destination-context-name>
     <maximum-messages-per-second>10</maximum-messages-per-second>
     <message-class>com.realops.adapter.jms.message.ByteMessageProcessor
     </message-class>
     <character-set>ISO-8859-1</character-set>
   </queue>
 </queues>
 <topics>
   <topic>
     <destination-context-name>dynamicTopics/topicnew
     </destination-context-name>
     <message-class>com.realops.adapter.jms.message.GenericMessageProcessor
     </message-class>
     <character-set>ISO-8859-1</character-set>
   </topic>
   <topic>
     <destination-context-name>dynamicTopics/topicnewnew
     </destination-context-name>
     <message-class>com.realops.adapter.jms.message.GenericMessageProcessor
     </message-class>
     <character-set>ISO-8859-1</character-set>
   </topic>
 </topics>
</config>

The following figure shows an XML sample of the JMS monitor adapter configuration for TIBCO Enterprise Messaging Service (EMS). 

XML sample of the JMS monitor adapter configuration for TIBCO EMS

<config>
 <jndi>
   <java.naming.factory.initial>com.tibco.tibjms.naming.TibjmsInitialContextFactory</java.naming.factory.initial>
   <java.naming.provider.url>tcp://tibco-hostname:portNumber</java.naming.provider.url>
   <java.naming.security.principal>username</java.naming.security.principal>
   <java.naming.security.credentials>password</java.naming.security.credentials>
 </jndi>
 <connection-factory>QueueConnectionFactory</connection-factory>
 <user-name> username </user-name>
 <password> password </password>
 <number-of-retries>3</number-of-retries>
 <retry-wait>2000</retry-wait>
<queues>
   <queue>
     <destination-context-name>Queue/sample.queue</destination-context-name>
     <maximum-messages-per-second>10</maximum-messages-per-second>
     <message-class>com.realops.adapter.jms.message.GenericMessageProcessor</message-class>
   </queue>
 </queues>
</config>

Encrypting an element's contents

You can add the attribute secure="true" to an XML adapter element XML view to ensure that the element's contents is encrypted when displayed.

Warning

Note

You must be using TrueSight Orchestration Platform version 8.1 or later to use this encryption attribute.

Enabling custom logging

To enable custom logging for the adapter, you must specify a log file name. You can also provide additional parameters for logging.

Warning

Note

You must be using TrueSight Orchestration version 8.1 or later to use the custom logging feature. These parameters will be ignored in earlier versions of TrueSight Orchestration Platform.

These parameters are available with supported adapter versions. See TrueSight Orchestration Content documentation for details.

  • Log File Name: Provide a name for the log file.
    This file will be stored in the AO_HOME/tomcat/logs directory. If Log File Max Backup Index value is greater than 0, the log file name is suffixed with the backup index. For example, if the parameter value is a.log, backup log files will have names, such as a.log.1, a.log.2.
  • Log File Size: Specify a size limit for the log file. 
    If the value specified for Log File Max Backup Index is greater than 0, when the specified size is reached, the current file is renamed with the suffix .1. Otherwise, the log file will be reset and over-written. The default value is 10MB. The available units are KiloBytes (KB), MegaBytes (MB) or GigaBytes (GB).
  • Log File Max Backup Index: Enter the maximum number of backup files allowed. The default value is 10.
  • Log File Append: Select this option to append new log information to the existing information in the file. If unselected, the file will be overwritten with new log information.
  • Log Level: Enter the logging level using one of the following choices:

    Logging level

    Description

    DEBUG

    The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    INFO

    (default)

    Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    WARN

    Logs recoverable erroneous conditions and unrecoverable erroneous conditions

    ERROR

    The least detailed logging level; logs only error conditions that are not usually recoverable

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Orchestration Content 21.02