Configure JBoss/AS for use with IDMS Server

Products

• IDMS
• IDMS - Database

Issue/Introduction

This article outlines the configuration steps needed to define an IDMS JDBC Data Source under JBoss Application Server version 7.1.

Environment

Release: All supported releases.
Component: IDMS Server.

Resolution

This document describes how to define both an XA and a non-XA type IDMS Data Source for use with JBoss/AS 7.1, in a JBoss 'Standalone Server' type configuration. Rather than using the JBoss Administration Console (which can be somewhat clumsy and temperamental), this process will be modifying the JBoss configuration XML files directly. Once defined, modify the IDMS Data Source definitions using the Admin Console if that is preferable.

The following steps should be followed:

1. Download the file "jbossidms.zip" attached to this article to location: "<JBOSS_ROOT>/modules/com".
2. Extract all files within the zip file into the current directory. Make sure to use the "Use folder names" option when the extract is performed.
3. Copy the existing "idmsjdbc.jar" file (usually found within directory " C:\Program Files\CA\CA IDMS Server\Java\lib") into directory "<JBOSS_ROOT>/modules/com/ca/idms/main".
4. Take a backup of the JBoss "standalone.xml" file, in the event that these changes will need to be backed out. The "standalone.xml"file file can be found under directory: "<JBOSS_ROOT>/standalone/configuration".
5. Open the JBoss "standalone.xml" file with Notepad, WordPad or any text file editor.
6. Open file: "Template updates to standalone xml for IDMS.txt". This should be within directory "<JBOSS_ROOT>/modules/com/ca/idms/main".
7. Customize file "Template updates to standalone xml for IDMS.txt" to meet site requirements. This file contains several strings that will need to be modified, as follows… Note that many of these strings occur in multiple locations:
   
   1. MyIdmsDs - Replace with the non-XA IDMS Data Source name
   2. MyIdmsHostName - Replace with the TCP/IP Host Name where the IDMS CV is running
   3. MyIdmsPortNbr - Replace with the TCP/IP Port Number referenced in the TCPJSRV bulk Listener PTE within the IDMS CV.
   4. MyIdmsDBName - Replace with the DBNAME to use in the IDMS CV.
   5. MyIdmsUid - Replace with the User-id authorized to access the IDMS CV.
   6. MyIdmsPwd - Replace with the Password for the UID named above.
   7. MyIdmsXaDs - Replace with the XA IDMS Data Source name.
8. Copy the two IDMS Data Source definitions within file "Template updates to standalone xml for IDMS.txt" into the windows cut/paste buffer. This text block starts with string
   "<datasource jta=…" and ends with string "</xa-datasource>".
9. Paste that cut/paste buffer into the appropriate location within the JBoss "standalone.xml" file (opened in step 2). This paste must be done within the "<datasources>" XML tags.
10. Copy the IDMS "Driver" definition within file "Template updates to standalone xml for IDMS.txt" into the windows cut/paste buffer. This text block starts with string
    "<driver name="IDMS"" and ends with string "</driver>".
11. Paste that cut/paste buffer into the appropriate location within the JBoss "standalone.xml" file (opened in step 2). This paste must be done within the "<drivers>" XML tags.
12. Save the updates to the "standalone.xml" file.
13. Cycle JBoss/AS (that is, stop and restart the JBoss Application Server).

The new IDMS Data Sources should now be ready for use. To test the IDMS connectivity, use the JBoss Administration Console. Note that by default, the JBoss Admin Console can be accessed via a browser at url: http://localhost:9990/console/App.html#server-overview. Use the following procedure to perform the test:

1. Click on the "Profile" action on the top-right portion of the page.
2. On the middle-top portion of the page select either "Datasources" or "XA Datasources".
3. Under the "Available (XA) Datasources" label, click the newly created IDMS Data Source to make it "current".
4. Under the "Selection" label (in the middle of the page) are the following items:
   
   
   1. Attributes Connection Security Properties Pool Validation
5. Select the "Connection" item.
6. Select the "Test Connection" button.

For more information on the use of the IDMS Server JDBC Driver, see the JDBC Programmer Reference section within the IDMS Server User Guide (provided in the product install directory).