Introduction

The The Arcadia-funded COAR Notify Project is developing and accelerating community adoption of a standard, interoperable, and decentralised approach to linking research outputs hosted in the distributed network of repositories with resources from external services such as overlay-journals and open peer review services, using linked data notifications. As part of this project, COAR is funding the development of platforms and systems to support the exchange of linked data notifications across partner organisations and the workflows to manage notifications in those platforms and systems. As the largest adopted repository platform in the World one of the first platforms to be addressed is DSpace the implementation of which has been entrusted to 4Science.

The application can receive and send LDN messages concerning items with external systems. The LDN system is the protocol of message exchanging; the Quality Assurance system is the mechanism used to approve or reject item updates.

How to enable

Configuration properties involved:

Relation with the Quality Assurance Correction Service

The LDN system, as a message exchanging i/o system, has an inbox and an outbox. Every LDN message refers to a Notify Service: all the Notify Services are configured manually from the admin application form. A Notify Service is just like an authority labelled on LDN messages.

...

The match between LDN message type and the QAEvent topic (suddenly created by the evaluation of the ldn message from the queue) is configured onto ldn-coar-notify.xml spring file. Every Processor owns a list of actions. An action is often an email to be sent and an action to create the qa event. The LDN processor receives the QAEvent topic as a parameter and creates the relative QAEvent.

LDN Autodiscovery mechanism

Third party system can retrieve the location of the repository LDN InBox via the LDN autodiscovery mechanism, nevertheless to be able to interact with DSpace they need to be approved by a Repository Administrators and listed in the LDN Services Directory (see next paragraph); otherwise their messages will be flagged as untrusted and not processed at all.

LDN Services Directory

...

(Registering Services)

You need to register the external services to trust allow the handling of the incoming LDN messages / send LDN messages to:.

These services are also used to send LDN notification during the submission process of an item (Please take a look at LDN Inbound pattern)

Administrators can do that manage services using the menu LDN Services. New/Edit Notify Service with this form

The following page is used to submit a new LDN Service:

LDN Inbox queueing

LDN incoming messages are stored into the ldn_message database table. As far as the property ldn.enabled  is true and the incoming json is valid, the LDN Message is stored on the table. Together with the storage of the record, the queue status of the message is initialized. The queue_status column of the table contains the status of the LDN message inside the queue. All the possible queue_status values are described into the java class org.dspace.app.ldn.LDNMessageEntity as integer constants.

If valued as queued the LDN message will be processedall validations are run successfully the LDN Notification status is set as QUEUE_STATUS_QUEUED and the notification will be processed as soon as the extractor retrieves it from the queue. 

The LDN Message logical queue is managed by:

• The LDN Message Extractor is an asynchronous DSpace task that reads which retrieves the oldest manageable processable LDN message and enroute it to the LDN Router; an ldn message is manageable .
  A LDN notification is processable by the Extractor only if its queue status is QUEUE_STATUS_QUEUED. the extractor instance other status will not be considered by the extractor.
  The extractor process ends as soon as the LDN extracted message extracted is routed and processed or failed. For each tentative the attempts counter of the message is (either with success of failure).

• The LDN Message Timeout Checker  is an asynchronous DSpace task that looks for timed-out messages with attempts less than Y, where Y= the value of the configuration property ldn.processor.max.attempts. Cron configuration at property ldn.queue.timeout.checker.cron
  Each notification if not successfully processed is retrieved in the next execution of the Checker and attempts are kept up to date (increased by 1 and the timeout is increased by X minutes), where X= the value of the configuration property ldn.processor.queue.msg.timeout | defaulted to 60. Cron configuration at property ldn.queue.extractor.cron

• The LDN Message Timeout Checker  is an asynchronous DSpace task that looks for timed-out messages with attempts less than Y, where Y= the value of the configuration property ldn.processor.max.attempts. Cron configuration at property ldn.queue.timeout.checker.cron

Please consider that Please consider that this means that the corresponding QAEvent is not automatically created as soon as the LDN Message is received. LDN Message (accepted by the inbox controller and stored into ldn_message table) => Extractor (started runtime as a batch) => Routing => Processor => Action that creates the QA - see class org.dspace.app.ldn.action.LDNCorrectionAction

...

The QA Event related to the LDN Notification will be created only once the notification is successfully processed by the extractor (LDN queue status set to QUEUE_STATUS_PROCESSED).

Notify status boxes

Considering these possible scenarios here at: COAR Notify Protocol: Example Scenarios

...

When Offer message has been followed by a related Announce incoming message, the box shown is blue! It is blue because receiving an Announce means - then the message is extracted - we produce a new QA Event. As every QA Event it is shown on Item Page and myDSpace page.

Configuring automatic QA evaluation using the Level of Trust

It’s Score is a number 0 < # < 1. Triggers
If the proper configuration is enabled an automatic check for approval of QAEvent QAEvents is run once the LDN message is extracted.
On qaevents.xml spring configuration files   file the bean qaScoreEvaluation describes we can configure three different boundaries defaults to manage to automatically approve/reject/ignore the level of trust:

<property name="scoreToReject" value="0.3" />
<property name="scoreToIgnore" value="0.5" />
<property name="scoreToApprove" value="0.8" />

• if score <= rejection deletes the QAEvent;

...

• if score <= ignore discards the QAEvent;

...

• if score >= approval accepts the QAEvent automatically

...

• if score respects the following:  scoreToIgnore < score < scoreToApprove
  no automatic action is performed and the user must check manually the QA event

This feature must not be confused with the automatic triggering for LDN Inbound pattern

Sending LDN Notifications during the submission of an item

...

In the example below it is shown the submission of an Item with a new section named for COAR-Notify. 
In this section we can manually choose manually specific ldn-services which cover the request on (which were not marked as automatic) in order to ask for Review, Endorsement and ReviewIngest to external services.
If No LDN-Services have been configured with these Inbound Patterns, combos on the COAR-Notify section are going to be empty! Example:  by flagging automatic to the Inbound Pattern Request Review of LDN Service named "X" , it means that the LDN Service X will not be visible on the Request Review combo of the COAR-Notify submission section. This is the meaning of automatic: a Request Review is going to be sent out to X every time an Item is submitted. All items? No, the items filtered by the Item Filter configured on that Inbound Pattern. 

...

Image Removed

Test calls: Request Endorsement (LDN Message on item submission)

Let's configure a new Notify Service such as:

Image Removed

and save.

...

Create a new Collection inside the community

created above.

It is important for this community to have no Entity Type set.

Take a look into the item-submission.xml file for the

"traditional" steps sequence configuration. Here we've set

the coarnotify-step! The traditional step sequence is used as the

default, and the default is used for Collection with no entity

type associated.

If the coar-notify step is needed for every collection possible,

the entry-step must be added onto every <submission-process>

described into item-submission.xml

...

Create a new Item, select the collection created above.

As expected we see the COAR Notify section: here it is the

ldn request configuration: comboes for Review, Endorsement and

Ingest are filled with the corresponding configured LDN Services.

For this example we see only one value for the Endorsement 

combo (see the Inbound Pattern configured onto the Notify Service

...

A new LDN Message of type Offer: Endorsement Action

is stored and enqueued! As soon as the Extractor manages it, it is

enrouted to the Processor configured at ldn-coar-notify.xml

(as one of the <outcomingProcessors>). The processor

is the bean named outcomingAnnounceEndorsementAction, which lists 

the SendLDNMessageAction. So, it is only at this point, when the

action SendLDNMessageAction is executed - that the notification

 is sent out to the external Notify Service.

To whom the notification is sent out? To the url configured 

as the LDN Inbox property of the Notify Service

(see above: https://notify-inbox.info/inbox/).

...

as soon as our Offer is correctly received on the Notify Service side,

the Notify Service has to provide us - asynchronously as a separate Acknowledge

LDN message - the Acceptance or Rejection of the Endorsement we offered.

When Acceptance is received:

The Acknowledge LDN Message - when received - is managed by the Processor

configured into the bean named acceptAckAction.

When Rejection is received:

The Acknowledge LDN Message - when received - is managed by the Processor

configured into the bean named rejectAckAction.

(non-automatic) pattern has been configured for the LDN Service this service will not be displayed in any of the dropdown. 

Automatic Inbound pattern triggering

When adding new LDN Inbound pattern to a LDN Service we can select if a pattern has to be automatic or not.

Flagging a pattern as automatic means that the request described by the current pattern is sent automatically to the external service:

• No action is required during the submission to select the LDN Service for a specific pattern
• The service in not even listed in the COAR notify step of the submission 

Item filters for Inbound pattern

When adding inbound pattern to a service we have the possibility to add an item-filter for each described pattern

An item filter allows to filter items according to specified criteria.

• If the pattern is flagged as automatic the item filter is evaluated automatically
  • if the item filter is respected the LDN Notification is stored and queued for sending
  • if the item filter is not respected the LDN Notification is not even generated an nothing will be sent to the external service
• If the pattern is not flagged as automatic the item filter is evaluated when choosing the service from the dropdown for Notify in the submission
  • if the pattern is not respected an error message will be displayed saying the selected LDN service cannot be used for the current item
  • if the pattern is respected no error message is displayed 

Item Filter is a non-mandatory field. It activates a filter to be applied to the item during the submission. 
If the item matches the item filter condition the submission will be successful: otherwise the submission will fail with a talkative message.
Visible item filters are configured into a static list mapped into item-filters.xml file - on a bean named ldnItemFilters. We established for the following item filter to be shown:

Has one Bitstream = the item must have exactly one bundle named "ORIGINAL";
Item is public = anonymous user can see/read the item;
Title starts with pattern = the dc.title metadata of the item must start with 'Pattern';
Type equals dataset = the dc.type metadata of the item must be 'Dataset';
Type equals dataset = the dc.type metadata of the item must be 'Journal Article';

item-filter.xml has all item filters declarations: only the ones declared inside the ldnItemFilters map are shown.

Image Added

The LDN Consumer

The LDN Consumer is the consume responsible for generating the outgoing LDN Notification.

This consumer is triggered any time an Item is successfully installed and a check against the registered LDN Services/patterns is done to generate the appropriate LDN Notification

This consumer is responsible for the handling of both automatic a non-automatic patterns

Understanding the structure of the LDN Notification

The LDN Notification includes some important section many of these if improperly set might led to errors in evaluations on the notification

Let's take a deeper look at the LDN Notification structure

@context

The context section is the same for any LDN Notification 

  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ]

actor

This section describes the actor which performs the request
This is a descriptive section and doesn't include important information

  "actor": {
    "id": "https://review-service.com",
    "name": "Review Service",
    "type": "Service"
  }

context

This is one of the most important section.
In this section we have a description of the Item being involved in the LDN Notification

• id → is the identifier URL of the item in the repository
  this field is really important to identify and link the Item to the current notification

other fields are descriptive fields for the item

  "context": {
    "id": "https://research-organisation.org/repository/preprint/201203/421/",
    "ietf:cite-as": "https://doi.org/10.5555/12345680",
    "type": "sorg:AboutPage",
    "url": {
      "id": "https://research-organisation.org/repository/preprint/201203/421/content.pdf",
      "mediaType": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    }
  }

id

The identifier of the LDN notification (Each notification has a different id)

inReplyTo

This field is used to reply to other LDN notification so that the system knows if the current notification is a response

object

This is a descriptive section of the received Review, Endorsement etc..

• id → is the URL of the review/endorsement etc.

  "object": {
    "id": "https://review-service.com/review/geo/202103/0021",
    "ietf:cite-as": "https://doi.org/10.3214/987654",
    "type": [
      "Document",
      "sorg:Review"
    ]
  }

origin

This is an important section since it is used (for incoming notifications) to determine the service among the registered ones.
If the service is not recognized as registered the notification is untrusted

The field being used for this check is inbox

  "origin": {
    "id": "https://review-service.com/system",
    "inbox": "https://review-service.com/inbox/",
    "type": "Service"
  }

target

This section is used to describe the target system involved in the notification workflow 

  "target": {
    "id": "https://generic-service.com/system",
    "inbox": "https://generic-service.com/system/inbox/",
    "type": "Service"
  }

type

This type section is important since it's determining how to process/evaluate any received notification

  "type": [
    "Announce",
    "coar-notify:ReviewAction"
  ]

...

Testing

Request Endorsement (LDN Message on item submission)

Let's configure a new Notify Service such as:

Image Added

and save.

(NOTE: If you plan to test with Docker, the "Service IP Range" should likely include 172.23.0.1 – this is the IP that your Host machine will likely appear as when running the backend in Docker.)

Testing Announce Review against current repository

Let's trigger an Request Review (see COAR official pattern documentation here).

For this specific example we can set just the first Inbound Pattern as Request Review and leave the item filter blank. This test is not about item submission.
Pick the following POST call from the Postman project (see below to download it and import it to your installed PostMan instance): let's emulate the Notify Service external system sending us an LDN Message!  

For this test to succeed you must update the json below based on your system configuration.  See the "IMPORTANT" lines.

...

...

at time of writing COAR service for test purposes is responding an HTTP 500

as we sent the Offer. This error did not exist back in December 2023 when we

firstly developed the LDN implementation.

Test calls: Announce Review

Let's trigger an Request Review (see COAR official pattern documentation here).

Create a new Item into the COAR Notify Collection (collection created for the previous test).

Configure a new Notify Service such as:

Image Removed

By clicking the + New green button fill the form as:
Image Removed

For this specific example we can set just the first Inbound Pattern as Request Review and leave the item filter blank. This test is not about item submission.
Pick the following POST call from the Postman project (see below to download it and import it to your installed PostMan instance): let's emulate the Notify Service external system sending us an LDN Message!

...

See below the successful response:

Image Removed

This means the LDN Message has been enqueued. Please remember the enqueued ldn messages must be evaluated by the Extractor for a QA Event (with source=coar-notify) to be produced. As soon as it is, a blue popup is shown on Item and myDSpace pages:

...

...

by clicking on that Check button navigation brings to the Quality Assurance Page for the source coar-notify:

...

If we navigate to the Quality Assurance page we can see the counter for QA Event of coar-notify source increased by 1!

...

Here it is the page of the specific QA Event in example:

...

Let's accept it with a click on the Green Check.
Go back to the item page to see the new Review metadata!

...

...

WORK IN PROGRESS Test calls: Request Review

 
Image Removed

Let's evaluate the request' json body (some field is commented) according to the COAR official documentation of this pattern:

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

See below the successful response:

This means the LDN Message has been received.
At this point there's not feedback if the notification has been stored & enqueued or just stored as untrusted.

Please remember the enqueued ldn messages must be evaluated by the Extractor for a QA Event (with source=coar-notify) to be created.

As soon as it is processed by the extractor, a blue popup is shown on Item and myDSpace pages:

by clicking on the Check button we are redirected to the Quality Assurance Page for the source coar-notify:

If we navigate to the previous Quality Assurance page we can see the counter for QA Event of coar-notify source increased by 1!

Here it is the page of the specific QA Event in example:

Let's accept it with a click on the Green Check.
Go back to the item page to see the new Review metadata!

Postman Collection for testing COAR-Notify Feature

See below the successful response:

Image Removed

This means the LDN Message has been enqueued. Please remember the enqueued ldn messages must be evaluated by the Extractor.

...

Here’s the Postman collection for all test purposesscenarios: 

View file
name Coar Notify.postman_collection.json height 150

...