Skip to content

Commit

Permalink
notifications+access request: primp for v12 release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
fenekku committed Jul 12, 2024
1 parent bdc6f7f commit 8b87fdb
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/develop/architecture/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The notification system in InvenioRDM is provided via the [`invenio-notification


## Service Level

Notifications are registered at the service level in the unit of work and send off to a celery task - which takes care of further processing. When dispatching this notification in the service, the context shall be as minimal as possible, to reduce passing huge chunks of data.
The implications of sending all of the required immediately would be a hit on performance and higher memory usage.
As the notification operations are registered during methods of the service level, it would increase response time for requests using these methods.
Expand All @@ -28,9 +29,8 @@ After it is build, it can be dumped and send to a background task for further pr


## Notification Manager
A notification manager is created, which will rely on certain [configuration values](../howtos/notifications.md#configuration-values) and provide logic to send notifications. Its task is also to call respective methods to resolve the notification context, generate recipients, filter recipients and generate the backend ids for further processing. With all information created, it will then dispatch further tasks to relay the notification to the backend, which will take care of sending the actual notification.


A notification manager is created, which will rely on certain [configuration values](../howtos/notifications.md#configuration-values) and provide logic to send notifications. Its task is also to call respective methods to resolve the notification context, generate recipients, filter recipients and generate the backend ids for further processing. With all information created, it will then dispatch further tasks to relay the notification to the backend, which will take care of sending the actual notification.

<details>
<summary>A recipient entity could look like this</summary>
Expand Down
14 changes: 10 additions & 4 deletions docs/features/features-walk-through/access_requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,21 @@ Note: accepted access requests grant to the requestor access to **all** versions
## Enable access requests

As a record owner, you first need to allow accessing restricted files via a request:

0. Create a record with restricted files

1. Click on the "Share" button on the record landing page:
![Share button](./img/access_request_share_button.png)
2. Navigate to the "Access requests" tab of the modal:

2. Navigate to the "Settings" tab of the modal:
![Access requests tab](./img/access_requests_tab.png)

3. Change the settings for the access requests:
* Allow authenticated or/and unauthenticated users to request access to restricted files of your record.
* Accept conditions. Provide a message that will be visible to the users in the request form (see screenshots below)
* Set access expiration date. This setting will be applied by default to all access requests. When reviewing an access request, you can set a different value.

* Allow authenticated or/and unauthenticated users to request access to restricted files of your record.
* Accept conditions. Provide a message that will be visible to the users in the request form (see screenshot below)
* Set access expiration date. This setting will be applied by default to all access requests. When reviewing an access request, you can set a different value.

4. Save your changes
![Access requests tab save](./img/access_requests_tab_save.png)

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions docs/features/features-walk-through/notifications.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Notifications

Notifications are sent at specific events (e.g. community invitation, community recod submission), to inform users of relevant actions. Institutions can define their own available ways of sending notifications. InvenioRDM ships with E-Mail notifications as standard.
_Introduced in InvenioRDM v12_

As an example, imagine submitting a record to a community. When you do this, a notification will be sent to community owners and managers informing them of your request. When they comment on your request, you will receive a notification of said comment. This will allow all participating parties to get informed of relevant actions and updates, without the need of manually observing the site.
Notifications are sent at specific events (e.g. community invitation, community record submission), to inform users of relevant actions. Institutions can define their own available ways of sending notifications. InvenioRDM ships with E-Mail notifications as standard.

As an example, imagine submitting a record to a community. When you do this, a notification will be sent to community owners and managers informing them of your request. When they comment on your request, you will receive a notification of said comment. This will allow all participating parties to get informed of relevant actions and updates, without anyone needing to manually observe the site.

## Notification Settings

Expand Down

0 comments on commit 8b87fdb

Please sign in to comment.