----------------------------------------------------------------------------------------------------------
* README
* Release Notes for JMSAXSMOD version 17.10
* Last update:  11/22/2021
----------------------------------------------------------------------------------------------------------

To load Access Module for JMS, user must set several environment variables that are
specific to the JMS-compliant message service providers and Java runtime environment.


Contents
----------------------------------------------------------------------------------------------------------
  o libjmsam.so               - Library for Teradata Access Module for JMS.
  o jmsam.jar                 - Jar file for Teradata Access Module for JMS to 
                                read/send JMS messages from/to a queue/topic.  
  o jmsam_charsets.properties - Properties file for Teradata and Java Character 
                                Sets mapping.  

System Requirements
----------------------------------------------------------------------------------------------------------
  o JDK Version: JDK1.8 or above
  o JMS Enable Messaging system: IBM WebSphere MQ (or) BEA WebLogic JMS (or) Apache ActiveMQ (or) any other JMS server (with JMS Version 1.1).
  

Setting up path and environment variables manually
----------------------------------------------------------------------------------------------------------
 Unix Configuration
 ==================

Set local variables JAVA_HOME, JAVA_LIB, JMSCLIENT_JARS.

    Set JAVA_HOME to J2SE SDK installation directory.
    Set JAVA_LIB to Java runtime environment library.
    Set JMSCLIENT_JARS to directory containing JMS-compliant message service's .jar files

Examples of some commonly used JMS Server jar files are:

    IBM WebSphere MQ: jms.jar, jndi.jar, provider.jar,fscontext.jar,  connector.jar, com.ibm.mq.jar, com.ibm.mqjms.jar, jta.jar

    BEA WebLogic: weblogic.jar

    Apache ActiveMQ: activemq-all-5.16.3.jar

The following example sets environment variables for JAVA and Apache ActiveMQ JMS server (5.16.3)  
-------------------------------------------------------------------------------------------------

1. Set local variables JAVA_HOME, JAVA_LIB:

    For Example:
    ------------
     export JAVA_HOME=/usr/java/jdk1.8.0_161
     export JAVA_LIB=/usr/java/jdk1.8.0_161/jre/lib/amd64

2. Set CLASSPATH to the directory containing:

    jmsam_charsets.properties
    jmsam.jar
    any JMS-complient messaging library classes

    For Example:
    ------------
    export JMSCLIENT_JARS=/apache-activemq-5.16.3/activemq-all-5.16.3.jar
    export JMSAM_CLASSPATH=/opt/teradata/client/17.10/lib64/:/opt/teradata/client/17.10/jmsaxsmod_64/jmsam.jar
    export CLASSPATH=$JMSCLIENT_JARS:$JMSAM_CLASSPATH:$CLASSPATH


3. Set LD_LIBRARY_PATH to the directory containing libjvm.so, libjava.so

     For example:
     ------------
     export LD_LIBRARY_PATH=$JAVA_LIB:$JAVA_LIB/server:$LD_LIBRARY_PATH
     export LD_LIBRARY_PATH=/opt/teradata/client/17.10/lib64/:$LD_LIBRARY_PATH

4. Known problems:

     For AIX - User might encounter a problem with the JVM library as follows:
     JVMCI200 - ERROR: User register saving is not enabled, Garbage Collection could be incorrect.
     JVMCI200 - ERROR: because of this the JVM library is explicitly aborting the process
     JVMCI200 - ERROR: You must run with "export LDR_CNTRL=USERREGS"

     action - export LDR_CNTRL=USERREGS
