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).
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 |
|---|---|
|
Manage Oracle User Messaging Service commands. |
Command Category: ums
Use with WLST: Online
configUserMessagingDriver is used to configure messaging drivers.
Specify a base driver type (email, xmpp, etc.) and a short name for the new driver configuration. The string "usermessagingdriver-" will be prepended to the specified application name.
configUserMessagingDriver(baseDriver, appName, driverProperties, clusterName=None propertyGroups=None)
| Argument | Definition |
|---|---|
|
|
Specifies the base messaging driver type. Must be a known driver type, such as 'email', 'extension', 'smpp', 'twitter', or 'xmpp'. |
|
|
A short descriptive name for the deployment. The specified value will be prepended with the string usermessagingdriver- |
|
|
An object with the driver properties. It can be an object of the following classes: CommonDriverProperties, EmailDriverProperties, SmppDriverProperties, TwitterDriverProperties, or XmppDriverProperties. To see all available driver properties for a driver, print the
|
|
|
Optional. The name of the cluster for which this configuration should be valid. If not specified, the configuration will be domain-wide configuration. |
|
|
Optional. The list of property groups to add or update. The items in the list must be of class ExtensionDriverProperties. |
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])
Command Category: ums
Use with WLST: Online
configUserMessagingServer(serverProperties, clusterName=None)
| Argument | Definition |
|---|---|
|
|
An object with the server properties. It must be an object of the class ServerProperties. To see all available properties, print the
|
|
|
Optional. The name of the cluster for which this configuration should be valid. If not specified, the configuration will be domain-wide configuration. |
Command Category: ums
Use with WLST: Offline
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.
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 |
|---|---|
|
|
specifies the upload or download operation to be performed. |
|
|
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. |
|
|
The JNDI URL to access the User Messaging Server. For example: |
|
|
The user name with login permission to access the User Messaging Server. |
|
|
The password of the username. |
|
|
(Optional) Character encoding to use to download the user preferences. |
|
|
(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. |
|
|
(Optional) This argument is for upload only. Valid values are:
|
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')