----
h1. Portal 3.0 User's Guide
----
{cagridroundpanel}
{pre:class=cagridheaderfont}Table of Contents{pre}
{toc:outline=true|exclude=Portal 3.0 User's Guide|style=none}
{cagridroundpanel}

h2. Using the caGrid Portal for the First Time

The caGrid Portal provides several ways to find all data sets, people, tools, communities, and institutions that participate in {reg-tm}caBIG{reg-tm}. These entities combine to form the caGrid Portal catalog. Each entity is called a catalog item in this documentation but can be a person, institution, shared query or other tool, or even a community built around a common interest in one of these entities.

Ways to find catalog items include clicking an icon on the Google map on the home page, entering a term in the search box to search all {reg-tm}caBIG{reg-tm} entities, or narrowing down the catalog by category types and area of focus.

Once you find an item in the catalog through one of these means, the power of the caGrid Portal becomes apparent. Click any item in your search results to get all available details about that item, then interact with other users by suggesting a related item, providing a citation or hyperlink, adding a comment, or executing a shared query on data sets you select. The caGrid Portal is a true community application, providing access to popular social media tools to bookmark and share interesting items you have found.

h3. Log In{anchor:login}

If you already have an account with a caGrid identity provider such as Dorian or the NCI Authentication Service, you can use those account credentials to log in to the caGrid Portal. If you do not have such an account yet, you must [register|#register].

*To log in to the caGrid Portal*
# Click the *Log In* link at the top of the page.
# Enter your user name and password.
# Select the identity provider from which you received your user name and password.

h3. Register as a New User{anchor:register}

Registration is required for users who do not already have an account with a caGrid identity provider such as Dorian or the NCI Authentication Service. When you register, you create an account with the caGrid identity provider you are using, which is usually Dorian.

If you already have an account with a caGrid identity provider such as Dorian or the NCI Authentication Service, _you do not need to register_. You can just log in with the account information you use for that identity provider.

*To register as a new user*

# Click the *Register* link at the top of any caGrid Portal page. A window appears with fields for your contact information.
# Enter information for each field. All fields except Street 2 are required. The user name must be between 4 and 15 characters. A valid password must be between 4 and 15 characters, CANNOT contain a dictionary word, and MUST contain at least one upper case letter, at least one lower case letter, at least one number, and at least one symbol (~\!@#$%^&*()_-+={}\[\]\|:;<>,.?)
# Click *Register*. A message appears stating that your account is approved and that your current account status is active. You can now [log in|#login] to the caGrid Portal page using your user name and password.

If your registration is not successful, a message explains the problem. Reasons for unsuccessful registration include duplicate user name, invalid user name, invalid password, and invalid email. Correct the problem and click *Register* again.

h2. Understanding the caGrid Portal Home Page{anchor:homepage}

The caGrid Portal home page includes many ways for you to find {reg-tm}caBIG{reg-tm}\-related resources that have been aggregated into the caGrid Portal catalog. These methods include a map for finding resources with geographic addresses, lists of popular catalog items, and a {tm}Google{tm}\-like search box. Once you find an item,

This list shows the people who have interacted with the Portal the most in a time period specified by the Portal administrator. Click any person's name to open the details page about that person.

h3. Top Ranked Entries{anchor:toprankedentries}

This list shows the catalog items that Portal users like the most. Click any item in the list to open its details page. To rate the item, log in and then click one of the stars at the top of the page. Five stars is the top rating.

h3. Latest Entries{anchor:latestentries}

This list shows the catalog items that have been added most recently to the Portal. Click any item to open its details page.

h3. Search the Entire Catalog{anchor:searchingcatalog}

At the top of each Portal page is a Search box that you can use to find any item in the caGrid Portal catalog.

*To search the entire caGrid Portal catalog*
# Enter any word or part of a word into the Search box at the top of the page. Search terms may include words associated with categories such as people, services, institutions, and tools such as shared queries.
# Click *Enter* on the keyboad. Matching catalog entries appear in a list. Click any result to see its details.

!Searchbox.gif|alt=Screenshot of the caGrid Portal home page with an arrow pointing to the Search box at the top with a caption that reads Enter search terms here.!

_Search the entire caGrid Portal catalog by entering a term or partial term in the Search box_

{info:title=Note}You can also [narrow down your search|#narrowingsearch] to a category or area of focus by clicking the *Catalog* button above the Search box.{info}

h2. Using the Map{anchor:usingmap}

The map on the caGrid Portal home page shows the geographic locations of all data that are associated with a geographic address in the caGrid Portal catalog. For example, the address of the point of contact associated with a data service or analytical service appears on the map, as does the address of all participant institutes. When a location includes more than one catalog item, this is noted using a different icon.

Click on the map icons to link to details about {reg-tm}caBIG{reg-tm} services and participants. You can also restrict your view of the map to a selected category.

h3. Show Data on the Map{anchor:showingmapdata}

Explain different icons and how to limit the view of the map to just one of them. To reset the map, refresh the browser.

h3. Adjust the View of the Map{anchor:viewingmap}

The {tm}Google{tm} map uses common panning and zooming controls. To move the map sideways or up and down, click the arrow buttons on the map. To get a closer view, click the + button. To see more of the map, click the - button.

{info:title=Note}To zoom in or out without using the mouse, press CTRL and + to zoom in or CTRL and - to zoom out.{info}

h3. Browse Data on the Map{anchor:browsingmapdata}

Click an icon on the map. If only one data or analytical service or participant institute is associated with that icon, that result appears in an information window along with a link you can follow to get more information about that item. If more than one result is associated with the icon you clicked, the information window lets you know how many results exist and provides a link to see the whole list. The image below shows an information window listing the results at a hosting research center in Alabama.

!MapSingleResult.gif|alt=Map of the United States with icons showing the location of data services, analytical services, participant institutes, and hosting research centers. A callout information window associated with a point in Alabama reads "There are three services at this location. View." The word View is a link to a list of those three services!

_Map with an information window linking to a list of services at the selected location_

If more than one data or analytical service or participant institute is associated with an icon on the map, you see these results in an information window on the map. Clicking the link in that information window opens a page listing all of the results for that one location. Each result includes a link you can click to see [more details|#getdetails] about that item.

!MapSearchResults.gif|alt=List of catalog items associated with selected icon on the map. List includes three cancer centers. To the left of this catalog items is a list of category types associated with the results. According to that list, these three centers have the category type of Grid Service Endpoints.!

_Catalog items associated with a map location_

h2. Narrowing Down Your Search{anchor:narrowingsearch}

The caGrid Portal catalog comprises all of the data sets, people, tools, communities, and institutions that participate in {reg-tm}caBIG{reg-tm}. The caGrid Portal considers each of these entities a catalog item and provides several ways for you to find them.

*Do one of the following to search the catalog*

* Enter one word or part of a word into the Search box at the top of any portal page. Press *Enter* on the keyboard to begin the search. The search results page appears with all catalog items that match your search term sorted by name on the right side of the page.

{info:title=Note}Search terms are case-insensitive and you can enter partial strings. Entering _Cancer_, _cancer_, or even _can_ into the search field will return all catalog items with the word Cancer in it. Entering only a partial string such as _can_ may return additional catalog items.
{info}

or

* Click the !CatalogButton.gif|alt=Catalog button! button in the top toolbar. The catalog search page appears with all catalog entries sorted by name on the right side of the page. Narrow down the list of catalog items by selecting a category in the Search Categories list on the left side of the page. Click the down arrow icon to next to the category to open subcategories. Clicking a category restricts which category entries appear to the right. Catalog items matching your search criteria appear in the list.

!MapSearchResults.gif|alt=Screenshot of catalog items resulting from a search starting from either the Search box on the home page or the catalog search page. Three catalog items resulted from this sample search.!

_Catalog items resulting from a search starting from either the Search box on the home page or the catalog search page_

h3. Search for Data Sets{anchor:searchingdatasets}

h3. Search for People{anchor:searchingpeople}

h3. Search for Tools{anchor:searchingtools}

h3. Search for Communities{anchor:searchingcommunities}

h3. Search for Institutions{anchor:searchinginstitutions}

h2. Working with Search Results{anchor:searchresults}

Explain featured results here.

h3. Get Details on a Catalog Item{anchor:getdetails}

The details available for a catalog item depend on the catalog type. For example, the details page for a Shared Query includes several ways for you to interact with the query including editing it, executing it against one or more data sets, associating other catalog items (related items) with it, and adding other information such as citations and comments. The details page for a person listed in the catalog is more limited than that but still includes the ability to add related items and add other information such as citations, hyperlinks, files, and comments.

In addition to interacting with a catalog item through the details page, you can bookmark it for future reference and even send it to a colleague through email.

*To get details about a catalog entry*
* Click a catalog entry name. Details about the entry appear. You can now interact with this entry in the following ways:
** [Bookmark or share|#bookmarkingsharing] the entry using a web-based tool.
** Rate the entry.
** Add a citation to the entry.
** Add a hyperlink to the entry.
** Associate a related entry in the caGrid Portal such as an institution, a data set, or a tool with the entry.
** Upload files associated with the entry.
** Add a note to the entry for others to read.
** Execute a shared query against selected data sets.
** Edit a shared query's XML.
** Edit the entry's other details.

!InstitutionDetails.gif|alt=Screenshot of the details page for a selected catalog item. This selection was the Abramson Cancer Center and it includes a rating of four stars and a related item (Joshua Phillips).!

_Details about a catalog item_

h3. Bookmark and Share Search Results{anchor:bookmarkingsharing}

h3. Rate an Entry{anchor:rating}

h3. Add a Citation{anchor:citation}

h3. Add a Hyperlink{anchor:hyperlink}

h3. Add a Related Entry{anchor:relatedentry}

h3. Upload Files{anchor:bookmarkingsharing}

h3. Add Comments and Notes{anchor:bookmarkingsharing}

h3. Use Shared Queries{anchor:sharedqueries}

h2. Adding Data to the caGrid Portal{anchor:addingdata}

h3. Create a Catalog Entry{anchor:creatingcatalogentry}

h2. Modifying caGrid Portal Data{anchor:modifyingdata}

h3. Edit a Catalog Entry's Details{anchor:editingdetails}

h3. Delete a Catalog Entry{anchor:deletingcatalogentry}