Sysrev

SRVC can integrate with Sysrev projects. This can be used to import documents and labels, or simply as a way to synchorize data between reviewers.

Sysrev project creation

  1. Log in or register on Sysrev.

  2. Go to the new project page.

  3. Type in your project name and click “Create Project”.
    ../_images/create-project.png

  4. Done! The new project is ready to use.

Adding reviewers

  1. Click on the “Users” tab of your project.
    ../_images/project-users-tab.png
  2. Invite reviewers, either by sending them the project-specific invite link, or by entering their email addresses and clicking “Send Invites”.
    ../_images/invite-reviewers.png

  3. The reviewers you have invited will be able to add documents to the project and submit label-answers.

Creating labels

Labels created in Sysrev can be used in SRVC projects.

  1. Click on the “Articles” tab of your project.

  2. Click on the “Add/Manage Articles” button.
    ../_images/create-labels-1.png
  3. Click on the “Label Definitions” tab.
    ../_images/create-labels-2.png
  4. Click on one of the “Add Label” buttons at the bottom of the page.
    ../_images/create-labels-3.png

  5. Fill out the label definition and save it.

  6. The label is ready to be used in answer assignments.

Creating an SRVC project from a Sysrev project

  1. Find the project’s ID number from its address. The ID number always directly follows “/p/”. E.g., if the project’s address is “https://sysrev.com/u/4957/p/122402/”, then the project ID is 122402.

  2. Create a SRVC project directory with a file named sr.yaml.

  3. Add this line to sr.yaml:
    base-uri: https://sysrev.com/web-api/srvc-config?project-id=PROJECT_ID

  4. Replace PROJECT_ID with your actual project ID.

  5. Add a flows section to sr.yaml with a sample review flow:

    flows:
  review:
    steps:
      - run-embedded: generator https://sysrev.com/web-api/srvc-events?project-id=PROJECT_ID

      - run-embedded: label-web
        labels: [overall include]
        port: 6000

  6. Again, replace PROJECT_ID with your actual project ID.

  7. This flow uses the default “overall include” label for all Sysrev projects. Change the labels entry to include the names of any other labels that you have added to the Sysrev project.

Running the review flow

  1. Go to the Sysrev user settings page
    ../_images/user-settings.png
  2. Find the “Enable Developer Account” section and make sure that your Developer Account is enabled.
    ../_images/enable-developer-account.png

  3. In this same section, find your “API Key” and copy it.

  4. Set the SRVC_TOKEN environment variable to your API key.

    This can be done with the following shell commmand, with API_KEY replaced with your actual API key:

    export SRVC_TOKEN=API_KEY
  5. If you are running SRVC in GitHub Codespaces, you can instead use encrypted secrets to store your SRVC_TOKEN.

    Use Managing encrypted secrets for your codespaces to create a secret named SRVC_TOKEN with a value equal to your Sysrev Developer API Key.

  6. Run the review flow via “sr flow review”.

    You should see the message “Listening on http://localhost:6000”

  7. View http://localhost:6000 in your browser and assign the appropriate label answers.

  8. Documents, labels, and answers should be synchronized across all reviewers using this Sysrev project.

  9. If the documents and labels were created in Sysrev, then answers should be also be visible on Sysrev.

    If they were created in SRVC but not in Sysrev, then they will not be visible on Sysrev. The data is there, however, and it will still appear in SRVC.