NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Revised to be consistent.

Include Page
Saving and Submitting for Review
Saving and Submitting for Review

Wiki Markup
{scrollbar:icons=false}

...

 This chapter describes how to manage protocols in caNanoLab with the Protocols function. This section includes the following topics:

Table of Contents
minLevel2

Protocols Overview

The Protocols function enables you to create or search for a protocol. A protocol provides clear and detailed documentation about the precise actions taken in creating or annotating a sample. When you click the Protocols option on the caNanoLab menu bar, the Manage Protocol Home page appears. The Protocol links on the Manage Protocol Home page provide the following options:

Description of a Protocol

During a caNanoLab workflow, you can identify a protocol used in creating or annotating a sample. A protocol provides clear and detailed documentation about the precise actions taken in any procedure that might be part of an experiment. For example, a protocol could describe the steps a laboratory used for characterizing samples. There are different type of protocols, such as Physical, In Vitro, and In Vivo.

With every protocol object you create in caNanoLab, you can define its visibility, in other words, its access to other users of caNanoLab. For more information about visibility options, see the tables corresponding to each characterization type.

Info
titleVisibility option

If you do not select an option for visibility, by default, Private is selected, meaning only the owner can view and/or modify it.

Submitting a Protocol

To submit a new protocol:

Click the Protocols caNanoLab menu option. On the Manage Protocols Home page, click the Submit a New Protocol link. This opens the Submit Protocol form.

...

The following table lists and describes the fields on the Submit a Protocol page. Enter and select the appropriate information as needed. Items with an asterisk are required fields.

...

Protocol Type*

...

Protocol Name*

...

Enter or select from the drop-down list the protocol name.

...

Protocol Abbreviation

...

Shortened phrase used in place of the protocol name

...

Protocol Version

...

Enter or select from the drop-down list the protocol version number.

...

Click the Browse button to navigate to the protocol to be associated with the protocol, or enter the URL where the protocol is located.

...

File Title

...

Enter the title of the protocol file.

...

Description

...

Enter any additional description information that the form does not include.

...

To clear the entries and start again, click the Reset button.

...

Editing a Protocol

You can edit a sample using the following techniques:

Updating a Protocol

The Protocol Update page opens when you click the Edit link corresponding to a protocol listed in 2 - Managing Protocols in caNanoLab 2.1 DRAFT. The page displays all of the information for a protocol that was entered when the protocol was created in caNanoLab (2 - Managing Protocols in caNanoLab 2.1 DRAFT). With appropriate permissions, you can edit the title, description and visibility of a protocol in this dialog box.

The following table lists and describes the fields. An asterisk indicates a required field. Click Update when you are done editing the Protocol. To disregard the changes, click Reset.

...

Protocol Type*

...

Protocol Name*

...

Enter or select from the drop-down list the protocol name.

...

Protocol Abbreviation

...

Shortened phrase used in place of the protocol name.

...

Protocol Version

...

Enter or select from the drop-down list the protocol version number.

...

Click the Browse button to navigate to the protocol to be associated with the protocol, or enter the URL where the protocol is located.

...

Protocol Abbreviation

...

Shortened phrase used in place of the protocol name.

...

Enter any additional description information that the form does not include.

...

Changing Group Access to the Protocol

To change the group access to the protocol:

  1. From the Access to the Protocol field, click Add.
    The Access Information dialog box opens.
  2. For Access By, you will specify the group or user to which you are specifying access:
    • Collaboration Group: If you click this option, Collaboration Group appears below the selection. You can type in a group name and click Search or select a group from the drop down to the right.
    • User: If you click this option, User Login Name appears below the selection. You can type in a login name and click Search or select a login from the drop down to the right.
    • Public: If you click this option, Public appears in the Collaboration Group box and cannot be edited.
  3. For Access to This Protocol, specify whether the selected group or user can read, update, and delete the protocol or read (only).
  4. Click Cancel to remove the entries or click Save to add the access information.
    The Update Protocol page appears with the group or user added to the Access to the Protocol panel.

Deleting a Protocol

Info
titleNote

This action deletes the protocol from the caNanoLab database, executed behind the scenes at a scheduled time.

To delete a protocol, perform a search, find the protocol that you want to delete, and click the Edit link in the first column of the the 2 - Managing Protocols in caNanoLab 2.1 DRAFT page. The Update Protocol page opens. From the Update Protocol page, click the Delete button in the lower-left corner of the window. Confirm the deletion.

Searching Existing Protocols

Tip

You can access this page after logging into caNanoLab or you can access publicly available sample protocols from the Login page.

To launch a search for a specific protocol:

...

Click the Protocols caNanoLab menu option. On the Manage Protocols Home page, click the Search Existing Protocols link. This opens the Search Protocols form.

Info
titleNote

When defining search criteria, there are no "required" fields. You can add only those parameters that you consider essential to the search. If you do not define any search criteria, all the protocols will be found.

The following table lists and describes the fields. Enter text or select criteria as appropriate.

...

Protocol Type

...

Protocol Name

...

Enter a partial or complete name of the protocol. Select Contains (for partial text) or Equals (for an exact search) from the dropdown list.

...

Protocol Abbreviation

...

Enter a partial or complete name of an abbreviation that has been assigned to the protocol.

...

Protocol File Title

...

Enter the name of the protocol file title

...

Click Search to launch the search.
To clear the values and start again, click Reset to clear the search criteria.

 

Panel
borderColorsilver
borderStylesolid
titleContents of This Chapter

Page Tree
expandCollapseAlltrue
root@self
startDepth2
searchBoxtrue

Protocol Search Results

Once you submit a search for a protocol (2 - Managing Protocols in caNanoLab 2.1 DRAFT), search results display in the caNanoLab screen. Results show pertinent protocol information defined which is defined in the 2 - Managing Protocols in caNanoLab 2.1 DRAFT section. Columns are sortable by page by clicking on the column heading.

Info
titleNote

The number of items located in the search display appears in the the upper-left of the search results table. The bottom right of the search results table enables you to navigate to pages.

To return to the Search page, click the Back ( Image Removed ) button not the Browser button.

The following table lists and describes each column.

...

Click Edit in the first column to display the protocol on the 2 - Managing Protocols in caNanoLab 2.1 DRAFT.

Info
titleNote:

Edit is only available for people that have an account and are logged into the system.

Click the Add to Favorites link to add a bookmark for the protocol on your Favorites tab. Success appears in the column when the protocol is successfully added.

Info
titleNote

If the protocol is already added as a Favorite, clicking Add to Favorites displays an error message.

...

Protocol Type

...

Protocol Name

...

Enter or select from the drop-down list the protocol name.

...

Protocol Version

...

Enter or select from the drop-down list the protocol version number.

...

Protocol Abbreviation

...

Shortened phrase used in place of the protocol name.

...

Protocol File

...

The Title and Description of the protocol are listed. Click View to download the protocol file.

The column is empty when there is no protocol file associated with the Protocol.

...

Adding a Protocol to My Favorites

Favorites displays samples, protocols, and publications that you choose to bookmarked for quick access. To add a protocol to My Favorites, perform a protocol search, find the protocol that you want to bookmark, and click the Add to Favorites link in the first column of the 2 - Managing Protocols in caNanoLab 2.1 DRAFT row. The Added to Favorites message appears in the results row.

Click the Favorites option in the menu bar, and the bookmarked protocol will be listed under My Protocols.

Wiki Markup
{scrollbar:icons=false}