Show / Hide Table of Contents

    Notifications

    Notification is a single notification of one user for one event. The event can contain multiple references to objects, definitions, etc.

    • Although notification is an entity in the Social interactions module, a notification can be raised by any module in the system.
    • A notification is most often "transmitted" by a real-time event.
    • Each notification is persistent. It lives in the database (i.e. it has a corresponding record).
    • Notifications MAY specify a data object.
    Note

    If a notification specifies a data object, this means that it's related to this data object. However, this attribute is not required and can be null.

    Notification interaction

    Often, the user can interact with a notification. The most common example when the notification appears as a toast- the user can click on it. In this scenario, if the notification is bound to a data object, it will be opened.

    A simple example:

    • You're following a specific document. E.g., an offer.
    • Someone writes a comment in its corresponding chatter control.
    • If you're online, you'll receive a notification as a toast.
    • If you click on the notification- you'll be navigated to the document (i.e. the offer).
    Note

    When a notification is displayed to a user, it is marked as read. This does not guarantee that the user has read or understood it.

    Note

    The UI in some apps might require the user to actually click on the notification in order to mark it as read.

    Notification classes

    Each notification has a class which specifies the type of the notification. Additionally, all notification classes are grouped for better classification.

    Also, most of the notifications are created automatically via business rules when the corresponding event occurs (e.g. when someone writes a comment).

    Notification class Group Business rule Description
    NT_DOC_STATE_IMPLICIT Document R33718 Document- Notify All Implicit Followers If a document changes its state and you're following an entity, related to this document (e.g. its customer, its document type, etc) you'll receive a notification.
    NT_SOC_REPLY Social R33428 SocialComment- Notify User Comment Replied There was a reply to your post or comment.
    NT_SOC_NEW_POST Social - New post in a group, in which you're a member.
    NT_SOC_MENTION Social R32943 SocialComment- Notify The Mentioned User You're mentioned in a post or comment.
    NT_SOC_REACTION Social R33427 SocialReaction- Notify User Comment Reaction There was a reaction to your post or comment.
    NT_WM_QTY_BELOW_MIN WMS - In Warehouse management, when the qty in a tracked bin falls below the minimum.
    NT_SOC_NEW_COMMENT Social R33417 SocialComment- Notify All Object Followers New comment to an object you are following.
    NT_AE_UPON_UPDATE All Entities R34361 All Entities - Notify All Object Followers Upon Update Create notification for all followers of each updated object.

    I don't care about notifications

    You can always mute the notification classes you're not interested in. Or you can mute all of them. This way you won't be notified of anything you don't want. For more information see our separate topic Notification settings

    Create notifications programmatically

    It's possible to create notifications programmatically via Domain API. For more information, check the dev topic,

    https://docs.erp.net/dev/domain-api/common-tasks/create-notification.html

    • Improve this Doc
    Back to top Generated by DocFX