Adding a Subscription

If you currently have no subscriptions, you can use the "Add Subscription to Resource/Collection" link to add a new subscription.

Follow the below instructions to add a new subscription in the Management Console.

Steps to Add Subscriptions

1. Sign in. Enter your user name and password to log on to the Management Console.

2. Click the "Configure" button to access the "Configure" menu.

3. In the "Configure" menu of "Governance Registry Management Console," click on "Notifications" to access the "Manage Notifications" page.

4. Click "Add Subscription to Resource/Collection" to access the "Registry Subscription" page.

Add Subscriptions to a Resource 

When you click on the given above link to add a new subscription you will be forwarded to a dedicated page through which you can subscribe to notifications made on resources and collections of a single or many types.

Add Subscriptions to a Collection

For Collections there is an additional facility of creating Hierarchical Subscriptions if needed. By default when a user adds a subscription to a Collection it will only get added to that collection. Similarly the user can add a subscription to that collection and its immediate child resources by selecting the option  Collection and Children only  or to that collection and all of its child resources by selecting the option  Collection,Children and Grand Children .

Add Subscription Options 

On the "Registry Subscription" page, specify the following options:

• Subscription Path - The path to the Resource/Collection. Click on the ".." button to "Select a Resource/Collection" from the "Resource Tree" browser.
• Event- The event type of the notification. You may select from the following options:
  • Check LC Item - Represents an event that occurs when an item is checked in a lifecycle checklist
  • Uncheck LC Item - Represents an event that occurs when an item is unchecked in a lifecycle checklist
  • Create Child - Represents the event of creating a resource (or collection) within an existing collection
  • Delete Child - Represents the event of deleting a resource (or collection) within an existing collection
  • Delete - Represents the event of deleting a resource (or collection)
  • Create LC - Represents the event of creating a lifecycle
  • Delete LC - Represents the event of deleting a lifecycle
  • Change LC State - Represents the event of changing a lifecycle state
  • Update - Represents the event of updating a resource or collection
• Notification- The notification method. You may select:
  • Email- Any valid email address
    
    • Email - The email address to which notifications should be sent
    • Digest Frequency- How often notifications are sent
      
      • None (instant)
      • Hourly
      • Daily
      • Weekly
      • Fortnightly
      • Monthly
  • REST - An endpoint accepting HTML or text content
    
    • Post URL - The URL of the endpoint accepting HTML or text content to which notifications should be sent
  • SOAP - An endpoint accepting notifications as a SOAP message
    
    • Endpoint - The URL of the endpoint to send a notification as a SOAP message
  • User Profile- A valid user's profile. Notifications will be sent to the email address specified in the user's default profile.
    
    • Name - The user's name
    • Digest Frequency- How often notifications are sent
      
      • None (instant)
      • Hourly
      • Daily
      • Weekly
      • Fortnightly (biweekly)
      • Monthly
  • Group Profile- A valid role. Notifications will be sent to all of the users in the specified role.
    
    • Role - The role's name
    • Digest Frequency- How often notifications are sent
      
      • None (instant)
      • Hourly
      • Daily
      • Weekly
      • Fortnightly (biweekly)
      • Monthly
  • Management Console - With a valid role Notifications will be sent to work-list of the role.
    
    • Role - The role's name 
  • JMX -  Notifications will be sent via JMX. Please refer Support for JMX.
• Hierarchical Subscription Method (for Collections only)
  • Collection only - The subscription will be effected on the selected collection only.
  • Collection and Children only - The subscription will be effected on the selected collection and its immediate child resources only.
  • Collection,Children and Grand Children - The subscription will be effected on the selected collection and its all child resources .
    

E-mail Notifications 

1. First to enable sending email notifications user has to configure the mail transport in axis2.xml at GREG_HOME/repository/conf/axis2/ . Please refer this page to enable email configuration.
2. User has to provide a valid email address to receive notifications from the subscribed resource. 
   
   

3. When a subscription is added initially a verification email will be sent to the user. When user clicks the verification URL the server console would get open in a different tab prompting a successfully verified message.

   One Time Email Verification

   When adding subscriptions to different resources defining the same email address as the notification method, for each subscription users will receive verification email with a link to verify the subscription. The subscription will get active only if the user clicks the verification URL. But if the user starts the server as ./wso2server.sh -Donetime.email.verification=true  the email verification would only happen once when the particular email address is used for first time.

   Changing Host Name of URLs in Verification/Notification E-mails

   To change the Host Name of URLs appearing in Verification and Notification e-mails, set the HostName attribute in repository/conf/carbon.xml.

   
   

4. When ever an event occurs which is in accordance with the subscription type, user will recieve notification emails . 

User Profile Notifications / Role Profile Notifications

1. User profile notification method can be used to subscribe different users to events of resources. And Role profile notification method can be used to subscribe different roles to events of resources so that all the users of that role would get subscribed for notifications.
2. In both these methods a user should have a profile and that profile should contain an email address. Notifications will be send as emails to the defined email address in the profile. Refer Managing User's Profile. 
3. To use these notification methods the mail transport configuration should be enabled in axis2.xml at GREG_HOME/repository/conf/axis2/. Please refer this page to enable email configuration.

Management Console Notifications

1. When using the Management Console notification method roles of users are subscribed to events of resources. And notifications will be displayed on worklist tab in the top. The number of notifications received will be shown on the tab and when the tab is clicked then the list of notifications will be displayed.
   
   
2. To enable this notification method first it is necessary to add WorkList configuration to registry.xml at  GREG_HOME/repository/conf/. Please refer this page to enable WorkList configurations.
   
   

Once all the options are specified, click the "Subscribe" button.

List Added Subscriptions

When a new subscription is added it will be displayed on the "Notifications" list.

Clicking on the "Path" name will take you to the "Browse" page containing the details of a Resource/Collection. See: Resources.