NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

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

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 have the option of identifying 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.

Visibility 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

This help topic

This help topic opens from the Update Protocol page, as well as from the Submit Protocol page. For more information about protocol update, see 2 - Managing Protocols in caNanoLab 2.1 DRAFT.

To submit a new protocol, follow these steps:

  1. 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.
  2. Select or enter the appropriate information in the text fields and drop-down lists. Fields are described in the following table. Items with an asterisk are required fields.

    To enter an alternative to an option, select other if available and enter a value. The value is added to the list of options.

    NameDescription

    Protocol Type*

    Enter or select from the drop-down list the protocol type (required).


    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

    Click the Browse button to navigate to the protocol file.

    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.

  3. When you finish defining the protocol, click the Submit button.

Searching Existing Protocols

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, follow these steps:

  1. Click the Protocols caNanoLab menu option. On the Manage Protocols Home page, click the Search Existing Protocols link. This opens the Search Protocols form.
  2. Enter text or select criteria as appropriate (described in the following table).
    When defining search criteria, there are no "required" fields. You can add only those parameters that you consider essential to the search.

    NameDescription

    Protocol Type

    Enter or select from the drop-down list the protocol type (required).


    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

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

    If you click the Search button having defined no parameters, all of the caNanoLab protocols will be listed in the Search Results.

  3. Click Search to launch the search.

Protocol Search Results

If you click the Search button having defined no parameters, all of the protocols located in the search display in the 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.

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

Sample Search Results ColumnsDescription
Action

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

Note:

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.

Note

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

Protocol Type

Enter or select from the drop-down list the protocol type (required).


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.

Created DateIndicates the date on which the sample was added.

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.

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. Click Update at the bottom of the page when you are done.

Sample Search Results ColumnsDescription

Protocol Type

Enter or select from the drop-down list the protocol type (required).


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.

Protocol File

Click the Browse button to navigate to the protocol file.

Protocol Abbreviation

Shortened phrase used in place of the protocol name.

File Title The title of the Protocol file.
Description

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

Access to the Protocol

Lists the Group Name that has access to the Protocol:

  •  Curator
  • Other??

Lists the type of Access that the Group has for the Protocol:

  • read
  • update
  • delete

Deleting a Protocol

Note

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

To delete a protocol, perform a search, 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 right of the window. Confirm the deletion.

 

  • No labels