User Messaging Service (UMS) Custom WLST Commands

8 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".

UMS WLST Command Group

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

Note:

To use these commands, you must invoke WLST from the Oracle home in which the component has been installed. See Getting Started Using the Oracle WebLogic Scripting Tool (WLST) in the Administering Oracle Fusion Middleware.

Parent topic: User Messaging Service (UMS) Custom WLST Commands

configUserMessagingDriver

Command Category: ums

Use with WLST: Online

Description

configUserMessagingDriver is used to configure messaging drivers.

Specify a base driver type (apns, smpp, email, xmpp, 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,serverName=None, enabled=true)

The use of propertyGroups are deprecated. Deprecated syntax:

configUserMessagingDriver(baseDriver, appName, driverProperties, 
clusterName=None 
         serverName=None, propertyGroups=None, enabled=true)

Argument	Definition
`baseDriver`	Specifies the base messaging driver type. Must be a known driver type, such as 'apns', 'email', 'extension', 'smpp', 'twitter', or 'xmpp'.
`appName`	A short descriptive name for the 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, ApnsDriverProperties, EmailDriverProperties, SmppDriverProperties, ExtensionDriverProperties, TwitterDriverProperties, 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__`
`serverName`	Optional. The name of the managed server for which this configuration shall be valid. One of the `clusterName` or `ServerName` should be specified, both are not allowed. If both are `None`, the configuration becomes managed server level configuration on all managed servers.
`clusterName`	Optional. The name of the cluster for which this configuration shall be valid.One of `clusterName` or `serverName` should be specified, both are not allowed.If both are `None`, the configuration becomes managed server level configuration on all managed servers.
`enabled`	Optional. Specifies if the configuration shall be enabled or disabled. If not set, default value is `true`.

Examples

Example 8-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 8-2 To configure a Extension driver with name 'extension'

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

Parent topic: UMS WLST Command Group

configUserMessagingServer

Command Category: ums

Use with WLST: Online

Description

configUserMessagingServer is used to configure the messaging server.

Syntax

configUserMessagingServer(serverProperties, clusterName=None), serverName=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 managed server for which this configuration shall be valid. One of the `clusterName` or `ServerName` should be specified, both are not allowed. If both are `None`, the configuration becomes managed server level configuration on all managed servers.
serverName	Optional. The name of the cluster for which this configuration shall be valid.One of `clusterName` or `serverName` should be specified, both are not allowed.If both are `None`, the configuration becomes managed server level configuration on all managed servers.

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 managed server for which this configuration shall be valid. One of the clusterName or ServerName should be specified, both are not allowed. If both are None, the configuration becomes managed server level configuration on all managed servers.

serverName

Optional. The name of the cluster for which this configuration shall be valid.One of clusterName or serverName should be specified, both are not allowed.If both are None, the configuration becomes managed server level configuration on all managed servers.

Examples

Example 8-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 8-4 To configure the security principal for the UMS server(s) in the domain

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

Parent topic: UMS WLST Command Group

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, or to delete the user preferences from the backend database and backup the preferences to the specified XML file.

Syntax

manageUserCommunicationPrefs (operation={'download' | 'upload' | 'delete'}, 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, delete, 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) to upload the user preferences. For delete, the filename (path) is used to store the removed 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`	(Optional) Character encoding to use to download the user preferences.
`guid`	(Optional) 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. For delete, the guid specifies the user whose preferences will be removed by this operation.
`merge`	(Optional) This argument 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

Note:

In the URLs below, port 7001 represents the Managed Server port where UMS is deployed.

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

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

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

wls:offline> manageUserCommunicationPrefs(operation='download', 
filename='download.xml', url='t3://localhost:7001', 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> manageUserCommunicationPrefs(operation='download', 
filename='download.xml', url='t3://localhost:7001', 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> manageUserCommunicationPrefs(operation='download', 
filename='download.xml', url='t3://localhost:7001', 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> manageUserCommunicationPrefs(operation='upload', filename='upload.xml', 
url='t3://localhost:7001', username='weblogic', password='<password>')

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

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

To delete the user preferences of the user with guid 'john.doe' and backup the preferences to the specified file.

wls:offline> manageUserCommunicationPrefs(operation='delete', filename='backup.xml', url='t3://localhost:7001', username='weblogic', password='<password>', guid='john.doe')

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

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

Parent topic: UMS WLST Command Group