WAS v8.5 > Reference > Jython script library

JMS configuration scripts

The scripting library provides many script procedures to manage your Java Messaging Service (JMS) configurations. This topic provides usage information for scripts that query your JMS configuration. We can run each script individually or combine many procedures to create custom automation scripts for the environment.

Each AdminJMS management script procedure is located in the app_server_root/scriptLibraries/resources/JMS/V70 directory.

Beginning with v7, the Jython script library provides script functions for JDBC providers, JMS resources, and resource providers at the server scope. We can write our own custom scripts to configure resources at the cell, node, or cluster level.

Do not edit the script procedures in the script library. To write custom script library procedures, use the scripts in the app_server_root/scriptLibraries directory as Jython syntax samples. Save the custom scripts to a new subdirectory to avoid overwriting the library.

Fast path: Beginning with Fix Pack 5, the Jython script library provides script functions for JDBC providers, JMS resources, and resource providers at the cell, node, server, or cluster scope. Resource providers include mail providers, URL providers, and resource environment providers. We do not have to write custom scripts to configure resources at a particular scope.

The example usage scripts and the script syntax are split on multiple lines for printing purposes.

Use the following script procedures to configure JMS in the environment:


Format for the scope argument

The scope format applies to the scripts in the script library that have the scope argument.

A cell is optional on node, server, and cluster scopes. A node is required on the server scope.

We can delimit the type using a comma (,) or a colon (:). We can use lower case for the type (cell=, node=, server=, or cluster=.)

The examples in the following table are split on multiple lines for publishing purposes.

Examples of the containment path, configuration ID, and type for a particular scope. The scope can be Cell, Node, Server, or Cluster.

Scope Containment path Configuration ID Type
Cell /Cell:myCell/ 
myCell(cells/myCell|
cell.xml#Cell_1)
 Cell=myCell or cell=myCell
Node /Cell:myCell/Node:myNode/ or /Node:myNode/ 
myNode(cells/myCell
/nodes/myNode|
node.xml#Node_1)
 
Cell=myCell,
Node=myNode
or 
Cell=myCell:
Node=myNode
or 
cell=myCell,
node=myNode
Server 
/Cell:myCell/Node:
myNode/
Server:myServer/
or 
/Node:myNode/Server:
myServer/
 
myServer(cells
/myCell/
nodes/myNode/
servers/myServer|
server.xml#Server_1)
 
Cell=myCell,
Node=myNode,
Server=myServer
or 
Node=myNode:
Server=myServer
or 
cell=myCell,
Node=myNode,
Server=myServer
Cluster 
/Cell:myCell/
ServerCluster:
myCluster/
or 
/ServerCluster:
myCluster/
 
myCluster(cells
/myCell/clusters/
myCluster|
cluster.xml
#ServerCluster_1)
 
Cell=myCell,
Cluster=myCluster
or 
Cell=myCell:
Cluster=myCluster
or 
cell=myCell,
Cluster=myCluster


createGenericJMSConnectionFactory

This script creates a new generic JMS connection factory in your configuration. The script returns the configuration ID of the created JMS connection factory in the respective cell.

To run the script, specify the node, server, JMS provider name, name of the new connection factory, JNDI name, and external JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createGenericJMSConnectionFactory script. Run the script to create a generic JMS connection factory.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider.
connFactoryName Name to assign to the new connection factory
jndiName JNDI name the system uses to bind the connection factory into the name space.
extJndiName JNDI name used to bind the queue into the application server name space. As a convention, use the fully qualified JNDI name; for example, in the form jms/Name, where Name is the logical name of the resource. This name is used to link the platform binding information. The binding associates the resources defined by the deployment descriptor of the module to the actual (physical) resources bound into JNDI by the platform.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
XAEnabled Whether XA recovery processing is enabled.

    ['XAEnabled', 'false']
authDataAlias Alias used for database authentication at runtime.

    ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Specifies the authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

Do not put either of the values in quotes for the string format of the command. 

['authMechanismPreference', 
'BASIC_PASSWORD']
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
connectionPool JMS connection pooling properties for the parent JMS connection factory instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

['connectionPool',
[['agedTimeout','100'],['connectionTimeout','1000'],
['freePoolDistributionTableSize',10],['maxConnections','12'],
['minConnections','5'],['numberOfFreePoolPartitions','3'],
['numberOfSharedPoolPartitions','6'],
['numberOfUnsharedPoolPartitions','3'],['properties',
[['description','My description'],['name', 'myName'],
['required','false'],['type','String'],
['validationExpression',''],['value','myValue']]],
['purgePolicy','EntirePool'],['reapTime','10000'],
['struckThreshold','3'],['struckTime','10'],
['struckTimerTime','10'],['surgeCreationInterval','10'],
['surgeThreshold','10'],['testConnection','true'],
['testConnectionInterval','10'],['unusedTimeout','10000']]]
description Description of the resource adapter.

    ['description', 'My description']
diagnoseConnectionUsage Whether connection usage diagnosis is enabled.

    ['diagnoseConnectionUsage', 'false']
logMissingTransactionContext Whether missing transaction context logging is enabled.

    ['logMissingTransactionContext', 'true']
manageCachedHandles Whether this data source is used for container-managed persistence of enterprise beans. The default value is true.

    ['manageCachedHandles', 'true']
mapping Mapping of the configuration login to a specified authentication alias name.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["mapping",[["authDataAlias","authDataAliasValue"],
["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["preTestConfig",[["preTestConnection", "true"],
["retryInterval", "12343"],["retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["properties",[["description","My description"],
["name","myName"],["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]]
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] ]]]]
provider JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType JMS provider type used by this JMS provider.

    ['providerType', 'myJMSProviderType']
sessionPool JMS session pooling properties for the parent JMS connection instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["sessionPool\",
[["agedTimeout","100"],["connectionTimeout","1000"],
["freePoolDistributionTableSize",10],["maxConnections","12"],
["minConnections","5"],["numberOfFreePoolPartitions","3"],
["numberOfSharedPoolPartitions","6"],
["numberOfUnsharedPoolPartitions","3"],["properties",
[["description","My description"],["name", "myName"],
["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]],
["purgePolicy",'EntirePool'],["reapTime","10000"],
["struckThreshold","3"],["struckTime","10"],
["struckTimerTime","10"],["surgeCreationInterval","10"],
["surgeThreshold","10"],["testConnection","true"],
["testConnectionInterval","10"],["unusedTimeout","10000"]]]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

    ['xaRecoveryAuthAlias', 'myCellManager01/a1']

Optional attributes, continued. Additional attribute available for the script.

Attributes Description Example
type Specifies QUEUE for queues, TOPIC for topics, and UNIFIED for both queues and topics.

Do not put either of the values in quotes for the string format of the command.

    ['type', 'TOPIC']

Syntax 

AdminJMS.createGenericJMSConnectionFactory(nodeName, 
 serverName, jmsProvider, connFactoryName, jndiName, 
 extJndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createGenericJMSConnectionFactory("myNode", "myServer", 
 "JMSTest", "JMSCFTest", "jmsjndi", "extjmsjndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createGenericJMSConnectionFactory("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"My Generic JMSConnection Factory", "JNDIName", "extJNDIName", "XAEnabled=false, 
authDataAlias=myAuthDataAlias, authMechanismPreference=BASIC_PASSWORD, category=myCategory, 
description='my JMS Connection Factory',
diagnoseConnectionUsage=false, logMissingTransactionContext=true, manageCachedHandles=true, 
providerType=myJMSProviderType, type=TOPIC, xaRecoveryAuthAlias=myCellManager01/a1")

The following example script includes optional attributes in a list format: 

AdminJMS.createGenericJMSConnectionFactory("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"My Generic JMSConnection Factory", 
"JNDIName", "extJNDIName", [['XAEnabled', 'false'], ['authDataAlias', 'myAuthDataAlias'], 
['authMechanismPreference', 'BASIC_PASSWORD'], ['category', 'myCategory'], 
['connectionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], 
['numberOfUnsharedPoolPartitions', '3'], 
['properties', [[['description', 'My description'], ['name', 'myName'], 
['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], 
['purgePolicy', 'EntirePool'], ['reapTime', '10000'], ['surgeCreationInterval', '10'], 
['surgeThreshold', '10'], ['testConnection', 'true'], ['testConnectionInterval', '10'], 
['unusedTimeout', '10000']]], ['description', 'My description'], 
['diagnoseConnectionUsage', 'false'], ['logMissingTransactionContext', 'true'], 
['manageCachedHandles', 'true'], ['mapping', [['authDataAlias', 'authDataAliasValue'], 
['mappingConfigAlias', 'mappingConfigAliasValue']]], ['preTestConfig', 
[['preTestConnection', 'true'], ['retryInterval', '12343'], ['retryLimit', '4']]], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['propertySet', 
[['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], 
['value', 'myDbName']], [['name', 'driverType'], ['type', 'java.lang.Integer'], 
['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], 
['value', 50000]]]]]], ['providerType', 'myJMSProviderType'], ['sessionPool', 
[['agedTimeout', '100'], ['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], 
['maxConnections', '12'], ['minConnections', '5'], ['numberOfFreePoolPartitions', '3'], 
['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], ['properties', 
[[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], 
['purgePolicy', 'EntirePool'], ['reapTime', '10000'], 
['surgeCreationInterval', '10'], ['surgeThreshold', '10'], 
['testConnection', 'true'], ['testConnectionInterval', '10'], [
'unusedTimeout', '10000']]], ['type', 'TOPIC'], ['xaRecoveryAuthAlias', 'myCellManager01/a1']] )


createGenericJMSConnectionFactoryUsingTemplate

This script uses a template to create a generic JMS connection factory in your configuration. The script returns the configuration ID of the created JMS connection factory using a template in the respective cell.

To run the script, specify the node, server, JMS provider name, template ID, connection factory name, JNDI name, and external JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createGenericJMSConnectionFactoryUsingTemplate script. Run the script to create a generic JMS connection factory.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider.
templateID Configuration ID of the template to use.
connFactoryName Name to assign to the new connection factory
jndiName JNDI name the system uses to bind the connection factory into the name space.
extJndiName JNDI name used to bind the queue into the application server name space. As a convention, use the fully qualified JNDI name; for example, in the form jms/Name, where Name is the logical name of the resource. This name is used to link the platform binding information. The binding associates the resources defined by the deployment descriptor of the module to the actual (physical) resources bound into JNDI by the platform.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
XAEnabled Whether XA recovery processing is enabled.

    ['XAEnabled', 'false']
authDataAlias Alias used for database authentication at runtime.

    ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Specifies the authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

Do not put either of the values in quotes for the string format of the command. 

['authMechanismPreference', 
'BASIC_PASSWORD']
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
connectionPool Specifies the JMS connection pooling properties for the parent JMS connection factory instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

['connectionPool',
[['agedTimeout','100'],['connectionTimeout','1000'],
['freePoolDistributionTableSize',10],['maxConnections','12'],
['minConnections','5'],['numberOfFreePoolPartitions','3'],
['numberOfSharedPoolPartitions','6'],
['numberOfUnsharedPoolPartitions','3'],['properties',
[['description','My description'],['name', 'myName'],
['required','false'],['type','String'],
['validationExpression',''],['value','myValue']]],
['purgePolicy','EntirePool'],['reapTime','10000'],
['struckThreshold','3'],['struckTime','10'],
['struckTimerTime','10'],['surgeCreationInterval','10'],
['surgeThreshold','10'],['testConnection','true'],
['testConnectionInterval','10'],['unusedTimeout','10000']]]
description Description of the resource adapter.

    ['description', 'My description']
diagnoseConnectionUsage Whether connection usage diagnosis is enabled.

    ['diagnoseConnectionUsage', 'false']
logMissingTransactionContext Whether missing transaction context logging is enabled.

    ['logMissingTransactionContext', 'true']
manageCachedHandles Whether this data source is used for container-managed persistence of enterprise beans. The default value is true.

    ['manageCachedHandles', 'true']
mapping Mapping of the configuration login to a specified authentication alias name.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["mapping",[["authDataAlias","authDataAliasValue"],
["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["preTestConfig",[["preTestConnection", "true"],
["retryInterval", "12343"],["retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["properties",[["description","My description"],
["name","myName"],["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]]
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myJMSProviderType']
sessionPool Specifies the JMS session pooling properties for the parent JMS connection instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["sessionPool\",
[["agedTimeout","100"],["connectionTimeout","1000"],
["freePoolDistributionTableSize",10],["maxConnections","12"],
["minConnections","5"],["numberOfFreePoolPartitions","3"],
["numberOfSharedPoolPartitions","6"],
["numberOfUnsharedPoolPartitions","3"],["properties",
[["description","My description"],["name", "myName"],
["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]],
["purgePolicy",'EntirePool'],["reapTime","10000"],
["struckThreshold","3"],["struckTime","10"],
["struckTimerTime","10"],["surgeCreationInterval","10"],
["surgeThreshold","10"],["testConnection","true"],
["testConnectionInterval","10"],["unusedTimeout","10000"]]]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

    ['xaRecoveryAuthAlias', 'myCellManager01/a1']

Optional attributes, continued. Additional attribute available for the script.

Attributes Description Example
type Specifies QUEUE for queues, TOPIC for topics, and UNIFIED for both queues and topics.

Do not put either of the values in quotes for the string format of the command.

    ['type', 'TOPIC']

Syntax 

AdminJMS.createGenericJMSConnectionFactoryUsingTemplate(nodeName, 
 serverName, jmsProvider, templateID, 
 connFactoryName, jndiName, extJndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createGenericJMSConnectionFactoryUsingTemplate("myNode", "myServer", 
 "JMSTest", "Generic QueueConnectionFactory for 
 Windows(templates/system|JMS-resource-provider-templates.xml#GenericJMSConnectionFactory_1)", 
"JMSCFTest", "jmsjndi", "extjmsjndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createGenericJMSConnectionFactoryUsingTemplate("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"Generic QueueConnectionFactory for Windows (templates/system|JMS-resource-provider-templates.xml#GenericJMSConnectionFactory_1)", 
"My Generic JMSConnection Factory", "JNDIName", "extJNDIName",  "XAEnabled=false, 
authDataAlias=myAuthDataAlias, authMechanismPreference=BASIC_PASSWORD, category=myCategory, 
description='my JMS Connection Factory using template',
diagnoseConnectionUsage=false, logMissingTransactionContext=true, manageCachedHandles=true, 
providerType=myJMSProviderType, type=TOPIC, xaRecoveryAuthAlias=myCellManager01/a1")

The following example script includes optional attributes in a list format: 

AdminJMS.createGenericJMSConnectionFactoryUsingTemplate("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"Generic QueueConnectionFactory for Windows(templates/system|JMS-resource-provider-templates.xml#GenericJMSConnectionFactory_1)", 
"My Generic JMSConnection Factory", "JNDIName", "extJNDIName", [['XAEnabled', 'false'], 
['authDataAlias', 'myAuthDataAlias'], ['authMechanismPreference', 'BASIC_PASSWORD'], 
['category', 'myCategory'], ['connectionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], 
['numberOfUnsharedPoolPartitions', '3'], ['properties', [[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], 
['purgePolicy', 'EntirePool'], ['reapTime', '10000'], ['surgeCreationInterval', '10'], 
['surgeThreshold', '10'], ['testConnection', 'true'], ['testConnectionInterval', '10'], 
['unusedTimeout', '10000']]], ['description', 'My description'], ['diagnoseConnectionUsage', 'false'], 
['logMissingTransactionContext', 'true'], ['manageCachedHandles', 'true'], ['mapping', 
[['authDataAlias', 'authDataAliasValue'], ['mappingConfigAlias', 'mappingConfigAliasValue']]], 
['preTestConfig', [['preTestConnection', 'true'], ['retryInterval', '12343'], ['retryLimit', '4']]], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['propertySet', [['resourceProperties', 
[[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myJMSProviderType'], ['sessionPool', [['agedTimeout', '100'], 
['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], 
['reapTime', '10000'], ['surgeCreationInterval', '10'], ['surgeThreshold', '10'], 
['testConnection', 'true'], ['testConnectionInterval', '10'], ['unusedTimeout', '10000']]], 
['type', 'TOPIC'], ['xaRecoveryAuthAlias', 'myCellManager01/a1']] )


createGenericJMSConnectionFactoryAtScope

This script creates a new generic JMS connection factory in your configuration at the scope specified. The script returns the configuration ID of the created JMS connection factory in the respective cell.

To run the script, specify the scope, JMS provider name, name of the new connection factory, JNDI name, and external JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createGenericJMSConnectionFactoryAtScope script. Run the script to create a generic JMS connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
jmsProvider Name of the JMS provider.
connFactoryName Name to assign to the new connection factory
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
extJndiName Specifies the JNDI name used to bind the queue into the application server name space. As a convention, use the fully qualified JNDI name; for example, in the form jms/Name, where Name is the logical name of the resource. This name is used to link the platform binding information. The binding associates the resources defined by the deployment descriptor of the module to the actual (physical) resources bound into JNDI by the platform.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
XAEnabled Whether XA recovery processing is enabled.

    ['XAEnabled', 'false']
authDataAlias Alias used for database authentication at runtime.

    ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Specifies the authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

Do not put either of the values in quotes for the string format of the command. 

['authMechanismPreference', 
'BASIC_PASSWORD']
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
connectionPool Specifies the JMS connection pooling properties for the parent JMS connection factory instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

['connectionPool',
[['agedTimeout','100'],['connectionTimeout','1000'],
['freePoolDistributionTableSize',10],['maxConnections','12'],
['minConnections','5'],['numberOfFreePoolPartitions','3'],
['numberOfSharedPoolPartitions','6'],
['numberOfUnsharedPoolPartitions','3'],['properties',
[['description','My description'],['name', 'myName'],
['required','false'],['type','String'],
['validationExpression',''],['value','myValue']]],
['purgePolicy','EntirePool'],['reapTime','10000'],
['struckThreshold','3'],['struckTime','10'],
['struckTimerTime','10'],['surgeCreationInterval','10'],
['surgeThreshold','10'],['testConnection','true'],
['testConnectionInterval','10'],['unusedTimeout','10000']]]
description Description of the resource adapter.

    ['description', 'My description']
diagnoseConnectionUsage Whether connection usage diagnosis is enabled.

    ['diagnoseConnectionUsage', 'false']
logMissingTransactionContext Whether missing transaction context logging is enabled.

    ['logMissingTransactionContext', 'true']
manageCachedHandles Whether this data source is used for container-managed persistence of enterprise beans. The default value is true.

    ['manageCachedHandles', 'true']
mapping Mapping of the configuration login to a specified authentication alias name.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["mapping",[["authDataAlias","authDataAliasValue"],
["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["preTestConfig",[["preTestConnection", "true"],
["retryInterval", "12343"],["retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["properties",[["description","My description"],
["name","myName"],["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]]
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myJMSProviderType']
sessionPool Specifies the JMS session pooling properties for the parent JMS connection instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["sessionPool\",
[["agedTimeout","100"],["connectionTimeout","1000"],
["freePoolDistributionTableSize",10],["maxConnections","12"],
["minConnections","5"],["numberOfFreePoolPartitions","3"],
["numberOfSharedPoolPartitions","6"],
["numberOfUnsharedPoolPartitions","3"],["properties",
[["description","My description"],["name", "myName"],
["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]],
["purgePolicy",'EntirePool'],["reapTime","10000"],
["struckThreshold","3"],["struckTime","10"],
["struckTimerTime","10"],["surgeCreationInterval","10"],
["surgeThreshold","10"],["testConnection","true"],
["testConnectionInterval","10"],["unusedTimeout","10000"]]]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

    ['xaRecoveryAuthAlias', 'myCellManager01/a1']

Optional attributes, continued. Additional attribute available for the script.

Attributes Description Example
type Specifies QUEUE for queues, TOPIC for topics, and UNIFIED for both queues and topics.

Do not put either of the values in quotes for the string format of the command.

    ['type', 'TOPIC']

Syntax 

AdminJMS.createGenericJMSConnectionFactoryAtScope(scope, 
 jmsProvider, connFactoryName, jndiName, 
 extJndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createGenericJMSConnectionFactoryAtScope("myScope", "JMSTest", "JMSCFTest", "jmsjndi", 
"extjmsjndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createGenericJMSConnectionFactoryAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My Generic JMSConnection Factory", "JNDIName", "extJNDIName", 
"XAEnabled=false, authDataAlias=myAuthDataAlias, authMechanismPreference=BASIC_PASSWORD, 
category=myCategory, diagnoseConnectionUsage=false, logMissingTransactionContext=true, 
description='my JMS Connection Factory at scope',
manageCachedHandles=true, providerType=myJMSProviderType, type=TOPIC, 
xaRecoveryAuthAlias=myCellManager01/a1")

The following example script includes optional attributes in a list format: 

AdminJMS.createGenericJMSConnectionFactoryAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My Generic JMSConnection Factory", "JNDIName", "extJNDIName", [['XAEnabled', 'false'], 
['authDataAlias', 'myAuthDataAlias'], ['authMechanismPreference', 'BASIC_PASSWORD'], 
['category', 'myCategory'], ['connectionPool', [['agedTimeout', '100'], 
['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], ['maxConnections', '12'], 
['minConnections', '5'], ['numberOfFreePoolPartitions', '3'], 
['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], ['properties', 
[[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], 
['reapTime', '10000'], ['surgeCreationInterval', '10'], ['surgeThreshold', '10'], 
['testConnection', 'true'], ['testConnectionInterval', '10'], ['unusedTimeout', '10000']]], 
['description', 'My description'], ['diagnoseConnectionUsage', 'false'], 
['logMissingTransactionContext', 'true'], ['manageCachedHandles', 'true'], ['mapping', 
[['authDataAlias', 'authDataAliasValue'], ['mappingConfigAlias', 'mappingConfigAliasValue']]], 
['preTestConfig', [['preTestConnection', 'true'], ['retryInterval', '12343'], 
['retryLimit', '4']]], ['properties', [[['description', 'My description'], ['name', 'myName'], 
['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], ['propertySet', 
[['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], 
['value', 'myDbName']], [['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], 
[['name', 'serverName'], ['type', 'java.lang.String'], ['value', 'localhost']], 
[['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myJMSProviderType'], ['sessionPool', [['agedTimeout', '100'], 
['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], ['maxConnections', '12'], 
['minConnections', '5'], ['numberOfFreePoolPartitions', '3'], 
['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], 
['reapTime', '10000'], ['surgeCreationInterval', '10'], ['surgeThreshold', '10'], 
['testConnection', 'true'], ['testConnectionInterval', '10'], ['unusedTimeout', '10000']]], 
['type', 'TOPIC'], ['xaRecoveryAuthAlias', 'myCellManager01/a1']] )


createGenericJMSConnectionFactoryUsingTemplateAtScope

This script uses a template to create a generic JMS connection factory in your configuration at the scope specified. The script returns the configuration ID of the created JMS connection factory using a template in the respective cell.

To run the script, specify the scope, JMS provider name, template ID, connection factory name, JNDI name, and external JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createGenericJMSConnectionFactoryUsingTemplateAtScope script. Run the script to create a generic JMS connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
jmsProvider Name of the JMS provider.
templateID Configuration ID of the template to use.
connFactoryName Name to assign to the new connection factory
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
extJndiName Specifies the JNDI name used to bind the queue into the application server name space. As a convention, use the fully qualified JNDI name; for example, in the form jms/Name, where Name is the logical name of the resource. This name is used to link the platform binding information. The binding associates the resources defined by the deployment descriptor of the module to the actual (physical) resources bound into JNDI by the platform.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
XAEnabled Whether XA recovery processing is enabled.

    ['XAEnabled', 'false']
authDataAlias Alias used for database authentication at runtime.

    ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Specifies the authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

Do not put either of the values in quotes for the string format of the command. 

['authMechanismPreference', 
'BASIC_PASSWORD']
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
connectionPool Specifies the JMS connection pooling properties for the parent JMS connection factory instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

['connectionPool',
[['agedTimeout','100'],['connectionTimeout','1000'],
['freePoolDistributionTableSize',10],['maxConnections','12'],
['minConnections','5'],['numberOfFreePoolPartitions','3'],
['numberOfSharedPoolPartitions','6'],
['numberOfUnsharedPoolPartitions','3'],['properties',
[['description','My description'],['name', 'myName'],
['required','false'],['type','String'],
['validationExpression',''],['value','myValue']]],
['purgePolicy','EntirePool'],['reapTime','10000'],
['struckThreshold','3'],['struckTime','10'],
['struckTimerTime','10'],['surgeCreationInterval','10'],
['surgeThreshold','10'],['testConnection','true'],
['testConnectionInterval','10'],['unusedTimeout','10000']]]
description Description of the resource adapter.

    ['description', 'My description']
diagnoseConnectionUsage Whether connection usage diagnosis is enabled.

    ['diagnoseConnectionUsage', 'false']
logMissingTransactionContext Whether missing transaction context logging is enabled.

    ['logMissingTransactionContext', 'true']
manageCachedHandles Whether this data source is used for container-managed persistence of enterprise beans. The default value is true.

    ['manageCachedHandles', 'true']
mapping Mapping of the configuration login to a specified authentication alias name.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["mapping",[["authDataAlias","authDataAliasValue"],
["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["preTestConfig",[["preTestConnection", "true"],
["retryInterval", "12343"],["retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["properties",[["description","My description"],
["name","myName"],["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]]
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myJMSProviderType']
sessionPool Specifies the JMS session pooling properties for the parent JMS connection instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["sessionPool\",
[["agedTimeout","100"],["connectionTimeout","1000"],
["freePoolDistributionTableSize",10],["maxConnections","12"],
["minConnections","5"],["numberOfFreePoolPartitions","3"],
["numberOfSharedPoolPartitions","6"],
["numberOfUnsharedPoolPartitions","3"],["properties",
[["description","My description"],["name", "myName"],
["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]],
["purgePolicy",'EntirePool'],["reapTime","10000"],
["struckThreshold","3"],["struckTime","10"],
["struckTimerTime","10"],["surgeCreationInterval","10"],
["surgeThreshold","10"],["testConnection","true"],
["testConnectionInterval","10"],["unusedTimeout","10000"]]]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

    ['xaRecoveryAuthAlias', 'myCellManager01/a1']

Optional attributes, continued. Additional attribute available for the script.

Attributes Description Example
type Specifies QUEUE for queues, TOPIC for topics, and UNIFIED for both queues and topics.

Do not put either of the values in quotes for the string format of the command.

    ['type', 'TOPIC']

Syntax 

AdminJMS.createGenericJMSConnectionFactoryUsingTemplateAtScope(scope, 
  jmsProvider, templateID, 
 connFactoryName, jndiName, extJndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createGenericJMSConnectionFactoryUsingTemplateAtScope("myScope", 
 "JMSTest", "Generic QueueConnectionFactory for 
 Windows(templates/system|JMS-resource-provider-templates.xml#GenericJMSConnectionFactory_1)", 
"JMSCFTest", "jmsjndi", "extjmsjndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createGenericJMSConnectionFactoryUsingTemplateAtScope
("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", 
"Generic QueueConnectionFactory for Windows(templates/system|JMS-resource-provider-templates.xml#GenericJMSConnectionFactory_1)", 
"My Generic JMSConnection Factory", "JNDIName", "extJNDIName", "XAEnabled=false, 
authDataAlias=myAuthDataAlias, authMechanismPreference=BASIC_PASSWORD, category=myCategory, 
diagnoseConnectionUsage=false, logMissingTransactionContext=true, manageCachedHandles=true, 
description='my JMS Connection Factory using a template and scope',
providerType=myJMSProviderType, type=TOPIC, xaRecoveryAuthAlias=myCellManager01/a1")

The following example script includes optional attributes in a list format: 

AdminJMS.createGenericJMSConnectionFactoryUsingTemplateAtScope
("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", 
"Generic QueueConnectionFactory for Windows(templates/system|JMS-resource-provider-templates.xml#GenericJMSConnectionFactory_1)", 
"My Generic JMSConnection Factory", "JNDIName", "extJNDIName", 
[['XAEnabled', 'false'], ['authDataAlias', 'myAuthDataAlias'], ['authMechanismPreference', 'BASIC_PASSWORD'], 
['category', 'myCategory'], ['connectionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], ['reapTime', '10000'], 
['surgeCreationInterval', '10'], ['surgeThreshold', '10'], ['testConnection', 'true'], 
['testConnectionInterval', '10'], ['unusedTimeout', '10000']]], ['description', 'My description'], 
['diagnoseConnectionUsage', 'false'], ['logMissingTransactionContext', 'true'], 
['manageCachedHandles', 'true'], ['mapping', [['authDataAlias', 'authDataAliasValue'], 
['mappingConfigAlias', 'mappingConfigAliasValue']]], ['preTestConfig', [['preTestConnection', 'true'], 
['retryInterval', '12343'], ['retryLimit', '4']]], ['properties', [[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], 
['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], 
['value', 'myDbName']], [['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], 
[['name', 'serverName'], ['type', 'java.lang.String'], ['value', 'localhost']], [['name', 'portNumber'], 
['type', 'java.lang.Integer'], ['value', 50000]]]]]], ['providerType', 'myJMSProviderType'], 
['sessionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], 
['maxConnections', '12'], ['minConnections', '5'], ['numberOfFreePoolPartitions', '3'], 
['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], ['properties', 
[[['description', 'My description'], ['name', 'myName'], ['required', 'false'], ['validationExpression', ''], 
['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], ['reapTime', '10000'], 
['surgeCreationInterval', '10'], ['surgeThreshold', '10'], ['testConnection', 'true'], 
['testConnectionInterval', '10'], ['unusedTimeout', '10000']]], ['type', 'TOPIC'], 
['xaRecoveryAuthAlias', 'myCellManager01/a1']] )


createGenericJMSDestination

This script creates a generic JMS destination in your configuration. The script returns the configuration ID of the created JMS destination in the respective cell.

To run the script, specify the node, server, JMS provider name, JMS destination name, JNDI name, and external JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createGenericJMSDestination script. Run the script to create a generic JMS destination.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider.
genericJMSDestination Name to assign to the new generic JMS destination.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
extJndiName Specifies the JNDI name used to bind the queue into the application server name space. As a convention, use the fully qualified JNDI name; for example, in the form jms/Name, where Name is the logical name of the resource. This name is used to link the platform binding information. The binding associates the resources defined by the deployment descriptor of the module to the actual (physical) resources bound into JNDI by the platform.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] [[name driverType]
[type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
type Specifies QUEUE for queues, TOPIC for topics, and UNIFIED for both queues and topics.

Do not put either of the values in quotes for the string format of the command.

    ['type', 'QUEUE']

Syntax 

AdminJMS.createGenericJMSDestination(nodeName, 
 serverName, jmsProvider, genericJMSDestination, 
 jndiName, extJndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createGenericJMSDestination("myNode", "myServer", "JMSTest", 
 "JMSDest", "destjndi", "extDestJndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createGenericJMSDestination("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"My JMSDestination", "JNDIName", "extJNDIName", "category=myCategory, description='My description', 
providerType=myProviderType, type=QUEUE")

The following example script includes optional attributes in a list format: 

AdminJMS.createGenericJMSDestination("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"My JMSDestination", "JNDIName", "extJNDIName", [['category', 'myCategory'], ['description', 
'My description'], ['propertySet', [['resourceProperties', [[['name', 'databaseName'], 
['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['type', 'QUEUE']] )


createGenericJMSDestinationUsingTemplate

This script uses a template to create a generic JMS destination in your configuration. The script returns the configuration ID of the created JMS destination in the respective cell.

To run the script, specify the node, server, JMS provider name, template ID, generic JMS destination name, JNDI name, and external JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createGenericJMSDestinationUsingTemplate script. Run the script to create a generic JMS destination.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider.
templateID Configuration ID of the template to use.
genericJMSDestination Name to assign to the new generic JMS destination.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
extJndiName Specifies the JNDI name used to bind the queue into the application server name space. As a convention, use the fully qualified JNDI name; for example, in the form jms/Name, where Name is the logical name of the resource. This name is used to link the platform binding information. The binding associates the resources defined by the deployment descriptor of the module to the actual (physical) resources bound into JNDI by the platform.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] [[name driverType]
[type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
type Specifies QUEUE for queues, TOPIC for topics, and UNIFIED for both queues and topics.

Do not put either of the values in quotes for the string format of the command.

    ['type', 'QUEUE']

Syntax 

AdminJMS.createGenericJMSDestinationUsingTemplate(nodeName, 
 serverName, jmsProvider, templateID, 
 genericJMSDestination, jndiName, extJndiName, 
 attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createGenericJMSDestinationUsingTemplate("myNode", "myServer", 
 "JMSTest", 
 "Example.JMS.Generic.Win.Topic(templates/system|JMS-resource-provider-templates.xml#GenericJMSDestination_2)", 
 "JMSDest", "destjndi", "extDestJndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createGenericJMSDestinationUsingTemplate("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"Example.JMS.Generic.Win.Queue(templates/system|JMS-resource-provider-templates.xml#GenericJMSDestination_1)", 
"My JMSDestination", "JNDIName", "extJNDIName","category=myCategory, description='My description', 
providerType=myProviderType, type=QUEUE ")

The following example script includes optional attributes in a list format: 

AdminJMS.createGenericJMSDestinationUsingTemplate("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"Example.JMS.Generic.Win.Queue(templates/system|JMS-resource-provider-templates.xml#GenericJMSDestination_1)", 
"My JMSDestination", "JNDIName", "extJNDIName", [['category', 'myCategory'], 
['description', 'My description'], ['propertySet', [['resourceProperties', [[['name', 'databaseName'], 
['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value','localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['type', 'QUEUE']] )


createGenericJMSDestinationAtScope

This script creates a generic JMS destination in your configuration at the scope specified. The script returns the configuration ID of the created JMS destination in the respective cell.

To run the script, specify the scope, JMS provider name, JMS destination name, JNDI name, and external JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createGenericJMSDestinationAtScope script. Run the script to create a generic JMS destination.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider.
genericJMSDestination Name to assign to the new generic JMS destination.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
extJndiName Specifies the JNDI name used to bind the queue into the application server name space. As a convention, use the fully qualified JNDI name; for example, in the form jms/Name, where Name is the logical name of the resource. This name is used to link the platform binding information. The binding associates the resources defined by the deployment descriptor of the module to the actual (physical) resources bound into JNDI by the platform.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] [[name driverType]
[type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
type Specifies QUEUE for queues, TOPIC for topics, and UNIFIED for both queues and topics.

Do not put either of the values in quotes for the string format of the command.

    ['type', 'QUEUE']

Syntax 

AdminJMS.createGenericJMSDestinationAtScope(scope, 
 jmsProvider, genericJMSDestination, 
 jndiName, extJndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createGenericJMSDestinationAtScope("myScope", "JMSTest", 
 "JMSDest", "destjndi", "extDestJndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createGenericJMSDestinationAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My JMSDestination", "JNDIName", "extJNDIName", "category=myCategory, 
description='My description', providerType=myProviderType, type=QUEUE")

The following example script includes optional attributes in a list format: 

AdminJMS.createGenericJMSDestinationAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My JMSDestination", "JNDIName", "extJNDIName", [['category', 'myCategory'], 
['description', 'My description'], ['propertySet', [['resourceProperties', [[['name', 'databaseName'], 
['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], ['type', 'java.lang.Integer'], 
['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], ['value', 'localhost']], [['name', 'portNumber'], 
['type', 'java.lang.Integer'], ['value',50000]]]]]], ['providerType', 'myProviderType'], ['type', 'QUEUE']] )


createGenericJMSDestinationUsingTemplateAtScope

This script uses a template to create a generic JMS destination in your configuration at the scope we specify. The script returns the configuration ID of the created JMS destination in the respective cell.

To run the script, specify the scope, JMS provider name, template ID, generic JMS destination name, JNDI name, and external JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createGenericJMSDestinationUsingTemplateAtScope script. Run the script to create a generic JMS destination.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider.
templateID Configuration ID of the template to use.
genericJMSDestination Name to assign to the new generic JMS destination.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
extJndiName Specifies the JNDI name used to bind the queue into the application server name space. As a convention, use the fully qualified JNDI name; for example, in the form jms/Name, where Name is the logical name of the resource. This name is used to link the platform binding information. The binding associates the resources defined by the deployment descriptor of the module to the actual (physical) resources bound into JNDI by the platform.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] [[name driverType]
[type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
type Specifies QUEUE for queues, TOPIC for topics, and UNIFIED for both queues and topics.

Do not put either of the values in quotes for the string format of the command.

    ['type', 'QUEUE']

Syntax 

AdminJMS.createGenericJMSDestinationUsingTemplateAtScope(scope, 
 jmsProvider, templateID, 
 genericJMSDestination, jndiName, extJndiName, 
 attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createGenericJMSDestinationUsingTemplateAtScope("myScope", 
 "JMSTest", 
 "Example.JMS.Generic.Win.Topic(templates/system|JMS-resource-provider-templates.xml#GenericJMSDestination_2)", 
 "JMSDest", "destjndi", "extDestJndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createGenericJMSDestinationUsingTemplateAtScope
("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "Example.JMS.Generic.Win.Queue
(templates/system|JMS-resource-provider-templates.xml#GenericJMSDestination_1)", 
"My JMSDestination", "JNDIName", "extJNDIName", "category=myCategory, 
description='My description', providerType=myProviderType, type=QUEUE")

The following example script includes optional attributes in a list format: 

AdminJMS.createGenericJMSDestinationUsingTemplateAtScope
("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "Example.JMS.Generic.Win.Queue
(templates/system|JMS-resource-provider-templates.xml#GenericJMSDestination_1)", 
"My JMSDestination", "JNDIName", "extJNDIName", [['category', 'myCategory'], ['description', 'My description'], 
['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], 
[['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['type', 'QUEUE']] )


createJMSProvider

This script creates a JMS provider in your configuration. The script returns the configuration ID of the created JMS provider in the respective cell.

To run the script, specify the node, server, JMS provider name, external initial contextual factory name, and external provider URL arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createJMSProvider script. Run the script to create a JMS provider.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProvider Name to assign to the new JMS provider.
extContextFactory Specifies the Java class name of the initial context factory for the JMS provider.
extProviderURL Specifies the JMS provider URL for external JNDI lookups.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
classpath List of paths or JAR file names which together form the location for the resource provider classes. Use a semicolon (;) to separate class paths. 
'-classpath', 
'${EXTERNAL_JMSPROVIDER_CLASSPATH}/extJms.jar'
description Description of the JMS Provider.

    ['description', 'My description']
isolatedClassLoader If set to true, specifies the resource provider is loaded in its own class loader.

A provider cannot be isolated when a native library path is specified.

    ['isolatedClassLoader', 'true']
nativepath Specifies an optional path to any native libraries, such as *.dll and *.so. Native path entries are separated by a semicolon (;). 
'-nativePath', 
'${EXTERNAL_JMSPROVIDER_NATIVEPATH}'
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] 
]]]]
providerType Specifies the JMS provider type that this JMS provider uses.

    ['providerType', 'myJMSProviderType']
supportsASF If set to true, specifies the JMS provider supports Application Server Facilities (ASF), which provides concurrency and transactional support for applications.

    ['supportsASF', 'true']

Syntax 

AdminJMS.createJMSProvider(nodeName, serverName, 
 jmsProvider, extContextFactory, extProviderURL, 
 attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createJMSProvider("myNode", "myServer", "JMSTest1", 
 "extInitCF", "extPURL")

The following example script includes optional attributes in a string format: 

AdminJMS.createJMSProvider("IBM-F4A849C57A0Node01", "server1", "MyJMSProvider", "extInitCF", "extPURL", 
"classpath='${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; 
${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar', 
description='My JMSProvider description',isolatedClassLoader=true, 
nativepath=${DB2UNIVERSAL_JDBC_DRIVER_NATIVEPATH}, providerType=myJMSProviderType, supportsASF=true")

The following example script includes optional attributes in a list format: 

AdminJMS.createJMSProvider("IBM-F4A849C57A0Node01", "server1", "MyJMSProvider", "extInitCF", "extPURL", 
[['classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; 
${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar'], ['description', 'My JMSProvider description'], 
['isolatedClassLoader', 'true'], ['nativepath', '${DB2UNIVERSAL_JDBC_DRIVER_NATIVEPATH}'], 
['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], 
['value', 'myDbName']], [['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], 
[['name', 'serverName'], ['type', 'java.lang.String'], ['value', 'localhost']], [['name', 'portNumber'], 
['type', 'java.lang.Integer'], ['value', 50000]]]]]], ['providerType', 'myJMSProviderType'], 
['supportsASF', 'true']] )


createJMSProviderUsingTemplate

This script uses a template to create a JMS provider in your configuration. The script returns the configuration ID of the created JMS provider using a template in the respective cell.

To run the script, specify the node, server, configuration ID of the JMS provider template, name to assign to the new JMS provider, external initial context factory, and external provider URL arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createJMSProviderUsingTemplate script. Run the script to create a JMS provider.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
templateID Configuration ID of the JMS provider template to use.
jmsProvider Name to assign to the new JMS provider.
extContextFactory Specifies the Java class name of the initial context factory for the JMS provider.
extProviderURL Specifies the JMS provider URL for external JNDI lookups.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
classpath List of paths or JAR file names which together form the location for the resource provider classes. Use a semicolon (;) to separate class paths. 
'-classpath', 
'${EXTERNAL_JMSPROVIDER_CLASSPATH}/extJms.jar'
description Description of the JMS Provider.

    ['description', 'My description']
isolatedClassLoader If set to true, specifies the resource provider is loaded in its own class loader.

A provider cannot be isolated when a native library path is specified.

    ['isolatedClassLoader', 'true']
nativepath Specifies an optional path to any native libraries, such as *.dll and *.so. Native path entries are separated by a semicolon (;). 
'-nativePath', 
'${EXTERNAL_JMSPROVIDER_NATIVEPATH}'
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] 
]]]]
providerType Specifies the JMS provider type that this JMS provider uses.

    ['providerType', 'myJMSProviderType']
supportsASF If set to true, specifies the JMS provider supports Application Server Facilities (ASF), which provides concurrency and transactional support for applications.

    ['supportsASF', 'true']

Syntax 

AdminJMS.createJMSProviderUsingTemplate(nodeName, 
 serverName, templateID, jmsProvider, 
 extContextFactory, extProviderURL, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createJMSProviderUsingTemplate("myNode", "myServer", "WebSphere JMS 
 Provider(templates/servertypes/APPLICATION_SERVER/servers/DeveloperServer|resources.xml#builtin_jmsprovider)", 
 "JMSTest", "extInitCF", "extPURL")

The following example script includes optional attributes in a string format: 

AdminJMS.createJMSProviderUsingTemplate("IBM-F4A849C57A0Node01", "server1", 
"WebSphere JMSProvider(templates/servertypes/APPLICATION_SERVER/servers/default|resources.xml#builtin_jmsprovider)", 
"MyJMSProvider", "extInitCF", "extPURL", 
"classpath='${DB2_JCC_DRIVER_PATH}/db2jcc4.jar;${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; 
${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar', description='My JMSProvider description', 
isolatedClassLoader=true, nativepath=${DB2UNIVERSAL_JDBC_DRIVER_NATIVEPATH}, 
providerType=myJMSProviderType,supportsASF=true")

The following example script includes optional attributes in a list format: 

AdminJMS.createJMSProviderUsingTemplate("IBM-F4A849C57A0Node01", "server1", 
"WebSphere JMSProvider(templates/servertypes/APPLICATION_SERVER/servers/default|resources.xml#builtin_jmsprovider)", 
"MyJMSProvider", "extInitCF", "extPURL", 
[['classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar;${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; 
${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar'], 
['description', 'My JMSProvider description'], ['isolatedClassLoader', 'true'], 
['nativepath', '${DB2UNIVERSAL_JDBC_DRIVER_NATIVEPATH}'], 
['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], 
['value', 'myDbName']], [['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], 
[['name', 'serverName'], ['type', 'java.lang.String'], ['value', 'localhost']], 
[['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myJMSProviderType'], ['supportsASF', 'true']])


createJMSProviderAtScope

This script creates a JMS provider in your configuration at the scope specified. The script returns the configuration ID of the created JMS provider in the respective cell.

To run the script, specify the scope, JMS provider name, external initial contextual factory name, and external provider URL arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createJMSProviderAtScope script. Run the script to create a JMS provider.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
jmsProvider Name to assign to the new JMS provider.
extContextFactory Specifies the Java class name of the initial context factory for the JMS provider.
extProviderURL Specifies the JMS provider URL for external JNDI lookups.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
classpath List of paths or JAR file names which together form the location for the resource provider classes. Use a semicolon (;) to separate class paths. 
'-classpath', 
'${EXTERNAL_JMSPROVIDER_CLASSPATH}/extJms.jar'
description Description of the JMS Provider.

    ['description', 'My description']
isolatedClassLoader If set to true, specifies the resource provider is loaded in its own class loader.

A provider cannot be isolated when a native library path is specified.

    ['isolatedClassLoader', 'true']
nativepath Specifies an optional path to any native libraries, such as *.dll and *.so. Native path entries are separated by a semicolon (;). 
'-nativePath', 
'${EXTERNAL_JMSPROVIDER_NATIVEPATH}'
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] 
]]]]
providerType Specifies the JMS provider type that this JMS provider uses.

    ['providerType', 'myJMSProviderType']
supportsASF If set to true, specifies the JMS provider supports Application Server Facilities (ASF), which provides concurrency and transactional support for applications.

    ['supportsASF', 'true']

Syntax 

AdminJMS.createJMSProviderAtScope(scope, 
 jmsProvider, extContextFactory, extProviderURL, 
 attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createJMSProvider("myScope", "JMSTest1", 
 "extInitCF", "extPURL")

The following example script includes optional attributes in a string format: 

AdminJMS. createJMSProviderAtScope ("Cell= IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"MyJMSProvider", "extInitCF", "extPURL", 
"classpath='${DB2_JCC_DRIVER_PATH}/db2jcc4.jar;${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; 
${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar', description='My JMSProvider description', 
isolatedClassLoader=true, nativepath=${DB2UNIVERSAL_JDBC_DRIVER_NATIVEPATH}, 
providerType=myJMSProviderType,supportsASF=true")

The following example script includes optional attributes in a list format: 

AdminJMS.createJMSProviderAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"MyJMSProvider", "extInitCF", "extPURL", [['classpath', 
'${DB2_JCC_DRIVER_PATH}/db2jcc4.jar;${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar;
${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar'], ['description', 'My JMSProvider description'], 
['isolatedClassLoader', 'true'], ['nativepath', '${DB2UNIVERSAL_JDBC_DRIVER_NATIVEPATH}'], 
['propertySet', [['resourceProperties', [[['name', 'databaseName'], 
['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], 
['type', 'java.lang.String'], ['value', 'localhost']], [['name', 'portNumber'], 
['type', 'java.lang.Integer'], ['value', 50000]]]]]], ['providerType', 'myJMSProviderType'], 
['supportsASF', 'true']] )


createJMSProviderUsingTemplateAtScope

This script uses a template to create a JMS provider at the scope specified. The script returns the configuration ID of the created JMS provider using a template in the respective cell.

To run the script, specify the scope, configuration ID of the JMS provider template, name to assign to the new JMS provider, external initial context factory, and external provider URL arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createJMSProviderUsingTemplateAtScope script. Run the script to create a JMS provider.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
templateID Configuration ID of the JMS provider template to use.
jmsProvider Name to assign to the new JMS provider.
extContextFactory Specifies the Java class name of the initial context factory for the JMS provider.
extProviderURL Specifies the JMS provider URL for external JNDI lookups.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
classpath List of paths or JAR file names which together form the location for the resource provider classes. Use a semicolon (;) to separate class paths. 
'-classpath', 
'${EXTERNAL_JMSPROVIDER_CLASSPATH}/extJms.jar'
description Description of the JMS Provider.

    ['description', 'My description']
isolatedClassLoader If set to true, specifies the resource provider is loaded in its own class loader.

A provider cannot be isolated when a native library path is specified.

    ['isolatedClassLoader', 'true']
nativepath Specifies an optional path to any native libraries, such as *.dll and *.so. Native path entries are separated by a semicolon (;). 
'-nativePath', 
'${EXTERNAL_JMSPROVIDER_NATIVEPATH}'
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] 
]]]]
providerType Specifies the JMS provider type that this JMS provider uses.

    ['providerType', 'myJMSProviderType']
supportsASF If set to true, specifies the JMS provider supports Application Server Facilities (ASF), which provides concurrency and transactional support for applications.

    ['supportsASF', 'true']

Syntax 

AdminJMS.createJMSProviderUsingTemplateAtScope(scope, 
 templateID, jmsProvider, 
 extContextFactory, extProviderURL, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createJMSProviderUsingTemplateAtScope("myScope", "WebSphere JMS 
 Provider(templates/servertypes/APPLICATION_SERVER/servers/DeveloperServer|resources.xml#builtin_jmsprovider)", 
 "JMSTest", "extInitCF", "extPURL")

The following example script includes optional attributes in a string format: 

AdminJMS. createJMSProviderUsingTemplateAtScope 
("Cell= IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"WebSphere JMSProvider(templates/servertypes/APPLICATION_SERVER/servers/default|resources.xml#builtin_jmsprovider)", 
"MyJMSProvider", "extInitCF", "extPURL", 
"classpath='${DB2_JCC_DRIVER_PATH}/db2jcc4.jar;${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; 
${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar', description='My JMSProvider description', 
isolatedClassLoader=true, nativepath=${DB2UNIVERSAL_JDBC_DRIVER_NATIVEPATH}, 
providerType=myJMSProviderType,supportsASF=true")
The following example script includes optional attributes in a list format: 
AdminJMS.createJMSProviderUsingTemplateAtScope("Cell=IBM-F4A849C57A0Cell01, Node=IBM-F4A849C57A0Node01", 
"WebSphere JMS Provider(templates/servertypes/APPLICATION_SERVER/servers/default|resources.xml#builtin_jmsprovider)", 
"MyJMSProvider", "extInitCF", "extPURL", 
[['classpath', '${DB2_JCC_DRIVER_PATH}/db2jcc4.jar; ${UNIVERSAL_JDBC_DRIVER}/db2jcc_license_cu.jar; 
${DB2_JCC_DRIVER_PATH}/db2jcc_license_cisuz.jar'], ['description', 'My JMSProvider description'], 
['isolatedClassLoader', 'true'], ['nativepath', '${DB2UNIVERSAL_JDBC_DRIVER_NATIVEPATH}'], 
['propertySet', [['resourceProperties', [[['name', 'databaseName'], 
['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], 
['type', 'java.lang.String'], ['value', 'localhost']], [['name', 'portNumber'], 
['type', 'java.lang.Integer'], ['value',50000]]]]]], ['providerType', 'myJMSProviderType'], 
['supportsASF', 'true']] )


createWASQueue

This script creates a WebSphere Application server queue in your configuration. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS queue in the respective cell.

To run the script, specify the node, server, JMS provider name, name to assign to the queue, and JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASQueue script. Run the script to create a queue.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider of interest.
queueName Name to assign to the new queue.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
expiry Length of time after which messages sent to this destination expire and are dealt with according to their disposition options. Valid values are APPLICATION_DEFINE, SPECIFIED, and UNLIMITED.

Do not put either of the values in quotes for the string format of the command.

    ['expiry', 'SPECIFIED']
persistence Level of persistence. Valid values are APPLICATION_DEFINED, NONPERSISTENT, and PERSISTENT.

    ['persistence', 'NONPERSISTENT']
priority Level of priority. Valid values are APPLICATION_DEFINED and SPECIFIED.

    ['priority', 'SPECIFIED']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a specific vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
specifiedExpiry Time in milliseconds after which messages on this queue are discarded.

    ['specifiedExpiry', '1000']
specifiedPriority Priority from 0 to 9 of the WASQueue WebSphere queue.

    ['specifiedPriority', '0']

Syntax 

AdminJMS.createWASQueue(nodeName, serverName, 
 jmsProvider, queueName, jndiName, 
 attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASQueue("myNode", "myServer", "JMSTest", 
 "WASQueueTest", "queuejndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASQueue("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"Example.JMS.WAS.Q1(templates/system|JMS-resource-provider-templates.xml#WASQueue_1)", 
"My WASQueue Name", "JNDIName", "category =myCategory, description='My description', 
expiry=SPECIFIED, persistence=NONPERSISTENT, priority=SPECIFIED, specifiedExpiry=1000, 
specifiedPriority=0")

The following example script includes optional attributes in a list format: 

AdminJMS.createWASQueue("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", "My WASQueue Name", 
"JNDIName", [['category ', 'myCategory'], ['description', 'My description'], ['expiry', 'SPECIFIED'], 
['persistence', 'NONPERSISTENT'], ['priority', 'SPECIFIED'], ['propertySet', [['resourceProperties', 
[[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['specifiedExpiry', '1000'], ['specifiedPriority', '0']] )


createWASQueueUsingTemplate

This script uses a template to create a WAS queue in your configuration. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS queue using a template in the respective cell.

To run the script, specify the node, server, JMS provider name, configuration ID of the template, name to assign to the queue, and JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASQueueUsingTemplate script. Run the script to create a queue.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider of interest.
templateID Configuration ID of the WAS queue template to use.
queueName Name to assign to the new queue.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
expiry Length of time after which messages sent to this destination expire and are dealt with according to their disposition options. Valid values are APPLICATION_DEFINE, SPECIFIED, and UNLIMITED.

Do not put either of the values in quotes for the string format of the command.

    ['expiry', 'SPECIFIED']
persistence Level of persistence. Valid values are APPLICATION_DEFINED, NONPERSISTENT, and PERSISTENT.

    ['persistence', 'NONPERSISTENT']
priority Level of priority. Valid values are APPLICATION_DEFINED and SPECIFIED.

    ['priority', 'SPECIFIED']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a specific vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
specifiedExpiry Time in milliseconds after which messages on this queue are discarded.

    ['specifiedExpiry', '1000']
specifiedPriority Priority from 0 to 9 of the WASQueue WebSphere queue.

    ['specifiedPriority', '0']

Syntax 

AdminJMS.createWASQueueUsingTemplate(nodeName, 
 serverName, jmsProvider, templateID, queueName, 
 jndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASQueueUsingTemplate("myNode", "myServer", "JMSTest", 
 "WASQueueTest", "queuejndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASQueueUsingTemplate("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"Example.JMS.WAS.Q1(templates/system|JMS-resource-provider-templates.xml#WASQueue_1)", "My WASQueue Name", 
"JNDIName", “category =myCategory, description='My description', expiry=SPECIFIED, 
providerType=myProviderType, specifiedExpiry=1000, specifiedPriority=0”)

The following example script includes optional attributes in a list format: 

Usage: AdminJMS.createWASQueueUsingTemplate("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"Example.JMS.WAS.Q1(templates/system|JMS-resource-provider-templates.xml#WASQueue_1)", "My WASQueue Name", 
"JNDIName", [['category ', 'myCategory'], ['description', 'My description'], ['expiry', 'SPECIFIED'], 
['persistence', 'NONPERSISTENT'], ['priority', 'SPECIFIED'], ['propertySet', [['resourceProperties', 
[[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['specifiedExpiry', '1000'], ['specifiedPriority', '0']] )


createWASQueueAtScope

This script creates a WAS queue in your configuration at the scope specified. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS queue in the respective cell.

To run the script, specify the scope, JMS provider name, name to assign to the queue, and JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASQueueAtScope script. Run the script to create a queue.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
jmsProvider Name of the JMS provider of interest.
queueName Name to assign to the new queue.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
expiry Length of time after which messages sent to this destination expire and are dealt with according to their disposition options. Valid values are APPLICATION_DEFINE, SPECIFIED, and UNLIMITED.

Do not put either of the values in quotes for the string format of the command.

    ['expiry', 'SPECIFIED']
persistence Level of persistence. Valid values are APPLICATION_DEFINED, NONPERSISTENT, and PERSISTENT.

    ['persistence', 'NONPERSISTENT']
priority Level of priority. Valid values are APPLICATION_DEFINED and SPECIFIED.

    ['priority', 'SPECIFIED']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a specific vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
specifiedExpiry Time in milliseconds after which messages on this queue are discarded.

    ['specifiedExpiry', '1000']
specifiedPriority Priority from 0 to 9 of the WASQueue WebSphere queue.

    ['specifiedPriority', '0']

Syntax 

AdminJMS.createWASQueueAtScope(scope, 
 jmsProvider, queueName, jndiName, 
 attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASQueueAtScope("scope", "JMSTest", 
 "WASQueueTest", "queuejndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASQueueAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My WASQueue Name", "JNDIName", “category =myCategory, description='My description', 
expiry=SPECIFIED, providerType=myProviderType, specifiedExpiry=1000, specifiedPriority=0”)

The following example script includes optional attributes in a list format: 

AdminJMS.createWASQueueAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My WASQueue Name", "JNDIName", [['category ', 'myCategory'], ['description', 'My description'], 
['expiry', 'SPECIFIED'], ['persistence', 'NONPERSISTENT'], ['priority', 'SPECIFIED'], ['propertySet', 
[['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], 
[['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], [
'providerType', 'myProviderType'], ['specifiedExpiry', '1000'], ['specifiedPriority', '0']] )


createWASQueueUsingTemplateAtScope

This script uses a template to create a WAS queue in your configuration at the scope specified. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS queue using a template in the respective cell.

To run the script, specify the scope, JMS provider name, configuration ID of the template, name to assign to the queue, and JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASQueueUsingTemplateAtScope script. Run the script to create a queue.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
jmsProvider Name of the JMS provider of interest.
templateID Configuration ID of the WAS queue template to use.
queueName Name to assign to the new queue.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
expiry Length of time after which messages sent to this destination expire and are dealt with according to their disposition options. Valid values are APPLICATION_DEFINE, SPECIFIED, and UNLIMITED.

Do not put either of the values in quotes for the string format of the command.

    ['expiry', 'SPECIFIED']
persistence Level of persistence. Valid values are APPLICATION_DEFINED, NONPERSISTENT, and PERSISTENT.

    ['persistence', 'NONPERSISTENT']
priority Level of priority. Valid values are APPLICATION_DEFINED and SPECIFIED.

    ['priority', 'SPECIFIED']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a specific vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
specifiedExpiry Time in milliseconds after which messages on this queue are discarded.

    ['specifiedExpiry', '1000']
specifiedPriority Priority from 0 to 9 of the WASQueue WebSphere queue.

    ['specifiedPriority', '0']

Syntax 

AdminJMS.createWASQueueUsingTemplateAtScope(scope, 
 jmsProvider, templateID, queueName, 
 jndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASQueueUsingTemplateAtScope("myScope", "JMSTest", 
 "WASQueueTest", "queuejndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASQueueUsingTemplateAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "Example.JMS.WAS.Q1(templates/system|JMS-resource-provider-templates.xml#WASQueue_1)", 
"My WASQueue Name", "JNDIName", "category =myCategory, description='My description', expiry=SPECIFIED, 
providerType=myProviderType, specifiedExpiry=1000, specifiedPriority=0")

The following example script includes optional attributes in a list format: 

AdminJMS.createWASQueueUsingTemplateAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "Example.JMS.WAS.Q1(templates/system|JMS-resource-provider-templates.xml#WASQueue_1)", 
"My WASQueue Name", "JNDIName", [['category ', 'myCategory'], ['description', 'My description'], ['expiry', 'SPECIFIED'], 
['persistence', 'NONPERSISTENT'], ['priority', 'SPECIFIED'], ['propertySet', [['resourceProperties', 
[[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['specifiedExpiry', '1000'], ['specifiedPriority', '0']] )


createSIBJMSQueue

This script creates a JMS queue in your configuration at the scope specified. The script returns the configuration ID of the created SIB JMS queue.

To run the script, specify the scope, JMS queue name, name to assign to the queue, and JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createSIBJMSQueue script. Run the script to create a JMS queue.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
name Name of the JMS queue of interest.
queueName Name of the service integration bus destination to which the JMS queue maps.
jndiName Specifies the JNDI name the system to bind the queue into the application server namespace.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes for the script.

Attributes Description
description Description of the SIB JMS queue.
DeliveryMode Delivery mode for messages. Valid values are Application, NonPersistent, and Persistent.
timeToLive Time in milliseconds before a message expires.
priority Priority for messages. Valid values are integers from 0 to 9, inclusive.
readAhead Specifies the read-ahead value. Valid values are Default, AlwaysOn, and AlwaysOff.
busName Name of the bus on which the queue resides.
ScopeToLocalQP Whether the SIB queue destination is scoped to a local queue point when addressed using this JMS queue.
ProducerBind How JMS producers bind to queue points of the clustered queue. A value of TRUE indicates that a queue point is chosen when the session is opened and never changes. A value of FALSE indicates that a queue point is chosen every time a message is sent.
ProducerPreferLocal Whether queue points local to the producer are used.
GatherMessages Whether JMS consumers and browsers are given messages from any queue points, rather than from the single queue point to which they are attached.

Syntax 

AdminJMS.createSIBJMSQueue(scope, 
 name, queueName, 
 jndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createSIBJMSQueue("myScope", "myName", 
 "SIBJMSQueueTest", "queuejndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createSIBJMSQueue
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName7", "myQueueName7", "readAhead=AlwaysOff,timeToLive=9")

The following example script includes optional attributes in a list format: 

AdminJMS.createSIBJMSQueue
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName7", "myQueueName7", [['readAhead', 'AlwaysOff'], ['timeToLive', '9']])


createWMQQueue

This script creates queue type destination for the WebSphere MQ messaging provider at the scope specified. The script returns the configuration ID of the created WebSphere MQ queue.

To run the script, specify the scope, name of the queue type destination, name to assign to the queue, and JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWMQQueue script. Run the script to create a queue type destination.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the WebSphere MQ messaging provider.
name Name of the WebSphere MQ messaging provider queue type destination.
queueName Name of the WebSphere MQ queue to store messages for the queue type destination definition of the WebSphere MQ messaging provider.
jndiName Name used to bind this object into WAS JNDI.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description
ccsid Coded character set identifier.
decimalEncoding Decimal encoding setting for this queue. Valid values are Normal and Reversed.
description Administrative description to associate with this WebSphere MQ JMS queue type destination.
expiry Amount of time after which messages, sent to this destination, expire and are dealt with based on their disposition options. Valid values are APP, UNLIM, or any positive integer.
floatingPointEncoding Floating point encoding setting for this queue. Valid values are IEEENormal, IEEEReversed and z/OS.
integerEncoding Integer encoding setting for this queue. Valid values are Normal and Reversed.
persistence Level of persistence used to store messages sent to this destination. Valid values are APP, QDEF, PERS, NON or HIGH.
priority Priority level to assign to messages sent to this destination. Valid values are APP, QDEF, 0, 1, 2, 3, 4, 5, 6, 7, 8, or 9.
qmgr Specifies the queue manager on which the WebSphere MQ queue resides.
readAheadClose Behavior that occurs when closing a message consumer that is receiving messages asynchronously. The message consumer uses a message listener from a destination that has the readAhead parameter set to true. When a value of DELIVERALL is specified, the close method invocation waits until all read-ahead messages are delivered to the consumer before closing it. When a value of DELIVERCURRENT is specified, then the close() method only waits for any in-progress delivery to end before closing the consumer. Valid values are DELIVERALL and DELIVERCURRENT.
readAhead Whether messages for non-persistent consumers can be read ahead and cached. Valid values are YES, NO or QDEF.
sendAsync Whether messages can be sent to this destination without requiring the queue manager acknowledges they have arrived. Valid values are YES, NO or QDEF.
useRFH2 Whether an RFH version 2 header is appended to messages sent to this destination. Valid values are true or false.
useNativeEncoding Native encoding settings for this queue.

Syntax 

AdminJMS.createWMQQueue(scope, 
 name, queueName, 
 jndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWMQQueue("myScope", "myName", 
 "WMQQueueTest", "queuejndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createWMQQueue
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName8", "myQueueName8", "readAhead=YES,description=myDescription")

The following example script includes optional attributes in a list format: 

AdminJMS.createWMQQueue
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName8", "myQueueName8", [['readAhead', 'YES'], ['description', 'myDescription']])


createWASQueueConnectionFactory

This script creates a WAS queue connection factory in your configuration. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS queue connection factory in the respective cell.

To run the script, specify the node, server, JMS provider name, name to assign to the queue connection factory, and JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASQueueConnectionFactory script. Run the script to create a queue connection factory.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider of interest.
queueConnFactoryName Name to assign to the new WAS queue connection factory.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
XAEnabled Whether XA recovery processing is enabled.

    ['XAEnabled', 'false']
authDataAlias Alias used for database authentication at runtime.

    ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Specifies the authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

Do not put either of the values in quotes for the string format of the command. 

['authMechanismPreference', 
'BASIC_PASSWORD']
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
connectionPool Specifies the JMS connection pooling properties for the parent JMS connection factory instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

['connectionPool',
[['agedTimeout','100'],['connectionTimeout','1000'],
['freePoolDistributionTableSize',10],['maxConnections','12'],
['minConnections','5'],['numberOfFreePoolPartitions','3'],
['numberOfSharedPoolPartitions','6'],
['numberOfUnsharedPoolPartitions','3'],['properties',
[['description','My description'],['name', 'myName'],
['required','false'],['type','String'],
['validationExpression',''],['value','myValue']]],
['purgePolicy','EntirePool'],['reapTime','10000'],
['struckThreshold','3'],['struckTime','10'],
['struckTimerTime','10'],['surgeCreationInterval','10'],
['surgeThreshold','10'],['testConnection','true'],
['testConnectionInterval','10'],['unusedTimeout','10000']]]
description Description of the resource adapter.

    ['description', 'My description']
diagnoseConnectionUsage Whether connection usage diagnosis is enabled.

    ['diagnoseConnectionUsage', 'false']
logMissingTransactionContext Whether missing transaction context logging is enabled.

    ['logMissingTransactionContext', 'true']
manageCachedHandles Whether this data source is used for container-managed persistence of enterprise beans. The default value is true.

    ['manageCachedHandles', 'true']
mapping Mapping of the configuration login to a specified authentication alias name.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["mapping",[["authDataAlias","authDataAliasValue"],
["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["preTestConfig",[["preTestConnection", "true"],
["retryInterval", "12343"],["retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["properties",[["description","My description"],
["name","myName"],["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]]
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myJMSProviderType']
sessionPool Specifies the JMS session pooling properties for the parent JMS connection instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["sessionPool\",
[["agedTimeout","100"],["connectionTimeout","1000"],
["freePoolDistributionTableSize",10],["maxConnections","12"],
["minConnections","5"],["numberOfFreePoolPartitions","3"],
["numberOfSharedPoolPartitions","6"],
["numberOfUnsharedPoolPartitions","3"],["properties",
[["description","My description"],["name", "myName"],
["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]],
["purgePolicy",'EntirePool'],["reapTime","10000"],
["struckThreshold","3"],["struckTime","10"],
["struckTimerTime","10"],["surgeCreationInterval","10"],
["surgeThreshold","10"],["testConnection","true"],
["testConnectionInterval","10"],["unusedTimeout","10000"]]]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

    ['xaRecoveryAuthAlias', 'myCellManager01/a1']

Syntax 

AdminJMS.createWASQueueConnectionFactory(nodeName, 
 serverName, jmsProvider, queueConnFactoryName, 
 jndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASQueueConnectionFactory("myNode", "myServer", 
 "JMSTest", "queueCFTest", "queuejndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASQueueConnectionFactory("IBM-F4A849C57A0Node01", "server1", 
"My JMS Provider Name1", "My WASQueue Name", "JNDIName", “XAEnabled=false, 
authDataAlias=myAuthDataAlias, authMechanismPreference=BASIC_PASSWORD,  category=myCategory, 
description='My description', diagnoseConnectionUsage=false, logMissingTransactionContext=true, 
manageCachedHandles=true, providerType=myProviderType, xaRecoveryAuthAlias=myCellManager01/a1")

The following example script includes optional attributes in a list format: 

AdminJMS.createWASQueueConnectionFactory("IBM-F4A849C57A0Node01", "server1", 
"My JMS Provider Name1", "My WASQueue Name", "JNDIName", [['XAEnabled', 'false'], 
['authDataAlias', 'myAuthDataAlias'], ['authMechanismPreference', 'BASIC_PASSWORD'], 
['category', 'myCategory'], ['connectionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ' '], ['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], 
['reapTime', '10000'], ['surgeCreationInterval', '10'], ['surgeThreshold', '10'], 
['testConnection', 'true'], ['testConnectionInterval', '10'], ['unusedTimeout', '10000']]], 
['description', 'My description'], ['diagnoseConnectionUsage', 'false'], 
['logMissingTransactionContext', 'true'], ['manageCachedHandles', 'true'], ['mapping', 
[['authDataAlias', 'authDataAliasValue'], ['mappingConfigAlias', 'mappingConfigAliasValue']]], 
['preTestConfig', [['preTestConnection', 'true'], ['retryInterval', '12343'], ['retryLimit', '4']]], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['propertySet', [['resourceProperties', 
[[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['sessionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], 
['numberOfUnsharedPoolPartitions', '3'], ['properties', [[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], 
['purgePolicy', 'EntirePool'], ['reapTime', '10000'], ['surgeThreshold', '10'], ['testConnection', 'true']]], 
['xaRecoveryAuthAlias', 'myCellManager01/a1']] ))


createWASQueueConnectionFactoryUsingTemplate

This script uses a template to create a WAS queue connection factory in your configuration. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS queue connection factory using a template in the respective cell.

To run the script, specify the node, server, JMS provider name, configuration ID of the template, name to assign to the queue connection factory, and JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASQueueConnectionFactoryUsingTemplate script. Run the script to create a queue connection factory.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider of interest.
templateID Configuration ID of the WAS queue connection factory template to use.
queueConnFactoryName Name to assign to the new WAS queue connection factory.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
XAEnabled Whether XA recovery processing is enabled.

    ['XAEnabled', 'false']
authDataAlias Alias used for database authentication at runtime.

    ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Specifies the authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

Do not put either of the values in quotes for the string format of the command. 

['authMechanismPreference', 
'BASIC_PASSWORD']
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
connectionPool Specifies the JMS connection pooling properties for the parent JMS connection factory instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

['connectionPool',
[['agedTimeout','100'],['connectionTimeout','1000'],
['freePoolDistributionTableSize',10],['maxConnections','12'],
['minConnections','5'],['numberOfFreePoolPartitions','3'],
['numberOfSharedPoolPartitions','6'],
['numberOfUnsharedPoolPartitions','3'],['properties',
[['description','My description'],['name', 'myName'],
['required','false'],['type','String'],
['validationExpression',''],['value','myValue']]],
['purgePolicy','EntirePool'],['reapTime','10000'],
['struckThreshold','3'],['struckTime','10'],
['struckTimerTime','10'],['surgeCreationInterval','10'],
['surgeThreshold','10'],['testConnection','true'],
['testConnectionInterval','10'],['unusedTimeout','10000']]]
description Description of the resource adapter.

    ['description', 'My description']
diagnoseConnectionUsage Whether connection usage diagnosis is enabled.

    ['diagnoseConnectionUsage', 'false']
logMissingTransactionContext Whether missing transaction context logging is enabled.

    ['logMissingTransactionContext', 'true']
manageCachedHandles Whether this data source is used for container-managed persistence of enterprise beans. The default value is true.

    ['manageCachedHandles', 'true']
mapping Mapping of the configuration login to a specified authentication alias name.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["mapping",[["authDataAlias","authDataAliasValue"],
["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["preTestConfig",[["preTestConnection", "true"],
["retryInterval", "12343"],["retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["properties",[["description","My description"],
["name","myName"],["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]]
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myJMSProviderType']
sessionPool Specifies the JMS session pooling properties for the parent JMS connection instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["sessionPool\",
[["agedTimeout","100"],["connectionTimeout","1000"],
["freePoolDistributionTableSize",10],["maxConnections","12"],
["minConnections","5"],["numberOfFreePoolPartitions","3"],
["numberOfSharedPoolPartitions","6"],
["numberOfUnsharedPoolPartitions","3"],["properties",
[["description","My description"],["name", "myName"],
["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]],
["purgePolicy",'EntirePool'],["reapTime","10000"],
["struckThreshold","3"],["struckTime","10"],
["struckTimerTime","10"],["surgeCreationInterval","10"],
["surgeThreshold","10"],["testConnection","true"],
["testConnectionInterval","10"],["unusedTimeout","10000"]]]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

    ['xaRecoveryAuthAlias', 'myCellManager01/a1']

Syntax 

AdminJMS.createWASQueueConnectionFactoryUsingTemplate(nodeName, 
 serverName, jmsProvider, templateID, 
 queueConnFactoryName, jndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASQueueConnectionFactoryUsingTemplate("myNode", "myServer", 
 "JMSTest", "Example WAS 
 QueueConnectionFactory(templates/system|JMS-resource-provider-templates.xml#WASQueueConnectionFactory_1)", 
 "queueCFTest", "queuecfjndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASQueueConnectionFactoryUsingTemplate("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"Example WAS QueueConnectionFactory(templates/system|JMS-resource-provider-templates.xml#WASQueueConnectionFactory_1)", 
"My WASQueue Name", "JNDIName", “XAEnabled=false, authDataAlias=myAuthDataAlias, 
authMechanismPreference=BASIC_PASSWORD,  category=myCategory, description='My description', 
diagnoseConnectionUsage=false, logMissingTransactionContext=true, manageCachedHandles=true, 
providerType=myProviderType, xaRecoveryAuthAlias=myCellManager01/a1")

The following example script includes optional attributes in a list format: 

AdminJMS.createWASQueueConnectionFactoryUsingTemplate("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"Example WAS QueueConnectionFactory(templates/system|JMS-resource-provider-templates.xml#WASQueueConnectionFactory_1)", 
"My WASQueue Name", "JNDIName", [['XAEnabled', 'false'],['authDataAlias', 'myAuthDataAlias'], 
['authMechanismPreference', 'BASIC_PASSWORD'], ['category', 'myCategory'], ['connectionPool', 
[['agedTimeout', '100'], ['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], 
['maxConnections', '12'], ['minConnections', '5'], ['numberOfFreePoolPartitions', '3'], 
['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], ['properties', 
[[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ' '], ['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], 
['reapTime', '10000'],['surgeCreationInterval', '10'], ['surgeThreshold', '10'], 
['testConnection', 'true'], ['testConnectionInterval', '10'], ['unusedTimeout', '10000']]], 
['description', 'My description'], ['diagnoseConnectionUsage', 'false'], 
['logMissingTransactionContext', 'true'], ['manageCachedHandles', 'true'], ['mapping', 
[['authDataAlias', 'authDataAliasValue'], ['mappingConfigAlias', 'mappingConfigAliasValue']]], 
['preTestConfig', [['preTestConnection', 'true'], ['retryInterval', '12343'], ['retryLimit', '4']]], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['propertySet', [['resourceProperties', 
[[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['sessionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], 
['reapTime', '10000'], ['surgeThreshold', '10'], ['testConnection', 'true']]], 
['xaRecoveryAuthAlias', 'myCellManager01/a1']] )


createWASQueueConnectionFactoryAtScope

This script creates a WAS queue connection factory in your configuration at the scope specified. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS queue connection factory in the respective cell.

To run the script, specify the scope, JMS provider name, name to assign to the queue connection factory, and JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASQueueConnectionFactoryAtScope script. Run the script to create a queue connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
jmsProvider Name of the JMS provider of interest.
queueConnFactoryName Name to assign to the new WAS queue connection factory.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
XAEnabled Whether XA recovery processing is enabled.

    ['XAEnabled', 'false']
authDataAlias Alias used for database authentication at runtime.

    ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Specifies the authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

Do not put either of the values in quotes for the string format of the command. 

['authMechanismPreference', 
'BASIC_PASSWORD']
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
connectionPool Specifies the JMS connection pooling properties for the parent JMS connection factory instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

['connectionPool',
[['agedTimeout','100'],['connectionTimeout','1000'],
['freePoolDistributionTableSize',10],['maxConnections','12'],
['minConnections','5'],['numberOfFreePoolPartitions','3'],
['numberOfSharedPoolPartitions','6'],
['numberOfUnsharedPoolPartitions','3'],['properties',
[['description','My description'],['name', 'myName'],
['required','false'],['type','String'],
['validationExpression',''],['value','myValue']]],
['purgePolicy','EntirePool'],['reapTime','10000'],
['struckThreshold','3'],['struckTime','10'],
['struckTimerTime','10'],['surgeCreationInterval','10'],
['surgeThreshold','10'],['testConnection','true'],
['testConnectionInterval','10'],['unusedTimeout','10000']]]
description Description of the resource adapter.

    ['description', 'My description']
diagnoseConnectionUsage Whether connection usage diagnosis is enabled.

    ['diagnoseConnectionUsage', 'false']
logMissingTransactionContext Whether missing transaction context logging is enabled.

    ['logMissingTransactionContext', 'true']
manageCachedHandles Whether this data source is used for container-managed persistence of enterprise beans. The default value is true.

    ['manageCachedHandles', 'true']
mapping Mapping of the configuration login to a specified authentication alias name.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["mapping",[["authDataAlias","authDataAliasValue"],
["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["preTestConfig",[["preTestConnection", "true"],
["retryInterval", "12343"],["retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["properties",[["description","My description"],
["name","myName"],["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]]
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myJMSProviderType']
sessionPool Specifies the JMS session pooling properties for the parent JMS connection instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["sessionPool\",
[["agedTimeout","100"],["connectionTimeout","1000"],
["freePoolDistributionTableSize",10],["maxConnections","12"],
["minConnections","5"],["numberOfFreePoolPartitions","3"],
["numberOfSharedPoolPartitions","6"],
["numberOfUnsharedPoolPartitions","3"],["properties",
[["description","My description"],["name", "myName"],
["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]],
["purgePolicy",'EntirePool'],["reapTime","10000"],
["struckThreshold","3"],["struckTime","10"],
["struckTimerTime","10"],["surgeCreationInterval","10"],
["surgeThreshold","10"],["testConnection","true"],
["testConnectionInterval","10"],["unusedTimeout","10000"]]]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

    ['xaRecoveryAuthAlias', 'myCellManager01/a1']

Syntax 

AdminJMS.createWASQueueConnectionFactoryAtScope(scope, 
 jmsProvider, queueConnFactoryName, 
 jndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASQueueConnectionFactoryAtScope("myScope", 
 "JMSTest", "queueCFTest", "queuejndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASQueueConnectionFactoryAtScope
("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My WASQueue Name", "JNDIName", “XAEnabled=false, authDataAlias=myAuthDataAlias, 
authMechanismPreference=BASIC_PASSWORD,  category=myCategory, description='My description', diagnoseConnectionUsage=false, 
logMissingTransactionContext=true, manageCachedHandles=true, providerType=myProviderType,
 xaRecoveryAuthAlias=myCellManager01/a1")

The following example script includes optional attributes in a list format: 

AdminJMS.createWASQueueConnectionFactoryAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My WASQueue Name", "JNDIName", [['XAEnabled', 'false'], ['authDataAlias', 'myAuthDataAlias'], 
['authMechanismPreference', 'BASIC_PASSWORD'], ['category', 'myCategory'], ['connectionPool', [['agedTimeout', '100'], 
['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], ['validationExpression', ' '], 
['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], ['reapTime', '10000'], ['surgeCreationInterval', '10'], 
['surgeThreshold', '10'], ['testConnection', 'true'], ['testConnectionInterval', '10'], ['unusedTimeout', '10000']]], 
['description', 'My description'], ['diagnoseConnectionUsage', 'false'], ['logMissingTransactionContext', 'true'], 
['manageCachedHandles', 'true'], ['mapping', [['authDataAlias', 'authDataAliasValue'], 
['mappingConfigAlias', 'mappingConfigAliasValue']]], ['preTestConfig', [['preTestConnection', 'true'], 
['retryInterval', '12343'], 
['retryLimit', '4']]], ['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['propertySet', [['resourceProperties', [[['name', 'databaseName'], 
['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], ['type', 'java.lang.Integer'], 
['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], ['value', 'localhost']], [['name', 'portNumber'], 
['type', 'java.lang.Integer'], ['value', 50000]]]]]], ['providerType', 'myProviderType'], ['sessionPool', 
[['agedTimeout', '100'], ['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], ['maxConnections', '12'], 
['minConnections', '5'], ['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], 
['numberOfUnsharedPoolPartitions', '3'], ['properties', [[['description', 'My description'], ['name', 'myName'], 
['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], ['reapTime', '10000'], 
['surgeThreshold', '10'], ['testConnection', 'true']]], ['xaRecoveryAuthAlias', 'myCellManager01/a1']] )


createWASQueueConnectionFactoryUsingTemplateAtScope

This script uses a template to create a WAS queue connection factory in your configuration at the scope specified. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS queue connection factory using a template in the respective cell.

To run the script, specify the scope, JMS provider name, configuration ID of the template, name to assign to the queue connection factory, and JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASQueueConnectionFactoryUsingTemplateAtScope script. Run the script to create a queue connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
jmsProvider Name of the JMS provider of interest.
templateID Configuration ID of the WAS queue connection factory template to use.
queueConnFactoryName Name to assign to the new WAS queue connection factory.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
XAEnabled Whether XA recovery processing is enabled.

    ['XAEnabled', 'false']
authDataAlias Alias used for database authentication at runtime.

    ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Specifies the authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

Do not put either of the values in quotes for the string format of the command. 

['authMechanismPreference', 
'BASIC_PASSWORD']
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
connectionPool Specifies the JMS connection pooling properties for the parent JMS connection factory instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

['connectionPool',
[['agedTimeout','100'],['connectionTimeout','1000'],
['freePoolDistributionTableSize',10],['maxConnections','12'],
['minConnections','5'],['numberOfFreePoolPartitions','3'],
['numberOfSharedPoolPartitions','6'],
['numberOfUnsharedPoolPartitions','3'],['properties',
[['description','My description'],['name', 'myName'],
['required','false'],['type','String'],
['validationExpression',''],['value','myValue']]],
['purgePolicy','EntirePool'],['reapTime','10000'],
['struckThreshold','3'],['struckTime','10'],
['struckTimerTime','10'],['surgeCreationInterval','10'],
['surgeThreshold','10'],['testConnection','true'],
['testConnectionInterval','10'],['unusedTimeout','10000']]]
description Description of the resource adapter.

    ['description', 'My description']
diagnoseConnectionUsage Whether connection usage diagnosis is enabled.

    ['diagnoseConnectionUsage', 'false']
logMissingTransactionContext Whether missing transaction context logging is enabled.

    ['logMissingTransactionContext', 'true']
manageCachedHandles Whether this data source is used for container-managed persistence of enterprise beans. The default value is true.

    ['manageCachedHandles', 'true']
mapping Mapping of the configuration login to a specified authentication alias name.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["mapping",[["authDataAlias","authDataAliasValue"],
["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["preTestConfig",[["preTestConnection", "true"],
["retryInterval", "12343"],["retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["properties",[["description","My description"],
["name","myName"],["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]]
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myJMSProviderType']
sessionPool Specifies the JMS session pooling properties for the parent JMS connection instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["sessionPool\",
[["agedTimeout","100"],["connectionTimeout","1000"],
["freePoolDistributionTableSize",10],["maxConnections","12"],
["minConnections","5"],["numberOfFreePoolPartitions","3"],
["numberOfSharedPoolPartitions","6"],
["numberOfUnsharedPoolPartitions","3"],["properties",
[["description","My description"],["name", "myName"],
["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]],
["purgePolicy",'EntirePool'],["reapTime","10000"],
["struckThreshold","3"],["struckTime","10"],
["struckTimerTime","10"],["surgeCreationInterval","10"],
["surgeThreshold","10"],["testConnection","true"],
["testConnectionInterval","10"],["unusedTimeout","10000"]]]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

    ['xaRecoveryAuthAlias', 'myCellManager01/a1']

Syntax 

AdminJMS.createWASQueueConnectionFactoryUsingTemplateAtScope(scope, 
 jmsProvider, templateID, 
 queueConnFactoryName, jndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASQueueConnectionFactoryUsingTemplateAtScope("myScope",
 "JMSTest", "Example WAS 
 QueueConnectionFactory(templates/system|JMS-resource-provider-templates.xml#WASQueueConnectionFactory_1)", 
 "queueCFTest", "queuecfjndi")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASQueueConnectionFactoryUsingTemplateAtScope
("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "Example WAS QueueConnectionFactory
(templates/system|JMS-resource-provider-templates.xml#WASQueueConnectionFactory_1)", 
"My WASQueue Name", "JNDIName", “XAEnabled=false, authDataAlias=myAuthDataAlias, authMechanismPreference=BASIC_PASSWORD,  
category=myCategory, description='My description', diagnoseConnectionUsage=false, logMissingTransactionContext=true, 
manageCachedHandles=true, providerType=myProviderType, xaRecoveryAuthAlias=myCellManager01/a1")

The following example script includes optional attributes in a list format: 

AdminJMS.createWASQueueConnectionFactoryUsingTemplateAtScope
("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "Example WAS QueueConnectionFactory
(templates/system|JMS-resource-provider-templates.xml#WASQueueConnectionFactory_1)", 
"My WASQueue Name", "JNDIName", [['XAEnabled', 'false'], ['authDataAlias', 'myAuthDataAlias'], 
['authMechanismPreference', 'BASIC_PASSWORD'], 
['category', 'myCategory'], ['connectionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], 
['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], ['properties', 
[[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], ['validationExpression', ' '], ['value', 'myValue']]]],
 ['purgePolicy', 'EntirePool'], 
['reapTime', '10000'], ['surgeCreationInterval', '10'], ['surgeThreshold', '10'], ['testConnection', 'true'], 
['testConnectionInterval', '10'], ['unusedTimeout', '10000']]], ['description', 'My description'],
 ['diagnoseConnectionUsage', 'false'], 
['logMissingTransactionContext','true'], ['manageCachedHandles', 'true'], ['mapping', 
[['authDataAlias', 'authDataAliasValue'], 
['mappingConfigAlias', 'mappingConfigAliasValue']]], ['preTestConfig', [['preTestConnection', 'true'], 
['retryInterval', '12343'], 
['retryLimit', '4']]], ['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['propertySet', [['resourceProperties', [[['name', 'databaseName'], 
['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], ['type', 'java.lang.Integer'], 
['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], ['value', 'localhost']], 
[['name', 'portNumber'], 
['type', 'java.lang.Integer'], ['value', 50000]]]]]], ['providerType', 'myProviderType'], ['sessionPool', 
[['agedTimeout', '100'], 
['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], 
['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], ['reapTime', '10000'], ['surgeThreshold', '10'],
 ['testConnection', 'true']]], 
['xaRecoveryAuthAlias', 'myCellManager01/a1']] )


createWASTopic

This script creates a WAS topic in your JMS configuration. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS topic in the respective cell.

To run the script, specify the node, server, JMS provider name, name to assign to the topic, JNDI name, and the topic arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASTopic script. Run the script to create a topic.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider of interest.
topicName Name to assign to the new topic.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
topic Name of the topic (as a qualifier in the topic space) that this topic is to use.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
expiry Length of time after which messages sent to this destination expire and are dealt with according to their disposition options. Valid values are APPLICATION_DEFINE, SPECIFIED, and UNLIMITED.

Do not put either of the values in quotes for the string format of the command.

    ['expiry', 'SPECIFIED']
persistence Level of persistence. Valid values are APPLICATION_DEFINED, NONPERSISTENT, and PERSISTENT.

    ['persistence', 'NONPERSISTENT']
priority Level of priority. Valid values are APPLICATION_DEFINED and SPECIFIED.

    ['priority', 'SPECIFIED']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a specific vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
specifiedExpiry Time in milliseconds after which messages on this queue are discarded.

    ['specifiedExpiry', '1000']
specifiedPriority Priority from 0 to 9 of the WASQueue WebSphere queue.

    ['specifiedPriority', '0']

Syntax 

AdminJMS.createWASTopic(nodeName, serverName, 
 jmsProvider, topicName, jndiName, topic, 
 attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASTopic("myNode", "myServer", "JMSTest", 
 "TopicTest", "topicjndi", "mytopic")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASTopic("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"My WASTopic", "JNDIName", "A WAS Topic",” category=myCategory, description='My description', 
expiry=SPECIFIED, persistence=PERSISTENT, priority=APPLICATION_DEFINED")

The following example script includes optional attributes in a list format: 

AdminJMS.createWASTopic("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", "My WASTopic", 
"JNDIName", "A WAS Topic", [['category', 'myCategory'], ['description', 'My description'], 
['expiry', 'SPECIFIED'], ['persistence', 'PERSISTENT'], ['priority', 'APPLICATION_DEFINED'], 
['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], 
['value', 'myDbName']], [['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], 
[['name', 'serverName'], ['type', 'java.lang.String'], ['value', 'localhost']], [['name', 'portNumber'], 
['type', 'java.lang.Integer'], ['value', 50000]]]]]], ['providerType', 'myProviderType'], 
['specifiedExpiry', '1000'], ['specifiedPriority', '0']] )


createWASTopicUsingTemplate

This script uses a template to create a WAS topic in your JMS configuration. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WebSphere topic in the respective cell.

To run the script, specify the node, server, JMS provider name, configuration ID of the template, name to assign to the topic, JNDI name, and the topic arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASTopicUsingTemplate script. Run the script to create a topic.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProvider Name of the JMS provider of interest.
templateID Configuration ID of the WAS topic template to use.
topicName Name to assign to the new topic.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
topic Name of the topic (as a qualifier in the topic space) that this topic is to use.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
expiry Length of time after which messages sent to this destination expire and are dealt with according to their disposition options. Valid values are APPLICATION_DEFINE, SPECIFIED, and UNLIMITED.

Do not put either of the values in quotes for the string format of the command.

    ['expiry', 'SPECIFIED']
persistence Level of persistence. Valid values are APPLICATION_DEFINED, NONPERSISTENT, and PERSISTENT.

    ['persistence', 'NONPERSISTENT']
priority Level of priority. Valid values are APPLICATION_DEFINED and SPECIFIED.

    ['priority', 'SPECIFIED']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a specific vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
specifiedExpiry Time in milliseconds after which messages on this queue are discarded.

    ['specifiedExpiry', '1000']
specifiedPriority Priority from 0 to 9 of the WASQueue WebSphere queue.

    ['specifiedPriority', '0']

Syntax 

AdminJMS.createWASTopicUsingTemplate(nodeName, 
 serverName, jmsProvider, templateID, topicName, 
 jndiName, topic, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASTopicUsingTemplate("myNode", "myServer", "JMSTest", 
 "Example.JMS.WAS.T1(templates/system|JMS-resource-provider-templates.xml#WASTopic_1)", 
"TopicTest", 
 "topicjndi", "mytopic")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASTopic("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"My WASTopic", "JNDIName", "A WAS Topic",” category=myCategory, description='My description', 
expiry=SPECIFIED, persistence=PERSISTENT, priority=APPLICATION_DEFINED”)

The following example script includes optional attributes in a list format: 

AdminJMS.createWASTopic("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", "My WASTopic", 
"JNDIName", "A WAS Topic", [['category', 'myCategory'], ['description', 'My description'], [
'expiry', 'SPECIFIED'], ['persistence', 'PERSISTENT'], ['priority', 'APPLICATION_DEFINED'], 
['propertySet', [['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], 
['value', 'myDbName']], [['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], 
[['name', 'serverName'], ['type', 'java.lang.String'], ['value', 'localhost']], [['name', 'portNumber'], 
['type', 'java.lang.Integer'], ['value', 50000]]]]]], ['providerType', 'myProviderType'], 
['specifiedExpiry', '1000'], ['specifiedPriority', '0']] )


createWASTopicAtScope

This script creates a WAS topic in your JMS configuration at the scope specified. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS topic in the respective cell.

To run the script, specify the scope, JMS provider name, name to assign to the topic, JNDI name, and the topic arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASTopicAtScope script. Run the script to create a topic.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
jmsProvider Name of the JMS provider of interest.
topicName Name to assign to the new topic.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
topic Name of the topic (as a qualifier in the topic space) that this topic is to use.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
expiry Length of time after which messages sent to this destination expire and are dealt with according to their disposition options. Valid values are APPLICATION_DEFINE, SPECIFIED, and UNLIMITED.

Do not put either of the values in quotes for the string format of the command.

    ['expiry', 'SPECIFIED']
persistence Level of persistence. Valid values are APPLICATION_DEFINED, NONPERSISTENT, and PERSISTENT.

    ['persistence', 'NONPERSISTENT']
priority Level of priority. Valid values are APPLICATION_DEFINED and SPECIFIED.

    ['priority', 'SPECIFIED']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a specific vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
specifiedExpiry Time in milliseconds after which messages on this queue are discarded.

    ['specifiedExpiry', '1000']
specifiedPriority Priority from 0 to 9 of the WASQueue WebSphere queue.

    ['specifiedPriority', '0']

Syntax 

AdminJMS.createWASTopicAtScope(scope, 
 jmsProvider, topicName, jndiName, topic, 
 attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASTopic("myScope", "JMSTest", 
 "TopicTest", "topicjndi", "mytopic")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASTopicAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My WASTopic", "JNDIName", "A WAS Topic", ” category=myCategory, description='My description', 
expiry=SPECIFIED, persistence=PERSISTENT, priority=APPLICATION_DEFINED”)

The following example script includes optional attributes in a list format: 

AdminJMS.createWASTopicAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My WASTopic", "JNDIName", "A WAS Topic", [['category', 'myCategory'], 
['description', 'My description'], 
['expiry', 'SPECIFIED'], ['persistence', 'PERSISTENT'], ['priority', 'APPLICATION_DEFINED'], ['propertySet', 
[['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], 
[['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], 
['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['specifiedExpiry', '1000'], ['specifiedPriority', '0']] )


createWASTopicUsingTemplateAtScope

This script uses a template to create a WAS topic in your JMS configuration at the scope specified. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WebSphere topic in the respective cell.

To run the script, specify the scope, JMS provider name, configuration ID of the template, name to assign to the topic, JNDI name, and the topic arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASTopicUsingTemplateAtScope script. Run the script to create a topic.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
jmsProvider Name of the JMS provider of interest.
templateID Configuration ID of the WAS topic template to use.
topicName Name to assign to the new topic.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
topic Name of the topic (as a qualifier in the topic space) that this topic is to use.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
description Description of the resource adapter.

    ['description', 'My description']
expiry Length of time after which messages sent to this destination expire and are dealt with according to their disposition options. Valid values are APPLICATION_DEFINE, SPECIFIED, and UNLIMITED.

Do not put either of the values in quotes for the string format of the command.

    ['expiry', 'SPECIFIED']
persistence Level of persistence. Valid values are APPLICATION_DEFINED, NONPERSISTENT, and PERSISTENT.

    ['persistence', 'NONPERSISTENT']
priority Level of priority. Valid values are APPLICATION_DEFINED and SPECIFIED.

    ['priority', 'SPECIFIED']
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string]
[value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string]
[value localhost]] 
[[name portNumber][type integer]
[value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a specific vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myProviderType']
specifiedExpiry Time in milliseconds after which messages on this queue are discarded.

    ['specifiedExpiry', '1000']
specifiedPriority Priority from 0 to 9 of the WASQueue WebSphere queue.

    ['specifiedPriority', '0']

Syntax 

AdminJMS.createWASTopicUsingTemplateAtScope(scope, 
 jmsProvider, templateID, topicName, 
 jndiName, topic, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASTopicUsingTemplateAtScope("myScope", "JMSTest", 
 "Example.JMS.WAS.T1(templates/system|JMS-resource-provider-templates.xml#WASTopic_1)", 
"TopicTest", 
 "topicjndi", "mytopic")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASTopicUsingTemplateAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "Example.JMS.WAS.T1(templates/system|JMS-resource-provider-templates.xml#WASTopic_1)", 
"My WASTopic", "JNDIName", "A WAS Topic", ” category=myCategory, description='My description', expiry=SPECIFIED, 
persistence=PERSISTENT, priority=APPLICATION_DEFINED”)

The following example script includes optional attributes in a list format: 

AdminJMS.createWASTopicUsingTemplateAtScope("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "Example.JMS.WAS.T1(templates/system|JMS-resource-provider-templates.xml#WASTopic_1)", 
"My WASTopic", "JNDIName", "A WAS Topic", [['category', 'myCategory'], ['description', 'My description'], 
['expiry', 'SPECIFIED'], ['persistence', 'PERSISTENT'], ['priority', 'APPLICATION_DEFINED'], ['propertySet', 
[['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], 
[['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['specifiedExpiry', '1000'], ['specifiedPriority', '0']] )


createSIBJMSTopic

This script create a new JMS topic for the default messaging provider at the scope specified. The script returns the configuration ID of the created SIB JMS topic.

To run the script, specify the scope, name to assign to the topic, and the JNDI name. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createSIBJMSTopic script. Run the script to create a JMS topic.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the default messaging provider.
name Name to assign to the new topic.
jndiName Specifies the JNDI name the system uses to bind this object into WAS JNDI.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description
description Description of the SIB JMS topic.
topicSpace Name of the underlying SIB topic space to which the topic points.
topicName Topic used inside the topic space, for example, stock/IBM.
deliveryMode Delivery mode for messages. Valid values are Application, NonPersistent, and Persistent.
timeToLive Time in milliseconds for message expiration.
priority Priority level to assign to messages sent to this destination. Valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, or 9.
readAhead Specifies the read-ahead value. Valid values are AsConnection, AlwaysOn, and AlwaysOff.
busName The name of the bus on which the topic resides.

Syntax 

AdminJMS.createSIBJMSTopic(scope, 
 name, 
 jndiName, attributes)

Example usage

The following example script contains required attributes only:

The following example script includes optional attributes in a string format: 

AdminJMS.createSIBJMSTopic
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", "myName" , 
"myJndiName9", "readAhead=AlwaysOff,timeToLive=6")

The following example script includes optional attributes in a list format: 

AdminJMS.createSIBJMSTopic
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", "myName" , 
"myJndiName9", [['readAhead', 'AlwaysOff'], ['timeToLive', '6']])


createWMQTopic

This script creates a JMS topic destination for the WebSphere MQ messaging provider at the scope specified. The script returns the configuration ID of the created WebSphere MQ topic.

To run the script, specify the scope, name to assign to the topic, and the JNDI name. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWMQTopic script. Run the script to create a JMS topic destination.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the WebSphere MQ messaging provider.
name Name to assign to the new topic.
jndiName Specifies the JNDI name the system uses to bind this object into WAS JNDI.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description
brokerCCDurSubQueue Name of the queue from which a connection consumer receives durable subscription messages.
brokerDurSubQueue Name of the queue from which a connection consumer receives non-durable subscription messages.
brokerPubQmgr Name of the queue manager on which the broker is running.
brokerPubQueue Name of the queue to which publication messages are sent.
brokerVersion Level of functionality required for publish and subscribe operations.
ccsid Coded character set identifier.
decimalEncoding Decimal encoding setting for this topic. Valid values are Normal and Reversed.
description Administrative description to associate with this WebSphere MQ JMS topic type destination.
expiry Amount of time after which messages, sent to this destination, expire and are dealt with based on their disposition options. Valid values are APP, UNLIM, or any positive integer.
floatingPointEncoding Floating point encoding setting for this topic. Valid values are IEEENormal, IEEEReversed and z/OS.
integerEncoding Integer encoding setting for this topic. Valid values are Normal and Reversed.
persistence Level of persistence used to store messages sent to this destination. Valid values are APP, TDEF, PERS, NON or HIGH.
priority Priority level to assign to messages sent to this destination. Valid values are APP, TDEF, 0, 1, 2, 3, 4, 5, 6, 7, 8, or 9.
readAheadClose Behavior that occurs when closing a message consumer that is receiving messages asynchronously. The message consumer uses a message listener from a destination that has the readAhead parameter set to true. When a value of DELIVERALL is specified, the close method invocation waits until all read-ahead messages are delivered to the consumer before closing it. When a value of DELIVERCURRENT is specified, then the close() method only waits for any in-progress delivery to end before closing the consumer. Valid values are DELIVERALL and DELIVERCURRENT.
readAhead Whether messages for non-persistent consumers can be read ahead and cached. Valid values are YES, NO or TDEF.
sendAsync Whether messages can be sent to this destination without requiring the queue manager acknowledges they have arrived. Valid values are YES, NO or TDEF.
useRFH2 Whether an RFH version 2 header is appended to messages sent to this destination. Valid values are true or false.
useNativeEncoding Native encoding settings for this topic.
wildcardFormat Which sets of characters are interpreted as topic wild cards.

Syntax 

AdminJMS.createWMQTopic(scope, 
 name, 
 jndiName, attributes)

Example usage

The following example script contains required attributes only:

The following example script includes optional attributes in a string format: 

AdminJMS.createWMQTopic
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName10", "myTopicName10", "readAhead=YES,sendAsync=NO")

The following example script includes optional attributes in a list format: 

AdminJMS.createWMQTopic
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName10", "myTopicName10", [['readAhead', 'YES'], ['sendAsync', 'NO']])


createWASTopicConnectionFactory

This script creates a WAS topic connection factory in your configuration. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS topic connection factory in the respective cell.

To run the script, specify the node, server, JMS provider name, name to assign to the connection factory, JNDI name, and the port arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASTopicConnectionFactory script. Run the script to create a topic connection factory.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProviderName Name of the JMS provider of interest.
topicConnFactoryName Name to assign to the new connection factory.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
port Specify the port of interest.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
XAEnabled Whether XA recovery processing is enabled.

    ['XAEnabled', 'false']
authDataAlias Alias used for database authentication at runtime.

    ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Specifies the authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

Do not put either of the values in quotes for the string format of the command. 

['authMechanismPreference', 
'BASIC_PASSWORD']
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
connectionPool Specifies the JMS connection pooling properties for the parent JMS connection factory instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

['connectionPool',
[['agedTimeout','100'],['connectionTimeout','1000'],
['freePoolDistributionTableSize',10],['maxConnections','12'],
['minConnections','5'],['numberOfFreePoolPartitions','3'],
['numberOfSharedPoolPartitions','6'],
['numberOfUnsharedPoolPartitions','3'],['properties',
[['description','My description'],['name', 'myName'],
['required','false'],['type','String'],
['validationExpression',''],['value','myValue']]],
['purgePolicy','EntirePool'],['reapTime','10000'],
['struckThreshold','3'],['struckTime','10'],
['struckTimerTime','10'],['surgeCreationInterval','10'],
['surgeThreshold','10'],['testConnection','true'],
['testConnectionInterval','10'],['unusedTimeout','10000']]]
description Description of the resource adapter.

    ['description', 'My description']
diagnoseConnectionUsage Whether connection usage diagnosis is enabled.

    ['diagnoseConnectionUsage', 'false']
logMissingTransactionContext Whether missing transaction context logging is enabled.

    ['logMissingTransactionContext', 'true']
manageCachedHandles Whether this data source is used for container-managed persistence of enterprise beans. The default value is true.

    ['manageCachedHandles', 'true']
mapping Mapping of the configuration login to a specified authentication alias name.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["mapping",[["authDataAlias","authDataAliasValue"],
["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["preTestConfig",[["preTestConnection", "true"],
["retryInterval", "12343"],["retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["properties",[["description","My description"],
["name","myName"],["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]]
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myJMSProviderType']
sessionPool Specifies the JMS session pooling properties for the parent JMS connection instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["sessionPool\",
[["agedTimeout","100"],["connectionTimeout","1000"],
["freePoolDistributionTableSize",10],["maxConnections","12"],
["minConnections","5"],["numberOfFreePoolPartitions","3"],
["numberOfSharedPoolPartitions","6"],
["numberOfUnsharedPoolPartitions","3"],["properties",
[["description","My description"],["name", "myName"],
["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]],
["purgePolicy",'EntirePool'],["reapTime","10000"],
["struckThreshold","3"],["struckTime","10"],
["struckTimerTime","10"],["surgeCreationInterval","10"],
["surgeThreshold","10"],["testConnection","true"],
["testConnectionInterval","10"],["unusedTimeout","10000"]]]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

    ['xaRecoveryAuthAlias', 'myCellManager01/a1']

Optional attributes, continued. Additional attributes available for the script.

Attributes Description Example
clientID Client ID.

    ['clientID', 'myClientID']
cloneSupport Whether the WebSphere topic connection factory is supported across clones.

    ['cloneSupport', 'true']

Syntax 

AdminJMS.createWASTopicConnectionFactory(nodeName, 
 serverName, jmsProviderName, topicConnFactoryName, 
 jndiName, port, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASTopicConnectionFactory("myNode", "myServer", 
 "JMSTest", "TopicCFTest", "topiccfjndi", "DIRECT")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASTopicConnectionFactory("IBM-F4A849C57A0Node01", "server1", 
"My JMS Provider Name1", "My WASTopicConnectionFactory", "JNDIName", "DIRECT", “XAEnabled=false, 
authDataAlias=myAuthDataAlias, authMechanismPreference=BASIC_PASSWORD, category=myCategory, 
clientID=myClientID, cloneSupport=true, description='My description', diagnoseConnectionUsage=false, 
logMissingTransactionContext=true, manageCachedHandles=true, providerType=myProviderType, 
xaRecoveryAuthAlias=myCellManager01/a1")

The following example script includes optional attributes in a list format: 

AdminJMS.createWASTopicConnectionFactory("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"My WASTopicConnectionFactory", "JNDIName", "DIRECT", [['XAEnabled', 'false'], 
['authDataAlias', 'myAuthDataAlias'], ['authMechanismPreference', 'BASIC_PASSWORD'], 
['category', 'myCategory'], ['clientID', 'myClientID'], ['cloneSupport', 'true'], 
['connectionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], 
['numberOfUnsharedPoolPartitions', '3'], ['properties', [[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], 
['purgePolicy', 'EntirePool'], ['reapTime', '10000'], ['surgeThreshold', '10'], 
['testConnection', 'true']]], ['description', 'My description'], ['diagnoseConnectionUsage', 'false'], 
['logMissingTransactionContext', 'true'], ['manageCachedHandles', 'true'], ['mapping', 
[['authDataAlias', 'authDataAliasValue'], ['mappingConfigAlias', 'mappingConfigAliasValue']]], 
['preTestConfig', [['preTestConnection', 'true'], ['retryInterval', '12343'], ['retryLimit', '4']]], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['propertySet', [['resourceProperties', 
[[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], 
[['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], 
['type', 'java.lang.String'], ['value', 'localhost']], [['name', 'portNumber'], 
['type', 'java.lang.Integer'], ['value', 50000]]]]]], ['providerType', 'myProviderType'], ['sessionPool', 
[['agedTimeout', '100'], ['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], 
['maxConnections', '12'], ['minConnections', '5'], ['numberOfFreePoolPartitions', '3'], 
['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], ['properties', 
[[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], 
['reapTime', '10000'], ['surgeThreshold', '10'], ['testConnection', 'true']]], 
['xaRecoveryAuthAlias', 'myCellManager01/a1']] )


createWASTopicConnectionFactoryUsingTemplate

This script uses a template to create a WAS topic connection factory in your configuration. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMS Server in a v7.0 cell. The script returns the configuration ID of the created WebSphere topic using a template in the respective cell.

To run the script, specify the node, server, JMS provider name, configuration ID of the template, name to assign to the connection factory, JNDI name, and the port arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASTopicConnectionFactoryUsingTemplate script. Run the script to create a topic connection factory.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.
jmsProviderName Name of the JMS provider of interest.
templateID Configuration ID of the WAS topic connection factory to use.
topicConnFactoryName Name to assign to the new connection factory.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
port Port of interest.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
XAEnabled Whether XA recovery processing is enabled.

    ['XAEnabled', 'false']
authDataAlias Alias used for database authentication at runtime.

    ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Specifies the authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

Do not put either of the values in quotes for the string format of the command. 

['authMechanismPreference', 
'BASIC_PASSWORD']
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
connectionPool Specifies the JMS connection pooling properties for the parent JMS connection factory instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

['connectionPool',
[['agedTimeout','100'],['connectionTimeout','1000'],
['freePoolDistributionTableSize',10],['maxConnections','12'],
['minConnections','5'],['numberOfFreePoolPartitions','3'],
['numberOfSharedPoolPartitions','6'],
['numberOfUnsharedPoolPartitions','3'],['properties',
[['description','My description'],['name', 'myName'],
['required','false'],['type','String'],
['validationExpression',''],['value','myValue']]],
['purgePolicy','EntirePool'],['reapTime','10000'],
['struckThreshold','3'],['struckTime','10'],
['struckTimerTime','10'],['surgeCreationInterval','10'],
['surgeThreshold','10'],['testConnection','true'],
['testConnectionInterval','10'],['unusedTimeout','10000']]]
description Description of the resource adapter.

    ['description', 'My description']
diagnoseConnectionUsage Whether connection usage diagnosis is enabled.

    ['diagnoseConnectionUsage', 'false']
logMissingTransactionContext Whether missing transaction context logging is enabled.

    ['logMissingTransactionContext', 'true']
manageCachedHandles Whether this data source is used for container-managed persistence of enterprise beans. The default value is true.

    ['manageCachedHandles', 'true']
mapping Mapping of the configuration login to a specified authentication alias name.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["mapping",[["authDataAlias","authDataAliasValue"],
["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["preTestConfig",[["preTestConnection", "true"],
["retryInterval", "12343"],["retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["properties",[["description","My description"],
["name","myName"],["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]]
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myJMSProviderType']
sessionPool Specifies the JMS session pooling properties for the parent JMS connection instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["sessionPool\",
[["agedTimeout","100"],["connectionTimeout","1000"],
["freePoolDistributionTableSize",10],["maxConnections","12"],
["minConnections","5"],["numberOfFreePoolPartitions","3"],
["numberOfSharedPoolPartitions","6"],
["numberOfUnsharedPoolPartitions","3"],["properties",
[["description","My description"],["name", "myName"],
["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]],
["purgePolicy",'EntirePool'],["reapTime","10000"],
["struckThreshold","3"],["struckTime","10"],
["struckTimerTime","10"],["surgeCreationInterval","10"],
["surgeThreshold","10"],["testConnection","true"],
["testConnectionInterval","10"],["unusedTimeout","10000"]]]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

    ['xaRecoveryAuthAlias', 'myCellManager01/a1']

Optional attributes, continued. Additional attribute available for the script.

Attributes Description Example
type Specifies QUEUE for queues, TOPIC for topics, and UNIFIED for both queues and topics.

Do not put either of the values in quotes for the string format of the command.

    ['type', 'TOPIC']

Syntax 

AdminJMS.createWASTopicConnectionFactoryUsingTemplate(nodeName, 
 serverName, jmsProviderName, templateID, 
 topicConnFactoryName, jndiName,  port, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASTopicConnectionFactoryUsingTemplate("myNode", "myServer", 
 "JMSTest", "First Example WAS 
 TopicConnectionFactory(templates/system|JMS-resource-provider-templates.xml#WASTopicConnectionFactory_1)", 
 "TopicCFTest", "topiccfjndi", "DIRECT")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASTopicConnectionFactoryUsingTemplate
("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"First Example WAS TopicConnectionFactory
(templates/system|JMS-resource-provider-templates.xml#WASTopicConnectionFactory_1)", 
"My WASTopicConnectionFactory", "JNDIName", "DIRECT", “XAEnabled=false, authDataAlias=myAuthDataAlias, 
authMechanismPreference=BASIC_PASSWORD, category=myCategory, clientID=myClientID, cloneSupport=true, 
description='My description', diagnoseConnectionUsage=false, logMissingTransactionContext=true, 
manageCachedHandles=true, providerType=myProviderType, xaRecoveryAuthAlias=myCellManager01/a1")

The following example script includes optional attributes in a list format: 

AdminJMS.createWASTopicConnectionFactoryUsingTemplate
("IBM-F4A849C57A0Node01", "server1", "My JMS Provider Name1", 
"First Example WAS TopicConnectionFactory
(templates/system|JMS-resource-provider-templates.xml#WASTopicConnectionFactory_1)", 
"My WASTopicConnectionFactory", "JNDIName", "'DIRECT'", [['XAEnabled', 'false'], 
['authDataAlias', 'myAuthDataAlias'], ['authMechanismPreference', 'BASIC_PASSWORD'], 
['category', 'myCategory'], ['clientID', 'myClientID'], ['cloneSupport', 'true'], 
['connectionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], 
['numberOfUnsharedPoolPartitions', '3'], ['properties', [[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], 
['purgePolicy', 'EntirePool'], ['reapTime', '10000'], ['surgeThreshold', '10'], 
['testConnection', 'true']]], ['description', 'My description'], ['diagnoseConnectionUsage', 'false'], 
['logMissingTransactionContext', 'true'], ['manageCachedHandles', 'true'], ['mapping', 
[['authDataAlias', 'authDataAliasValue'], ['mappingConfigAlias', 'mappingConfigAliasValue']]], 
['preTestConfig', [['preTestConnection', 'true'], ['retryInterval', '12343'], ['retryLimit', '4']]], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['propertySet', [['resourceProperties', 
[[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], [['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['sessionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], 
['numberOfUnsharedPoolPartitions', '3'], ['properties', [[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], 
['purgePolicy', 'EntirePool'], ['reapTime', '10000'], ['surgeThreshold', '10'], 
['testConnection', 'true']]], ['xaRecoveryAuthAlias', 'myCellManager01/a1']] )


createWASTopicConnectionFactoryAtScope

This script creates a WAS topic connection factory in your configuration at the scope specified. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMSServer in a v7.0 cell. The script returns the configuration ID of the created WAS topic connection factory in the respective cell.

To run the script, specify the scope, JMS provider name, name to assign to the connection factory, JNDI name, and the port arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASTopicConnectionFactoryAtScope script. Run the script to create a topic connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
jmsProviderName Name of the JMS provider of interest.
topicConnFactoryName Name to assign to the new connection factory.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
port Specify the port of interest.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes, continued. Additional attribute available for the script.

Attributes Description Example
type Specifies QUEUE for queues, TOPIC for topics, and UNIFIED for both queues and topics.

Do not put either of the values in quotes for the string format of the command.

    ['type', 'TOPIC']

Syntax 

AdminJMS.createWASTopicConnectionFactoryAtScope(scope, 
 jmsProviderName, topicConnFactoryName, 
 jndiName, port, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASTopicConnectionFactoryAtScope("myScope", 
 "JMSTest", "TopicCFTest", "topiccfjndi", "DIRECT")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASTopicConnectionFactoryAtScope
("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My WASTopicConnectionFactory", "JNDIName", "DIRECT", “XAEnabled=false, 
authDataAlias=myAuthDataAlias, 
authMechanismPreference=BASIC_PASSWORD, category=myCategory, clientID=myClientID, cloneSupport=true, 
description='My description', 
diagnoseConnectionUsage=false, logMissingTransactionContext=true, manageCachedHandles=true, 
providerType=myProviderType, 
xaRecoveryAuthAlias=myCellManager01/a1")

The following example script includes optional attributes in a list format: 

AdminJMS.createWASTopicConnectionFactoryAtScope
("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "My WASTopicConnectionFactory", "JNDIName", "'DIRECT'", [['XAEnabled', 'false'], 
['authDataAlias', 'myAuthDataAlias'], ['authMechanismPreference','BASIC_PASSWORD'], ['category', 'myCategory'], 
['clientID', 'myClientID'], ['cloneSupport', 'true'], ['connectionPool', [['agedTimeout', '100'], 
['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], 
['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], ['properties', 
[[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], 
['purgePolicy', 'EntirePool'], 
['reapTime', '10000'], ['surgeThreshold', '10'], ['testConnection', 'true']]], 
['description', 'My description'], 
['diagnoseConnectionUsage', 'false'], ['logMissingTransactionContext', 'true'], 
['manageCachedHandles', 'true'], 
['mapping', [['authDataAlias', 'authDataAliasValue'], ['mappingConfigAlias', 'mappingConfigAliasValue']]], 
['preTestConfig', 
[['preTestConnection', 'true'], ['retryInterval', '12343'], ['retryLimit', '4']]], ['properties', 
[[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], ['propertySet', 
[['resourceProperties', [[['name','databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], 
[['name', 'driverType'], ['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], 
['type', 'java.lang.String'], 
['value', 'localhost']], [['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], 
['providerType', 'myProviderType'], ['sessionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], 
['freePoolDistributionTableSize', 10], ['maxConnections', '12'], ['minConnections', '5'], 
['numberOfFreePoolPartitions', '3'], 
['numberOfSharedPoolPartitions', '6'], ['numberOfUnsharedPoolPartitions', '3'], ['properties', 
[[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], 
['purgePolicy', 'EntirePool'], 
['reapTime', '10000'], ['surgeThreshold', '10'], ['testConnection', 'true']]], 
['xaRecoveryAuthAlias','myCellManager01/a1']] )


createWASTopicConnectionFactoryUsingTemplateAtScope

This script uses a template to create a WAS topic connection factory in your configuration at the scope specified. You should only use JMS resources for applications that perform messaging with a WAS version 5.1 embedded JMS Server in a v7.0 cell. The script returns the configuration ID of the created WebSphere topic using a template in the respective cell.

To run the script, specify the scope, JMS provider name, configuration ID of the template, name to assign to the connection factory, JNDI name, and the port arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWASTopicConnectionFactoryUsingTemplateAtScope script. Run the script to create a topic connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
jmsProviderName Name of the JMS provider of interest.
templateID Configuration ID of the WAS topic connection factory to use.
topicConnFactoryName Name to assign to the new connection factory.
jndiName Specifies the JNDI name the system uses to bind the connection factory into the name space.
port Port of interest.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description Example
XAEnabled Whether XA recovery processing is enabled.

    ['XAEnabled', 'false']
authDataAlias Alias used for database authentication at runtime.

    ['authDataAlias', 'myAuthDataAlias']
authMechanismPreference Specifies the authentication mechanism. Valid values are BASIC_PASSWORD for basic authentication and KERBEROS for Kerberos authentication.

Do not put either of the values in quotes for the string format of the command. 

['authMechanismPreference', 
'BASIC_PASSWORD']
category Category that can be used to classify or group the resource.

    ['category', 'myCategory']
connectionPool Specifies the JMS connection pooling properties for the parent JMS connection factory instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

['connectionPool',
[['agedTimeout','100'],['connectionTimeout','1000'],
['freePoolDistributionTableSize',10],['maxConnections','12'],
['minConnections','5'],['numberOfFreePoolPartitions','3'],
['numberOfSharedPoolPartitions','6'],
['numberOfUnsharedPoolPartitions','3'],['properties',
[['description','My description'],['name', 'myName'],
['required','false'],['type','String'],
['validationExpression',''],['value','myValue']]],
['purgePolicy','EntirePool'],['reapTime','10000'],
['struckThreshold','3'],['struckTime','10'],
['struckTimerTime','10'],['surgeCreationInterval','10'],
['surgeThreshold','10'],['testConnection','true'],
['testConnectionInterval','10'],['unusedTimeout','10000']]]
description Description of the resource adapter.

    ['description', 'My description']
diagnoseConnectionUsage Whether connection usage diagnosis is enabled.

    ['diagnoseConnectionUsage', 'false']
logMissingTransactionContext Whether missing transaction context logging is enabled.

    ['logMissingTransactionContext', 'true']
manageCachedHandles Whether this data source is used for container-managed persistence of enterprise beans. The default value is true.

    ['manageCachedHandles', 'true']
mapping Mapping of the configuration login to a specified authentication alias name.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["mapping",[["authDataAlias","authDataAliasValue"],
["mappingConfigAlias","mappingConfigAliasValue"]]]
preTestConfig Pretest connection configuration settings.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["preTestConfig",[["preTestConnection", "true"],
["retryInterval", "12343"],["retryLimit", "4"]]]
properties Specifies either a typed property type or a descriptive property type.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["properties",[["description","My description"],
["name","myName"],["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]]
propertySet Optionally specifies resource properties in the following format: [propertySet[[resourceProperties[[[name1 nameValue1][type1 typeValue1][value1 valueValue1]]... [[namen nameValuen][typen typeValuen][valuen valueValuen]] ]]]]

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

[propertySet [[resourceProperties 
[[[name databaseName][type string][value mys]] 
[[name driverType][type integer][value 4]] 
[[name serverName][type string][value localhost]] 
[[name portNumber][type integer][value 50000]] ]]]]
provider Specifies the JMS driver implementation class for access to a vendor database. To create a pool of connections to that database, associate a data source with the JMS provider.

    ['provider', 'myJMSProvider']
providerType Specifies the JMS provider type used by this JMS provider.

    ['providerType', 'myJMSProviderType']
sessionPool Specifies the JMS session pooling properties for the parent JMS connection instance.

When we use this attribute in a script, use the list format. The string format does not work because this attribute is a configuration object type. 

["sessionPool\",
[["agedTimeout","100"],["connectionTimeout","1000"],
["freePoolDistributionTableSize",10],["maxConnections","12"],
["minConnections","5"],["numberOfFreePoolPartitions","3"],
["numberOfSharedPoolPartitions","6"],
["numberOfUnsharedPoolPartitions","3"],["properties",
[["description","My description"],["name", "myName"],
["required","false"],["type","String"],
["validationExpression",""],["value","myValue"]]],
["purgePolicy",'EntirePool'],["reapTime","10000"],
["struckThreshold","3"],["struckTime","10"],
["struckTimerTime","10"],["surgeCreationInterval","10"],
["surgeThreshold","10"],["testConnection","true"],
["testConnectionInterval","10"],["unusedTimeout","10000"]]]
xaRecoveryAuthAlias Database authentication alias used during XA recovery processing. When this property is specified, the default value is the alias for application authentication.

    ['xaRecoveryAuthAlias', 'myCellManager01/a1']

Optional attributes, continued. Additional attribute available for the script.

Attributes Description Example
type Specifies QUEUE for queues, TOPIC for topics, and UNIFIED for both queues and topics.

Do not put either of the values in quotes for the string format of the command.

    ['type', 'TOPIC']

Syntax 

AdminJMS.createWASTopicConnectionFactoryUsingTemplateAtScope(scope, 
 jmsProviderName, templateID, 
 topicConnFactoryName, jndiName,  port, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createWASTopicConnectionFactoryUsingTemplateAtScope("myScope", 
 "JMSTest", "First Example WAS 
 TopicConnectionFactory(templates/system|JMS-resource-provider-templates.xml#WASTopicConnectionFactory_1)", 
 "TopicCFTest", "topiccfjndi", "DIRECT")

The following example script includes optional attributes in a string format: 

AdminJMS.createWASTopicConnectionFactoryUsingTemplateAtScope
("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "First Example WAS TopicConnectionFactory
(templates/system|JMS-resource-provider-templates.xml#WASTopicConnectionFactory_1)", 
"My WASTopicConnectionFactory", "JNDIName", "DIRECT", “XAEnabled=false, authDataAlias=myAuthDataAlias,
 authMechanismPreference=BASIC_PASSWORD, 
category=myCategory, clientID=myClientID, cloneSupport=true, description='My description',
 diagnoseConnectionUsage=false, 
logMissingTransactionContext=true, manageCachedHandles=true, providerType=myProviderType, 
xaRecoveryAuthAlias=myCellManager01/a1”)

The following example script includes optional attributes in a list format: 

AdminJMS.createWASTopicConnectionFactoryUsingTemplateAtScope
("Cell=IBM-F4A849C57A0Cell01,Node=IBM-F4A849C57A0Node01,Server=server1", 
"My JMS Provider Name1", "First Example WAS TopicConnectionFactory
(templates/system|JMS-resource-provider-templates.xml#WASTopicConnectionFactory_1)", 
"My WASTopicConnectionFactory", "JNDIName", "'DIRECT'", [['XAEnabled', 'false'], 
['authDataAlias', 'myAuthDataAlias'], 
['authMechanismPreference', 'BASIC_PASSWORD'], ['category', 'myCategory'], ['clientID', 'myClientID'], 
['cloneSupport', 'true'], 
['connectionPool', [['agedTimeout', '100'], ['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], 
['maxConnections', '12'], ['minConnections', '5'], ['numberOfFreePoolPartitions', '3'], 
['numberOfSharedPoolPartitions', '6'], 
['numberOfUnsharedPoolPartitions', '3'], ['properties', [[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], 
['validationExpression', ''], ['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], 
['reapTime', '10000'], ['surgeThreshold', '10'], 
['testConnection', 'true']]], ['description', 'My description'], ['diagnoseConnectionUsage', 'false'], 
['logMissingTransactionContext', 'true'], 
['manageCachedHandles', 'true'], ['mapping', [['authDataAlias', 'authDataAliasValue'], 
['mappingConfigAlias', 'mappingConfigAliasValue']]], 
['preTestConfig', [['preTestConnection', 'true'], ['retryInterval', '12343'], ['retryLimit', '4']]],
 ['properties', [[['description', 'My description'], 
['name', 'myName'], ['required', 'false'], ['validationExpression', ''], ['value', 'myValue']]]], 
['propertySet', 
[['resourceProperties', [[['name', 'databaseName'], ['type', 'java.lang.String'], ['value', 'myDbName']], 
[['name', 'driverType'], 
['type', 'java.lang.Integer'], ['value', 4]], [['name', 'serverName'], ['type', 'java.lang.String'], 
['value', 'localhost']], 
[['name', 'portNumber'], ['type', 'java.lang.Integer'], ['value', 50000]]]]]], ['providerType', 'myProviderType'], 
['sessionPool', 
[['agedTimeout', '100'], ['connectionTimeout', '1000'], ['freePoolDistributionTableSize', 10], 
['maxConnections', '12'], 
['minConnections', '5'], ['numberOfFreePoolPartitions', '3'], ['numberOfSharedPoolPartitions', '6'], 
['numberOfUnsharedPoolPartitions', '3'], 
['properties', [[['description', 'My description'], ['name', 'myName'], ['required', 'false'],
 ['validationExpression', ''], 
['value', 'myValue']]]], ['purgePolicy', 'EntirePool'], ['reapTime', '10000'], ['surgeThreshold', '10'],
 ['testConnection', 'true']]], 
['xaRecoveryAuthAlias', 'myCellManager01/a1']] )


createSIBJMSConnectionFactory

The script creates a new SIB JMS connection factory for the default messaging provider at the scope specified. The script returns the configuration ID of the created SIB JMS connection factory.

To run the script, specify the scope, name, JNDI name, and bus name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createSIBJMSConnectionFactory script. Run the script to create a JMS connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
name Administrative name assigned to this connection factory.
jndiName Specifies the JNDI name specified in the bindings for message-driven beans associated with this connection factory.
busName Name of the service integration bus to which connections are made.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description
authDataAlias User ID and password to be used to authenticate connections to the JMS provider for application-managed authentication.
containerAuthAlias Container managed authentication alias, from which security credentials are used to establish a connection to the JMS provider.
mappingAlias Specifies the JAAS mapping alias to use when determining the security related credentials. The security related credentials are used when establishing a connection to the JMS provider.
xaRecoveryAuthAlias Authentication alias used during XA recovery processing.
category Category that can be used to classify or group the connection factory
description Description of the connection factory.
logMissingTransactionContext Whether missing transaction context logging is enabled.
manageCachedHandles Whether cached handles , which are handles held in instance variables in a bean, are tracked by the container
clientID Client ID which is required only for durable subscriptions.
userName User name used to create connections from the connection factory.
password Password used to create connections from the connection factory.
nonPersistentMapping Specifies a non-persistent mapping value. Valid values are BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent, AsSIBDestination, and None.
persistentMapping Specifies a persistent mapping value. Valid values are BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent, AsSIBDestinationand None.
durableSubscriptionHome Durable subscription home value.
readAhead Specifies the read-ahead value. Valid values are Default, AlwaysOn, and AlwaysOff.
target Name of a target that resolves to a group of messaging engines.
targetType Type of the name in the target parameter. Valid values are BusMember, Custom, and ME.
targetSignificance Significance of the target group. Valid values are Preferred and Required.
targetTransportChain Name of the protocol that to connect to a remote messaging engine.
providerEndPoints Comma-separated list of endpoint triplets of the form host:port:chain.
connectionProximity Proximity of acceptable messaging engines. Valid values are Bus, Host, Cluster, and Server.
tempQueueNamePrefix Specifies a temporary queue name prefix.
tempTopicNamePrefix Specifies a temporary topic name prefix.
shareDataSourceWithCMP How to control data sources that are shared.
shareDurableSubscriptions How to control durable subscriptions that are shared. Valid values are InCluster, AlwaysShared, and NeverShared.
consumerDoesNotModifyPayloadAfterGet When a message consuming application receives object or byte messages, the system serializes the message data only when necessary. The application is connected to the bus using this connection factory. Applications that obtain the data from these messages must treat the data as read-only data. Valid values are true and false. Default is false.
producerDoesNotModifyPayloadAfterSet When a message consuming application sends object or byte messages, the data is not copied and the system serializes the data only when necessary. The application is connected to the bus using this connection factory. Applications sending such messages must not modify the data after it has been set in a message. Valid values are true and false. Default is false.

Syntax 

AdminJMS.createSIBJMSConnectionFactory(scope, 
 name, jndiName, 
 busName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createSIBJMSConnectionFactory("myScope", "myName", "myJNDIName", 
"MyBusName")

The following example script includes optional attributes in a string format: 

AdminJMS.createWMQConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName2", "readAhead=AlwaysOff,description=my description")

The following example script includes optional attributes in a list format: 

AdminJMS.createSIBJMSConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", "myName"
, "myJndiName1", "myBusName", [['readAhead', 'AlwaysOff'], ['description', 'my description']])


createWMQConnectionFactory

The script creates a connection factory for the WebSphere MQ messaging provider at the scope specified. The script returns the configuration ID of the created WebSphere MQ connection factory.

To run the script, specify the scope, name, and JNDI name, arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWMQConnectionFactory script. Run the script to create a connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
name Administrative name assigned to this WebSphere MQ messaging provider connection factory.
jndiName Name and location used to bind this object into WAS JNDI.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description
maxBatchSize Maximum number of messages to take from a queue in one packet when using asynchronous message delivery.
brokerCCSubQueue Name of the queue from which non-durable subscription messages are retrieved for a connection consumer. This parameter is valid only for topic connection factories.
brokerCtrlQueue Broker control queue to use if this connection factory is to subscribe to a topic. This parameter is valid only for topic connection factories.
brokerQmgr Name of the queue manager on which the queue manager is running. This parameter is valid only for topic connection factories.
brokerSubQueue Specifies the queue for obtaining subscription messages if this connection factory subscribes to a topic. This parameter is valid only for topic connection factories.
brokerVersion Level of functionality required for publish and subscribe operations. This parameter is valid only for topic connection factories.
brokerPubQueue Specifies the queue to send publication messages to when using queue based brokering. This parameter is valid only for topic connection factories.
ccdtQmgrName Specifies a queue manager name used to select one or more entries from a client channel definition table.
ccdtUrl Specifies a URL to a client channel definition table. Use this attribute for this connection factory, when contacting the WebSphere MQ messaging provider. Connection factories created using this attribute are ccdtURL connection factories.
ccsid Coded character set ID to use on connections.
cleanupInterval Interval between background executions of the publish and subscribe cleanup utility. This parameter is valid only for topic connection factories.
cleanupLevel Cleanup Level for BROKER or MIGRATE subscription stores. This parameter is valid only for topic connection factories.
clientId Client identifier used for connections started using this connection factory.
clonedSubs Whether two or more instances of the same durable topic subscriber can run simultaneously. This parameter is valid only for topic connection factories.
compressHeaders Determines if message headers are compressed or not.
compressPayload Determines if message payloads are compressed or not.
containerAuthAlias Container managed authentication alias that has security credentials used for establishing a connection to the WebSphere MQ messaging provider.
description Description of the connection factory.
failIfQuiescing Behavior of certain calls to the queue manager when the queue manager is put into a quiescent state.
localAddress Specifies either or both of the following items:

  • The local network interface to be used.
  • The local port, or range of local ports, to be used.

mappingAlias Specifies the JAAS mapping alias to use when determining the security related credentials. The security related credentials are used when establishing a connection to the WebSphere MQ.
modelQueue Specifies the WebSphere MQ model queue definition to use as a basis when creating JMS temporary destinations. This parameter is valid only for queue connection factories.
msgRetention Whether the connection consumer keeps unwanted messages on the input queue. A value of true means that it does. A value of false means the messages are disposed of based on their disposition options. This parameter is valid only for queue connection factories.
msgSelection Where message selection occurs. This parameter is valid only for topic connection factories.
pollingInterval Specifies in milliseconds the maximum time that elapses during a polling interval. If a message listener within a session has no suitable message on its queue, the message listener uses the polling interval to determine how often to poll its queue for a message. Increase the value for this property if sessions frequently do not have a suitable message available. This attribute is applicable only in the client container.
providerVersion Minimum version and capabilities of the queue manager.
pubAckInterval Number of publications to send to a queue based broker before sending a publication which solicits an acknowledgement. This attribute is valid only for topic connection factories.
qmgrHostname Specifies the hostname that this connection factory uses when attempting a client mode connection to WebSphere MQ.
qmgrName Specifies the queue manager name that this connection factory uses when contacting the WebSphere MQ messaging provider. Connection factories created using this parameter are user-defined connection factories.
qmgrPortNumber Port number that this connection factory uses when attempting a client mode connection to WebSphere MQ.
qmgrSvrconnChannel SVRCONN channel to use when connecting to WebSphere MQ. Connection factories created using this parameter are user-defined connection factories.
rcvExitInitData Specifies initialization data to pass to the receive exit.
rcvExit Comma separated list of receive exit class names.
replyWithRFH2 Whether, when replying to a message, an RFH version 2 header is included in the reply message. This parameter is valid only for queue connection factories.
rescanInterval Specifies in milliseconds the maximum time that elapses during a scanning interval. When a message consumer in the point-to-point domain uses a message selector to select which messages it wants to receive, the WebSphere MQ JMS client searches the WebSphere MQ queue for suitable messages in the sequence determined by the MsgDeliverySequence attribute of the queue. When the client finds a suitable message and delivers it to the consumer, the client resumes the search for the next suitable message from its current position in the queue. The client continues to search the queue until it reaches the end of the queue, or until the interval of time specified by this property has expired. In each case, the client returns to the beginning of the queue to continue its search, and a new time interval starts. This parameter is only valid for queue connection factories.
secExitInitData Specifies initialization data to pass to the security exit.
secExit Comma separated list of security exit class names.
sendExitInitData Specifies initialization data to pass to the send exit.
sendExit Comma separated list of send exit class names.
sparseSubs Message retrieval policy of a TopicSubscriber object. This parameter is only valid for topic connection factories.
sslConfiguration Specifies a specific SSL configuration to secure network connections to the queue manager.
sslCrl List of LDAP servers which can be used to provide certificate revocation information if this connection factory establishes an SSL connection to WebSphere MQ.
sslPeerName Specifies a peer name to match against the distinguished name in the peer certificate. This attribute is used when the connection factory establishes an SSL connection to the queue manager.
sslResetCount Number of bytes to transfer before resetting the symmetric encryption key used for the SSL session. This attribute is used when the connection factory establishes an SSL connection to the queue manager.
sslType Configuration, if any, when the connection factory establishes an SSL connection to the queue manager.
stateRefreshInt Specifies in milliseconds the maximum time that elapses between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This property is relevant only if subStore attribute has the value QUEUE. This attribute is valid only for topic connection factories.
subStore Specifies that WebSphere MQ JMS stores persistent data relating to active subscriptions. This attribute is valid only for topic connection factories.
support2PCProtocol Whether the connection factory acts as a resource which is capable of participating in distributed two phase commit processing.
tempQueuePrefix Prefix to apply to WebSphere MQ temporary queues. These temporary queues represent JMS temporary queue type destinations. This attribute is valid only for queue connection factories.
tempTopicPrefix Prefix to apply to WebSphere MQ temporary topics. These temporary topics represent JMS temporary topic type destinations. This attribute is valid only for topic connection factories.
wildcardFormat Which sets of characters are interpreted as topic wild cards. This attribute is valid only for topic connection factories.
wmqTransportType How this connection factory connects to WebSphere MQ. Connection factories created using this attribute are user-defined. Valid values are BINDINGS, BINDINGS_THEN_CLIENT, and CLIENT.
xaRecoveryAuthAlias Authentication alias to connect to WebSphere MQ for XA recovery.

Syntax 

AdminJMS.createWMQConnectionFactory(scope, 
 name, jndiName, 
 attributes)

Example usage

The following example script contains required attributes only:

The following example script includes optional attributes in a string format: 

AdminJMS.createWMQConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName2", "maxBatchSize=15,description=my description")

The following example script includes optional attributes in a list format: 

AdminJMS.createWMQConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName2", [['maxBatchSize', '15'], ['description', 'my description']])


createSIBJMSQueueConnectionFactory

The script creates a new SIB JMS queue connection factory for the default messaging provider at the scope specified. The script returns the configuration ID of the created SIB JMS queue connection factory.

To run the script, specify the scope, name, JNDI name, and bus name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createSIBJMSQueueConnectionFactory script. Run the script to create a JMS queue connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
name Administrative name assigned to this connection factory.
jndiName Specifies the JNDI name specified in the bindings for message-driven beans associated with this connection factory.
busName Name of the service integration bus to which connections are made.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description
authDataAlias User ID and password to be used to authenticate connections to the JMS provider for application-managed authentication.
containerAuthAlias Container managed authentication alias, from which security credentials are used to establish a connection to the JMS provider.
mappingAlias Specifies the JAAS mapping alias to use when determining the security related credentials. The security related credentials are used when establishing a connection to the JMS provider.
xaRecoveryAuthAlias Authentication alias used during XA recovery processing.
category Category that can be used to classify or group the connection factory
description Description of the connection factory.
logMissingTransactionContext Whether missing transaction context logging is enabled.
manageCachedHandles Whether cached handles , which are handles held in instance variables in a bean, are tracked by the container
clientID Client ID which is required only for durable subscriptions.
userName User name used to create connections from the connection factory.
password Password used to create connections from the connection factory.
nonPersistentMapping Specifies a non-persistent mapping value. Valid values are BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent, AsSIBDestination, and None.
persistentMapping Specifies a persistent mapping value. Valid values are BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent, AsSIBDestinationand None.
durableSubscriptionHome Durable subscription home value.
readAhead Specifies the read-ahead value. Valid values are Default, AlwaysOn, and AlwaysOff.
target Name of a target that resolves to a group of messaging engines.
targetType Type of the name in the target parameter. Valid values are BusMember, Custom, and ME.
targetSignificance Significance of the target group. Valid values are Preferred and Required.
targetTransportChain Name of the protocol that to connect to a remote messaging engine.
providerEndPoints Comma-separated list of endpoint triplets of the form host:port:chain.
connectionProximity Proximity of acceptable messaging engines. Valid values are Bus, Host, Cluster, and Server.
tempQueueNamePrefix Specifies a temporary queue name prefix.
tempTopicNamePrefix Specifies a temporary topic name prefix.
shareDataSourceWithCMP How to control data sources that are shared.
shareDurableSubscriptions How to control durable subscriptions that are shared. Valid values are InCluster, AlwaysShared, and NeverShared.
consumerDoesNotModifyPayloadAfterGet When a message consuming application receives object or byte messages, the system serializes the message data only when necessary. The application is connected to the bus using this connection factory. Applications that obtain the data from these messages must treat the data as read-only data. Valid values are true and false. Default is false.
producerDoesNotModifyPayloadAfterSet When a message consuming application sends object or byte messages, the data is not copied and the system serializes the data only when necessary. The application is connected to the bus using this connection factory. Applications sending such messages must not modify the data after it has been set in a message. Valid values are true and false. Default is false.

Syntax 

AdminJMS.createSIBJMSQueueConnectionFactory(scope, 
 name, jndiName, 
 busName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createSIBJMSQueueConnectionFactory("myScope", "myName", "myJNDIName", 
"MyBusName")

The following example script includes optional attributes in a string format: 

AdminJMS.createSIBJMSQueueConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", "myName" , 
"myJndiName3", "myBusName", "readAhead=AlwaysOff,description=my description")

The following example script includes optional attributes in a list format: 

AdminJMS.createSIBJMSQueueConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", "myName" , 
"myJndiName3", "myBusName", [['readAhead', 'AlwaysOff'], ['description', 'my description']])


createWMQQueueConnectionFactory

The script creates a queue connection factory for the WebSphere MQ messaging provider at the scope specified. The script returns the configuration ID of the created WebSphere MQ queue connection factory.

To run the script, specify the scope, name, and JNDI name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWMQQueueConnectionFactory script. Run the script to create a queue connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
name Administrative name assigned to this WebSphere MQ messaging provider connection factory.
jndiName Name and location used to bind this object into WAS JNDI.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description
maxBatchSize Maximum number of messages to take from a queue in one packet when using asynchronous message delivery.
brokerCCSubQueue Name of the queue from which non-durable subscription messages are retrieved for a connection consumer. This parameter is valid only for topic connection factories.
brokerCtrlQueue Broker control queue to use if this connection factory is to subscribe to a topic. This parameter is valid only for topic connection factories.
brokerQmgr Name of the queue manager on which the queue manager is running. This parameter is valid only for topic connection factories.
brokerSubQueue Specifies the queue for obtaining subscription messages if this connection factory subscribes to a topic. This parameter is valid only for topic connection factories.
brokerVersion Level of functionality required for publish and subscribe operations. This parameter is valid only for topic connection factories.
brokerPubQueue Specifies the queue to send publication messages to when using queue based brokering. This parameter is valid only for topic connection factories.
ccdtQmgrName Specifies a queue manager name used to select one or more entries from a client channel definition table.
ccdtUrl Specifies a URL to a client channel definition table. Use this attribute for this connection factory, when contacting the WebSphere MQ messaging provider. Connection factories created using this attribute are ccdtURL connection factories.
ccsid Coded character set ID to use on connections.
cleanupInterval Interval between background executions of the publish and subscribe cleanup utility. This parameter is valid only for topic connection factories.
cleanupLevel Cleanup Level for BROKER or MIGRATE subscription stores. This parameter is valid only for topic connection factories.
clientId Client identifier used for connections started using this connection factory.
clonedSubs Whether two or more instances of the same durable topic subscriber can run simultaneously. This parameter is valid only for topic connection factories.
compressHeaders Determines if message headers are compressed or not.
compressPayload Determines if message payloads are compressed or not.
containerAuthAlias Container managed authentication alias that has security credentials used for establishing a connection to the WebSphere MQ messaging provider.
description Description of the connection factory.
failIfQuiescing Behavior of certain calls to the queue manager when the queue manager is put into a quiescent state.
localAddress Specifies either or both of the following items:

  • The local network interface to be used.
  • The local port, or range of local ports, to be used.

mappingAlias Specifies the JAAS mapping alias to use when determining the security related credentials. The security related credentials are used when establishing a connection to the WebSphere MQ.
modelQueue Specifies the WebSphere MQ model queue definition to use as a basis when creating JMS temporary destinations. This parameter is valid only for queue connection factories.
msgRetention Whether the connection consumer keeps unwanted messages on the input queue. A value of true means that it does. A value of false means the messages are disposed of based on their disposition options. This parameter is valid only for queue connection factories.
msgSelection Where message selection occurs. This parameter is valid only for topic connection factories.
pollingInterval Specifies in milliseconds the maximum time that elapses during a polling interval. If a message listener within a session has no suitable message on its queue, the message listener uses the polling interval to determine how often to poll its queue for a message. Increase the value for this property if sessions frequently do not have a suitable message available. This attribute is applicable only in the client container.
providerVersion Minimum version and capabilities of the queue manager.
pubAckInterval Number of publications to send to a queue based broker before sending a publication which solicits an acknowledgement. This attribute is valid only for topic connection factories.
qmgrHostname Specifies the hostname that this connection factory uses when attempting a client mode connection to WebSphere MQ.
qmgrName Specifies the queue manager name that this connection factory uses when contacting the WebSphere MQ messaging provider. Connection factories created using this parameter are user-defined connection factories.
qmgrPortNumber Port number that this connection factory uses when attempting a client mode connection to WebSphere MQ.
qmgrSvrconnChannel SVRCONN channel to use when connecting to WebSphere MQ. Connection factories created using this parameter are user-defined connection factories.
rcvExitInitData Specifies initialization data to pass to the receive exit.
rcvExit Comma separated list of receive exit class names.
replyWithRFH2 Whether, when replying to a message, an RFH version 2 header is included in the reply message. This parameter is valid only for queue connection factories.
rescanInterval Specifies in milliseconds the maximum time that elapses during a scanning interval. When a message consumer in the point-to-point domain uses a message selector to select which messages it wants to receive, the WebSphere MQ JMS client searches the WebSphere MQ queue for suitable messages in the sequence determined by the MsgDeliverySequence attribute of the queue. When the client finds a suitable message and delivers it to the consumer, the client resumes the search for the next suitable message from its current position in the queue. The client continues to search the queue until it reaches the end of the queue, or until the interval of time specified by this property has expired. In each case, the client returns to the beginning of the queue to continue its search, and a new time interval starts. This parameter is only valid for queue connection factories.
secExitInitData Specifies initialization data to pass to the security exit.
secExit Comma separated list of security exit class names.
sendExitInitData Specifies initialization data to pass to the send exit.
sendExit Comma separated list of send exit class names.
sparseSubs Message retrieval policy of a TopicSubscriber object. This parameter is only valid for topic connection factories.
sslConfiguration Specifies a specific SSL configuration to secure network connections to the queue manager.
sslCrl List of LDAP servers which can be used to provide certificate revocation information if this connection factory establishes an SSL connection to WebSphere MQ.
sslPeerName Specifies a peer name to match against the distinguished name in the peer certificate. This attribute is used when the connection factory establishes an SSL connection to the queue manager.
sslResetCount Number of bytes to transfer before resetting the symmetric encryption key used for the SSL session. This attribute is used when the connection factory establishes an SSL connection to the queue manager.
sslType Configuration, if any, when the connection factory establishes an SSL connection to the queue manager.
stateRefreshInt Specifies in milliseconds the maximum time that elapses between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This property is relevant only if subStore attribute has the value QUEUE. This attribute is valid only for topic connection factories.
subStore Specifies that WebSphere MQ JMS stores persistent data relating to active subscriptions. This attribute is valid only for topic connection factories.
support2PCProtocol Whether the connection factory acts as a resource which is capable of participating in distributed two phase commit processing.
tempQueuePrefix Prefix to apply to WebSphere MQ temporary queues. These temporary queues represent JMS temporary queue type destinations. This attribute is valid only for queue connection factories.
tempTopicPrefix Prefix to apply to WebSphere MQ temporary topics. These temporary topics represent JMS temporary topic type destinations. This attribute is valid only for topic connection factories.
wildcardFormat Which sets of characters are interpreted as topic wild cards. This attribute is valid only for topic connection factories.
wmqTransportType How this connection factory connects to WebSphere MQ. Connection factories created using this attribute are user-defined. Valid values are BINDINGS, BINDINGS_THEN_CLIENT, and CLIENT.
xaRecoveryAuthAlias Authentication alias to connect to WebSphere MQ for XA recovery.

Syntax 

AdminJMS.createWMQQueueConnectionFactory(scope, 
 name, jndiName, 
 attributes)

Example usage

The following example script contains required attributes only:

The following example script includes optional attributes in a string format: 

AdminJMS.createWMQQueueConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", "myName
" , "myJndiName4", "maxBatchSize=15,description=my description")

The following example script includes optional attributes in a list format: 

AdminJMS.createWMQQueueConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName4", [['maxBatchSize', '15'], ['description', 'my description']])


createSIBJMSTopicConnectionFactory

The script creates a new SIB JMS topic connection factory for the default messaging provider at the scope specified. The script returns the configuration ID of the created SIB JMS topic connection factory.

To run the script, specify the scope, name, JNDI name, and bus name arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createSIBJMSTopicConnectionFactory script. Run the script to create a SIB JMS topic connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
name Administrative name assigned to this connection factory.
jndiName Specifies the JNDI name specified in the bindings for message-driven beans associated with this connection factory.
busName Name of the service integration bus to which connections are made.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description
authDataAlias User ID and password to be used to authenticate connections to the JMS provider for application-managed authentication.
containerAuthAlias Container managed authentication alias, from which security credentials are used to establish a connection to the JMS provider.
mappingAlias Specifies the JAAS mapping alias to use when determining the security related credentials. The security related credentials are used when establishing a connection to the JMS provider.
xaRecoveryAuthAlias Authentication alias used during XA recovery processing.
category Category that can be used to classify or group the connection factory
description Description of the connection factory.
logMissingTransactionContext Whether missing transaction context logging is enabled.
manageCachedHandles Whether cached handles , which are handles held in instance variables in a bean, are tracked by the container
clientID Client ID which is required only for durable subscriptions.
userName User name used to create connections from the connection factory.
password Password used to create connections from the connection factory.
nonPersistentMapping Specifies a non-persistent mapping value. Valid values are BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent, AsSIBDestination, and None.
persistentMapping Specifies a persistent mapping value. Valid values are BestEffortNonPersistent, ExpressNonPersistent, ReliableNonPersistent, ReliablePersistent, AssuredPersistent, AsSIBDestinationand None.
durableSubscriptionHome Durable subscription home value.
readAhead Specifies the read-ahead value. Valid values are Default, AlwaysOn, and AlwaysOff.
target Name of a target that resolves to a group of messaging engines.
targetType Type of the name in the target parameter. Valid values are BusMember, Custom, and ME.
targetSignificance Significance of the target group. Valid values are Preferred and Required.
targetTransportChain Name of the protocol that to connect to a remote messaging engine.
providerEndPoints Comma-separated list of endpoint triplets of the form host:port:chain.
connectionProximity Proximity of acceptable messaging engines. Valid values are Bus, Host, Cluster, and Server.
tempQueueNamePrefix Specifies a temporary queue name prefix.
tempTopicNamePrefix Specifies a temporary topic name prefix.
shareDataSourceWithCMP How to control data sources that are shared.
shareDurableSubscriptions How to control durable subscriptions that are shared. Valid values are InCluster, AlwaysShared, and NeverShared.
consumerDoesNotModifyPayloadAfterGet When a message consuming application receives object or byte messages, the system serializes the message data only when necessary. The application is connected to the bus using this connection factory. Applications that obtain the data from these messages must treat the data as read-only data. Valid values are true and false. Default is false.
producerDoesNotModifyPayloadAfterSet When a message consuming application sends object or byte messages, the data is not copied and the system serializes the data only when necessary. The application is connected to the bus using this connection factory. Applications sending such messages must not modify the data after it has been set in a message. Valid values are true and false. Default is false.

Syntax 

AdminJMS.createSIBJMSTopicConnectionFactory(scope, 
 name, jndiName, 
 busName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createSIBJMSTopicConnectionFactory("myScope", "myName", "myJNDIName", 
"MyBusName")

The following example script includes optional attributes in a string format: 

AdminJMS.createSIBJMSTopicConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName5", "myBusName", "readAhead=AlwaysOff,description=my description")

The following example script includes optional attributes in a list format: 

AdminJMS.createSIBJMSTopicConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName5", "myBusName", [['readAhead', 'AlwaysOff'], ['description', 'my description']])


createWMQTopicConnectionFactory

The script creates a topic connection factory for the WebSphere MQ messaging provider at the scope specified. The script returns the configuration ID of the created WebSphere MQ topic connection factory.

To run the script, specify the scope, name, and JNDI name, arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWMQTopicConnectionFactory script. Run the script to create a topic connection factory.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the JMS provider.
name Administrative name assigned to this WebSphere MQ messaging provider connection factory.
jndiName Name and location used to bind this object into WAS JNDI.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description
maxBatchSize Maximum number of messages to take from a queue in one packet when using asynchronous message delivery.
brokerCCSubQueue Name of the queue from which non-durable subscription messages are retrieved for a connection consumer. This parameter is valid only for topic connection factories.
brokerCtrlQueue Broker control queue to use if this connection factory is to subscribe to a topic. This parameter is valid only for topic connection factories.
brokerQmgr Name of the queue manager on which the queue manager is running. This parameter is valid only for topic connection factories.
brokerSubQueue Specifies the queue for obtaining subscription messages if this connection factory subscribes to a topic. This parameter is valid only for topic connection factories.
brokerVersion Level of functionality required for publish and subscribe operations. This parameter is valid only for topic connection factories.
brokerPubQueue Specifies the queue to send publication messages to when using queue based brokering. This parameter is valid only for topic connection factories.
ccdtQmgrName Specifies a queue manager name used to select one or more entries from a client channel definition table.
ccdtUrl Specifies a URL to a client channel definition table. Use this attribute for this connection factory, when contacting the WebSphere MQ messaging provider. Connection factories created using this attribute are ccdtURL connection factories.
ccsid Coded character set ID to use on connections.
cleanupInterval Interval between background executions of the publish and subscribe cleanup utility. This parameter is valid only for topic connection factories.
cleanupLevel Cleanup Level for BROKER or MIGRATE subscription stores. This parameter is valid only for topic connection factories.
clientId Client identifier used for connections started using this connection factory.
clonedSubs Whether two or more instances of the same durable topic subscriber can run simultaneously. This parameter is valid only for topic connection factories.
compressHeaders Determines if message headers are compressed or not.
compressPayload Determines if message payloads are compressed or not.
containerAuthAlias Container managed authentication alias that has security credentials used for establishing a connection to the WebSphere MQ messaging provider.
description Description of the connection factory.
failIfQuiescing Behavior of certain calls to the queue manager when the queue manager is put into a quiescent state.
localAddress Specifies either or both of the following items:

  • The local network interface to be used.
  • The local port, or range of local ports, to be used.

mappingAlias Specifies the JAAS mapping alias to use when determining the security related credentials. The security related credentials are used when establishing a connection to the WebSphere MQ.
modelQueue Specifies the WebSphere MQ model queue definition to use as a basis when creating JMS temporary destinations. This parameter is valid only for queue connection factories.
msgRetention Whether the connection consumer keeps unwanted messages on the input queue. A value of true means that it does. A value of false means the messages are disposed of based on their disposition options. This parameter is valid only for queue connection factories.
msgSelection Where message selection occurs. This parameter is valid only for topic connection factories.
pollingInterval Specifies in milliseconds the maximum time that elapses during a polling interval. If a message listener within a session has no suitable message on its queue, the message listener uses the polling interval to determine how often to poll its queue for a message. Increase the value for this property if sessions frequently do not have a suitable message available. This attribute is applicable only in the client container.
providerVersion Minimum version and capabilities of the queue manager.
pubAckInterval Number of publications to send to a queue based broker before sending a publication which solicits an acknowledgement. This attribute is valid only for topic connection factories.
qmgrHostname Specifies the hostname that this connection factory uses when attempting a client mode connection to WebSphere MQ.
qmgrName Specifies the queue manager name that this connection factory uses when contacting the WebSphere MQ messaging provider. Connection factories created using this parameter are user-defined connection factories.
qmgrPortNumber Port number that this connection factory uses when attempting a client mode connection to WebSphere MQ.
qmgrSvrconnChannel SVRCONN channel to use when connecting to WebSphere MQ. Connection factories created using this parameter are user-defined connection factories.
rcvExitInitData Specifies initialization data to pass to the receive exit.
rcvExit Comma separated list of receive exit class names.
replyWithRFH2 Whether, when replying to a message, an RFH version 2 header is included in the reply message. This parameter is valid only for queue connection factories.
rescanInterval Specifies in milliseconds the maximum time that elapses during a scanning interval. When a message consumer in the point-to-point domain uses a message selector to select which messages it wants to receive, the WebSphere MQ JMS client searches the WebSphere MQ queue for suitable messages in the sequence determined by the MsgDeliverySequence attribute of the queue. When the client finds a suitable message and delivers it to the consumer, the client resumes the search for the next suitable message from its current position in the queue. The client continues to search the queue until it reaches the end of the queue, or until the interval of time specified by this property has expired. In each case, the client returns to the beginning of the queue to continue its search, and a new time interval starts. This parameter is only valid for queue connection factories.
secExitInitData Specifies initialization data to pass to the security exit.
secExit Comma separated list of security exit class names.
sendExitInitData Specifies initialization data to pass to the send exit.
sendExit Comma separated list of send exit class names.
sparseSubs Message retrieval policy of a TopicSubscriber object. This parameter is only valid for topic connection factories.
sslConfiguration Specifies a specific SSL configuration to secure network connections to the queue manager.
sslCrl List of LDAP servers which can be used to provide certificate revocation information if this connection factory establishes an SSL connection to WebSphere MQ.
sslPeerName Specifies a peer name to match against the distinguished name in the peer certificate. This attribute is used when the connection factory establishes an SSL connection to the queue manager.
sslResetCount Number of bytes to transfer before resetting the symmetric encryption key used for the SSL session. This attribute is used when the connection factory establishes an SSL connection to the queue manager.
sslType Configuration, if any, when the connection factory establishes an SSL connection to the queue manager.
stateRefreshInt Specifies in milliseconds the maximum time that elapses between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This property is relevant only if subStore attribute has the value QUEUE. This attribute is valid only for topic connection factories.
subStore Specifies that WebSphere MQ JMS stores persistent data relating to active subscriptions. This attribute is valid only for topic connection factories.
support2PCProtocol Whether the connection factory acts as a resource which is capable of participating in distributed two phase commit processing.
tempQueuePrefix Prefix to apply to WebSphere MQ temporary queues. These temporary queues represent JMS temporary queue type destinations. This attribute is valid only for queue connection factories.
tempTopicPrefix Prefix to apply to WebSphere MQ temporary topics. These temporary topics represent JMS temporary topic type destinations. This attribute is valid only for topic connection factories.
wildcardFormat Which sets of characters are interpreted as topic wild cards. This attribute is valid only for topic connection factories.
wmqTransportType How this connection factory connects to WebSphere MQ. Connection factories created using this attribute are user-defined. Valid values are BINDINGS, BINDINGS_THEN_CLIENT, and CLIENT.
xaRecoveryAuthAlias Authentication alias to connect to WebSphere MQ for XA recovery.

Syntax 

AdminJMS.createWMQTopicConnectionFactory(scope, 
 name, jndiName, 
 attributes)

Example usage

The following example script contains required attributes only:

The following example script includes optional attributes in a string format: 

AdminJMS.createWMQTopicConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName6", "maxBatchSize=15,description=my description")

The following example script includes optional attributes in a list format: 

AdminJMS.createWMQTopicConnectionFactory
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName6", [['maxBatchSize', '15'], ['description', 'my description']])


createSIBJMSActivationSpec

This script creates a new JMS activation specification for the default messaging provider at the scope specified. The script returns the configuration ID of the created SIB JMS activation specification.

To run the script, specify the scope, activation specification name, JNDI name, and the JNDI name destination arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createSIBJMSActivationSpec script. Run the script to create a JMS activation specification.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the default messaging provider at which the JMS activation specification is to be created.
name Name assigned to this activation specification.
jndiName Specifies the JNDI name specified in the bindings for message-driven beans associated with this activation specification.
destinationJndiName Specifies the JNDI name of the destination JMS queue or topic the message-driven bean uses.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description
description Specifies the JMS activation specification the default messaging provider uses to validate the activation-configuration properties for a JMS MDB.
acknowledgeMode How the session acknowledges any messages it receives.
authenticationAlias Name of a J2C authentication alias used for component-managed authentication of connections to the service integration bus.
busName Name of the service integration bus to which connections are made.
clientId Specifies the JMS client identifier. The client identifier is required for durable topic subscriptions.
destinationType Whether the message-driven bean uses a queue or topic destination.
durableSubscriptionHome Name of the durable subscription home. This attribute identifies the messaging engine where all durable subscriptions accessed through this activation specification are managed.
maxBatchSize Maximum number of messages received from the messaging engine in a single batch.
maxConcurrency Maximum number of endpoints to which messages are delivered concurrently.
messageSelector Specifies the JMS message selector used to determine which messages the MDB receives.
password Password for Java 2 connector security to use.
subscriptionDurability Whether a JMS topic subscription is durable or nondurable.
subscriptionName Subscription name needed for durable topic subscriptions.
shareDurableSubscriptions How durable subscriptions are shared.
userName User identify for the Java 2 connector security to use.
readAhead Specifies the read-ahead value. Valid values are Default, AlwaysOn, and AlwaysOff.
target New target value of the SIB JMS activation specification.
targetType New target value of the SIB JMS activation specification. Valid values are BusMember, Custom, and ME.
targetSignificance Significance of the target group.
targetTransportChain Name of the protocol that used to connect to a remote messaging engine.
providerEndPoints Comma-separated list of endpoint triplets of the form host:port:chain.
shareDataSourceWithCMP How data sources are shared.
consumerDoesNotModifyPayloadAfterGet Specifies, when enabled, that object messages received through this activation specification only have their message data serialized by the system when necessary. Applications that obtain data from these messages must be treated as read-only. Valid values are true and false. The default is false.
forwarderDoesNotModifyPayloadAfterSet Specifies, when enabled, that object or byte messages forwarded through this activation specification that have their payload modified will not have the data copied when the data is sent in the message. The system serializes the message data only when necessary. Applications sending such messages must not modify the data after they send it in the message. Valid values are true and false. The default is false.
alwaysActivateAllMDBs Specifies the MDB server-selection rule. The rule determines which servers can drive MDBs deployed to them. Valid values are true and false. The default is false. Specify true to activate MDBs in all servers. Otherwise, only servers with a running messaging engine are used.
retryInterval Delay in seconds between attempts to connect to a messaging engine, both for the initial connection and for any subsequent attempts to establish a better connection. The default is 30. The delay must be greater than zero.
autoStopSequentialMessageFailure The endpoint is stopped when the number of sequentially failing messages reaches the configured limit. Due to processing dependencies in the MDB, the actual number of messages processed might exceed this value.
failingMessageDelay Period of time that passes before a message can be retried. A message is retried when the MDB fails to process it, but the message has not reached its maximum failed delivery limit. Other messages can be tried during this period, unless the sequential failure threshold and the maximum concurrency are set to 1.

Syntax 

AdminJMS.createSIBJMSActivationSpec(scope, 
 name, jndiName, 
 destinationJndiName, attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createSIBJMSActivationSpec("myScope", "myName", 
 "myJNDIName", "myDestinationName")

The following example script includes optional attributes in a string format: 

AdminJMS.createSIBJMSActivationSpec(
"server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName11", "myDestinationJndiName11", "readAhead=AlwaysOff,maxBatchSize=54")

The following example script includes optional attributes in a list format: 

AdminJMS.createSIBJMSActivationSpec
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName11", "myDestinationJndiName11", [['readAhead', 'AlwaysOff'], ['maxBatchSize', '54']])


createWMQActivationSpec

This script creates a new activation specification for the WebSphere MQ messaging provider at the scope specified. The script returns the configuration ID of the created WebSphere MQ activation specification.

To run the script, specify the scope, activation specification name, JNDI name, and the JNDI name destination arguments. We can optionally specify attributes. The arguments and attributes are defined in the following tables:

Arguments for the createWMQActivationSpec script. Run the script to create an activation specification.

Argument Description
scope Specifies a scope of cell, node, server, or cluster for the activation specification of the WebSphere MQ messaging provider.
name Name assigned to this activation specification.
jndiName Name and location used to bind this object into WAS JNDI.
destinationJndiName Specifies the JNDI name of a WebSphere MQ messaging provider queue or topic type destination. When an MDB is deployed with this activation specification, messages for the MDB are consumed from this destination.
destinationType Type of the destination. Valid values are javax.jms.Queue and javax.jms.Topic. The argument has no default value.
attributes

Optionally specifies additional attributes in a particular format:

List format

[["attr1", "value1"], ["attr2", "value2"]]

String format

"attr1=value1, attr2=value2"

Optional attributes. Additional attributes available for the script.

Attributes Description
authAlias Authentication alias used to obtain the credentials that this activation specification needs to establish a connection to WebSphere MQ.
brokerCCDurSubQueue Name of the queue from which a connection consumer receives durable subscription messages.
brokerCCSubQueue Name of the queue from which non-durable subscription messages are retrieved for a connection consumer.
brokerCtrlQueue Broker control queue to use when this activation specification subscribes to a topic.
brokerQmgr Name of the queue manager on which the broker is running.
brokerSubQueue Specifies the queue for obtaining subscription messages if this activation subscribes to a topic.
brokerVersion Level of functionality required for publish and subscribe operations.
ccdtQmgrName Name of the queue manager that selects one or more entries from a client channel definition table.
ccdtUrl Specifies the URL to client channel definition table. Use this attribute for this activation specification when contacting WebSphere MQ. Activation specifications created using this attribute are ccdtURL activation specifications.
ccsid Coded character set ID used on connections.
cleanupInterval Interval between background executions of the publish and subscribe cleanup utility.
cleanupLevel Cleanup level for broker or migrate subscription stores.
clientId Client identifier for connections started with this activation specification.
clonedSubs Whether two or more instances of the same durable topic subscriber can run simultaneously.
compressHeaders Whether message headers are compressed.
compressPayload Whether message payloads are compressed.
description Administrative description assigned to the activation specification.
failIfQuiescing Behavior of certain calls to the queue manager when the queue manager is put into a quiescent state.
failureDeliveryCount Number of sequential delivery failures allowed before the endpoint is suspended.
maxPoolSize Maximum number of server sessions in the server session pool the connection consumer uses.
messageSelector Which messages are delivered.
msgRetention Whether the connection consumer keeps unwanted messages on the input queue. A value of true means that it does. A value of false means the messages are disposed of based on the disposition options.
msgSelection Where message selection occurs.
poolTimeout Period of time, in milliseconds, that an unused server session is held open in the server session pool before being closed due to inactivity.
providerVersion Minimum version and capabilities of the queue manager.
qmgrHostname Specifies the hostname which used for this activation specification, when attempting a client mode connection to WebSphere MQ.
qmgrName Name of the queue manager for this activation specification, when contacting WebSphere MQ. Activation specifications created using this attribute are user defined.
qmgrPortNumber Port number for this activation specification, when attempting a client mode connection to WebSphere MQ.
qmgrSvrconnChannel SVRCONN channel to use when connecting to WebSphere MQ. Activation specifications created using this attribute are user defined.
rcvExitInitData Specifies initialization data to pass to the receive exit.
rcvExit Comma separated list of receive exit class names.
rescanInterval Specifies in milliseconds the maximum time that elapses during a scanning interval. When a message consumer in the point-to-point domain uses a message selector to select which messages it wants to receive, the WebSphere MQ JMS client searches the WebSphere MQ queue for suitable messages in the sequence determined by the MsgDeliverySequence attribute of the queue. When the client finds a suitable message and delivers it to the consumer, the client resumes the search for the next suitable message from its current position in the queue. The client continues to search the queue until it reaches the end of the queue, or until the interval of time specified by this property has expired. In each case, the client returns to the beginning of the queue to continue its search, and a new time interval starts.
secExitInitData Specifies initialization data to pass to the security exit.
secExit Specifies a security exit class name.
sendExitInitData Specifies initialization data to pass to the send exit.
sendExit Comma separated list of class names for the send exit.
sparseSubs Message retrieval policy of a topic subscriber object.
sslConfiguration Specifies the SSL configuration used to secure network connections to the queue manager.
sslCrl List of LDAP servers which can be used to provide certificate revocation information if this activation specification establishes an SSL connection to WebSphere MQ.
sslPeerName Specifies a value to match against the distinguished name in the peer certificate. This attribute is used when the activation specification establishes an SSL connection to the queue manager.
sslResetCount How many bytes to transfer before resetting the symmetric encryption key for the SSL session. This attribute is used when the activation specification establishes an SSL connection to the queue manager.
sslType Specifies the SSL configuration for the network connection to the queue manager.
startTimeout Period of time in milliseconds within which delivery of a message to an MDB must start after the work to deliver the message has been scheduled. If this period of time elapses, the message is returned to the queue.
stateRefreshInt Interval in milliseconds between refreshes of the long running transaction that detects when a subscriber loses its connection to the queue manager. This attribute is relevant only if the subStore attribute has the value QUEUE.
stopEndpointIfDeliveryFails Whether the endpoint is stopped if message delivery fails the number of times specified by the failureDeliveryCount attribute.
subscriptionDurability Whether a durable or nondurable subscription is used to deliver messages to an MDB subscribing to the topic.
subscriptionName Name of the durable subscription.
subStore Where WebSphere MQ JMS stores persistent data relating to active subscriptions.
wildcardFormat Which sets of characters are interpreted as topic wild cards.
wmqTransportType Manner in which, for this activation specification, a connection is established with WebSphere MQ. Activation specifications created using this attribute are user defined. Valid values are BINDINGS, BINDINGS_THEN_CLIENT and CLIENT.
localAddress Specifies either or both of the following options:

  • The local network interface to be used
  • The local port, or range of local ports, to be used

Syntax 

AdminJMS.createSIBJMSActivationSpec(scope,name, jndiName, 
 destinationJndiName, destinationType,attributes)

Example usage

The following example script contains required attributes only: 

AdminJMS.createSIBJMSActivationSpec("myScope", "myName", 
 "myJNDIName", "myDestinationName", "myDestinationType")

The following example script includes optional attributes in a string format: 

AdminJMS.createWMQActivationSpec
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName12", "myDestinationJndiName12", "javax.jms.Topic", "poolTimeout=2222,startTimeout=9999")

The following example script includes optional attributes in a list format: 

AdminJMS.createWMQActivationSpec
("server1(cells/avmoghe01Cell02/nodes/avmoghe01Node02/servers/server1|server.xml#Server_1237476439906)", 
"myName" , "myJndiName12", "myDestinationJndiName12", "javax.jms.Topic", [['poolTimeout', '2222'], 
['startTimeout', '9999']])


startListenerPort

This script starts a listener port in the environment. The script returns a value of 1 if the system successfully starts the listener port or a value of -1 if the system does not start the listener port.

To run the script, specify the node and server name arguments, as defined in the following table:

Arguments for the startListenerPort script. Run the script to start a listener port.

Argument Description
nodeName Name of the node of interest.
serverName Name of the server of interest.

Syntax 

AdminJMS.startListenerPort(nodeName, 
 serverName)

Example usage


Related


Use the script library to automate the application serving environment using wsadmin.sh


Reference:

JMS query scripts


+

Search Tips   |   Advanced Search