Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Subscriptions

Truedat can send email notifications to application users based on subscriptions to different events. Users can subscribe through different subscription types.

Subscribers:

  • User/Email: Subscribe a single user to events. This subscriber type lets you define which user receives notifications for each event.

  • Role: Subscribe all users with a specific role in the selected domain. For example, users with the "Data Owner" role for a concept receive notifications when that concept changes.

  • Role in taxonomy: Same as Role, but includes users with the role in the selected domain or any subdomain.

Resources:

Subscriptions link to a selected application resource. Available resources depend on the event type:

  • Structure

  • Domain: resources assigned to this specific domain.

  • Domain and children: resources assigned to this specific domain or any of its subdomains.

  • Concept

  • Quality Rule

  • Quality Implementation

  • Source

Events:

The following events currently support 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 updated

    • Structure Note versioned

  • Grants:

    • New grant request pending approval

    • Grant request approval: new approval

    • Grant request approval: consensus

    • Grant request rejected (*)

    • Grant request canceled

    • Grant request: process started (processing)

    • Grant request: process completed (processed)

    • Grant request: process failure

    • 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 detects a removed relation element)

  • Sources:

    • Jobs status changes

  • Quality:

    • Rule created

    • Implementation created

    • Remediation plan created

(*) When a grant request is rejected, the requesting user is automatically notified. No subscription is required.

(**) Subscriptions to this event work differently from other events. Although the subscription is configured for a role, only the user granted access is notified. Other users with that role are not notified.

Events with parameters

  • Rule result created:

    • 🔴 < Threshold

    • 🔶 > Threshold, <Goal

    • ✅ > Goal

    • Empty data set

    • Failed execution

  • Implementation status updated:

    • Draft

    • Pending approval

    • Rejected

    • Published

    • Versioned

    • Deleted

Subscriptions administration

Use the administration option to create subscriptions that alert users about events affecting concepts where they have a specific role.

New Subscription

  1. Select the subscriber type. Depending on the type, select from a list of roles or users, or enter free text. For Role and Role in taxonomy, the domain is determined by the selected resource.

  2. Select the resource type for the notifications. Depending on the resource type, select the corresponding entity. Domain and Domain and children work differently:

    • Domain: Includes only entities directly linked to the selected domain.

    • Domain and children: Includes entities linked to the selected domain or any subdomain.

  3. Periodicity: Choose immediate emails when an event occurs, or periodic notifications daily or hourly.

  4. Events: Select the events for this subscription. Some events cannot be combined in one subscription. Compatibility depends on each event type's required parameters.

Examples of Role and Role in taxonomy

For the Published concept event:

Subscriber: Role (Data Owner) | Resource: Domain (Domain 1)

Notifications:

  • When 'Concept 1' is published, 'Data owner 1' is notified.

Subscriber: Role (Data Owner) | Resource: Domain and children (Domain 1)

Notifications:

  • When either 'Concept 1' or 'Concept 1.1' or 'Concept 1.2' are published, 'Data owner 1' is notified.

Subscriber: Role in taxonomy (Data Owner) | Resource: Domain and children (Domain 1)

Notifications:

  • When 'Concept 1' is published, 'Data owner 1' will be notified.

  • When 'Concept 1.1' is published, both 'Data owner 1' and 'Data owner 1.1' are notified.

  • When 'Concept 1.2' is published, both 'Data owner 1' and 'Data owner 1.2' are notified.

Subscription details

From the subscription view, an administrator can review the configuration and perform these actions:

  • Edit subscription: You cannot modify the subscriber or resource. Changes create a new subscription.

  • Delete subscription