Setting up Cluster/Maximo Enterprise Adapter for Maximo 6 on WebSphere 6.0

Technote (troubleshooting)


This document applies only to the following language version(s):

English

Problem(Abstract)

This document describes the steps required to set up a clustered Maximo application along with a stand-alone MEA application for best performance

Resolving the problem

When using the Maximo Enterprise Adapter (MEA) in a clustered environment the following should be considered.
· For best performance with minimal impact to users, the MEA can be configured to run on a single instance of Maximo while users log in and work with User Interface (UI) Instances of Maximo. In this case, you will need separate application servers (MEA and UI instances).

· To share these resources, all resources will need to be defined at the cell level within the WebSphere console. The reason for this is although the MEA instance will do all of the processing of inbound transactions, the outbound transaction events will still occur from the UI instances upon saving Maximo records. This means that the UI instances need to have access to the JMS resources such as connection factories in order to be able to send outbound messages.

· The MEA instance which will be responsible for processing inbound MEA transactions from the continuous queue will need to have the Message Driven Bean (MDB) deployed along with the Maximo application to its own application server and therefore will need a maximo.ear build that is slightly different than the UI instances which will not need the Message Driven Bean running within them.

Below you will find instructions for setting up a cluster environment for UI instances of Maximo and a stand-alone application server for Maximo MEA transaction processing.

In the example configuration below, we will use the following names:
MXSERVER is the application server for the Maximo UI from initial installation.
MAXIMOMEA is the application server for the Maximo Enterprise Adapter instance
MAXIMOCLUSTER is the cluster
MAXIMOUI1 is a clustered server for the UI
MAXIMOUI2 is a clustered server for the UI

Create a second application server: Name this second server MAXIMOMEA
Follow the instructions in the Maximo System Administrator's Guide to create a second application server
Name this server MAXIMOMEA

NOTE: When setting the maximum heap size for the MAXIMOMEA application server JVM, the admin guide says to set this to 1024MB, however, since this application server will not be used by users directly, the memory size can be increased to 2048MB so that it can handle large volumes of messages

Create a cluster and cluster members.
1. Open the WebSphere Administrative Console.
2. Click Servers > Clusters in the navigation pane.
3. Click New in the Server Cluster pane.

4. In Step 1 of the Enter Basic Cluster Information panel, perform the following actions:
a. Type MAXIMOCLUSTER in the Cluster name field.
b. Select the Prefer local box.
c. Select Do not include an existing server in this cluster button.
d. Click Next.

5. In Step 2 of the Create New Clustered Servers panel, perform the following actions:
a. Type MAXIMOUI1 in the Member name field.
b. Accept the defaults in the Select Node and Weight fields.
c. Select Generate Unique Http Ports.
d. Select the Existing application server button, and choose MAXIMOSERVER (this is the application server name created initially for Maximo) from the drop down list.
e. Click Apply.

6. Repeat step 5 to create a second cluster member, and in the Member name field enter MAXIMOUI2.

NOTE You do not have to perform step 5-d when you create additional clustered servers, because MAXIMOUI2 automatically defaults to the template you selected for MAXIMOUI1.

7. Click Next.
8. Click Finish to create the cluster and clustered servers.
9. Click Save.
10. Select Synchronize changes with Nodes, then click Save again.

Update Virtual Hosts
This procedure describes how to verify port numbers used by the clustered servers. It also explains how to update the virtual host with the port number information. A virtual host enables a single host machine to resemble multiple host machines. Each virtual host has a logical name and a list of one or more DNS aliases by which it is known.

1. To verify port numbers of the clustered application servers, perform the following actions:
a. In the navigation pane, click Servers > Application Servers.
b. In the Application Servers panel, click MAXIMOUI1.
c. Under the Communication heading, click Ports.
Note the WC_defaulthost port for use in Step 3 below (for example, step 3-h requires a WC_defaulthost port.)

2. Repeat Step 1 for MAXIMOUI2.

3. In the navigation pane, click Environment > Virtual Hosts.
Complete the following actions:
a. Click New to add a new virtual host for the cluster, then enter MAXIMOCLUSTER_host for the Name.
b. Click Apply.
c. Click Host Aliases under Additional Properties.
d. Click New in the Host Alias panel to add Host name and port number values to the host aliases list.
e. Enter the following:
Host Name: *
Port: 80 (same as port number for the IBM HTTP Server), Click OK.
f. Click Host Aliases, then click New.
g. Enter the following:
Host Name: *
Port: 9081 (same as port number for MAXIMOUI1), Click OK.
h. Click Host Aliases, then click New.
i. Enter the following:
Host Name: *
Port: 9082 (same as port number for MAXIMOUI2), Click OK.

4. To save the configuration, complete the following actions:
a. Click Save.
b. Check Synchronize changes with Nodes.
c. Click Save.

Creating data source providers for JMS stores
Set two data sources in the WebSphere console for use by the JMS resources
Note that each data source will require a unique schema, one will be used by the MEA instance, and the other by the Cluster. This is a WebSphere requirement that two message engines require unique schema names. As you add bus members, each member added will cause a unique message engine to be created. In this configuration there are two members, the MEA instance and the Cluster.

Since two schemas will be required for this configuration, and the first schema name will be the maximo schema, work with your DBA to create a second schema in the same database specifically for use by the second data source before proceeding with the steps below.

Note: The user that owns the second schema must be able to create tables.

1. Log in to the WebSphere console, and from the left pane, select Resources/JDBC Providers

2. On the JDBC providers screen, set the scope to be the cell and click "Apply"
This can be done by clearing all fields before clicking the apply button

3. Click the "new" button

4. In the General Properties, select your database type and provider type (i.e. oracle and oracle driver). In the implementation type dropdown select "XA data source", click next

5. In the name field, enter
oraclexa

6. In the classpath text box, enter (be sure to correct the path to reflect your oraclethin.jar path):
C:\maximo\applications\maximo\lib\oraclethin.jar

7. Click "apply" and save and synchronize with other nodes.

Creating the first data source
1. Navigate to your JDBC provider called oraclexa

2. Click the link on the right side of the screen called "data sources"

3. Click the "new" button

4. In the name field enter the value:
oraclexads

5. In the JNDI name field, enter the value:
jdbc/oraclexads

6. Select a data store helper class for your oracle version:
Example: Oracle 9i and prior data store helper

7. In the URL field, enter your JDBC URL (this can be found in your maximo.properties if you are not sure)
jdbc:oracle:thin:@server1:1521:maximo

8. Click apply, save and synchronize with other nodes

Creating your first authentication data entry
1. Navigate to your JDBC provider called oraclexa, then click data sources and select your data source called oraclexads

2. On the right side of the screen, under Related Items, click the link for "J2ee Connection Architecture Authentication data entries"

3. Click the "new" button

4. In the alias field, enter a value you would like to use: i.e. maximo

5. Enter the username and password used to connect to the database: i.e. maximo/maximo

6. Enter a Description that identifies this entry, click apply

7. Save and synchronize with other nodes

8. Navigate back to your data source called oraclexads

9. In the dropdown field for "Component managed authentication alias", select your data alias (i.e. maximo)

10. Click apply and save and synchronize with other nodes

11. Navigate to your data source again and click the test button at the top of the screen to test your data source

Once the test has succeeded, you can proceed to the next data source

Creating the second data source
1. Navigate to your JDBC provider oraclexa

2. Click the link on the right side of the screen called "data sources"

3. Click the "new" button

4. In the name field enter the value:
oraclexads2

5. In the JNDI name field, enter the value:
jdbc/oraclexads2

6. Select a data store helper class for your oracle version:
i.e. Oracle 9i and prior data store helper

7. In the URL field, enter your JDBC URL (this will be the URL to your new schema used for the second store)
jdbc:oracle:thin:@server1:1521:maximo2

8. Click apply, save and synchronize with other nodes

Creating your second authentication entry
1. Navigate to your JDBC provider called oraclexa, then click data sources and select your data source called oraclexads2

2. On the right side of the screen, under Related Items, click the link for "J2ee Connection Architecture Authentication data entries"

3. Click the "new" button

4. In the alias field, enter a value you would like to use: i.e. maximo2

5. Enter the username and password used to connect to the database: i.e. maximo/maximo

6. Enter a Description that identifies this entry, click apply

7. Save and synchronize with other nodes

8. Navigate back to your data source called oraclexads2

9. In the dropdown field for "Component managed authentication alias", select your data alias (i.e. maximo2)

10. Click apply and save and synchronize with other nodes

11. Navigate to your data source again and click the test button at the top of the screen to test your data source

Once the test has succeeded, you can proceed to the next section

Creating JMS resources for use in a clustered environment

Creating the JMS buses:
1. Log in to the WebSphere console and navigate in the left pane to Integration/buses

2. Click the "new" button to create a new bus

3. In the name field, enter "meajmsbus"

4. Deselect the "secure" checkbox

5. Change the "high message threshold" to 500,000 messages, click "apply"

6. Navigate again in the left pane to Integration/buses

7. Click the "new" button to create a second new bus

8. In the name field, enter "uijmsbus"

9. Deselect the "secure" checkbox

10. Change the "high message threshold" to 500,000 messages

11. Click "apply"

Adding members to the bus:

1. Navigate in the left pane to Integration/buses

2. Select the first bus created above called meajmsbus

3. Under "additional properties", select "bus members"

4. Click the "Add" button

5. Add the MAXIMOMEA server as a bus member by selecting that under the server section

6. In the data source JNDI name field, enter:
jdbc/oraclexads

7. Click Next, then click Finish

8. Navigate in the left pane to Integration/buses

9. Select the second bus created above called uijmsbus

10. Add the MAXIMOCLUSTER by selecting that under the cluster section

11. In the data source JNDI name field, enter:
jdbc/oraclexads2

12. Save and synchronize with other nodes.

Setting the data stores and authentication alias
1. Select the bus member (MEA instance) of your meajmsbus bus

2. from the list of message engines, select your message engine

3. Under "additional properties" click "data store"

4. In the data source JNDI name field, enter
jdbc/oraclexads

5. In the schema name field, enter your maximo schema name (i.e. maximo)

6. In the authentication alias dropdown, select the alias created for the data source above, click OK

7. Navigate back to your list of buses and select the uijmsbus

8. Select the bus member (Cluster) of your uijmsbus bus

9. From the list of message engines, select your message engine

10. Under "additional properties" click "data store"

11. In the data source JNDI name field, enter
jdbc/oraclexads2

12. In the schema name field, enter your second schema created above by your DBA (i.e. maximo2)

13. In the authentication alias dropdown, select the second alias created for this data source above

14. Click OK

15. Save and synchronize with other nodes

Creating bus destinations
1. Log in to the WebSphere console and navigate to Service Integration/buses

2. Select your bus meajmsbus

3. Under "Additional properties" click "destinations"

4. Click the "new" button

5. Set the destination type as "queue" and click next

6. In the identifier field, enter "cqinbdcls"

7. Assign the queue in the next screen to the MAXIMOMEA application server

8. Click next.

9. Then click finish

10. Repeat the steps above to create the sqinbdcls destination and assigning it to the
MAXIMOMEA application server

11. Navigate in the WebSphere console to Service Integration/buses

12. Select your bus uijmsbus

13. Under "Additional properties" click "destinations"

14. Click the "new" button

15. Set the destination type as "queue" and click next

16. In the identifier field, enter "sqoutbdcls"

17. Assign the queue in the next screen to the UI Cluster

18. Click next, then click finish

19. Navigate in the WebSphere console to each destination created above on both buses

20. For each destination above, set the "exception destination" to "none", then click Apply

21. Save and synchronize with other nodes

Creating MEA connection factories
1. Log in to the WebSphere console

2. Navigate in the left pane to Resources/JMS providers/default messaging

3. Set the scope to the cell and click apply, making sure node, cluster, and server fields are empty

4. Under "connection factories", select "JMS queue connection factory"

5. Click the "new" button

6. In the name field, enter "meaconfact"

7. In the JNDI name field, enter
jms/mro/int/qcf/intqcfmea

8. Select the bus meajmsbus from the dropdown

9. Click "apply" and save and synchronize with other nodes

10. Under "connection factories, select "JMS queue connection factory"

11. Click the "new" button

12. In the name field, enter "uiconfact"

13. In the JNDI name field, enter
jms/mro/int/qcf/intqcfui

14. Select the bus uijmsbus from the dropdown

15. Click "apply" and save and synchronize with other nodes

Creating JMS queues
Continuous inbound queue:
1. Log in to the WebSphere console and navigate to Resources/JMS providers/default messaging

2. Ensure that the scope is set to the Cell, and Under "destinations", click "jms queue"

3. Click the "new" button

4. Enter the name as "cqincls"

5. In the JNDI name field, enter "jms/mro/int/queues/cqincls

6. Select the meajmsbus as the bus for this queue

7. In the queue name field, enter the destination name for this as "cqinbdcls"

8. Click "OK"

Sequential inbound queue
1. Log in to the WebSphere console and navigate to Resources/JMS providers/default messaging

2. Under "destinations", click "jms queue"

3. Click the "new" button

4. Enter the name as "sqincls"

5. In the JNDI name field, enter "jms/mro/int/queues/sqincls

6. Select the meajmsbus as the bus for this queue

7. In the queue name field, enter the destination name for this as "sqinbdcls"

8. Click "OK"

Sequential inbound queue
1. Log in to the WebSphere console and navigate to Resources/JMS providers/default messaging

2. Under "destinations", click "jms queue"

3. Click the "new" button

4. Enter the name as "sqoutcls"

5. In the JNDI name field, enter "jms/mro/int/queues/sqoutcls

6. Select the uijmsbus as the bus for this queue

7. In the queue name field, enter the destination name for this as "sqoutbdcls"

8. Click "OK"

9. Save and synchronize with other nodes

Creating the JMS Activation Specification
1. Log in to the WebSphere console and navigate to Resources/JMS providers/default messaging

2. Ensure that the scope is set to the Cell

3. Under additional properties, click "jms activation specification"

4. Click the "new" button

5. In the name field, enter "meajmsactcls"

6. In the JNDI name field, enter "meajmsactcls"

7. In the "Destination JNDI name" field, enter "jms/mro/int/queues/cqincls"

8. Make sure the destination type is "queue"

9. Select your bus "meajmsbus" as the bus for this specification

10. Set Maximum batch size to 10

11. Set Maximo end points to 5

12. Click OK and save and synchronize with other nodes

13. Stop and Restart all IBM services

Build and deploy multiple EAR files from the same Maximo directory
You will need to build multiple ear file builds of Maximo where some of the files to be included in each ear file will be different from the next ear file, you do not need multiple instances of the Maximo installation folder.

For example, the User Interface (MAXIMOCLUSTER) application server requires one ear file that disables the MEA Inbound crontasks and the MEA application server requires an ear file that disables the MEA Outbound crontasks.

For each file that will be modified, making it different for one ear from the next, make a copy of that file and name it appropriately. An example of the files that would be unique to each ear file for the above scenario might look like this:

\maximo\applications\maximo\properties
maximo.properties
maximo.propertiesUI
maximo.propertiesMEA

\maximo\applications\maximo\META-INF\
application.xml
application.xmlUI
application.xmlMEA

maximo\applications\maximo\META-INF\
deployment-application.xml
deployment-application.xmlUI
deployment-application.xmlMEA

\maximo\applications\maximo\meajmsejb\ejbmodule\META-INF\
ibm-ejb-jar-bnd.xmi
ibm-ejb-jar-bnd.xmiUI
ibm-ejb-jar-bnd.xmiMEA

Where there are 3 copies of each file, one with the default name, the next named for the User Interface (Cluster) ear, and one named for the MEA ear.

In this scenario, for the creation of two different ear files you would make two copies of the file buildmaximoear.cmd and give them names such as the following:

buildmaximoear-UI.cmd
buildmaximoear-MEA.cmd

These would be the files you use to build your individual ear files.

These are the steps to change the new cmd files to build your unique ear files:

1. Edit the buildmaximoear-UI.cmd file,
a. At the top, enter the following shell commands:

copy /Y \maximo\applications\maximo\properties\maximo.propertiesUI \maximo\applications\maximo\properties\maximo.properties

copy /Y \maximo\applications\maximo\META-INF\application.xmlUI \maximo\applications\maximo\META-INF\application.xml

copy /Y maximo\applications\maximo\META-INF\deployment-application.xmlUI maximo\applications\maximo\META-INF\deployment-application.xml

copy /Y \maximo\applications\maximo\meajmsejb\ejbmodule\META-INF\ibm-ejb-jar-bnd.xmiMEA \maximo\applications\maximo\meajmsejb\ejbmodule\META-INF\ibm-ejb-jar-bnd.xmi

b. Change the EAR_FILENAME variable to reflect the unique ear file name for the UI and MEA, for example:

set EAR_FILENAME=maximoUI.ear

2. You can then run this build scripts to build the ear files. In this case, the resulting ear file will be named maximoUI.ear.
3. Repeat the above steps to create the maximoMEA.ear as well, changing references for UI to MEA.

Prepare and Deploy the UI application server
Since we want all MEA Inbound crontasks to run in the MAXIMOMEA instance, they are listed here as DONOTRUN for the UI application (MAXIMOCLUSTER).

1. Edit the maximo.propertiesUI file and add the donotrun option as below:
mxe.crontask.donotrun=JMSQSEQCONSUMER.SEQQIN,IFACETABLECONSUMER.IFACEIN,BBcron.BBCRON1,......

Note: Use of the above donotrun option is recommended over the target-enabled option because the donotrun option is Cluster-aware. Therefore, if the crontask is running in one application server, and that application server is shut down, another application server can take over running the crontasks.

Also, be sure to go through your list of crontasks and note each instance in the correct case and add it to the mxe.crontask.donotrun parameter in the maximo.propertiesUI, each separated by a comma

2. Build the maximoUI.ear file – using the buildmaximoear-UI.cmd.

3. Now that you have created and configured the MAXIMOCLUSTER, you should now deploy your maximoUI.ear (enterprise application - EAR) to the MAXIMOCLUSTER.

Note: When mapping modules to servers, make sure you select both MAXIMOCLUSTER and the webserver1 as the web server:
WebSphere:cell-ctgCell01,server=MAXIMOCLUSTER
WebSphere:cell-ctgCell01,node=ctgNode01,server=webserver1

4. Also, when mapping virtual hosts to web modules, use the MAXIMOCLUSTER_host virtual host.

5. Lastly, start/restart the MAXIMOCLUSTER server.

6. To access the cluster, open HTTP://<node name>:<port>/maximo where <port> is the port number of the IBM HTTP server (80)

Prepare and Deploy the MEA application
For the MAXIMOMEA application instance, edit the following files and uncomment the meajmsejb.jar:

1. Locate and edit this file under \maximo\applications\maximo\META-INF\application.xmlMEA
a. Uncomment the following (they may already be in the state below):
<!-- JMS MDB is not deployed by default -->
<module>
<ejb>/meajmsejb/ejbmodule</ejb>
</module>

2. Locate and edit the file under \maximo\applications\maximo\META-INF\deployment-application.xmlMEA
a. Uncomment the following (they may already be in the state below):
<!-- JMS MDB is not deployed by default -->
<module id="EjbModule_1077124925237">
<ejb>meajmsejb.jar</ejb>
</module>

3. The activation specification JNDI name is not the default (i.e. meajmsact) so you will need to edit the following file, and change the value as below to your new JNDI name:
\maximo\applications\maximo\meajmsejb\ejbmodule\META-INF\ibm-ejb-jar-bnd.xmiMEA
a. Locate the following line and change to:
<ejbBindings xmi:type="com.ibm.ejs.models.base.bindings.ejbbnd:MessageDrivenBeanBinding" xmi:id="MessageDrivenBeanBinding_1" activationSpecJndiName="meajmsactcls">

4. Edit the maximo.propertiesMEA file and set mxe.name to a unique value such as MAXIMOMEA and save
a. Edit the line so that all crontasks except for the JMSQSEQCONSUMER.SEQQOUT crontask will run on this server:
mxe.crontask.donotrun=JMSQSEQCONSUMER.SEQQOUT
(This will be the only crontask entry because this is the only crontask that we do not want to run.)

5. Build the maximoMEA.ear file – using the buildmaximoear-MEA.cmd.

6. Now that you have created and configured the MAXIMOMEA application server, you should now build and deploy your maximoMEA.ear (enterprise application - EAR) to the MAXIMOMEA application server.

Note: When mapping modules to servers, make sure you select both MXServer and the webserver1 as the web server:
WebSphere:cell-ctgCell01,server=MAXIMOMEA
WebSphere:cell-ctgCell01,node=ctgNode01,server=webserver1


7. Also, when mapping virtual hosts to web modules, use the MAXIMO_host virtual host.

8. Lastly, start/restart the MAXIMOMEA application server.

Changes required in Maximo

1. Launch the Maximo application and log in:

http://host:port/maximo

2. Navigate to configuration/cron task setup

3. Bring up the JMSQSEQCONSUMER crontask

4. For the SEQQIN instance, change the queue name to match your inbound sequential queue name:

jms/mro/int/queues/sqincls

5. For the SEQQOUT instance, change the queue name to match your outbound sequential queue name:

jms/mro/int/queues/sqoutcls

6. Save your changes.

7. Next, navigate to the Integration/External Systems application

8. Select any external system and then from the action menu, select add/modify queues

9. Create your three new queues with the following values:

Continuous inbound queue:
Queue JNDI name: jms/mro/int/queues/cqincls
Queue Connection Factory: jms/mro/int/qcf/intqcfmea
Sequential: NO
Inbound: Yes
Maximum Try count: 0

Sequential inbound queue:
Queue JNDI name: jms/mro/int/queues/sqincls
Queue Connection Factory: jms/mro/int/qcf/intqcfmea
Sequential: Yes
Inbound: Yes
Maximum Try count: 0

Sequential outbound queue:
Queue JNDI name: jms/mro/int/queues/sqoutcls
Queue Connection Factory: jms/mro/int/qcf/intqcfui
Sequential: Yes
Inbound: NO
Maximum Try count: 0

10. You will then need to bring up each external system and change the queue names associated with each system in the top right side of the screen to match those created above.

11. Save your changes.

Deploying web services:

When deploying web services, you will need to set up the web service administration URL and port to point to the MAXIMOMEA application server IP address and port.
When sending transactions to these interfaces, you will need to point your web service client to the IP address and port of the MAXIMOMEA application server IP address and port, not the cluster address for the UI instances.

Important note:

Importing data can only be performed while logged into the MEA instance where the Message Driven Bean is deployed. Exporting data can only be performed while logged into one of the UI cluster members.


Cross reference information
Segment Product Component Platform Version Edition
Systems and Asset Management IBM Maximo Enterprise Adapter Not Applicable

Product Alias/Synonym

MAXIMO

Rate this page:

(0 users)Average rating

Add comments

Document information


More support for:

IBM Maximo Asset Management
MEA: Generic

Software version:

6.0, 6.1, 6.2, 6.2.1, 6.2.2, 6.2.3, 6.2.4, 6.2.5, 6.2.6, 6.2.7, 6.2.8

Operating system(s):

Windows

Software edition:

All Editions

Reference #:

1282841

Modified date:

2011-08-09

Translate my page

Machine Translation

Content navigation