Draft Marked for review

Scenario 1: Author requests review with possible endorsement (via overlay journal)

The corresponding author requests a review from an overlay journal for one of their papers, held in a repository. The overlay journal notifies the repository of any successful reviews and endorsements

Overlay Journal

Notifications

Repository

1 Initiate Request for Review
The corresponding author initiates a request for review by an overlay journal (automatically including endorsement if positive) of their preprint in a repository
2 Review conducted
The overlay journal conducts the review.
3 Announce Review

The overlay journal notifies the repository of a new review

The @context must include:

id

Notify notifications must describe an AS 2.0 activity. The activity has an id which must be a URI, and the use of URN:UUID is recommended. An HTTP URI may be used instead, but in such cases the URI should resolve to a useful resource.

type

The activity has a type which should include at least Announce from AS 2.0 and coar-notify:ReviewAction from Notify.

actor

The activity should have an actor describing the party responsible for initiating this activity. The actor:

  • has an id which must be an HTTP URI.
  • has a type which should be one of: Application, Group, Organization, Person or Service from AS 2.0.
  • may have a name

context

This offer activity has a context representing the preprint. The context has:

  • An id which is the HTTP URI of the "landing page" for the resource.
  • A type which should include the value AboutPage from schema.org.
  • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.
  • A url containing the details of the actual content resource. The url has:
    • An id containing the HTTP URI of the content file for the resource.
    • A type describing the content file.
    • A mediaType which contains the MIME Type of the content file.

object

The activity has an object representing the journal-review. The object has:

  • An id which is the HTTP URI of the "landing page" for the resource.
  • A type which should include the value Document from AS 2.0.
  • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.

origin

The activity has an origin describing the system which has sent the notification. The origin has:

  • An id which is an HTTP URI identifying the overlay-journal.
  • A type which should include the value Service from AS 2.0.
  • An inbox which is the HTTP URI of the LDN inbox for the overlay-journal

target

The activity has a target describing the system which is intended to receive the notification. The target has:

  • An id which is an HTTP URI identifying the repository.
  • A type which should include the value Service from AS 2.0.
  • An inbox which is the HTTP URI of the LDN inbox for the repository

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://overlay-journal.com",
    "name": "Overlay Journal",
    "type": "Service"
  },
  "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",
      "media-type": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    }
  },
  "id": "urn:uuid:94ecae35-dcfd-4182-8550-22c7164fe23f",
  "object": {
    "id": "https://overlay-journal.com/reviews/000001/00001",
    "ietf:cite-as": "https://doi.org/10.3214/987654",
    "type": [
      "Document",
      "sorg:Review"
    ]
  },
  "origin": {
    "id": "https://overlay-journal.com/system",
    "inbox": "https://overlay-journal.com/system/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://research-organisation.org/repository",
    "inbox": "https://research-organisation.org/repository/inbox/",
    "type": "Service"
  },
  "type": [
    "Announce",
    "coar-notify:ReviewAction"
  ]
}
4 Repository Links to Review
The repository creates a links to the review
5 Announce Endorsement

The overlay journal notifies the repository of its endorsement

The @context must include:

id

Notify notifications must describe an AS 2.0 activity. The activity has an id which must be a URI, and the use of URN:UUID is recommended. An HTTP URI may be used instead, but in such cases the URI should resolve to a useful resource.

type

The activity has a type which should include at least Announce from AS 2.0 and coar-notify:EndorsementAction from Notify.

actor

The activity should have an actor describing the party responsible for initiating this activity. The actor:

  • has an id which must be an HTTP URI.
  • has a type which should be one of: Application, Group, Organization, Person or Service from AS 2.0.
  • may have a name

context

This offer activity has a context representing the preprint. The context has:

  • An id which is the HTTP URI of the "landing page" for the resource.
  • A type which should include the value AboutPage from schema.org.
  • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.
  • A url containing the details of the actual content resource. The url has:
    • An id containing the HTTP URI of the content file for the resource.
    • A type describing the content file.
    • A mediaType which contains the MIME Type of the content file.

object

The activity has an object representing the endorsement. The objecthas:

  • An id which is the HTTP URI of the "landing page" for the resource.
  • A type which should include the value Page from AS 2.0.
  • An ietf:cite-as which contains the persistent HTTP URI (sometimes called the "PID") which is to be used to cite or link to the resource.

origin

The activity has an origin describing the system which has sent the notification. The origin has:

  • An id which is an HTTP URI identifying the overlay-journal.
  • A type which should include the value Service from AS 2.0.
  • An inbox which is the HTTP URI of the LDN inbox for the overlay-journal

target

The activity has a target describing the system which is intended to receive the notification. The target has:

  • An id which is an HTTP URI identifying the repository.
  • A type which should include the value Service from AS 2.0.
  • An inbox which is the HTTP URI of the LDN inbox for the repository

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://overlay-journal.com",
    "name": "Overlay Journal",
    "type": "Service"
  },
  "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",
      "media-type": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    }
  },
  "id": "urn:uuid:94ecae35-dcfd-4182-8550-22c7164fe23f",
  "object": {
    "id": "https://overlay-journal.com/articles/00001/",
    "ietf:cite-as": "https://overlay-journal.com/articles/00001/",
    "type": [
      "Page",
      "sorg:WebPage"
    ]
  },
  "origin": {
    "id": "https://overlay-journal.com/system",
    "inbox": "https://overlay-journal.com/system/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://research-organisation.org/repository",
    "inbox": "https://research-organisation.org/repository/inbox/",
    "type": "Service"
  },
  "type": [
    "Announce",
    "coar-notify:EndorsementAction"
  ]
}
6 Repository Links to Endorsement
The repository creates a link to the endorsement