5 User Messaging Service (UMS) Custom WLST Commands

This chapter provides detailed descriptions of custom WLST commands for UMS, including command syntax, arguments and command examples.

Use the User Messaging Service commands, listed in Table 5-1, to download user messaging preferences from your backend database.

Note:

To use these commands, you must invoke WLST from the Oracle home in which the component has been installed. See "Using Custom WLST Commands" in the Oracle Fusion Middleware Administrator's Guide.

Table 5-1 User Messaging Service for WLST Configuration

Command category	Description
Section 5.1, "UMS WLST Command Group"	Manage Oracle Unified Messaging Service commands.

5.1 UMS WLST Command Group

The UMS WLST commands are listed under the command group "ums".

5.1.1 manageUserMessagingPrefs

Command Category: UMS

Use with WLST: Offline

5.1.1.1 Description

manageUserMessagingPrefs is used to download the user messaging preferences from a backend database to the specified XML file, or to upload the user messaging preferences from an XML file into the backend database.

5.1.1.2 Syntax

manageUserMessagingPrefs (operation=, filename, url, username, password, 
[encoding], [guid], [merge] )

Argument	Definition
`operation`	specifies the upload or download operation to be performed.
`filename`	For download, a unique file name (path) to download the user preferences to. For example, /tmp/download.xml (Linux) or C:\\temp\\download.xml (Windows). For upload, the file name (path) from which to upload the user preferences.
`url`	The JNDI URL to access the User Messaging Server. For example: `t3://<hostname>:<port>`
`username`	The username with login permission to access the User Messaging Server.
`password`	The password of the username.
`encoding`	Character encoding to use to download the user preferences.
`guid`	The globally unique identifier (guid) of a list of users to use to download their preferences. If no guid is specified, the preferences for all users are downloaded.
`merge`	This option is for upload only. Valid values are: `create_new` (default): Create new user device, device addresses and/or ruleset entities. An exception will be thrown if an entity with the same primary key already exists and processing will terminate. `overwrite`: Remove all existing entities of a user and then create new entities. `append`: Only upload entities that do not already exist.

5.1.1.3 Examples

To download the user messaging preferences of all users to the specified file.

wls:offline> manageUserMessagingPrefs(operation='download', 
filename='download.xml', url='t3://localhost:8001', username='weblogic', 
password='<password>')

To download the user messaging preferences of all users to the specified file using UTF-8 character encoding.

wls:offline> manageUserMessagingPrefs(operation='download', 
filename='download.xml', url='t3://localhost:8001', username='weblogic', 
password='<password>', encoding='UTF-8')

To download the user messaging preferences of the user with guid 'john.doe' to the specified file.

wls:offline> manageUserMessagingPrefs(operation='download', 
filename='download.xml', url='t3://localhost:8001', username='weblogic', 
password='<password>', guid='john.doe')

To download the user messaging preferences of the users with guid 'john.doe' and 'jane.doe' to the specified file using UTF-8 character encoding.

wls:offline> manageUserMessagingPrefs(operation='download', 
filename='download.xml', url='t3://localhost:8001', username='weblogic', 
password='<password>', guid='john.doe,jane.doe', encoding='UTF-8')

To upload the user messaging preferences from the specified file to the backend database.

wls:offline> manageUserMessagingPrefs(operation='upload', filename='upload.xml', 
url='t3://localhost:8001', username='weblogic', password='<password>')

To upload the user messaging preferences from the specified file to the backend database and overwrite existing preferences.

wls:offline> manageUserMessagingPrefs(operation='upload', filename='upload.xml', 
url='t3://localhost:8001', username='weblogic', password='<password>', 
merge='overwrite')

5.1.2 deployUserMessagingDriver

Command Category: UMS

Use with WLST: Online

5.1.2.1 Description

deployUserMessagingDriver is used to deploy additional instances of user messaging drivers.Specify a base driver type (for example: email, xmpp, voicexml, and others) and a short name for the new driver deployment. The string usermessagingdriver- will be prepended to the specified application name. Any valid parameters for the deploy command can be specified, and will be passed through when the driver is deployed.

5.1.2.2 Syntax

deployUserMessagingDriver(baseDriver, appName, [targets], [stageMode], 
[options])

Argument Definition

Argument	Definition
`baseDriver`	Specifies the base messaging driver type. Must be a known driver type, such as 'email', 'proxy', 'smpp', 'voicexml', or 'xmpp'.
`appName`	A short descriptive name for the new deployment. The specified value will be prepended with the string usermessagingdriver-
`targets` `stageMode` `options`	Optional. Additional arguments that are valid for the deploy command can be specified and will be passed through when the new driver is deployed.

baseDriver

Specifies the base messaging driver type.

Must be a known driver type, such as 'email', 'proxy', 'smpp', 'voicexml', or 'xmpp'.

appName A short descriptive name for the new deployment. The specified value will be prepended with the string usermessagingdriver-

targets

stageMode

options

Optional. Additional arguments that are valid for the deploy command can be specified and will be passed through when the new driver is deployed.

5.1.2.3 Examples

To deploy a second instance of an email driver with name myEmail.

wls:base_domain/servereConfig> deployUserMessagingDriver(baseDriver='email', 
appName='myEmail')

To deploy a second instance of an email driver, specifying deployment targets.

wls:base_domain/servereConfig> deployUserMessagingDriver(baseDriver='email', 
appName='email2', targets='server1,server2')