createWSRRDefinition command

Use the createWSRRDefinition command to create a WSRR definition.

The createWSRRDefinition command is a multistep command in which the steps define the type of connection definition and its specific properties. You can specify only one step, because a WSRR definition can have only one connection definition.
The createWSRRDefinition command is run using the AdminTask object of the wsadmin scripting client.
  • Locate the command that starts the wsadmin scripting client: this is found in the install_root\bin directory.
  • Run the wsadmin command.
    • If the server is not running, use the -conntype none option.
    • If you are not connecting to the default profile, use the -profileName profile_name option.
Use the following command to list all the WSRR administrative commands.
$AdminTask help SIBXWSRRAdminCommands
Use the following command to get detailed help on a particular command.
$AdminTask help command_name

Prerequisites

Location

The createWSRRDefinition command is run using the AdminTask object of the wsadmin scripting client. The wsadmin scripting client is located in the install_root\bin directory.

Syntax

$AdminTask createWSRRDefinition {-paramName paramValue ...}

Required parameters

-name definitionName
The name of the WSRR definition, as a string.
-connectionType WEBSERVICE
Connection type. Currently the only connection type is WEBSERVICE.
-defaultCacheExpiryTimeout timeout
Timeout of the cache, in seconds. A value of 0 indicates that query results are never cached. Default is 300.

Optional parameters

-description defDescription
Brief description of the definition. This is optional, for your own reference.

Steps

If you specify more than one step, an exception is thrown.
To set properties for a web service connection associated with the WSRR definition, you can specify values for the registry URL, the authentication alias and the SLL configuration as follows:
-WSConnection {{registryURL authAlias repertoire}}
To use the default registry URL (which is http://localhost:9080/WSRRCoreSDO/services/WSRRCoreSDOPort), specify a pair of double quotation marks ("") for the first value. To omit the authentication alias, specify a pair of double quotation marks ("") for the second value. To omit the repertoire (the SLL configuration), specify a pair of double quotation marks ("") for the third value.

Examples

Using the default connection:
  • Jython example:
    AdminTask.createWSRRDefinition('[-name mydefName -description "my description" 
        -defaultCacheExpiryTimeout 300 -connectionType WEBSERVICE]') 
  • Jacl example:
    $AdminTask createWSRRDefinition {-name mydefName -description "my description" 
        -defaultCacheExpiryTimeout 300 -connectionType WEBSERVICE}
Setting the connection properties:
  • Jython example:
    AdminTask.createWSRRDefinition('[-name mydefName -description "my description" 
        -defaultCacheExpiryTimeout 300 -connectionType WEBSERVICE 
        -WSConnection  [-registryUrl http://localhost:9080 -authAlias AUTH_ALIAS1 -repertoire SSL_CONFIG1]]')
  • Jacl example:
    $AdminTask createWSRRDefinition {-name mydefName -description "my description" 
        -defaultCacheExpiryTimeout 300 -connectionType WEBSERVICE 
        -WSConnection {{ http://localhost:9080 AUTH_ALIAS1 SSL_CONFIG1 }}}

Setting one connection property:

Setting one connection property using alternative list syntax.
  • Jython example:
    AdminTask.createWSRRDefinition('[-name defName -description "my description" 
        -defaultCacheExpiryTimeout 300 -connectionType WEBSERVICE 
        -WSConnection  [ ["" AUTH_ALIAS1  ""] ]]')
  • Jacl example:
    $AdminTask createWSRRDefinition {-name defName -description "my description" 
        -defaultCacheExpiryTimeout 300 -connectionType WEBSERVICE 
        -WSConnection {{ "" AUTH_ALIAS1 "" }}}