WebSphere WebSphere Application Server Version 6.1.x Feature Pack for Web Services Operating Systems: AIX, HP-UX, i5/OS, Linux, Solaris, Windows, z/OS

Creating a new messaging engine using the wsadmin tool

When you create a service integration bus and add a server or a cluster member to that bus, a messaging engine with default settings is created automatically. Use the createSIBEngine command to create an additional messaging engine for a cluster bus member.

Each server bus member has exactly one messaging engine. Cluster bus members can support additional engines. If you create an additional messaging engine for a cluster, you must explicitly configure both the data store and the JDBC data source that the messaging engine uses to interact with the data store. You must create the data source at cluster scope, not node scope. For more information about creating messaging engines, see Configuring a data source for a messaging engine running in a cluster.

To run the command, use the AdminTask object of the wsadmin scripting client.

For i5/OS platforms The wsadmin scripting client is run from Qshell. For more information, see the topic "Configure Qshell to run WebSphere Application Server scripts".

This command is only valid when used with WebSphere Application Server Version 6 and later application servers. Do not use it with earlier versions.

Command-line help is provided for service integration bus commands:

After using the command, save your changes to the master configuration; for example, by using the following command:
 $AdminConfig save

Purpose

This command creates a new messaging engine for a cluster bus member.

Command name
createSIBEngine
Target
None.
Result
A messaging engine object on the bus.

Required parameters

-bus busname
The name of the service integration bus on which the bus member is configured. You can use the listSIBuses command to list the names of existing buses.

Conditional parameters

-node node
To create a messaging engine for a node as a bus member, specify the name of the node.
-server server
To create a messaging engine for a server as a bus member, specify the name of the server.
-cluster cluster
To create a messaging engine for a server cluster as a bus member, specify the name of the cluster.

Optional parameters

-description text
An optional description for the messaging engine, for administrative purposes.
-initialState STARTED | STOPPED
The initial state determines whether the messaging engine is started automatically when the server or server cluster is started.
STARTED
When the associated application server is started, the messaging engine is started and is available to process messages.
STOPPED
When the associated application server is started, the messaging engine is stopped and is not available to process messages.
-highMessageThreshold number
The maximum total number of messages that the messaging engine can place on its message points.

When the messaging engine is created, the high message threshold of the bus is used to set the default value for this property. When a message point is created on this messaging engine, the value of this property is used to set the default high message threshold for the message point.

-fileStore

A file store is a type of message store that directly uses files in a file system through the operating system.

You can specify the type of message store of the messaging engine to be a file store. The type of message store can also be a data store, for more information see related links.
-logSize logsize
Size of the log file in MB.
-logDirectory logdirectoryname
If you do not want to use the default log directory, you can specify a different one.
-minPermanentStoreSize minpermanentstoresize
Minimum size of the permanent store file in MB.
-minTemporaryStoreSize mintemporarystoresize
Minimum size of the temporary store file in MB.
-maxPermanentStoreSize maxpermanentstoresize
Maximum size of the permanent store file in MB.
-maxTemporaryStoreSize maxtemporarystoresize
Maximum size of the temporary store file in MB.
-unlimitedPermanentStoreSize TRUE | FALSE
A boolean parameter specifying whether the permanent store size is unlimited.
-unlimitedTemporaryStoreSize TRUE | FALSE
A boolean parameter specifying whether the temporary store size is unlimited.
-permanentStoreDirectory permanentstoredirectoryname
If you do not want to use the default permanent store directory, you can specify a different one.
-temporaryStoreDirectory temporarystoredirectoryname
If you do not want to use the default temporary store directory, you can specify a different one.
-dataStore

A data store consists of the set of tables that a messaging engine uses to store persistent data in a database. Refer to Data store tables for a list of the tables that comprise a data store. All the tables in a data store are held in the same database schema. You can create multiple data stores in the same database only by using a different schema for each data store.

You can specify the type of message store of the messaging engine to be a data store, although the default is file store. For more information see related links.
-createDefaultDatasource TRUE | FALSE
Set this parameter to true to create a default data source when the messaging engine is created.
-createTables TRUE | FALSE
Set this parameter to true to create the database tables automatically for the data source. If you set this option to false, the database administrator must create the tables.

For z/OS platforms For the z/OS operating system, you must not create tables, so set this parameter to FALSE.

-authAliasauthalias
The user also has to provide an authentication alias, which the messaging engine uses to connect to the database in its data store.
-schemaName schemaname
If you do not want to use the default schema name, you can specify a different one. For more details on default schema, see Creating users and schemas in the database.
-datasourceJndiName jndiname
The JNDI name of the data source that the messaging engine uses to access the relational database management system (RDBMS) for the data store.

Depending on the choice of the message store and its attributes, you need to specify different combinations of the parameters. To avoid errors when specifying the message store when creating the messaging engine, see Avoiding errors when creating a messaging engine with a file store or a data store using the wsadmin tool.

Examples

Create a messaging engine on the bus

$AdminTask createSIBEngine -bus busName

Create a messaging engine on the bus, using a file store to save messages, with default settings

$AdminTask createSIBEngine -bus busName -fileStore

Create a messaging engine on the bus, using a file store to save messages, with options

$AdminTask createSIBEngine -bus busName -fileStore {{logDirectory "c:\fred" logSize 3636363}}

Create a messaging engine on the bus, using a data store to save messages, with default settings

$AdminTask createSIBEngine -bus busName -dataStore

Create a messaging engine on the bus, using a data store to save messages, with options

$AdminTask createSIBEngine -bus busName -dataStore {{createDefaultDatasource true datasourceJndiName myjndi}}

Create a messaging engine on the bus, using a data store to save messages, with syntax

$AdminTask createSIBEngine -bus busName -createDefaultDatasource true -datasourceJndiName myjndi
Related concepts
Considerations when choosing between a file store and a data store

Reference topic

Terms of use | Feedback


Timestamp icon Last updated: 27 November 2008
http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/index.jsp?topic=/com.ibm.websphere.pmc.wsfep.multiplatform.doc/ref/rjk_cli_me_create.html

Copyright IBM Corporation 2004, 2008. All Rights Reserved.
This information center is powered by Eclipse technology. (http://www.eclipse.org)