Go to primary content
Agile Product Lifecycle Management Web Services Guide
Release 9.3.6
E71166-01
  Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

4 Subscribing to Agile PLM Objects

Once you load an Agile PLM business object, such as an item or change, you can subscribe to that object. Whenever a triggering event occurs for that object, you will receive a Notification. Subscription events can be a lifecycle change, a change to attachment files, or a change to the value of any cell that is made available for subscription.

You can subscribe to both routable and non-routable objects. The Agile web services provides an interface which enables retrieving and modifying all subscriptions for an object. All objects that you subscribe to are listed on the Subscription table.

4.1 Subscribe Privilege

To subscribe to an object, you must have the Subscribe privilege for that class. Many predefined Agile PLM roles, such as Creator, already have the Subscribe privilege for several object classes. To change your roles and privileges, see the administrator of your Agile PLM system.

4.2 Subscription Notifications

Subscription events trigger two types of Agile PLM Notifications:

  • Email - Email Notifications are sent only if the user's Receive Email Notification preference is set to Yes. For information on user and system preferences, refer to the Agile PLM Administrator Guide.

  • Inbox - Inbox Notifications occur automatically regardless of user preferences

A user with Administrator privileges can create and configure these Notifications in Java Client, which provides two very similar dialogs for this purpose. The two dialogs are provided because there are two sets of Email and Inbox Notifications:

  • Those that the "To" field is grayed out

  • Those that the administrator user can select, who are notified when the subscription event is triggered.

4.2.1 Getting Subscriptions for an Object

To retrieve the current subscriptions for an object, use getSubscriptions method, which returns an array of all subscription objects, both enabled and disabled.

4.2.2 Modifying the Subscriptions of an Object

You can use the Agile web services to modify subscriptions for the current user only. If you change your subscriptions for a particular business object, other users' subscriptions for that object remain unaffected.

The list of subscription events for any object is set at the server and cannot be modified by the Agile web service. However, you can select the fields (attributes) you want subscribed. If you have Administrator privileges, you can also modify classes to define which fields are available for subscription.

To work with a subscription, use the "modifySubscriptions."