Oracle® Beehive Administrator's Guide Release 2 (2.0.1.8) Part Number E16648-07 |
|
|
PDF · Mobi · ePub |
This module describes how to manage subscriptions and notifications in Oracle Beehive. Read this module if you are an Oracle Beehive System Administrator, an Oracle Beehive Business Administrator, or if you are responsible for creating or managing Oracle Beehive subscriptions and notifications. This module includes the following sections:
See Also:
For information on configuring the Notification Delivery Service, see "Notification Delivery Service" in Chapter 4, "Oracle Beehive Property Reference", of the Oracle Beehive Administrator's Reference GuideBy default, each newly-provisioned Oracle Beehive user is subscribed to receive notifications about the following events:
The user is invited to an event.
An event the user is invited to, is deleted.
The user is assigned a task.
A task assignment is withdrawn.
Users can set up new notifications and disable default notifications provided to them, and they can control where the notifications are delivered.
Users make changes to their notification preferences using the Oracle Beehive user preference pages, which can be accessed using Oracle Beehive Central: http(s)://<beehive host>:<port>/bcentral
.
Users can enable or disable notifications, and can choose a particular delivery channel they would like notification sent to for each notification type. By default, notifications are sent to the e-mail inbox. Users can temporarily disable notifications to a particular delivery channel. For example, users could turn off SMS delivery if they are going to be unavailable for a day, and then re-enable it afterwards.
You can alter what a user is subscribed to after they are provisioned. The easiest way to do this is by using Oracle Beekeeper. You can also manage user subscriptions using beectl
commands.
Managing User Subscriptions using beectl
You can add a user subscription by using the
command. You must specify the type of entity subscription, a subscription rule, the container the subscription is being attached (applied) to, and the user:beectl
add_user_subscription
beectl> add_user_subscription --source_entity_class <sourceEntityClass of template> --rule <rule name> --attach <identifier of attached entity> --subscriber <identifier of subscriber>
The following example shows how to subscribe a user to be notified whenever a new document is uploaded to a workspace:
beectl> add_user_subscription --source_entity_class Document --rule NOTIFY_ON_ANY_NEW_DOCUMENT --attach <Workspace identifier> --subscriber <User identifier> Subscription has been created successfully. Identifier of the newly created subscription is: 05C1:7403:subs:D493EDCBB1B34A06B680C37A30288E8B000000000000
Note:
Make a note of the subscription identifier. You may need it if you decide to modify the subscription in the future.Table 9-1, "User Subscription Entities and Rules" lists the entities that can be subscribed to and the subscription rules available for each entity.
Table 9-1 User Subscription Entities and Rules
Entity | Rule |
---|---|
AddressBook |
NOTIFY_ON_ANY_UPDATED_CONTACT NOTIFY_ON_ANY_DELETED_CONTACT NOTIFY_ON_ANY_NEW_CONTACT |
Artifact |
NOTIFY_ON_ANY_NEW_DISCUSSION_ARTIFACT |
Assignment |
NOTIFY_ON_ANY_UPDATED_ASSIGNMENT NOTIFY_ON_ANY_NEW_ASSIGNMENT NOTIFY_ON_ANY_DELETED_ASSIGNMENT NOTIFY_ON_ANY_COMPLETED_ASSIGNMENT |
DiscussionsMessage |
NOTIFY_ON_ANY_NEW_DISCUSSION_MESSAGE NOTIFY_ON_ANY_DELETED_DISCUSSION_MESSAGE NOTIFY_ON_ANY_UPDATED_DISCUSSION_MESSAGE |
Document |
NOTIFY_ON_ANY_CREATED_CONTENT NOTIFY_ON_ANY_MODIFIED_CONTENT NOTIFY_ON_ANY_DELETED_CONTENT |
Forum |
NOTIFY_ON_ANY_NEW_DISCUSSION_FORUM NOTIFY_ON_ANY_DELETED_DISCUSSION_FORUM NOTIFY_ON_ANY_RENAMED_DISCUSSION_FORUM NOTIFY_ON_ANY_UPDATED_DISCUSSION_FORUM |
Invitation |
NOTIFY_ON_ANY_NEW_INVITATION NOTIFY_ON_ANY_UPDATED_INVITATION NOTIFY_ON_ANY_DELETED_INVITATION |
Resource |
NOTIFY_ON_ANY_INVITATION_CREATED_FOR_RESOURCE_APPROVAL NOTIFY_ON_ANY_INVITATION_UPDATED_FOR_RESOURCE_APPROVAL |
Topic |
NOTIFY_ON_ANY_NEW_DISCUSSION_TOPIC NOTIFY_ON_ANY_UPDATED_DISCUSSION_TOPIC NOTIFY_ON_ANY_DELETED_DISCUSSION_TOPIC NOTIFY_ON_ANY_MOVED_DISCUSSION_TOPIC |
Workspace |
NOTIFY_ON_ANY_MEMBER_ADDED NOTIFY_ON_ANY_MEMBER_REMOVED NOTIFY_ON_WORKSPACE_LOCKED NOTIFY_ON_WORKSPACE_UNLOCKED |
You can enable or disable an existing user subscription using the
command:beectl
modify_user_subscription
beectl> modify_user_subscription --enable {true|false} --subscription <Subscription identifier>
In addition to notifications, you can create Server-Side Rules (SSRs) using RULE_STATEMENT syntax with the beectl add_user_subscription
command.
Example 9-1 shows a SSR subscription with multiple conditions and multiple actions:
Example 9-1 Server-Side Rules in User Subscription
beectl> add_user_subscription --source_entity_class Message --attach 5457:7954:wspr:5B5DB5E3F6652295E040578C92165D03000000000456 --subscriber user=user1 --name MyServerSideRule_1 --rule RULE_STATEMENT:CONDITION:created_any_from_contains=beehive,created_any_subject_contains=build,ACTION:move_to=5457:7954:afrh:5B5DB5E3F6652295E040578C92165D03000000000440,forward_to=user1@example.com
Note:
This example uses CollabIDs for the workspace specified with the--attach
option and the folder specified with the move_to
action; however, you can use regular BODN identifiers for these objects as well.Example 9-1 is a rule that invokes the following actions, if the following conditions are met:
The From: field contains the string 'beehive'
AND, the Subject: field contains the string 'build'
Move the new message to a folder
AND, forward the message to the address 'user1@example.com'
Table 9-2 presents the available conditions and attributes you can use when creating e-mail SSRs.
Table 9-2 E-mail Server Side Rule Condition Attributes
Condition Name | Attribute Name |
---|---|
CONTAINER_MESSAGE_CREATED |
created_any |
CONTAINER_MESSAGE_CREATED_SUBJECT_IS |
created_any_subject_is |
CONTAINER_MESSAGE_CREATED_SUBJECT_CONTAINS |
created_any_subject_contains |
CONTAINER_MESSAGE_CREATED_SUBJECT_IS_NOT |
created_any_subject_is_not |
CONTAINER_MESSAGE_CREATED_SUBJECT_CONTAINS_NOT |
created_any_subject_contains_not |
CONTAINER_MESSAGE_CREATED_FROM_IS |
created_any_from_is |
CONTAINER_MESSAGE_CREATED_FROM_CONTAINS |
created_any_from_contains |
CONTAINER_MESSAGE_CREATED_FROM_IS_NOT |
created_any_from_is_not |
CONTAINER_MESSAGE_CREATED_FROM_CONTAINS_NOT |
created_any_from_contains_not |
CONTAINER_MESSAGE_CREATED_TO_IS |
created_any_to_is |
CONTAINER_MESSAGE_CREATED_TO_CONTAINS |
created_any_to_contains |
CONTAINER_MESSAGE_CREATED_TO_IS_NOT |
created_any_to_is_not |
CONTAINER_MESSAGE_CREATED_TO_CONTAINS_NOT |
created_any_to_contains_not |
CONTAINER_MESSAGE_CREATED_CC_IS |
created_any_cc_is |
CONTAINER_MESSAGE_CREATED_CC_CONTAINS |
created_any_cc_contains |
CONTAINER_MESSAGE_CREATED_CC_IS_NOT |
created_any_cc_is_not |
CONTAINER_MESSAGE_CREATED_CC_CONTAINS_NOT |
created_any_cc_contains_not |
CONTAINER_MESSAGE_CREATED_PRIORITY_IS |
created_any_priority_is |
CONTAINER_MESSAGE_CREATED_PRIORITY_IS_NOT |
created_any_priority_is_not |
CONTAINER_MESSAGE_CREATED_TO_OR_CC_CONTAINS |
created_any_to_or_cc_contains |
CONTAINER_MESSAGE_CREATED_TO_OR_CC_IS |
created_any_to_or_cc_is |
CONTAINER_MESSAGE_CREATED_TO_OR_CC_CONTAINS_NOT |
created_any_to_or_cc_contains_not |
CONTAINER_MESSAGE_CREATED_TO_OR_CC_IS_NOT |
created_any_to_or_cc_is_not |
Table 9-3 presents the action names and attributes you can use when creating e-mail SSRs.
Table 9-3 E-mail Server Side Rule Action Attributes
Action Name | Attribute Name |
---|---|
NOTIFY |
channel |
MOVE |
move_to |
FORWARD |
forward_to |
BCC |
bcc_to |
SET_FLAGS |
flag |
DELETE |
delete |
You can create rules with multiple values (such as multiple destination addresses for a forwarded e-mail message) by specifying the attribute name-value pair multiple times. For example:
beectl> add_user_subscription --source_entity_class Message --attach 5457:7954:wspr:5B5DB5E3F6652295E040578C92165D03000000000456 --subscriber user=user1 --name MyServerSideRule_1 --rule RULE_STATEMENT:CONDITION:created_any_from_contains=beehive,created_any_subject_contains=build,ACTION:move_to=5457:7954:afrh:5B5DB5E3F6652295E040578C92165D03000000000440,forward_to=user2@example.com,forward_to=user3@example.com
This example is a rule that invokes the following actions, if the following conditions are met:
The From: field contains the string 'beehive'
AND, the Subject: field contains the string 'build'
Move the new message to a folder (identified by the folder's CollabID)
AND, forward the message to the two addresses 'user2@example.com' and 'user3@example.com'
Oracle Beehive can send users notifications as email messages, instant messages, or as mobile messages in the form of SMS. SMS notifications are only possible if the Oracle Beehive SMS delivery channel is enabled and configured to point to an SMS Aggregator.
Note:
Some mobile operators will not deliver messages from a short code they do not recognize. You may need to work with your SMS aggregator to register your short code with such operators.You can configure SMS notifications in any one of the following ways:
See Also:
For information on configuring the SMPP Delivery Service, see "Managing the SMPP Delivery Service"The SMS delivery channel is configured by default to use Short Message Peer-to-Peer (SMPP). It will not be able to deliver SMS notifications until a subscription from an SMPP-compliant aggregator is secured.
See Also:
For a list of supported SMPP-compliant aggregators, see "Oracle Beehive Mobility Data Sheet" on the Oracle Technology Network website, at the following URL:http://www.oracle.com/technology/products/beehive/pdf/oracle%20beehive%20mobility%20data%20sheet.pdf
Once you have received an SMS subscription from one of these two vendors, you must make the SMS delivery channel aware of your credentials and enable the delivery channel.
To configure SMS with SMPP, perform the following steps:
Set the Notification Delivery Service to SMPP mode:
beectl> modify_property --component _NotificationDeliveryService:SmsSettings --name SmsMode --value SMPP
Update the Notification Delivery Service with the URL, system ID, and password for your SMS subscription:
beectl> modify_property --component _SmppDeliveryService --name SmppServiceUrl --value <service url> beectl> modify_property --component _SmppDeliveryService --name SmppSystemID --value <system id> beectl> modify_secure_property --component _SmppDeliveryService --name SmppPassword -value <password>
If you are using Clickatell Gateway, you must also set the SmppSystemType
. The value is your assigned ID for the SMPP configuration with Clickatell via the Web interface:
beectl> modify_secure_property --component _SmppDeliveryService --name SmppSystemType -value <assigned ID>
Activate your proposed configuration using the
command:beectl
activate_configuration
beectl> activate_configuration
You can configure SMS delivery with the Oracle iAS Wireless XMS Interface by using the Oracle Beehive SMS delivery channel's XMS mode.
To configure SMS with XMS, perform the following steps:
Set the Notification Delivery Service SMS mode to XMS:
beectl> modify_property --component _NotificationDeliveryService:SmsSettings --name SmsMode --value XMS
Update the Notification Delivery Service with the user name, password, proxy host name, and proxy port for your XMS interface by issuing the following
commands:beectl
beectl> modify_property --component _NotificationDeliveryService:XmsSettings --name XmsUserName --value <username> beectl> modify_secure_property --component _NotificationDeliveryService:XmsSettings --name XmsPassword --value <password> beectl> modify_property --component _NotificationDeliveryService:XmsSettings:WebProxySettings --name ProxyHostName --value <host> beectl> modify_property --component _NotificationDeliveryService:XmsSettings:WebProxySettings --name ProxyPort --value <port>
Activate your proposed configuration using the
command:beectl
activate_configuration
beectl> activate_configuration
An actionable notification is an Oracle Beehive feature that allows users to accept or decline an invitation or assignment by replying to notifications they receive.
By default, however, notifications are one-way (from the server to the user). In order to enable actionable notifications, you must perform several post installation configuration steps.
To enable actionable notifications, perform the following procedure:
Create a user account that will be used to receive notification responses from users. For example:
beectl> add_user --given_name NotificationAdmin --family_name NotificationAdmin --login_id NotificationAdmin --login_password <password> --address business_1:mailto:NotificationAdmin@example.com --address business_1:im:NotificationAdmin@example.com --scope <enterprise identifier>
In this example, the user is called NotificationAdmin, but you can use any name. You can also create this account using Oracle Beekeeper.
Note:
If you are synchronizing the User Directory with an external, LDAP-based directory, you must create this account in your external directory with e-mail and instant message addresses, just like creating any other user account. Make sure the account is subsequently synchronized to the Oracle Beehive User Directory.Use the beectl list_users
command to get the EID of the user you just created. For example:
beectl> list_users --user loginid=NotificationAdmin --entity_format id
Make a note of the EID included in the output from this command.
Set a property of the Notification Delivery Service using the EID of the new user account you just created, with the beectl modify_property
command:
beectl> modify_property --component _NotificationDeliveryService:ActionAskSetings --name ActionableNotificationUser --value <eid of user>
Activate your proposed configuration using the
command:beectl
activate_configuration
beectl> activate_configuration
The Notification Delivery Service will automatically start sending actionable notifications.
Actionable Notifications with SMS
In order to allow replies to SMS Notifications, a two-way SMS connection is required. Follow the steps for enabling the SMS delivery channel found in "Configuring Notifications to use SMS". In order to support two-way SMS you must use SMPP mode. All that is required is for a proper short code to be assigned as part of the NotificationDeliveryService.SmsSettings
configuration object.
Note:
When Actionable Notifications with SMS are enabled, users can interact with the "ASK Service" interface, which allows them to send SMS commands to the Notification Delivery Service and retrieve a variety of e-mail, calendar, and contacts data.For more information about the ASK Service, see "Using ASK Commands" in "Configuring Mobile Devices Help," available on the Oracle Technology Network Website at the following URL:
http://www.oracle.com/technology/products/beehive/beehive_users/2_0/mobile.htm#BABDCJGH
Disabling Actionable Notification Responses
By default, when a user responds to an actionable notification, the system will reply with a confirmation message. You can set the ActionableNotificationReplyDisabled
property of the NotificationDeliveryService.ActionAskSettings
subcomponent to true
to disable actionable notification responses. Set this property back to false
to re-enable actionable notification responses.
See Also:
"NotificationDeliveryService.ActionAskSettings" in Chapter 4, "Oracle Beehive Property Reference," of the Oracle Beehive Administrator's Reference Guide