9 User Messaging Service (UMS) Custom WLST Commands

Oracle User Messaging Service provides a common service responsible for sending out messages from applications to devices. It also routes incoming messages from devices to applications.

This chapter describes the WLST commands that you can use with Oracle User Messaging Service (UMS).

UMS WLST Command Group

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

Use the User Messaging Service commands, listed in Table 9-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 Administering Oracle Fusion Middleware.

Table 9-1 User Messaging Service for WLST Configuration

Command category	Description
UMS WLST Command Group	Manage Oracle User Messaging Service commands.

configUserMessagingDriver

Command Category: ums

Use with WLST: Online

Description

configUserMessagingDriver is used to configure messaging drivers.

Specify a base driver type (email, xmpp, voicexml, etc.) and a short name for the new driver configuration. The string "usermessagingdriver-" will be prepended to the specified application name.

Syntax

configUserMessagingDriver(baseDriver, appName, driverProperties, clusterName=None propertyGroups=None)

Argument	Definition
`baseDriver`	Specifies the base messaging driver type. Must be a known driver type, such as 'email', 'extension', 'proxy', 'smpp', 'twitter', 'voicexml', 'worklist' or 'xmpp'.
`appName`	A short descriptive name for the new deployment. The specified value will be prepended with the string usermessagingdriver-
`driverProperties`	An object with the driver properties. It can be an object of the following classes: CommonDriverProperties, EmailDriverProperties, ProxyDriverProperties, SmppDriverProperties, TwitterDriverProperties, VoiceXmlDriverProperties, WorklistDriverProperties or XmppDriverProperties. To see all available driver properties for a driver, print the `dict` field in the class. For example: `print CommonDriverProperties.__dict__` `print EmailDriverProperties.__dict__`
`clusterName`	Optional. The name of the cluster for which this configuration should be valid. If not specified, the configuration will be domain-wide configuration.
`propertyGroups`	Optional. The list of property groups to add or update. The items in the list must be of class ExtensionDriverProperties.

Examples

Example 9-1 To configure a XMPP driver with name 'xmpp'

driverProperties = XmppDriverProperties()
driverProperties.SenderAddresses = 'IM:alice@example.com'
driverProperties.IMServerHost = 'example.com'
driverProperties.IMServerUsername = 'alice'
driverProperties.IMServerPassword = 'secret'
configUserMessagingDriver(baseDriver='xmpp', appName='xmpp', 
   driverProperties=driverProperties, clusterName='my_cluster')

Example 9-2 To configure a Extension driver with name 'extension'

driverProperties = CommonDriverProperties()
extensionDriverProperties = ExtensionDriverProperties()
extensionDriverProperties.PropertyGroupName = 'example.com'
extensionDriverProperties.EndpointURL = 'http://domain.example.com/extension'
extensionDriverProperties.MappedDomain = 'example.com'
extensionDriverProperties.Protocol = 'popup'
configUserMessagingDriver(baseDriver='extension', appName='extension',
   driverProperties=driverProperties, 
   propertyGroups=[extensionDriverProperties])

configUserMessagingServer

Command Category: ums

Use with WLST: Online

Description

configUserMessagingServer is used to configure the messaging server.

Syntax

configUserMessagingServer(serverProperties, clusterName=None)

Argument Definition

Argument	Definition
`serverProperties`	An object with the server properties. It must be an object of the class ServerProperties. To see all available properties, print the `dict` field in the class. For example: `print serverProperties.__dict__`
`clusterName`	Optional. The name of the cluster for which this configuration should be valid. If not specified, the configuration will be domain-wide configuration.

serverProperties

An object with the server properties. It must be an object of the class ServerProperties.

To see all available properties, print the dict field in the class. For example:

print serverProperties.__dict__

clusterName

Optional. The name of the cluster for which this configuration should be valid. If not specified, the configuration will be domain-wide configuration.

Examples

Example 9-3 To configure the JPS Context name for the UMS server(s) in the cluster named 'my_cluster'

serverProperties = ServerProperties()
serverProperties.JpsContext = 'my_jps_context'
configUserMessagingServer(serverProperties=serverProperties, clusterName='my_cluster')

Example 9-4 To configure the security principal for the UMS server(s) in the domain

serverProperties = ServerProperties()
serverProperties.SecurityPrincipal = 'MyUser'
configUserMessagingServer(serverProperties=serverProperties)

deployUserMessagingDriver

Command Category: ums

Use with WLST: Online

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. Optionally, specify the principal name for the driver to run as to connect securely to JMS resources (default value is 'OracleSystemUser'). Any valid parameters for the deploy command can be specified, and will be passed through when the driver is deployed.

Syntax

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

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-
`runAsPrincipalName`	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. For more information about the `deploy` command, see WLST Command Reference for WebLogic Server.

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')

manageUserCommunicationPrefs

Command Category: ums

Use with WLST: Offline

Description

manageUserCommunicationPrefs 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.

Syntax

manageUserCommunicationPrefs (operation={'download' | 'upload'}, filename='file_name', url='jndi_url', username='username', password='password'
 [, encoding='character_encoding'] [, guid='guid1,guid2, ...' ] [, merge={'create_new' | 'overwrite' | 'append'}] )

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 user name 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.

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')