IBM Business Process Manager, V8.0.1, All platforms > Reference > Commands and scripts > Commands (wsadmin scripting)

modifyWSRRDefinition command

Use the modifyWSRRDefinition command to modify the details of a definition, given its name.

The modifyWSRRDefinition command is a multi-step command, in which the steps define the type of connection definition and the specific properties. You can specify only one step, because a WSRR definition can only have one connection definition. You specify the object to be modified, either as a target object or by a name parameter.

If there is a conflict between the target object and the name parameter, or a definition cannot be found, you will see an error message.

Before you begin

The modifyWSRRDefinition 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 administrative commands.

$AdminTask help SIBXWSRRAdminCommands

Use the following command to get detailed help on a particular command.

$AdminTask help command_name

Syntax

$AdminTask modifyWSRRDefinition {-paramName paramValue ...}

Required parameters

-name definitionName

The name of the WSRR definition, as a string.

-newName newdefName

The new name of the WSRR definition, as a string, if required.

-description defDescription

Brief description of the definition.

-defaultCacheExpiryTimeout timeout

Timeout of the cache, in seconds. A value of 0 indicates that query results are never cached.

Steps

Only one step can be specified or you will see an error message. Select the step that matches the connection of the definition.

To modify the properties for a web service connection associated with the WSRR definition, you can specify values for the registry URL and the authentication alias as in this example:

-WSConnection {{registryURL authAlias repertoire}}

If you do not want to specify one of these values, use "".

The default connection has a default registry URL and no authentication alias or repertoire (SSL configuration).

Example

• Jython example:

  AdminTask.modifyWSRRDefinition('[-name MydefName -newName newdefName 
      -description "my new description" -defaultCacheExpiryTimeout 300 
      -WSConnection [-registryUrl http://localhost:9084 -authAlias NEW_AUTH_ALIAS -repertoire NEW_SSL_CONFIG]]')
  

• Jacl example:

  $AdminTask modifyWSRRDefinition {-name MydefName -newName newdefName 
      -description "my new description" -defaultCacheExpiryTimeout 300 
      -WSConnection {{ http://localhost:9084 NEW_AUTH_ALIAS NEW_SSL_CONFIG }}}
  

Parent topic: Commands (wsadmin scripting)

Related information:

Obtaining online help using wsadmin scripting
Administrative command invocation syntax using wsadmin scripting
Use the wsadmin scripting tool
Jython script library