Truedat Docs
Search…
Subscriptions
Truedat has capabilities to send notifications via email to the application users depending on subscriptions to different events in the application. Users can be subscribed via different type of subscriptions.

Subscribers:

  • User: Subscribe an user to one event. With this type of subscriber we could define exactly which user want to receive notifications for which events.
  • Role: We could subscribe a role to receive a notification. This way we could, for example, set-up that all users with role "Data Owner" over a quality rule will receive notifications when there is an error over that rule.
  • Role in taxonomy: Same as Roles suscriber but using taxonomy to inherite the role to subdomains to the selected domain.

Resources:

Subscriptions will be linked to selected resource in the application. Resources enabled will be different depending on the type of event to be subscribed:
  • Structure
  • Domain
  • Domain and children
  • Concept
  • Quality Rule
  • Quality Implementation
  • Source
A subscription linked to a domain will allow to receive notifications for any event produced within the domain.

Events:

List of events currently supported for subscriptions:

Events without parameters:

  • Concepts:
    • Concept deprecated
    • Concept published
    • Concept rejection canceled
    • Concept submitted (for approval)
    • Delete concept draft
    • New Concept Draft
    • Update concept draft
    • Comment created
  • Data Structures:
    • Tag added to structure
    • Tag modified
    • Tag deleted from structure
    • Structure Note deleted
    • Structure Note deprecated
    • Structure Note return to draft
    • Structure Note pending to approval
    • Structure Note published
    • Structure Note rejected
    • Structure Note versioned
  • Grants:
    • Access to a structure has been granted
    • Access to a structure has been revoked
  • Relationships:
    • Relation created (between concept and other concepts or structures)
    • Relation deleted
    • Relation deprecated (automatically discovery of removed element in the relation)
  • Sources:
    • Jobs status changes
  • Quality:
    • Rule created
    • Implementation created

Events with parameters

  • Rule result created:
    • ​
      🔴
      < Threshold
    • ​
      🔶
      > Threshold, <Goal
    • ​
      ✅
      > Goal
    • ​
      Failed execution
  • Implementation status update:
    • Draft
    • Pending approval
    • Rejected
    • Published
    • Versioned
    • Deleted
​

Subscriptions administration

Using the administration option you will be able to create new subscriptions in order to alert users of different events happening to concepts in which the user has a certain rol.

New Subscription

  1. 1.
    Select the type of subscriber you want to select and will be given a list of roles, list of users or free text field depending on the selection.
  2. 2.
    Select the type of resource you want for your subscription. Depending of the type of resource selected you will have to select the corresponding entity. Be aware that Domain and "Domain and children" work in slightly different manner.
    • Domain: Subscription only to entities directly linked to the given domain
    • Domain and children: All entities linked to the given domain or any of its children will be included in the subscription.
  3. 3.
    Periodictiy: Select if you want users to receive emails immediately when the event is produced or have periodic notifications (daily or hourly).
  4. 4.
    Events: Select to which events this subscription will apply. Be aware that some of the events are not compatible in the same subscription. Compatibility between events depends on the parameters required for each type of event.

Subscription details

From the subscription view an administrator will be able to check the subscrition configuration and perform following actions
  • Edit subscription: Subscriber and resource are not allowed to be modified since in that case it is considered a new subscription.
  • Delete subscription