This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Adding a Subscription

You can use the "Add Subscription to Resource/Collection" link to add a new subscription.

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

1. Sign in. Enter your user name and password to log on to the Management Console as described here for Windows users and here for Linux users.

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

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

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

Note

To be able to see this link, you must first add a subscription (as described in Managing Subscriptions).

5. 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
        • Hourly
        • Daily
        • Weekly
        • Fortnightly
        • Monthly
    • HTML/Plain-Text - An endpoint accepting HTML or text content
      • 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
      • URL - 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
        • 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
        • Hourly
        • Daily
        • Weekly
        • Fortnightly (biweekly)
        • Monthly

Tip

If you have subscribed with the notification method "User Profile," you can also browse the user's default profile by clicking on the "User Profile" link under the "Notification" tab.

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

Tip

You can also add new subscriptions to a Resource/Collection by browsing that Resource/Collection using the "Resource" browser and clicking the "Add Subscription" link in the "Subscriptions" box that appears in the right-hand side pane of the resource browser. See: Managing the Resources.

7. A new subscription is added to the "Notifications" list.

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

Tip

If you have subscribed with the notification method "User Profile," you can also browse the user's default profile by clicking on the "User Profile" link under the "Notification" tab.

Note

To send email notifications, configure the mail transport in axis2. This can be done by adding the following configuration to the file IS_HOME/repository/conf/axis2.xml

<transportSender name="mailto" class="org.apache.axis2.transport.mail.MailTransportSender">
        <parameter name="mail.smtp.host">smtp.gmail.com</parameter>
        <parameter name="mail.smtp.port">587</parameter>
        <parameter name="mail.smtp.starttls.enable">true</parameter>
        <parameter name="mail.smtp.auth">true</parameter>
        <parameter name="mail.smtp.user">USERNAME</parameter>
        <parameter name="mail.smtp.password">PASSWORD</parameter>
        <parameter name="mail.smtp.from">USERNAME@gmail.com</parameter>
    </transportSender>