Creating a Viewer Protocol

Introduction

This document will demonstrate how to create a Viewer Protocol. With our Read Task functionality available as of our 16.14 release, the ability to configure multiple viewer protocols on a project is now supported. This allows multiple unique viewer workflows to occur simultaneously on the same project. For example, a set of users could be performing initial QA assessments of new data as it lands in the system while another set of users are performing detailed image annotation workflows for images that are QA approved.

1. Go to https://www.postman.com/ and create a free account
2. Create a new workspace 
3. Once in your new workspace, import this example.  

 

4. A new workspace entry labeled Full OCT Annotation should now be displayed. When expanded, there are four Post sub components on the left hand side.

 

 

5. Click on the header Full OCT Annotation and perform the following steps on the right side of the screen:

a. Authorization

1. TYPE - Choose API Key as the type
2. KEY - In the key field enter Authorization
3. VALUE - In the value field enter “scitran-user {{fw-api-key}}
4. ADD TO - Choose Header as the add to option

b. Pre-request Script

     i. Leave blank

c. Tests

     i. Leave blank

d. Variables

     i. Variable #1

1. Create a variable for: “Fw-api-key”
2. Obtain your User API Key for theFlywheel site you want to add the viewer protocol to. Learn more about creating User API Keys from the Profile page.

     3. Paste the API Key into the CURRENT VALUE in postman

 

      ii. Variable #2

1. 1. Create a variable for: “fw-base-url”
   2. Copy and paste the URL for the Flywheel site you want to add the viewer protocol to in the CURRENT VALUE field

 

     iii. Save your variables using the Save option in the upper right corner. 

 

 

6. Click on POST Create Viewer Form

     a. In the “POST” field, enter “{{fw-base-url}}/api/forms”

 

 

     b. Go to Headers and add the following fields

          i. Key = “Authorization”

          ii. Value = “scitran-user {{fw-api-key}}”

 

 

          iii. Save your changes in the upper right corner

     c. Go to Body

          i. Choose JSON as the type

           ii. Verify that there is JSON content in the body

 

 

          iii. When ready, click Send in the upper right corner. In the response, if successful, you will see                   something displayed like the image below. One will need the “_id” later on,  so leave this                         POST Create Viewer Form tab open and then Save.

 

 

7. Click on POST Create Viewer Config

     a. In the “POST” field, enter “{{fw-base-url}}/api/viewerconfigs”

     b. Go to Headers and add the following fields

          i. Key = “Authorization”

          ii. Value = “scitran-user {{fw-api-key}}”

          iii. Save your changes in the upper right corner

     c. Go to Body

          i. Choose JSON as the type

          ii. Verify that there is JSON content in the body and add the contents in the green box in the                      screenshot below

 

 

 

           iii. When ready, click Send in the upper right corner. In the response, if successful, you will see                    something displayed like the image below. One will need the “_id” later on,  so leave this                        POST Create Viewer Form tab open and then Save.

 

 

8. Click on POST Create Viewer Protocol

     a. In the POST field, enter “{{fw-base-url}}/api/read_task_protocols”

     b. Go to “Headers” and add the following fields

          i. Key = “Authorization”

          ii. Value = “scitran-user {{fw-api-key}}”

          iii. Save your changes in the upper right corner

     c. Go to “Body”

          i. Choose JSON as the type

          ii. Verify that there is JSON content in the body

 

1. Copy and paste the form_id from the Send response in the POST Create Viewer Form tab.
2. Copy and paste the viewer_config_id from the “Send” response in the POST Create Viewer Config tab
3. Upon returning to your Flywheel site, choose the project you want to save the viewer protocol to and copy the project ID from the URL.
4. Then paste it in the “id” section outlined in orange above.
   1. 1.  

 

 

          iiii. When ready, click Send in the upper right corner. In the response, if successful, you will see a response. Click Save.

1. 1. 1. 1. Return to your Flywheel project > tasks > create new task > see the protocol in the drop down.

 

Resources

• Zendesk: https://docs.flywheel.io/hc/en-us/requests/new

 

FAQs