| DocuShare User's Guide |
Subscription Overview
Subscription Events of Interest
Adding a Subscription
Viewing Subscription Properties
Editing Subscription Properties
Editing Recipients of a Subscription
Deleting a Subscription
Retrieving a Deleted Subscription
| Table of Contents | DocuShare Calendars | DocuShare URLs |
DocuShare allows users to subscribe to DocuShare content and be notified by email when changes occur. As with all DocuShare objects, subscriptions have a title, description, and the standard set of permission attributes. Unlike the other DocuShare objects, however, subscriptions do not appear in collections or other container objects. Subscriptions to DocuShare objects can be created and managed through those objects' Edit menu.
Subscriptions provide a variety of options to specify which events are of interest, who should be notified when those events occur, and when email notifications will be sent. The subscription Events of Interest property lists which modifications (e.g., Any Change, Something Deleted) will be reported to the subscription recipients. The subscription Period property indicates when the notifications will be sent, and may be on an Immediate, Daily, or Weekly basis. All daily and weekly notices scheduled to be received by each recipient are combined into a single summary report. The recipients of a subscription may be changed on an as-needed basis through the Edit Recipients option on the subscription's Edit menu.
When a subscription is made to a container object, such as a collection, it applies to the collection and everything within that collection. When a subscription is made to individual, non-container objects, such as a file, it applies only to that individual object.
Each subscription lists the specific set of change events that are of interest to the recipients. Subscriptions can be made for all changes, a limited set of changes, or just one type of change.
The set of possible event types are:
| Event | Description |
| Any change | The Any Change event type covers all possible changes and subsumes all other events types. |
| Something added | A new object has been added. This event type applies to container objects only, such as collections. |
| A new version | A new version has been added to a file. This event type applies to collection and file objects. |
| Something deleted | An object within the scope of the subscription, such as a collection's contents or the subscribed-to object itself, was deleted. |
| Properties edited | The properties of an object, such as its title or description, were edited. |
| Permissions edited | The permissions of an object, including who has read, write or manager permission, were edited. |
| Change in ownership | The owner of an object was changed. |
| Location edited | An object was moved. This event type will include moving something out of or into the scope of the subscription, such as moving a file into a subscribed-to collection or out of a subscribed-to collection. |
| File locked or checked out | A file has been locked for editing. A file may be locked explicitly via the Lock option on its Services page, or as a side-effect of having been checked out. |
| File unlocked | A file has been unlocked. This event applies only to files that have been explicitly UnLocked without addition of a new version. |
Any user with Read access to an object may create a subscription to that object. If the object is a container, such as a collection, the subscription includes changes to the collection and its contents.
To add a subscription:
Note: If you are unsure of the purpose of a field while creating the subscription, you can click on the highlighted field name for a brief Help description of the field.
Note: To select more than one parameter, press the CONTROL key while clicking on the additional parameters.
The Add Subscription page has the following properties:
| Property | Description |
| Events of Interest | The DocuShare events about which you would like to be notified. This is a required field. |
| Period | The period property specifies when you would like to be notified about the events of interest. The value Immediate indicates that you want to receive notification immediately after the event occurs. The value Daily indicates that you want the event to be included in a daily summary report. The value Weekly indicates that you want the event to be included in a weekly summary report. |
| Include Recipient's Activity | A subscription will notify its recipients of all events of interest. The value No indicates that a recipient should not be notified of her/his own activity. Setting this property to No avoids receiving email about edits that you made yourself. |
To view the properties of a subscription, you must access the Services page by clicking on the View Properties option in the Edit... pull-down menu, or by clicking on the Services icon to the right of the link. Subscription properties include:
You can edit the properties of a subscription by selecting Edit Subscription from the Edit... pull-down menu, or by clicking on the Services icon. The Edit Subscription page contains the following properties:
| Property | Description |
| Title | This field should contain the title of the object being submitted to the DocuShare repository. The title should be short but descriptive and may contain spaces and other punctuation marks. This is a required field. |
| Summary | (Optional) This field should contain a short description of the object being submitted to the DocuShare repository. The contents of this field will be displayed beneath the object's title when printing the contents of a Collection in which this object appears. The Description field may be used to provide a more detailed description of the object. |
| Description | (Optional) This field should contain a detailed description of the object. For Collections and other container-type objects, the contents of this field will be displayed at the top of the page, just below the title and/or image associated with the object. If desired, this field may contain HTML markup that will be inserted into the page without modification. |
| Keywords | This field should contain any Keywords associated with this object. Keywords help to categorize documents and allow for more accurate searching. Simply type in a series of words in the field. |
| External Recipients | A list of email addresses for recipients who are not registered users on this DocuShare server. External recipients will always be sent immediate email in plain-text format. Daily or weekly summary reports are not available for external recipients. |
| Events | The DocuShare events about which you would like to be notified. To select more than one event, press the CONTROL key while selecting the additional events. This is a required field. Note: Use the CONTROL key for MS Windows-based Operating Systems only. Substitute the Command (or Apple key) key for the MacOS. Unix-based systems require no special key for this multiple list item selection. |
| Period | The period property specifies when you would like to be notified about the events of interest. The value Immediate indicates that you want to receive notification immediately after the event occurs. The value Daily indicates that you want the event to be included in a daily summary report. The value Weekly indicates that you want the event to be included in a weekly summary report. |
| Include Recipient's Activity | A subscription will notify its recipients of all events of interest. The value No indicates that a recipient should not be notified of her/his own activity. Setting this property to No avoids receiving email about edits that you made yourself. |
To edit properties of a subscription:
DocuShare allows managers of a subscription to add and remove users or groups from a subscription.
To add or remove users from a subscription:
To delete a subscription:
If you inadvertently delete an object from the DocuShare repository, the Site Administrator can easily restore it for you. All deleted content is sent to a trashcan accessible only to the Site Administrator. If you mistakenly delete an object, you must contact the Site Administrator and provide him/her with the necessary information. The Site Administrator is responsible for purging the recycle bin on an as-needed basis. After purging, you will be unable to restore items deleted up to that point, so be sure to notify the Site Administrator of deletion restorations in a timely manner.
| Table of Contents | DocuShare Calendars | DocuShare URLs |
P/N 613P08550 3/00