Manage object subscriptions across users - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

This is used to manage the subscriptions of all users to all objects.

  1. Select Administration > Subscription > Manage Object Subscriptions across users in the Desktop Client.

    When using this option, you are provided a filter dialog box that you can use to reduce the results returned.

    Option

    Description

    Class definition

    This lists all class definitions that realize ISPFSubscribableItem, used to determine the valid interfaces.

    InterfaceDef

    When a class definition is selected, this box lists its associated interface definitions with the primary definition auto selected. Users can multi-select from this list.

    This list is sequenced by the interface's specialization value and not alphabetically.

    Subscribed object name

    This will return the subscriptions to any object with the name entered. Wild cards (*) can be used.

    This box is useful if the customer has a naming convention for their documents.

    Event

    Return all subscriptions trigged by the specified event.

    Creation user

    Return all subscriptions created by the specified user.

    Recipient user

    Return all subscriptions the specified user will receive.

    Recipient role

    Return all subscriptions the specified role will receive.

    Creation date

    Return all subscriptions created on, before, after or between specified dates.

    Click in this box to display the Set Time and Date form.

  2. Select the required options, and click OK. The Object Subscriptions for All Users form is displayed with any subscriptions found listed at the bottom of the form.

    If the selected interface definitions have no existing subscriptions, then there will be no entries for it in the list, and so no new subscriptions will be able to be added for it on this form. Subscriptions for the required class must be managed individually first.

    SHARED Tip Leave the filter form fields blank to return all subscriptions for the object.

  3. Select an object in the list. The Object box and Event list are populated.

    Option

    Description

    Object

    Displays the object selected in the list below.

    Event

    Lists all the events for the selected object.

    Condition

    Lists the conditions that can be set for the object.

    Roles

    The role subscribed to the object.

    Users

    The user subscribed to the object.

    Add

    Adds the subscription to the object.

    Update

    Enables the subscription, selected in the list, to be updated.

    Remove

    Removes the selected subscription from the object.

    Remove All

    Removes all the subscriptions from the object.

    The columns displayed in the list are delivered with the standard core model. You can use the Manage Related Items option (see Manage related items for details) to edit the columns in the Subscriptions form. However, users are advised to only add columns and not delete existing ones.

  4. To Add another subscription to the object:

    • Select the object in the list.

    • Select the Event to trigger the subscription (mandatory).

    • Select a Condition if required (optional).

    • Select a User or Role (optional when managing subscriptions).

    • Click Add. The subscription is added to the object and also displayed in the list (bottom of form).

    • The recipient for a particular subscription can be a user or a role, but not both.

    • You can only add a subscription if there is an existing subscription on the object.

  5. To Update a subscription to the object:

    • Select the object in the list.

    • Change the event, condition, user or role settings as required.

    • Click Update. The subscription is updated.

  6. To remove a subscription to the object:

    • Select the object in the list.

    • Click Remove. The subscription is removed from the object and also removed from the list.

The above form can only be used to add, update or remove subscriptions to the objects currently in the list (that is, objects that already have subscriptions). To add a subscription to an object not in the list you must, use the shortcut menu command from the object in the Desktop Client.