Example: Hiding or enabling a subscription option within the TCM application

Users can subscribe to events within a teamspace. (See Subscriptions for more information.) The Collaboration User Subscription Definitions.xml file controls the notification options that are available to users of the application. You can edit this file to hide or display different options.

(See Example Collaboration User Subscription Definitions.xml file for an example of the file. See Customizing the Collaboration User Subscription Definitions.xml file for more information on customizing the file.)

By default, a user can subscribe to automatic notification when a document or folder is added to another folder. However, the user cannot subscribe to be notified only when a folder is added, or only when a document is added. The examples below illustrate how to remove the default notification and replace it with individual subscriptions for new folders and new documents. This allows users to be notified when a document is added, when a folder is added, or both. (See Control notifications sent automatically when a document or folder changes for more information on using these options within the TCM application.)

Hide the "Notify me whenever a document or folder is added to this folder" subscription

  1. Use Enterprise Manager or another method to check out a copy of the Collaboration User Subscription Definitions.xml file. The file is located in the Collaboration Object Store under \Root Folder\Collaboration Store.
  2. Open the Collaboration User Subscription Definitions.xml file for editing using a text editor or an XML editor.
  3. Search for <label>Change to Folder</label> to locate the following section of the file:
    <subscriptiondef>
<defid>{6F87F156-E46B-4c16-8E3E-710BF6D518DA}</defid>
<type>300</type>
<label>Change to Folder</label>
<cebased>true</cebased>
<description>Notify me whenever a document or folder is added to this Folder</description>
<subscribableobj>folder</subscribableobj>
</subscriptiondef>
  1. To remove the option, comment out the section to look like this:
    <!--    
<subscriptiondef>
<defid>{6F87F156-E46B-4c16-8E3E-710BF6D518DA}</defid>
<type>300</type>
<label>Change to Folder</label>
<cebased>true</cebased>
<description>Notify me whenever a document or folder is added to this Folder</description>
<subscribableobj>folder</subscribableobj>
</subscriptiondef>
-->
  1. Save the file and check it into the object store using the Collaboration Configuration document class.
  2. Recycle the Application Server (Tomcat, Weblogic, etc.) to eliminate any cached copies of the configuration files, then restart the Collaboration Engine.

 

Enable the individual "document added to folder" and "folder added to folder" subscription options

  1. Open the Collaboration User Subscription Definitions.xml file for editing using a text editor or an XML editor.
  2. Search for <label>Document added to this Folder</label> to locate the following section of the file:
    <!--
<subscriptiondef>
<defid>{3B31FAC8-9BB0-4aa2-A48D-DA77EC4809BC}</defid>
<type>301</type>
<label>Document added to this Folder</label>
<cebased>true</cebased>
<description>Notify me whenever a document is added to this Folder</description>
<subscribableobj>folder</subscribableobj>
</subscriptiondef>
-->
  1. Remove the comment marks ( <!-- and --> ) .
  2. Search for <label>Folder added to Folder</label> to locate the following section of the file:
    <!--
<subscriptiondef>
<defid>{12B12DBC-5ABC-4486-AB02-F046D910814E}</defid>
<type>302</type>
<label>Folder added to Folder</label>
<cebased>true</cebased>
<description>Notify me whenever a Folder is added to this Folder</description>
<subscribableobj>folder</subscribableobj>
</subscriptiondef>
-->
  1. Remove the comment marks ( <!-- and --> ) .
  2. Save the file and check it into the object store using the Collaboration Configuration document class.
  3. Recycle the Application Server (Tomcat, Weblogic, etc.) to eliminate any cached copies of the configuration files, then restart the Collaboration Engine.