Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Export

...

/Import CP

A CP can be exported and imported from one instance of OpenSpecimen to another. E.g. QA server to production server.

Pre-requisites before importing a protocol from one server to another: 

  • Users used as PI/coordinators exists

  • Sites associated to the protocol or used as default sites in events exists

  • User who is doing the import has sufficient access

  • If new dropdown values like specimen type, collection containers etc. are created to be used in the protocol, make sure those are imported as well

Expand
titleClick here to view the steps...
  1. Click on the 'Export' option from the collection protocol details page

    Image RemovedImage Added
  2. This will export the protocol definition to

    a 

    .json

     file

     file

  3. Go to the collection protocols list page of the other instance of OpenSpecimen where the exported CP has to be imported.

  4. Click on 'Import' option and select option 'Collection Protocol'
    Image Modified

  5. Upload the .json file and click on 'Import'
    Image Modified

    Note

    The protocol cannot be imported under the same instance, the system will throw an error for the duplicate title.

    Note

    In version v5.2 onwards, the 'CP Export' option, it exports the collection protocol along with the configured workflow CP JSON.

Clone Collection Protocol

Clone CP

A CP can be cloned to make an exact copy on the same instance of OpenSpecimen. This will copy all the details, consents, events, requirements and settings. The administrator can change the name and create another similar protocol. This is useful if there is a similar study that is starting up and saves administrator time in setting up the protocol. Another use case of the clone feature is when you create a CP on the QA/Test server and have to move it to the production server.Image Removed

Note
titlev5.2

In version v5.2 onwards, the 'Clone' collection protocol option, clones the Collection Protocol along with the configured workflow.

...

Delete CP

Administrators who have the privilege to delete protocols can delete protocol from the main overview page. Click on 'Delete' to delete the collection protocol.
Image Modified
If participants and specimens are already registered under the protocol, the system warns and makes the user type 'DELETE ANYWAY' so that it is not deleted by mistake. This will delete the protocol with all data under it.Image Removed

...

Close

...

CP

Administrators who have the privilege of close protocols can close the protocol from the main overview page. Click on 'Close' to close the collection protocol.Image Removed

...

The participants, visits, and specimens are cannot be added to the closed collection protocol. If the collection protocol no longer used then it can be closed.

The activity status of closed CP is 'Closed'.Image Removed

...

To reopen the collection protocol, go to the overview page of the closed collection protocol and click on 'Reopen'.Image Removed

...

...

Starring CP

From v6.3, it is possible for users to ‘star’ a protocol which they work on regularly. This is similar to a browser bookmark where users can mark the sites they visit frequently.

...

This starring is login-specific. Each logged-in user can have her/his own list of starred collection protocols.

Expand
titleSteps to mark the collection protocol as starred
  1. From the ‘Navigation’ menu, go to the ‘Collection Protocols’ list page.

  2. On the left-hand side, a blank ‘star’ icon is visible.

    Image Added

  3. Search for the protocols that need to be accessed more frequently than the others. Click on the star(s) present in front of such protocols. They turn golden once you click on them.

    Image Added

  4. Refresh the page. These will appear at the top whenever you login using the same login id.
    Starred CPs are ordered in the descending order of starred time. More recently starred CPs will appear above the previously starred CPs.

    Image Added

The starred CPs can be unstarred by clicking again on the golden ‘star’ icon.