Most Web Client pages include several nuggets. A large portion of the average page declaration involves arranging nuggets on the page and passing parameters to nuggets.
This reference does not include detailed information about all available nuggets. You can get a list of nuggets by viewing the Nugget Declarations report with the Application Server. Note that many of the nuggets are used for specific purposes in the out-of-the-box pages and rarely used when customizing the Web Client.
View a List of Available Nuggets
To view the available nuggets and their parameters, do the following:
- Log on to the Web Client as an administrative user.
- In the main menu, select the Admin menu item. This opens a page with quick access to several common administrative reports.
- Under the WebClient Configuration heading, select the Nugget Declarations report. The Web Client will display a list of all nuggets available on your Application Server.
- Each nugget on the report appears as a link. Select the link to get more information about a specific nugget, such as the list of parameters.
Commonly Used Nuggets
When designing your own pages, these are the most frequently used nuggets:
- The spacer.jsp nugget is used to insert spacing, graphics (such as logos). It is used extensively on the out-of-the-box home page. The nugget accepts parameters for setting the size of the space and any content to insert (such as static text or graphics).
- The quickSearch.jsp nugget displays a simple search form for finding contacts. It has no parameters.
- The nuggetLists.jsp nugget displays a set of links defined in a separate nugget list declaration. The links can open the target pages in a frame area on the same page or in separate windows. This nugget is used frequently on the Person/Company Overview pages to display profiles/lists, activities, and related contacts. The nugget has several parameters for specifying the layout of the links and the declaration to use for the links.
- The searchList.jsp nugget is similar to the nuggetLists.jsp nugget. It displays a simple set of links defined in a separate search list declaration. This nugget is typically used for simple sets of links that don’t require the extra functionality in nuggetLists.jsp.
- The formatSearchList.jsp is similar to the searchList.jsp nugget. It also displays a set of links defined in a separate search list declaration. Unlike searchList.jsp, formatSearchList.jsp displays the links as a bullet list. This nugget is used on the out-of-the-box home page.
- The grid.jsp and grid2.jsp nuggets display a list of contacts in a grid with multiple columns. The nugget displays the grid of contacts, the drop-down menus above the contacts, the preview pane for the selected contact, and the print/export links in the upper left corner of the page.
- This nugget has several parameters that control the appearance of the grid. A separate grid declaration defines the content displayed in the grid. Generally, if you want to use a grid nugget on a custom page, you can use one of the existing grid declarations.
Refer to the Nugget Declarations report for details about the parameters for these nuggets. You can display this report in the Web Client; for details, see “View a List of Available Nuggets”, above.
Nuggets - spacer.jsp, quickSearch.jsp, and formatSearchList.jsp
[A] The spacer.jsp nugget can display a graphic such as the InterAction logo, or empty space.
[B] These headings also use spacer.jsp.
[C] The top of the quickSearch.jsp nugget.
[D] Examples of the formatSearchList.jsp nugget.
[A] An example of the nuggetLists.jsp nugget.
[B] The list of links displayed by this instance of the nuggetLists.jsp nugget. These are defined in a nugget list declaration.
[A] This entire “chunk” is a single nugget - grid2.jsp.