Document toolboxDocument toolbox

(no) Notifications

Owned by Maciej Zabielski
Aug 13, 2020
4 min read

Translation needed

The content of this page was copied from another page tree and needs to be translated or updated.

When you finish translation, make sure to

  • Replace the label NEEDS-TRANSLATING with TRANSLATED

  • Remove this macro from the page



Since 2.3.0

Introduction

HDC provides a highly configurable notifications system that can be divided into three main categories:

  1. E-mail notifications

  2. Notifications Log

  3. Push Notifications

Notifications Scheme

Specific users can be notified about an event. An administrator can decide what users will receive what type of notifications for each given event type.

Such assignment can be made in an Administrative Panel in Notifications Scheme section.

  • Direct Assignment - users listed by name or group will always receive a notification abut such event, regardless if they were part of this event or interaction. 

  • Owner - Owner of the event is a contextual user that has triggered the event. 

  • Target - Target user is a contextual user that was a target of this event, e.g. something was shared with that user. It also supports groups of users. 
    Each user will be notified only once per event, event if one is listed in multiple groups or as a named user.

The notification system will check given user privilege at the time the event takes place. If a user listed by direct assignment does not have a right to view given object, he/she will be excluded from the subscription. 

Base systems security cannot be overridden by notification scheme. 

Available Events

List of events is easily expandable and can cover wider range of situations. Please note, that if recommended assignments are not in place, some functions in the user interface might not behave as expected.

Current version supports the following events:

Event name

Direct Assignment

Owner

Target

Recommended Assignment

Event name

Direct Assignment

Owner

Target

Recommended Assignment

Draft Unshared

Yes

Yes

Yes

Minimum of Target assignment for selected notification types.

Draft Shared

Yes

Yes

Yes

Minimum of Target assignment for selected notification types.

Document Changed

Yes

Yes

No

Assign "Users" group in your system, that includes all users to Push type only.

Avoid setting e-mail or log notifications.

Redline Shared

Yes

Yes

Yes

Minimum of Target assignment for selected notification types.

Redline Unshared

Yes

Yes

Yes

Minimum of Target assignment for selected notification types.

Draft Published

Yes

Yes

No

Assign users or groups that should be informed about change.

Import Finished

Yes

Yes

No

Assign Owner for selected notification types.

Tiling finished

Yes

Yes

No

Assign Owner for selected notification types.

Batch Print Finished

Yes

Yes

No

Assign Owner for Push notification.

If not set, server will not notify user about finished print jobs!

Default Version Changed

Yes

Yes

No

Assign users or groups that should be informed about change.

Export Finished

Yes

Yes

No

Assign Owner for selected notification types.

Event Plugin Processing Finished

Yes

Yes

No

Assign Owner for selected notification types.

Subtree Processing Finished

Yes

Yes

No

Assign Owner for selected notification types.

Advanced Search Query Shared

Yes

Yes

Yes

Minimum of Target assignment for selected notification types.

Advanced Search Query Unshared

Yes

Yes

Yes

Minimum of Target assignment for selected notification types.

Excessive login attempts
(since v. 3.8.0)

Yes

Yes

No

Assign Owner for selected notification types. If needed selected administrators can be chosen directly to receive notification for all multiply failed logins attempts.

Auto Linking Finished
(since v. 3.8.0)

Yes

Yes

No

Assign Owner for selected notification types.

Metadata Report Finished
(since v. 3.8.0)

Yes

Yes

No

Assign Owner for selected notification types.

Request Created
(since v. 3.8.0)

Yes

Yes

No

Assign Owner for selected notification types or/and selected user performing role of Request manager if needed.

Request User Assigned
(since v. 3.8.0)

Yes

Yes

Yes

Minimum of Target assignment for selected notification types.

Request State Changed
(since v. 3.8.0)

Yes

Yes

Yes

Assign Owner and Target for selected notification types. Also selected user performing role of Request manager can be assigned if needed.

Request New Comment
(since v. 3.8.0)

Yes

Yes

Yes

Assign Owner and Target for selected notification types. Also selected user performing role of Request manager can be assigned if needed.



Please note that Basic Archive Manager role is needed for users to open drafts shared with them.



E-mail notifications

Email notifications are based on templates that are specific for every event type. 

Templates can be customized to meet user needs and are send out in recipient preferred language. 

Message body contains contextual navigation buttons that are dependent on the content, and allow direct navigation to given object or document when applicable. 

Notifications Log & Dashboard



Notifications log is build based on scheme. There is no need to log all events, but an Administrator can decide what type of events are persistent and are stored in the system.

Stored events (log) can be accessed through user dashboard and Activity widget.



Each notification has it's own template with contextual action buttons.

User can easily open a shared document, object or system Draft. 



Additional filters can be used to limit a number of shown log items. Select Event Types that should be shown using a drop-down menu:

Select "Only Mine" filter, to see events that were meant for you directly, meaning you were the "target identity" of that event. 

Events that you have subscribed by directly, without being a target, will be omitted. 

Push Notifications

Push notifications have multiple use cases. They can be used to instantly notify users about a given change or event, like the fact that something was changed or shared with them.

They can also be used to instruct client application that something needs reloading, so that a user can have a better experience and up to date information.

An image below shows an example of Toast message shown as a result of Draft shared event.