Configuring EIF WebSphere JMS Provider using script

The EIF WebSphere JMS Provider can be reconfigured using the configuration script provided. The script is located at <was_profile_path>/eventext/bin/eifjms.jacl. Use the wsadmin tool to run the eifjms.jacl script. The script can perform the following:

  1. Create a new set of configuration for the EIF WebSphere JMS Provider.
  2. Remove the configuration of the EIF WebSphere JMS Provider.
  3. Configure the EIF WebSphere JMS Provider to forward events to an additional Enterprise Console server.
  4. Remove the configuration of forwarding events to the additional Enterprise Console server.

WebSphere Application Server needs to be restarted for the configuration changes to take effect.

Usage

Invoke wsadmin and supply the name of this script on the -f parameter.This script takes the following parameters:
-action
Specify one of [install/uninstall/addconnection/removeconnection]
Specifying install will create a new set of configuration for the EIF WebSphere JMS Provider.The JMS Provider is installed and an event group is created.
Specifying uninstall will remove the configuration of the EIF WebSphere JMS Provider. The JMS provider is uninstalled and the event group is removed.
Specifying addconnection will configure the EIF WebSphere JMS Provider to forwards events to an additional Enterprise Console server.A JMS connection factory is created for the installed JMS Provider and a corresponding event group is created.
Specifying removeconnection will remove the configuration for forwarding events to the additional Enterprise Console server. The JMS conectionfactory and the corresponding event group is removed
This parameter is required.
-scope
Specify the scope (cell, node, server or cluster) at which the JMS provider is to be installed/uninstalled or from which a connection is to be added/removed.
This parameter is required.
-node
Specify the name of the node to which the JMS Provider is to be installed/uninstalled or from which a connection is to be added/removed
This parameter is required if the scope parameter is set to node/server.
-server
Specify the name of the server to which the JMS Provider is to be installed/uninstalled or from which a connection is to be added/removed.
This parameter is required if the scope parameter is set to server.
-cluster
Specify the name of the cluster to which the JMS Provider is to be installed/uninstalled or from which a connection is to be added/removed.
This parameter is required if the scope parameter is set to cluster.
-qname
Specify the name of Queue to be created for the JMS Provider.
This parameter is required if the action parameter is install.
-qcfname
Specify the name of Queue Connection Factory to be created for the JMS Provider. This parameter is required if the action parameter is set to install/addconnection/removeconnection.
-qjndi
Specify the JNDI name of Queue that is created for the JMS Provider.
This parameter is optional. Default value is jms/eif/<qname>.
-qcfjndi
Specify the JNDI name of Queue Connection Factory that is created for the JMS Provider.
This parameter is optional. Default value is jms/eif/<qcfname>.
-eventselector
Specify the selector string for events to be forwarded to Tivoli Enterprise Console server.This must be a valid XPath expression.
This parameter is optional.Default value is all events.
-trace

Specify this option to display detailed processing information.

This parameter is optional. Detailed information is not displayed by default.

The script additionally takes a list of properties in the form of key=value, which are set as the Custom Properties for the Queue Connection Factory created during install or when a connection is added.

The allowed keys of the properties are:

BarocLocation
Specify the location of the baroc files
This property is optional. Default value is set to ${USER_INSTALL_ROOT}/eventext/tec_classes
ServerLocation
Specify the host name of the Enterprise Console server to forward the events
This property is optional. Default value is set to localhost.
ServerPort
Specify the receiving port of the Tivoli Enterprise server
This property is optional. Default value is set to 5529
BufferEvents
Specify if events forwarded to Enterprise Console server are to be buffered. Valid vales are [YES/NO]
This property is optional. Default value is NO
BufEvtPath
Specify the location and name of the file where buffered events are to be stored
This property is required if BufferEvents is set to YES.Default value is /tmp/<qcfname>.cache.
LogLevel
Specify the level of logging to be done.
This property is optional. Default is none.
TraceLevel
Specify the level of tracing to be done.
This property is optional. Default is none.
LogFileName
Specify the location and name of the log file
This property needs to be specified if LogLevel is specified
Default value is /tmp/<qcfname>.log
TraceFileName
Specify the location and name of the trace file
This property needs to be specified if TraceLevel is specified
Default value is /tmp/<qcfname>.trace

Examples

Example for install action
An example for creating a new set of configuration. This command is executed from <was_profile_path>/eventext/bin directory
wsadmin
-f eifjms.jacl
-action install
-scope node
-node mynode
-qname TECQueue
-qcfname TECQCF
-trace
ServerLocation=myhost
BufferEvents=yes
BufEvtPath=/tmp/tecevt.buf
Example for uninstall action
An Example for removing the configuration. This command is executed from <was_profile_path>/eventext/bin directory
wsadmin
-f eifjms.jacl
-action uninstall
-scope node
-node mynode
-trace
Example for addconnection action
Example for adding a connection.This command is executed from <was_profile_path>/eventext/bin directory.
wsadmin
-f eifjms.jacl
-action addconnection
-scope node
-node mynode
-qcfname TECQCF
-eventselector "CommonBaseEvent[@extensionName = 'CLASS' and @severity > 40]"
-trace
ServerLocation=myanotherhost
Example for removeconnection action
Example for removing a connection. This command is executed from <profile_home>/eventext/bin directory
wsadmin
-f eifjms.jacl
-action removeconnection
-scope node
-node mynode
-qcfname TECQCF
-trace

Reference
Configuring JMS Provider
Configuring event group

Related topics
Changing the forwarding Tivoli Enterprise Console Server
Selecting the events to forward
Enabling event buffering
Forwarding events to multiple servers
Modifying the scope of configuration
Modifying Enterprise Console event class definitions

Parent topic
Administering the EIF WebSphere JMS Provider