Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Versions of this document

  • 12 August 2022: Make document reflect current state of the API and how it's used
  • 2 December 2021: Draft update for removal of review publishing via Archie.
  • 15 January 2021: Draft update for production improvements: publication date determined by HighWire & Aries JATS packaging (Gert van Valkenhoef)
  • 2 July 2019: Draft update for new review publishing file format ("JATS") project (Gert van Valkenhoef).
  • 12 July 2016: Updated DTD. Added missing licenceType parameter to description of Test Method.
  • 13 November 2015: Minor updates for consistency + added aim of document (Rasmus Moustgaard + Ida Wedel-Heinen)
  • 03 November 2015: Added section about Review Updating Classification Framework, added the metadata file DTD as Appendix 1, and minor updates for consistency ()
  • 11 January 2013: Added information under 'Test Method' (Rasmus Moustgaard)
  • 2012: First version describing the "When Ready" publishing method under development (Rasmus Moustgaard)

...

Workflow - content published via Archie

From 2022-01-18As of January 2022, only translations and topics lists will be are published via this Archie API.

  1. When translations are marked for publication in Archie, Archie sets the datePublicationMarked field in its database.
  2. Wiley will access a web service method (Get Content for Publication) to fetch a data package (zip archive, see Data format) with all the content from Archie that is ready for publication. Archie will deliver all content that has not yet been delivered and has the requested delivery date (datePublicationMarked field) set before or equal to the current date/time.
    1. CRG topics lists and the The global browse menu are also (EDITORIAL topics list) is included in the zip archive , but unlike reviews and translations these are not versioned or marked for publication, so the data package will simply contain a once daily (at 2 PM UTC), being a snapshot of the latest data in Archie at the time of delivery (without explicit "mark for publication").
    2. Wiley can access the Get Content for Publication method at any time to fetch the latest content; however, 15-minute intervals are expected according to specifications.
    3. The web service will never return multiple versions of the same content in the same call.
  3. On receipt and basic checking of content, Wiley will make a call-back (Content Received) to confirm that the content has been received. Wiley will send the list of received content as an XML document in a custom format (see below) where content is identified using a combination of ID and Archie version number. At this point, Archie will record the actual delivery date/time (datePublicationDelivered field) of the content that was successfully delivered to Wiley.
    1. Note: These callbacks are also expected to occur for content published via ProduXion Manager (see below)
  4. When the delivered content is actually published (as opposed to being picked up), Wiley will make a second web service call-back to Archie (Content Published), this time providing the list of content that was published. At this point Archie will set the publication date (datePublished field) to the current date/time (and also make other changes to the database like setting the published flag for the published versions and marking them as the latest published versions).
    1. Note: These callbacks are also expected to occur for content published via ProduXion Manager (see below)

...

A data package will be delivered as a zip archive. The file/folder structure inside the archive will match the structure of this example (with only Get Published Content including reviews):

  • AIRWAYS
    • topics.xml
    • reviews
      • CD005304.pub3.zip
      • CD008250.pub2.zip
      • CD010005.pub2.zip
      • CD010126.zip
      • CD010139.zip
      • CD010177.zip
      • CD010178.zip
    • translations
      • CD001116.pub3.fr.zip
      • CD006100.pub2.fr.zip
      • CD008250.pub2.fr.zip
      • CD008469.pub2.fr.zip
  • ANAESTH
      topics.xml
    • reviews
      • CD003587.pub2.zip
      • CD007105 .pub2.zip
      • CD010134.zip
      • CD010135.zip
      • CD010160.zip
  • ARI
    • topics.xml
    • reviews
      • CD004882 .pub3.zip
      • CD006822 .pub3.zip
      • CD008116 .pub2.zip
      • CD008268 .pub2.zip
      • CD008723 .pub2.zip
      • CD008858 .pub2.zip
      • CD009088 .pub2.zip
      • CD010130.zip
    • translations
      • CD004882.pub3.fr.zip
      • CD006206.pub3.fr.zip
  • BACK
      topics.xml
    • translations
      • CD004250.pub4.fr.zip
      • CD001351.pub2.fr.retracted
  • EDITORIAL
    • topics.xml
  • output.log
  • success.log

...

  • In order to demonstrate as many aspects as possible, this example has example has been made unrealistically large. With 15 minute pickup intervals the majority of packages will packages will be empty or only contain a single review (+ topics).
  • The root folders represent Cochrane entities (CRGs, CEUgroups (review groups and the EDITORIAL group) and are named with the entities' publisher IDs. Root folders will only be present for entities with content ready to publish.
  • The reviews sub-folder contains published reviews (only for "Get Published Content"). The structure of individual ZIP files is specified elsewhere: JATS - changes for Aries compatibility. The folder will be absent if no reviews are included in the package.
  • The file name of each individual review follows this convention:
    [CD number].[pub number].zip
    NOTE: .[pub number] is absent for first publication (i.e. ".pub1" is omitted).

  • The translations sub-folder contains translations of reviews, but not necessarily for the included reviews. The folder will be absent if no translations are included.
  • The file name of each individual translation follows this convention:
    [CD number of review].[pub number of review].[language code].zip
    For example: CD001478.pub4.da.xml

  • The EDITORIAL/topics.xml files file contains the topics list (CRGs) or browse menu (Editorial Unit). All topics list files referring to a review included in the package are included. The browse menu is delivered in the EDITORIAL folder (EDITORIAL is the publisher ID of the CEU).In this example the BACK folder contains a topics list even though no reviews from this CRG are included. This is because a topic link refers to an included review from the ARI group (CD004882.pub3).
  • Notification about a retracted translation is handled by including the latest version of the translation with a filename according to the following convention:
    [CD number of review].[pub number of review].[language code].retracted
    For example: CD001351.pub2.fr.retracted
  • The root file output.log contains log entries from the export process. In addition, either an empty success.log file or an error.log file (with details of the error) will be present.

...