How to edit the Subscription.properties File
Adjusting property values in the subscription.properties file will affect email notifications for subscriptions when multiple event notifications are sent. Property values in this file also change the time interval for an event to be considered part of the same transaction on an object. A transaction is any action on an object that occurs within the time interval set by the timeGap property.
Warning: Before making any modifications to the Subscription.properties file, make a backup copy and rename the copy Subscription.properties.orig.
Note: After making modifications you must restart DocuShare.
Two properties in the subscription.properties file can be changed to reduce the incidence of multiple email notifications for a single transaction.
- Change the spamOK property to spamOK=no. This will send only one notification per transaction to a user.
- If necessary, increase the timeGap property to a higher value.
CAUTION: Caution should be used when increasing the timeGap. If timeGap is set too high it may eliminate required notifications of events. For example, if a user adds a new version of a document and also changes the ACL permissions of the document within the timeGap interval, both events will be considered a single transaction. Only one email notification will be sent although two unique events occurred on the document.
The subscription.properties file is located in <DocuShare-home>/config. Edit the file using an ASCII text editor such as Notepad.exe.
The following properties are new to DocuShare 4.0. This list below describes these properties and their usage.
This property triggers the garbage collection process to remove cached outdated events. Default is 10 minutes. Garbage collection time can be shortened on systems where a high volume of uploads or changes are driven by automated processes or scripts. This will reduce the memory required for caching outdated events. Running garbage collection more often can have a negative impact by increasing processing overhead.
Used for diagnostics. When Subscription logging level is set to TRACE or DEBUG and printDebugTime=yes the processing time for internal processes is written to the log.
Default is 100 milliseconds. This value sets the time interval for an event to be considered to be from the same transaction. For example, if a new version of a document is added and a property change occurs on the new version within 100 milliseconds the two events are considered to be one transaction. Only one notification event will be sent out.
Default is spamOk=yes. When set to spamOk=no only one subscription message per recipient per transaction will be sent. This works in conjunction with the timeGap= property to set time interval for a transaction.
Default is blank. This property is used to specify event type(s) that will be skipped for subscription processing. Specify a string of comma separated events in a single line. Valid types are:
The password for accessing authenticated SMTP session. The user enters the password of the DocuShare Admin email account as plaintext. An encrypted string replaces it after DocuShare is running. For SMTP service that allows anonymous access an encrypted empty string is displayed.
Indicates the main DS version for which patches apply for. Do not change this value unless directed to by DocuShare Customer Support.
Property changes must be made by editing the subscription.properties file with an ASCII text editor. The subscription.properties file is located in <DocuShare-home>/config.
Solution Updated: March 28th, 2012
Solution ID: 181