Subscription Service
The subscription service enables users to keep track of changes to documents and folders. It informs users about changes to subscribed resources by sending notification e-mails at defined intervals (see Notifications ).
A variant of the subscription service is used for managing subscriptions in discussions.
The following services are configured and activated:
The following parameters determine the behavior of the subscription service:
Subscription Service Parameters
| Parameter | Required | Description |
|---|---|---|
|
Name |
Yes |
ID of the service. |
|
Allowed AdminNotifications |
No |
Selection of subscription events for which a notification is sent. The following values can be entered separated by commas: create (default): Sends a notification when the subscription is created. delete : Sends a notification when the subscription is deleted. update : Sends a notification when the subscription properties, for example, frequency or duration, are changed. updateresource : Sends a notification when subscribed resources are changed. When the events listed above take place, the owner of the subscription in question, and the users who have subscribed to the resource, receive a notification. updaterecipient (default): Sends a notification when the recipient list is changed. When this event takes place, the owner of the subscription, and any users who have newly subscribed to the resource, receive a notification. unsubscribe : Sends a notification when a user has removed himself or herself from the recipient list. When this event takes place, the owner of the subscription, and the user who has canceled his or her subscription, receive a notification. mark_for_archiving : Sends a notification when a KMC archiving object is marked for archiving. archiving : Sends a notification when a KMC archiving object is archived. |
|
Service User |
No |
The user used by the subscription service for polling resources (for example, subscription_service ). The user must be configured as a system principal ). The default user is subscription_service . |
|
Subscription Service ID in Database |
No |
ID of subscription service entries in the database. More than one subscription service can have the same Subscription Service ID . This makes sense if the subscriptions of a repository are to be distributed among several subscription services. If no specification is made, the system enters the Name as the Subscription Service ID by default. |
|
Send Admin Notifications to Action Inbox |
No |
Boolean property that determines whether administration notifications sent by e-mail also appear in the universal worklist. An administration notification informs you about changes to a subscription, not about changes to the subscribed resource. By default, this parameter is activated. |
|
Send Notifications to Action Inbox |
No |
Boolean property that determines whether notifications sent by e-mail also appear in the universal worklist. By default, this parameter is activated. If the parameter is deactivated, notifications only appear in the client of the e-mail server specified in the configuration of the e-mail communication channels . |
|
Originators |
Yes |
List of originators that appear as sender names in notifications sent by the subscription service using various communication channels (see Channel Originators ). A channel originator of the type EMAIL (for example, subscription.EMAIL ) has to be specified so that you can receive subscriptions by e-mail. |
|
Expiration Values |
No |
Specifies the possible values, which appears for users when they manage notifications. Separate multiple entries with commas. The following entries are permitted: never one_week: After a week one_month: After a month six_months: After six months one_year: After a year |
|
Frequency Values |
No |
Specifies the possible values, which appears for users when they manage notifications. Separate multiple entries with commas. The following entries are permitted: daily weekly monthly every_event: For every event |
|
Scope Values |
No |
Specifies the possible values, which appears for users when they manage notifications. Separate multiple entries with commas. The following entries are permitted: folder: Only changes to the folder itself level_0: All items in this folder level_1: All items in this folder, including subfolders level_2: Down to the third level level_3: Down to the fourth level level_infinity: Recursive |
|
Maximum Allowed Users |
Yes |
Specify the limitation for the maximum number of users that can be assigned to a single subscription. If a limit is set for the maximum number of recipients for a single subscription, adding more users to the subscription when the limit is reached will be disallowed.
By default the Maximum Allowed Users parameter is 500 . The negative value (for example, -1 ) removes the limitation of users that can be assigned to a single subscription. |
The KM standard configuration comes with two preconfigured variants of the subscription service:
- Subscription (uses standard event mapping of low-level events to events relevant for subscriptions)
- subscription_collaboration (uses a special event mapping for subscriptions to discussions).
If you want notifications only to be sent to the universal worklist, you have to select the value NULL in the configuration of the notificator service in the Channels parameter (see Notificator Service ).Then select the channel None when creating a notification (see Notifications ).
Normally, you do not need to change the configuration of these services.
To check or change the configuration of the subscription service, choose Content Management → Repository Services → (Show Advanced Options) → Subscription Service in the Configuration iView.
You need to register the subscription service with every repository in which you want to use subscriptions. The subscription_collaboration service has to be registered with the repository that contains the collaboration data.
Note that the user receives the notifications for the subscription to a resource in a collaboration room when he or she has the read permissions for a given resource. When such a user is removed as a member of a collaboration room, the created subscription is not deleted, but the removed member did not receive the notifications for this subscription because of the lost read permissions.
By default, the date displayed in the text of the notification e-mails reflects the time zone of the system where the Application Server Java (AS Java) is installed. You can optionally configure the date to reflect the time zone of the subscription owner. As a prerequisite, the following properties must be configured in the user profile of the subscription owner:
|
Property |
Description |
|
Language |
From the Language dropdown list on the General Information tab page, select the language in which you want the date and time to appear in the text of the notification e-mails. |
|
Time Zone |
From the Time Zone dropdown list on the Contact Information tab page, select the time zone that should be displayed in the text of the notification e-mails. |