Draft Marked for review

Scenario 6: Author submits to overlay journal using repository to host resource and reviews

See these use-cases to understand this scenario in context: Peer-review, Endorsement

The corresponding author submits a paper to an overlay journal. The journal deposits the paper in a repository and arranges reviews. The reviews are deposited in the repository

Overlay Journal

Notifications

Repository

1 Manuscript submission
The corresponding author submits a manuscript to the journal. The journal requests that the new manuscript is ingested by the repository.
2 Request for Ingest

The overlay journal requests that a repository ingest an author's submitted manuscript

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 Offer from AS 2.0 and coar-notify:IngestAction 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

object

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

  • 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.
  • 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.

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"
  },
  "id": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
  "object": {
    "id": "https://overlay-journal.com/submissions/00001/",
    "type": "sorg:AboutPage",
    "url": {
      "id": "https://overlay-journal.com/submissions/00001/files/content.pdf",
      "media-type": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    }
  },
  "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": [
    "Offer",
    "coar-notify:IngestAction"
  ]
}
3 Ingest
The repository ingests the manuscript into a dedicated collection corresponding to the particular overlay journal
4 Announce Ingest

The repository notifies the overlay journal that it has ingested the resource

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:IngestAction 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

The activity has a context representing the submission. The contexthas:

  • 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.
  • 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.

inReplyTo

inReplyTo is specified because this is a response to a previous notification. inReplyTo takes the URI (URN:UUID or HTTP URI) which identifies the activity for which this is a response.

object

This activity has an object representing the preprint. The object 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.

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 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

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 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

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ],
  "actor": null,
  "context": {
    "id": "https://overlay-journal.com/submissions/00001/",
    "type": "sorg:AboutPage",
    "url": {
      "id": "https://overlay-journal.com/submissions/00001/files/content.pdf",
      "media-type": "application/pdf",
      "type": [
        "Article",
        "sorg:ScholarlyArticle"
      ]
    }
  },
  "id": "urn:uuid:94ecae35-dcfd-4182-8550-22c7164fe23f",
  "inReplyTo": "urn:uuid:0370c0fb-bb78-4a9b-87f5-bed307a509dd",
  "object": {
    "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"
      ]
    }
  },
  "origin": {
    "id": "https://research-organisation.org/repository",
    "inbox": "https://research-organisation.org/repository/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://overlay-journal.com/system",
    "inbox": "https://overlay-journal.com/system/inbox/",
    "type": "Service"
  },
  "type": [
    "Announce",
    "coar-notify:IngestAction"
  ]
}
5 Reviewer invitation
The journal invites reviewers
6 Review submission
A reviewer submits a review for a manuscript. The review becomes a new repository item linked to the original manuscript. The repository notifies the journal that a new review has been submitted.
7 Announce Review

The repository notifies the overlay journal 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 repository-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 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

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 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

{
  "@context": [
    "https://www.w3.org/ns/activitystreams",
    "https://purl.org/coar/notify"
  ],
  "actor": {
    "id": "https://research-organisation.org",
    "name": "Research Organisation",
    "type": "Organization"
  },
  "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://research-organisation.org/repository/review/00001",
    "ietf:cite-as": "https://doi.org/10.3214/000001",
    "type": [
      "Document",
      "sorg:Review"
    ]
  },
  "origin": {
    "id": "https://research-organisation.org/repository",
    "inbox": "https://research-organisation.org/repository/inbox/",
    "type": "Service"
  },
  "target": {
    "id": "https://overlay-journal.com/system",
    "inbox": "https://overlay-journal.com/system/inbox/",
    "type": "Service"
  },
  "type": [
    "Announce",
    "coar-notify:ReviewAction"
  ]
}
8 Manuscript endorsement
The journal endorses the manuscript
9 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"
  ]
}
10 Update metadata
The repository assigns a DOI to the manuscript and updates its metadata to indicate the new status as "endorsed".