Administering Portals

This chapter provides overviews of portal administration, folder navigation, and discusses how to:

• Administer portal definitions.

• Administer folders.

• Administer SmartNavigation folders.

• Administer content references.

• Manage folders and content references.

• Manage general portal settings.

• Manage portal objects.

• Review menu item information.

• Build registry search indexes.

Understanding Portal Administration

Every component delivered with PeopleSoft applications is registered as a content reference in the portal registry . Common administrative tasks include adding, deleting, and renaming portal definitions. If you have portal administrator access, you can use the administration pages to manage the registry, including folders, content references, and security.

Additionally, to provide programmatic access to the portal registry, PeopleTools PeopleSoft delivers a portal registry API. This API provides the same kind of registry management capability as the administration pages and is fully described in the PeopleCode documentation. Developers can also register components by using the Registration Wizard, which is part of PeopleSoft Application Designer.

You use the administration pages to:

• Manage the portal registry, or the structure and content of a portal, which includes:

  • Templates.

  • Navigation collections.

  • Folders.

  • Content references.

  • Pagelets.

  • Homepages.

  • Dashboard pages.

• Manage general portal settings, which include node templates, the portal template, navigation options, portal search options, and so on.

• Add, edit, and delete local and remote portal definitions.

• Add, edit, and delete local and remote node definitions.

• Populate a portal registry with custom menus by importing menu definitions.

• Generate a Verity search index or collection that reflects the content of the portal registry.

The following diagram shows the organizational structure of the portal administration component and folders. Note the location of the special Portal Objects folder. This folder contains folders and content references for all templates and pagelets associated with a given portal.

Portal administration pages

Note. To view the portal administration pages, you must have the appropriate security permissions.

See Also

Adding and Configuring Nodes

Understanding Folder Navigation

PeopleSoft applications integrate folders into the menu, or navigational, structure. While most forms of navigation in PeopleSoft applications use folders, the term folder navigation has a specific meaning for PeopleTools portals. Folder navigation is the default method of navigation delivered in PeopleSoft applications and refers to a specific response by the portal when the user clicks a folder, which is rather than expanding and collapsing menu items, the portal generates navigation pages in the target content area.

Navigation Pages

Note these points about the characteristics of navigation pages:

• Navigation pages provide users with an organized, graphical approach to traversing the menu structure.

• Navigation pages, like menus, reflect the structure of the portal registry. Each navigation page corresponds to a folder in the portal registry and provides access to any subordinate folders and content references.

• Users click folders to navigate through the menu structure to other navigation pages.

• Breadcrumb links appear in the header of the navigation page to indicate position in the hierarchy of folders. Click a breadcrumb link to return a higher-level navigation page.

• Navigation pages provide access to access transaction pages when users click a content reference link.

• The character and appearance of navigation pages is controlled by a default folder navigation object (page) that is standard with every PeopleTools implementation.

• You can modify the appearance of any navigation page by changing its default folder navigation object.

• The folders and content references that appear on navigation pages vary by user according to his or her assigned permissions.

This sample navigation page, which uses the default folder navigation obejct, shows the Security folder when folder navigation is enabled:

Traversing Menus Without Engaging Navigation Pages

If you use one of these methods to navigate the menu structure, the portal will not generate navigation pages.

• For drop-down navigation: Click the folder name. This action causes the menus to cascade sideward revealing subfolders and content references.

• For left navigation: Click the triangle icon to the left of the menu name. This action causes the menus to expand downward revealing submenus and content references.

Important! You enable folder navigation at the portal definition and general portal settings levels; folder navigation must be enabled at both levels for the feature to work. When you enable folder navigation at the site level, you can navigate all folders by using this method; however, you can disable or override folder navigation at the individual folder level.

Note. If folder navigation is disabled, then navigation pages do not appear when the user clicks a folder. Instead, the item expands to display any subordinate menu items. The user continues to expand menu items by clicking them until he or she clicks a content reference. No content appears in the target area until the user clicks the content reference.

See Also

Adding and Editing Portal Definitions

Managing General Settings for Portals

Understanding Navigation Pages

“Working with Permission Lists,” PeopleTools 8.52 PeopleBook: Security Administration

“Working with Roles,”PeopleTools 8.52 PeopleBook: Security Administration

Common Elements Used in This Chapter

Administering Portal Definitions

This section lists common elements used in this section and discusses how to:

• Define portals.

• Add and edit portal definitions.

• Change default portals.

Common Elements Used in This Section

Pages Used to Administer Portal Definitions

Defining Portals

Access the Portal Definitions page (PeopleTools, Portal, Portal Definitions).

You can have multiple portals on a database or create one portal on multiple databases. You can define portals from other databases and associate them with a node. This supports transfers between portals and redirected requests for a portal not supported by the local web server.

See Also

Managing General Portal Settings

Adding and Editing Portal Definitions

Access the Portal Definitions - Add Portal page (Click the Add button on the Portal Definitions page).

Note. The Edit Portal page contains the same fields as the Add Portal page (Click the Edit button on the Portal Definitions page).

Folder Navigation

Use these fields to enable folder navigation and define the objects associated with folder navigation for portals other than the one you are currently signed in to. To enable folder navigation for the current portal, use the General Settings page.

Important! Folder navigation is not enabled unless you select the Is Folder Navigation Enabled check box on both the Portal Definition and General Settings pages. Is Folder Navigation Enabled is selected by default in the standard PeopleTools portals.

See Managing General Settings for Portals.

Changing Default Portals

You can change the default portal in two ways:

• Change the default portal in the node definition.

• Insert the new default portal name into the URL.

Changing the Default Portal in the Portal Definition

To change the default portal:

1. In the current default portal, select PeopleTools, Portal, Node Definitions.

2. Select the default local node and then click the Portal tab.

3. Select the Default check box for the portal that you want to open.

4. Save.

5. Sign out.

6. Shut down and restart the portal web server.

7. Sign in.

   When you sign in, the new default portal is invoked.

Changing the Default Portal by Inserting the New Portal Name in the URL

You can also change the default portal by changing the URL. To change the URL, insert the new portal name instead of the existing portal name. For example, to change to the supplier portal from the employee portal, make the following substitution:

URL before the change:
http://localhost/psp/ps/EMPLOYEE/QE_LOCAL/c/UTILITIES.PORTAL_DEFINITIONS.GBL

URL after the change:
http://localhost/psp/ps/SUPPLIER/QE_LOCAL/c/UTILITIES.PORTAL_DEFINITIONS.GBL

Note. This type of portal change is valid until the browser session is closed.

Administering Folders

This section provides an overview of folder administration and discusses how to:

• Define folders.

• Set folder permissions.

Understanding Folder Administration

In the portal registry, folders organize content references into a multilevel hierarchy. A folder can contain content references and other folders. When you create folder definitions, you explicitly configure the properties, attributes, and position of the folder in the hierarchy. The portal uses your configurations to create the menu structure, which remains static unless you modify structure in the portal registry.

Organization of the Portal Registry

You use the Structure and Content component to access the portal registry, where you create and manage folders and content references. When you click the Structure and Content link, the application opens the portal registry at the root level. The initial set of folders, content references, and links that you see correspond to the high level folders and links that appear directly under Main Menu or in the Menu pagelet.

The Structure and Content component enables you to organize and manage your folders and content references; all folders and content references that share the same Structure and Content page are at the same level hierarchically and share the same parent folder. You click the Edit link to access the properties of a folder. You click the folder label link to navigate one level lower in the hierarchy where any child folders and content references that exist appear.

As you navigate through the hierarchy of folders, breadcrumbs appear at the top of the page directly beneath the Main Menu navigation bar. The breadcrumbs appear to visually indicate your current position in hierarchy of the portal registry. Click a link in the breadcrumbs to return to the folder. In this sample Structure and Content page, the breadcrumbs indicate that you are viewing elements that appear in the PeopleTools, Security folder:

The portal uses the hierarchy of folders in the portal registry to create the menu structure of the PeopleSoft application. Menus open to reveal the folders and content references in the same general sequence and location as they appear in the portal registry. In this sample drop-down menu, notice that the organization of folders and content references in the PeopleTools, Security folder correspond to the folders and links located in the Security folder in the portal registry:

Folder and content reference organization in the PeopleTools, Security folder

Folders can appear at any level in the menu hierarchy in both the left navigation Menu pagelet and the Main Menu drop-down navigation. Folders cascade open when users click the folder label and generate navigation pages when you click the folder icon. Most PeopleSoft application folders are standard navigation folders; however, you can configure certain folder properties to create SmartNavigation folders.

See Also

Administering FoldersAdministering SmartNavigation Folders

Pages Used to Administer Folders

Defining Folders

Access the Folder Administration page (Select PeopleTools, Portal, Structure and Content Click the Add Folder link).

1. Enter values in the Folder Administration fields.

2. (Optional) Enter values in the Folder Attributes fields.

3. If this folder is a SmartNavigation folder, enter values in the Application Navigation fields.

   See Defining SmartNavigation Folders.

4. Set the folder security.

   See Setting Folder Permissions.

5. Save the folder.

Folder Administration

This table describes the primary fields that appear on the Folder Administration page:

Application Navigation

Use these fields to create SmartNavigation folders.

See Defining SmartNavigation Folders.

Folder Attributes

Folder attributes can be used by portal-aware applications for application-specific processing that adds functionality to folders.

1. Specify the attribute name.

2. (Optional) Specify the attribute label.

3. Enter the attribute value.

4. Select the Translate check box to make an attribute label and attribute value translatable.

This table describes the fields that you use to define folder attributes.

See Also

Using Menu Pagelets

Content Reference Attributes

Setting Folder Permissions

Access the Folder Security page (Select PeopleTools, Portal, Structure and Content. Navigate the portal registry to the appropriate folder, click the Edit link, and then select the Folder Security tab.)

Public	Select to make the folder available to all users. When this check box is selected, all other fields except Label are hidden.
Author Access	Select to restrict folder access to the creator of the folder, regardless of how other permissions are set. This setting is useful for troubleshooting and testing purposes.

Security Authorizations

You can base noninherited folder security on roles or permission lists. You can specify any combination of roles and permission lists to provide folder security.

Inherited Security Authorizations

Displays authorizations that have been inherited from parent folders. The fields in this grid have the same purpose as the corresponding fields in the Security Authorizations grid. You can change inherited authorizations by modifying the Cascade setting in the Security Authorizations grid of the parent folder.

See Also

Setting Up Permission Lists

Setting Up Roles

Administering SmartNavigation Folders

This section provides overviews of SmartNavigation folders; rowset, tree, and dynamic hierarchy data sources; and discusses how to:

• Define SmartNavigation folders.

• Define rowset-based SmartNavigation folders.

• Define tree-based SmartNavigation folders

• Define dynamic hierarchy folders.

Important! This topic contains code samples to guide you in using the built-in PeopleCode functions that generate SmartNavigation folders and content references. The code samples exist for illustrative purposes only; never use code samples in a production environment.

Understanding SmartNavigation Folders

SmartNavigation is a form of folder navigation, but unlike standard navigation, with SmartNavigation, you define only the root folder in the portal registry. All subordinate SmartNavigation folders and content references are generated dynamically when the user begins to navigate a SmartNavigation menu. The character and appearance of SmartNavigation is also quite different from standard folder navigation because of additional folder properties that enable the portal to access and use your application data.

Note these points about SmartNavigation folders:

• When you configure SmartNavigation folders, you explicitly define the root folder only; all subordinate menu items, which reflect the data values from the data source, are generated dynamically when the user clicks SmartNavigation menu.

• The menu items in SmartNavigation menus reflect a hierarchical set of application data, which you specify as the data source for the SmartNavigation folder.

• Two data source types exist for SmartNavigation folders: rowsets and trees.

• Each SmartNavigation menu item and content reference corresponds to a data element: a row in a rowset or node in a tree.

• SmartNavigation menu hierarchy reflects the parent-child relationships that exists between rows.

• You differentiate SmartNavigation folders and content references from standard folders and content references by the images that appear beside the link. The default SmartNavigation folder and content reference images look like stylized representations of multiple entities or a single entity, respectively. You can replace these images with your own.

  See Replacing SmartNavigation Images.

• SmartNavigation folders can appear as content references instead of folders.

• You can configure SmartNavigation to take advantage of related content services, which appear in an Actions folder in the drop-down menu hierarchy.

Important! SmartNavigation folders appear in the drop-down navigation only; they do not appear in left navigation (the Menu pagelet).

See Navigation Options.

SmartNavigation Pages

When you click a SmartNavigation folder, the portal generates a navigation page; this response is comparable to standard folder navigation. The SmartNavigation page provides a characteristically different navigation experience than the standard navigation page.

Note these points about SmartNavigation pages:

• SmartNavigation pages display an organizational chart rather than folders and links.

• The character and appearance of SmartNavigation pages are controlled by PT_ABN_ORGCHART, the default chart navigation component that is standard with every PeopleTools implementation. You can clone this component and use the copy to create a different character and appearance to your SmartNavigation page or to extend and enhance the functionality of the chart.

• The chart on SmartNavigation pages reflects both the content and the structure of your data. Each chart node corresponds to a data element: a row in a rowset or a node in a tree. Chart hierarchy reflects the parent-child relationships that exists between rows.

• The nodes that appear on navigation pages vary by user based on the data permission security model that is specific to your application and your implementation.

• You associate nodes with details components so that when users click the Details link, the transaction page appears.

• As is the case with standard navigation pages, breadcrumb links appear at the top of the navigation page to indicate position in the hierarchy. Click a breadcrumb link to access a higher-level node.

• You can configure SmartNavigation pages to take advantage of related content services so that related actions are accessible from each chart node. Users do not have to navigate back through a menu; the links are available in the Actions drop-down list box on the node.

Notice the organization chart and the navigation path (breadcrumbs) on this sample SmartNavigation page, which clearly indicates the hierarchical nature of this type of navigation. :

Sample SmartNavigation page showing organization chart structure

See Understanding Related Actions Assignment.

Understanding Data Sources: Rowsets

A rowset is a data structure that represents hierarchically organized records. A scroll area and all of its subordinate scroll areas are an example of a rowset. You create PeopleCode application packages or iScripts to programmatically populate rowset objects with your application data, which the portal uses when it builds SmartNavigation folders.

Rowset Characteristics

Note these points about the rowsets that you use as SmartNavigation folder data sources:

• The rowset must be a standalone rowset because the component buffers do not contain this data.

• The rowset structure must include these subrecords in this order:

  1. PTORGNODE_SBR

  2. PT_ABNNDURL_SBR

  3. PT_ABNNDDTL_SBR

  4. PTORGBOXFLD_SBR

• Because SmartNavigation pages display up to three levels of the organizational chart, the rowset should contain the relevant data required to display:

  • The requested node, which is determined by a user click or mouse over event.

  • The parent of the requested node.

  • The children of the requested node.

• The rowset should contain the data that the portal requires to build the hierarchy of folders in the breadcrumb trail. The breadcrumb trail should being with the defined SmartNavigation folder and be followed by the rowset root node. Next, each child node should appear in the breadcrumb trail in hierarchical order until the trail ends with either the focus node or content reference.

• The rowset should contain data that relevant to the current user only.

• For each row in the rowset, set a details component. The details component information must include these elements:

  • MenuName- the menu definition that contains the component.

  • BarName- the menu bar beneath which the component appears.

  • ItemName - the component name.

  • PageName- the page that appears to the user when the component is accessed.

  • ActionSpecifier- the action mode of the component. Use the single character identifier, such as U, A, and so on.

  • SearchRecordName - the component search record.

  • NumberOfKeys - the number of keys. (Use a three-digit format; for example, use 001 for one key, 010 for ten keys, and 100 for one hundred keys.)

  • KeyFieldName - the key field name.

  • KeyFieldValue - the key value.

• The details component information must be assigned to the PT_ABN_CHART_DFLD2 field value as a string that takes the following format:

  Note. A comma followed by a space delimits the elements of the string.

  MenuName.MenuName, BarName.BarName, ItemName.ItemName, Page.PageName, Action.ActionSpecifier, Record.SearchRecordName, KeyFieldNumber.NumberOfKeys, FieldName.KeyFieldName, FieldValue.'KeyFieldValue', FieldName.KeyFieldName, FieldValue.'KeyFieldValue'

  Important! If you deviate from the format then SmartNavigation cannot parse the details component information string.

Application Package PeopleCode Sample: Rowset

This items in this list step through a sample PeopleCode program for use as the data source of a rowset-based SmartNavigation folder. The next topic explains the PeopleCode that you see in this list.

See Application Package PeopleCode Sample Explanation: Rowset.

Important! This code sample exists for illustrative purposes only. Use this sample to guide your programming; never use code samples in a production environment.

1. Declare the method and variables.

   method QE_ABNRS_M
   
   	Local Request &req = %Request;
   	Local Rowset &rs_DataSource, &rs_DatabaseData;
   	Local Rowset &rs_ChartRowset, &rs_DbReqNode;
   
   	rem create related actions rowset for SmartNavigation;
   	Local Rowset &rs_RelatedActions;
   
   	rem added for app pkg;
   	Local array of array of string &reqParams;
   	Local string &dataKey;
   	Local string &szDtlCompData;
   	Local integer &i;
   
   

2. Get the SmartNavigation request parameters and specify the initial node of the rowset.

   	rem Get request parameters and set initial node
   	rem Binu's Org;
   	&reqParams = ​GetABNReqParameters("BINU01"); 
   

3. Create the stand alone rowset data source.

   	rem begin: create the data source rowset;
   
   	rem retrieve complete data source;
   	rem &rs_DatabaseData = CreateRowset(Record.MY_ORG_NODES);
   	rem &dataKey = "PT_ORG_001";
   	rem &rs_DatabaseData.Fill("Where MY_ORG_KYFLD=:1", &dataKey);
   	rem &rs_DataSource = CreateRowset(Record.MY_ORG_NODE_DR);
   	rem &rs_DatabaseData.CopyTo(&rs_DataSource, Record.MY_ORG_NODES, ⇒
   Record.MY_ORG_NODE_DR);
   
   	rem retrieve subset of data source
   	&rs_DbReqNode = ​CreateRowset(Record.MY_ORG_NODES);
   	&rs_DatabaseData = ​CreateRowset(Record.MY_ORG_NODES);
   	&dataKey = "PT_ORG_001";
   	&rs_DbReqNode.Fill("Where  MY_ORG_KYFLD=:1 AND PTCHART_NODE=:2", ⇒
   &dataKey, ​GetABNNode(&reqParams));
   	&rs_DatabaseData.Fill("Where  MY_ORG_KYFLD=:1 AND (PTCHART_NODE=:2 ⇒
   OR PTPARENT_CHART_ND=:2 OR PTCHART_NODE=:3)", &dataKey, ⇒
   ​GetABNNode(&reqParams), ⇒
   &rs_DbReqNode(1).MY_ORG_NODES.PTPARENT_CHART_ND.Value);
   	&rs_DataSource = ​CreateRowset(Record.MY_ORG_NODE_DR);
   	&rs_DatabaseData.CopyTo(&rs_DataSource, Record.MY_ORG_NODES, ⇒
   Record.MY_ORG_NODE_DR);
   
   

4. Set the details component

   	rem set details componenent for all nodes;
   	&szDtlCompData = "MenuName.MY_MENU, BarName.USE, ItemName.EMPLOYEE, ⇒
   Page.EMPLOYEE, Action.U, Record.EMPLOYEE, KeyFieldNumber.001, ⇒
   FieldName.EMPLID, FieldValue.";
   
   	For &i = 1 To &rs_DatabaseData.ActiveRowCount
   
   		&rs_DataSource(&i).QE_ABNRS_DS.PT_ABN_CHART_DFLD2.Value = ⇒
   &szDtlCompData | &rs_DataSource(&i).QE_ABNRS_DS.PTCHART_NODE.Value;
   
   	End-For;
   
   	rem end: create the data source;
   

5. Get the chart rowset.

   	rem get the chart rowset returns the chart rowset;
   	&rs_ChartRowset = ​GetABNChartRowSet();
   

6. Get the SmartNavigation related actions rowset.

   	rem  gets  related action rowset from the chart component;
   	&rs_RelatedActions = ​GetABNRelActnRowSet();

7. Generate the HTML for the SmartNavigation menu.

   	rem generate the html fragment for the menu;
   	rem ​GenHTMLMenu(&rs_DataSource, ⇒
   ​GetABNNode(&reqParams), ⇒
   ​GetABNInitialNode(&reqParams));

8. Load the chart rowset.

   	rem load the chart rowset from the data source rowset;
   	​LoadABN(&rs_DataSource, &rs_ChartRowset, ⇒
   &rs_RelatedActions, ​GetABNNode(&reqParams), ⇒
   ​GetABNInitialNode(&reqParams));
   
   
   end-method;

Application Package PeopleCode Sample Explanation: Rowset

Each item in this list explains the corresponding list item in the application package PeopleCode sample program.

1. Declare the function and variables.

2. Get the SmartNavigation request parameters and specify the initial node of the rowset.

   • Retrieves a two dimensional array, or array of arrays, of name/value pairs.

   • The name/value pairs are request parameters needed by SmartNavigation functionality.

   • The input parameter is the identifier of the initial node .

3. Create the stand alone rowset data source.

   • The rowset structure is based on the record MY_ORG_NODES, which includes the necessary subrecords.

   • This table describes the variables that are used to store data in the functions:

     Parameter	Description
     &rs_dbReqNode	Rowset that contains the data for the requested node.
     &rs_DatabaseData	Rowset that contains the data for the requested node, parent node, child nodes.
     &rs_dataKey	Variable that contains the high level key.
     &rs_DataSource	Rowset that contains the entire data set that is used by SmartNavigation chart.

   • Retrieve the data for the requested node (&rs_DbReqNode.Fill).

   • Retrieve the data for the parent and child nodes of the requested node (&rs_DatabaseData.Fill).

   • Copy the data from all nodes to the chart rowset (&rs_DatabaseData.CopyTo)

4. Set the details component.

   1. Set the name of the details component.

   2. Loop through all of the nodes and insert the component string into the PT_ABN_CHART_DFLD2 field.

5. Get the chart rowset.

   • This function returns Null if triggered by a mouse over event; returns the rowset if triggered by an on click event at a menu element or the first link of a chart node.

   • Upon retrieval of the related actions rowset, the chart rowset is flushed. So, this function be called one time only in the iScript program.

   • Retrieval of the related action rowset allows developers to access and modify the chart rowset beyond the PeopleTools’ functionality.

6. Get the SmartNavigation related actions rowset.

   • This function returns Null if triggered by an on click event of the menu item (folder) label; returns the rowset if triggered by an on click event of the menu item (folder) image or the first link of a chart node.

   • Upon retrieval of the related actions rowset, the chart rowset is flushed. So, this function be called one time only in the iScript program.

   • Retrieval of the related action rowset allows developers to access and modify the chart rowset beyond the PeopleTools’ functionality.

7. Generate the HTML for the SmartNavigation menu.

8. Load the chart rowset from the data source rowset.

   • This table describes the parameters for the function:

     Parameter	Description
     &rs_DataSource	Data source rowset retrieved in item 4 in this list.
     &rs_ChartRowset	Chart rowset retrieved in item 6 in this list.
     &rs_RelatedActions	Related actions rowset retrieved in item 7 in this list.
     &reqParams	The requested parameters retrieved in item 2 in this list.
     GetABNNode(&reqParams)	The requested node based on the user on click event of a menu item (folder) image or the on click event of the first link of a chart node.
     GetABNInitialNode(&reqParams)	The initial node set in item 2 in this list

   • End the method.

See Also

GetABNChartRowSet

GetABNInitialNode

GetABNNode

GetABNRelActnRowSet

GetABNReqParameters

GenHTMLMenu

LoadABN

Understanding Data Sources: Trees

Trees are hierarchically-organized structures that represent a group of summarization rules for a particular database field. For example, a tree can specify how your manufacturing locations should be summarized for reporting purposes. Or a tree can show the reporting relationships within an organization by specifying how the individual department should be summarized into territories, territories into regions, and regions into countries. Similarly, a tree can categorize items in a catalog.

Tree Characteristics

Note these points about trees that you use as SmartNavigation folder data sources:

• Trees must be valid and active. Inactive, draft, and unaudited trees render unexpected results.

• SmartNavigation passes the values of several tree-specific fields to the application via URL. Certain characters are inappropriate for use in a URL and should be avoided. When you set up trees, do not use any of the following characters in the Tree Name, SetID, Set Control Value, and Tree Branch fields: pound (#). percent (%). dollar ($). ampersand (&). plus (+). comma (,). forward slash/virgule (/). colon (:). semi-colon (;). equals (=). question mark (?). at symbol (@). space ( ), quotation marks("), less than symbol (<), greater than symbol (>), left curly brace ({), right curly brace (}), vertical bar/pipe (|), backslash (\), caret (^), tilde (~), left square bracket ([), right square bracket (]), and grave accent (`).

• The root node of the tree appears as the initial node of the SmartNavigation page unless you use PeopleCode to specify another initial node.

iScript PeopleCode Sample: Tree

This items in this list step through a sample PeopleCode program for use as the data source of a tree-based SmartNavigation folder. The next topic explains the PeopleCode that you see in this list.

See iScript PeopleCode Sample Explanation: Tree.

Important! This code sample exists for illustrative purposes only. Use this sample to guide your programming; never use code samples in a production environment.

1. Declare the function and variables.

   Function IScript_PT_ABN()
   
   	Local Request &req = %Request;
   	Local string &szLI;
   	Local ApiObject &Session = %Session;
   	Local ApiObject &MyTree, &MyNode, &ChildNode, &ChildLeaf;
   	Local Rowset &rs, &rars;
   

    

2. Retrieve the chart rowset.

   	rem get the chart rowset;
   	&rs = ​GetABNChartRowSet();
   
   

3. Retrieve the related actions rowset from the chart component.

   	rem retrieve the related action rowset from the chart component;
   	&rars = ​GetABNRelActnRowSet();
   
   

4. Get the SmartNavigation request parameters and specify the initial node of the tree.

   	rem get the request parameters and specify the initial node or not;
   	&reqParams = ​GetABNReqParameters("00001");
   

5. Create an empty tree from session object and open the tree based on the request parameters.

   	/* get an empty tree from the session object */
   	&MyTree = &Session.GetTree();
   
   	/* open the tree based on the request parameters */
   	&TreeReturn = &MyTree.Open(GetABNTreeSetid(&reqParams), ˙ ˇ⇒
   ​GetABNTreeUserKey(&reqParams), ⇒
   ​GetABNTreeName(&reqParams), ⇒
   ​GetABNTreeEffdt(&reqParams), "", True); 
   

6. Retrieve the requested tree node.

   	/* get the requested tree node */
   	&MyNode = &MyTree.FindNode(GetABNNode(&reqParams), "");
   
   

7. Load the requested node into the chart rowset.

   	rem load the requested node into the chart and track the starting node; 
   	&MyNode.LoadABNChart(&rs, &rars, True, ⇒
   ​GetABNInitialNode(&reqParams));
   
   

8. Generate the related actions of the requested tree node.

   	rem generate the requested node's related actions;
   	&szLI = &szLI | &MyNode.GenRelatedActions();
   
   

9. Generate the SmartNavigation folder elements to display in the menu (based on some optional criteria).

   	/* begin-filter 
   	based on some criteria, display only the child nodes and leaves of the 
   	requested tree node that meet the criteria */
   
   	&nNodeOrder = &MyNode.allChildCount;
   	If &MyNode.HasChildNodes Then
   		/* get the first child node */
   		&ChildNode = &MyNode.FirstChildNode;
   
   		/* generate the <li> tag that the portal consumes for this node */
   		&szLI = &szLI | &ChildNode.GenABNMenuElement⇒
   ​(GetABNInitialNode(&reqParams));
   

10. Load the child node into the chart rowset buffer.

    		&ChildNode.LoadABNChart(&rs, &rars, False, ⇒
    ​GetABNInitialNode(&reqParams));
    	End-If;
    	If &MyNode.HasChildLeaves Then
    		 If &MyNode.ChildLeafCount >= 3 Then
    			 &MaxCount = 3;
    		 Else
    			 &MaxCount = &MyNode.ChildLeafCount;
    		 End-If;
    	
    		 For &i = 1 To &MaxCount
    			 If &i = 1 Then 
    				 /* get the first child leaf */
    				 &ChildLeaf = &MyNode.FirstChildLeaf;
    			 Else 
    				 /* get the next child leaf */
    				 &ChildLeaf = &ChildLeaf.NextSib;
    			 End-If;
     	
    

11. Generate the SmartNavigation content reference elements to display in the menu.

    			 /* generate the <li> tag that is consumed by the portal for this leaf */
    			 &szLI = &szLI | &ChildLeaf.GenABNMenuElement();
    			 
    

12. Load a child node of the requested tree node and its related actions into the chart buffer.

    			 rem load the  child leaf of requested node into the chart;
    			 &ChildLeaf.LoadABNChart(&rs, &rars);
    		 End-For;
    
    	 End-If;
    	
    	/* end-filter */
    

13. Generate the entire HTML that the portal consumes to create the SmartNavigation menu.

    	 /* generate the html fragment required by the portal to build menu structure */
    	 ​GenHTMLMenu(&szLI);
    

14. Close the tree and end the function.

    	 &MyTree.Close();
    
    End-Function;
    

iScript PeopleCode Sample Explanation: Tree

Each item in this list explains the corresponding list item in the sample Tree PeopleCode program.

See iScript PeopleCode Sample: Tree.

1. Declare Function and variables.

2. Retrieve the chart rowset.

   • This function returns Null if triggered by an on click event of the menu item label; returns the rowset if triggered by an on click event of the menu item image or the first link of a chart node.

   • The rowset must be retrieved because the tree API doesn't have access, or know of the existence of the panel processor.

   • The rowset must be passed to the tree api so that the tree API can properly load the chart rowset.

   • Upon retrieval of the chart rowset, the chart rowset is flushed. So, function should be called one time only in the iScript program.

   • Retrieval of the chart rowset enables developers to access and modify the chart rowset beyond the PeopleTools’ functionality.

   • If you use a chart component other than the PeopleTools-delivered chart component, the component buffer structure must match the PeopleTools-delivered template so that this function can find the correct rowset. The chart rowset must be at level 1 and the first scroll at level 1.

3. Retrieve the related actions rowset from the chart component buffer.

   • This function returns Null if triggered by a mouse over event; returns the rowset if triggered by an on click event at a menu element or the first link of a chart node.

   • Upon retrieval of the related actions rowset, the chart rowset is flushed. So, this function be called one time only in the iScript program.

   • Retrieval of the related action rowset allows developers to access and modify the chart rowset beyond the PeopleTools’ functionality.

4. Get the SmartNavigation request parameters and specify the initial node of the tree.

   • Retrieves a two dimensional array, or array of arrays, of name/value pairs.

   • The name/value pairs are request parameters needed by SmartNavigation functionality.

   • The input parameter is the initial node identifier.

   • If no input parameter is passed, the initial node is the root node of the tree.

5. Create an empty tree from session object and open the tree based on the request parameters.

   • Create an empty tree session object.

   • Open the tree using the request parameters. This table describes the tree parameters:

     Tree Parameter	Description
     GetABNTreeSetid(&reqParams)	Retrieves the SetId key value from the input parameter
     GetABNTreeUserKey(&reqParams)	Retrieves the tree user key value from the input parameter
     GetABNTreeUserKey(&reqParams)	Retrieves the SetId key value from the input parameter
     GetABNTreeEffdt(&reqParams)	Retrieves the SetId key value from the input parameter

     Note. For the preceding table, &reqParams is the output of item 4 in this list.

6. Retrieve the requested tree node.

   • The requested node is the menu element upon which the user is focused during the mouse over or click event.

   • The SmartNavigation function retrieves the node identifier from the input parameter, which is the output of item two in this list.

7. Load the requested node into the chart rowset.

   • Load the requested node from item six in this list into the chart rowset buffer.

   • If necessary, load the parent node into the chart buffer.

   • Determine the initial node by retrieving its identifier from request parameters set in item three in this list.

   • This table describes the function parameters:

     Parameter	Description
     &rs	Chart component rowset retrieved from item 2 in this list.
     &rars	Related action rowset retrieved by item 3 in this list.
     Boolean	Boolean which, if true, directs the function to load the node’s parent so that the correct number of chart levels are displayed.
     GetABNInitialNode(&reqParams)	Retrieves the identifier tree initial node from the input parameter. The value of the input parameter is the output of item three in this list. You must keep track of the starting node so that PeopleTools can navigate correctly.

8. Generate the related actions elements to display in the menu.

   • Generate the <li> element for related actions. In the SmartNavigation menu, these elements appear as the folder and subordinate actions for the requested tree node.

   • The output of the function is concatenated to the current string of <li> elements, &szLI, to create a list of <li> elements.

   • The list of <li> elements is used to generate an HTML fragment that the portal consumes.

9. Generate the SmartNavigation folder elements to display in the menu (based on some optional criteria).

   • Filter the nodes that you want to display and order them

   • Generate an <li> element for a tree node. In the SmartNavigation menu, this element appears as a folder.

   • The output of the function is concatenated to the current string of <li> elements, &szLI, to create a list of <li> elements.

   • The list of <li> elements is used to generate an HTML fragment that the portal consumes.

   • This table describes the function parameters:

     Parameter	Description
     &rs	Chart component rowset retrieved from item 2 in this list.
     &nNodeOrder	The display order of the leaf in the chart.
     &szLI	The list of items that appear in the menu.
     GetABNInitialNode(&reqParams)	Retrieves the identifier tree initial node from the input parameter. The value of the input parameter is the output of item three in this list.

10. Load the child node into the chart rowset buffer.

    • Load the child node from item 2 in this list into the chart buffer.

    • Load the related actions rowset from item 3 in this list into the chart buffer.

    • Determine the initial node by retrieving its identifier from request parameters set in item 4 in this list.

    • This table describes the function parameters:

      Parameter	Description
      &rs	Chart component rowset retrieved from item 2 in this list.
      &rars	Related actions rowset retrieved from item 3 in this list.
      Boolean	Boolean which, if false, directs the function to load the calling node into the chart buffer. Because the requested node is loaded in the buffer already, select false.
      GetABNInitialNode(&reqParams)	Retrieves the identifier of the initial node from the input parameter. The value of the input parameter is the output of item 3 in this list.

11. Generate the SmartNavigation content reference elements to display in the menu.

    • Generate an <li> element for a tree leaf. In the SmartNavigation menu, this element appears as a content reference.

    • The output of the function is concatenated to the current string of <li> elements, &szLI, to create a list of <li> elements.

    • The list of <li> elements is used to generate an HTML fragment that the portal consumes.

12. Load a child leaf into the chart rowset buffer.

    • Load the child leaf from item 2 in this list into the chart buffer.

    • Load the related actions of the child leaf from item 3 in this list into the chart buffer.

13. Generate the HTML that creates the SmartNavigation menu.

    Generate the HTML fragment using the list of <li> elements from items 9, 10, and 11 in this list.

14. Close the tree and end the function.

See Also

GetABNChartRowSet

GetABNTreeEffdt

GetABNTreeName

GetABNTreeSetid

GetABNTreeUserKey

GetABNInitialNode

GetABNNode

GetABNRelActnRowSet

GetABNReqParameters

GenHTMLMenu

LoadABN

Understanding Data Sources: Dynamic Hierarchy

A dynamic hierarchy is a data source that enables you to group SmartNavigation folders within a folder. You define the dynamic hierarchy by creating an application package PeopleCode program that you reference from the defined dynamic hierarchy folder. All of the properties of the subordinate SmartNavigation folders, such as data source , must be defined programmatically in an application package PeopleCode program. Then, the PeopleCode generates the enclosing SmartNavigation folder elements of each tree or rowset so that groups of SmartNavigation folders appear under one menu.

With other SmartNavigation folders, permission lists and roles determine whether the SmartNavigation folder and the underlying details component are visible and accessible to users. Dynamic hierarchy folders, through the use of application package PeopleCode, enable you to add another element to the security mechanism for the programmatically defined SmartNavigation folders. For example, you could use a dynamic hierarchy folder to display project data for projects that are assigned to the current user only.

Dynamic Hierarchy Characteristics

Note these points about the dynamic hierarchy data source:

• The dynamic hierarchy folder must specify an application package PeopleCode program.

• The application package PeopleCode must generate a string of <li> elements, each of which a programmatically-defined SmartNavigation folder that will appear as a subordinate menu item in the dynamic hierarchy folder.

• These subordinate menu items are logical SmartNavigation folders; they are not defined in the portal registry.

• The application package PeopleCode then generates an HTML fragment that the portal consumes; this HTML creates the SmartNavigation menu structures..

Application Package PeopleCode Sample: Dynamic Hierarchy

This items in this list step through a sample PeopleCode program for use as the data source of a dynamic hierarchy folder. The next topic explains the PeopleCode that you see in this list.

See Application Package PeopleCode Sample Explanation: Dynamic Hierarchy.

Important! This code sample exists for illustrative purposes only. Use this sample to guide your programming; never use code samples in a production environment.

1. Declare the method within the appropriate class.

   class TEST_ABN_DYN
   	method ​GenerateDynFlyout();
   end-class;
   
   
   method GenerateDynFlyout
   
   

2. Declare the variables.

   	Local string &flderList;
   	Local string &ds_t, &cref_t, &id_t, &label_t, &portal, &node, &chart, ⇒
   &pcode_t, &tree_name, &tree_setid, &tree_userkey, &tree_effdt, &tree_branch;
   	Local string &ds_r, &cref_r, &id_r, &label_r, &pcode_r;
   
   

3. Provide the values for the tree-based SmartNavigation folder as variable assignments.

   	rem tree information;
   	&ds_t = "t";
   	&cref_t = "f";
   	&label_t = "New Dynamic ABN Tree";
   	&chart = "PT_ABN_CHART.PT_ABN_ORGCHART.GBL";
   	&pcode_t = "QE_ABNTREE.qe_abntree.QE_ABN_TREE_AP";
   	&tree_name = "QE_PERS_DATA";
   	&tree_setid = "QEDM1";
   	&tree_userkey = "";
   	&tree_effdt = "1997/05/05";
   	&tree_branch = "";
   
   

4. Create the list of tree-based SmartNavigation folders.

   	rem create the <li> element for the tree-based SmartNav folder;
   	&flderList = ​GenDynABNElement(&ds_t, &cref_t, &fldr_id, ⇒
   &label_t, &chart, &pcode_t, &tree_name, &tree_setid, &tree_userkey, &tree_effdt, &tree_branch);
   

5. Provide the values for the rowset-based SmartNavigation folder.

   	rem rowset information;
   	&ds_r = "r";
   	&cref_r = "f";
   	&label_r = "Dynamic ABN Rowset";
   	&chart = "PT_ABN_CHART.PT_ABN_ORGCHART.GBL
   	&pcode_r = "QE_ABN_RS_APKG.QE_ABN_RS_1:QE_ABNRS_C1.QE_ABNRS_M";
   	
   

6. Create the list of rowset-based SmartNavigation folders.

   	rem create the <li> element for the smartnav rowset folder and append;
   	&flderList = &flderList | ​GenDynABNElement(&ds_r, &cref_r, &label_r, ⇒
   &chart, &pcode_r);
   	
   

7. Generate the HTML that the portal uses to construct the menu navigation.

   	rem this function already exists;
   	​GenHTMLMenu(&flderList);
   	
   end-method;
   

Application Package PeopleCode Sample Explanation: Dynamic Hierarchy

Each item in this list explains the corresponding list item in the Application Package PeopleCode Sample: Dynamic Hierarchy:

See Application Package PeopleCode Sample: Dynamic Hierarchy.

1. Declare the method in the appropriate class.

2. Declare the variables.

   • Declare the necessary local variables.

   • All variables in the sample program are strings.

3. Provide the values for the tree-based SmartNavigation folder as variable assignments.

   This table describes the tree parameters; you use these parameters in the next step.

   Parameter	Description
   &ds_t = "data source type"	Data source type: t, tree; r, rowset
   &cref_t ="flag value"	Display as content reference flag: true, content reference; false, folder
   &fldr_id = " folder ID"	Folder ID
   &label_t = "menu folder label"	Folder label
   &chart = "chart component"	Chart component
   &pcode_t = "PeopleCode location"	PeopleCode ID: (package:path:method) or (weblib_record.event.function_name)
   &tree_name = "tree name"	Tree name
   &tree_setid = "setID value"	Tree setID
   &tree_userkey = "key value"	Tree user key
   &tree_effdt = "EFFDT value"	Tree effective date
   &tree_branch = "branch value"	Tree branch

4. Create the list of tree-based SmartNavigation folders.

   • This function creates the tree-based SmartNavigation folders based on the parameter values you provide.

   • The parameters are the same as the Application Navigation properties that you supply on the Folder Administration page to create a SmartNavigation folder.

     See Defining SmartNavigation Folders.

   • The output is a string composed of <li> elements for the tree-based SmartNavigation folders.

5. Provide the values for the rowset-based SmartNavigation folder as variable assignments.

   This table describes the rowset parameters; you use these parameters in the next step.

   Parameter	Description
   &ds_r = "data source type"	Data source type: t, tree; r, rowset
   &cref_r ="flag value"	Display as content reference flag: true, content reference; false, folder
   &fldr_id = " folder ID"	Folder ID
   &label_r = "menu folder label"	Folder label
   &chart = "chart component"	Chart component
   &pcode_r = "PeopleCode location"	PeopleCode ID: (package:path:method) or (weblib_record.event.function_name)

6. Create the list of rowset-based SmartNavigation folders.

   • This function creates the rowset-based SmartNavigation folders based on the parameter values you provide.

   • The parameters are the same as the Application Navigation properties that you supply on the Folder Administration page to create a SmartNavigation folder.

     See Defining SmartNavigation Folders.

   • The output is a string composed of <li> elements of the tree-based SmartNavigation elements from item 4 in this list concatenated with the string composed of <li> elements for the rowset-based SmartNavigation folders.

7. Generate the HTML that the portal uses to construct the menu navigation.

   • The dynamic hierarchy folder becomes the top level menu and each programmatically-defined SmartNavigation folder appears as a subordinate menu item in the list of folders.

   • The input parameter is the list of <li> elements.

   • The output is an HTML fragment.

8. Load the chart rowset.

   • Load the chart rowset from the data source rowset.

   • Load the related actions rowset.

   • Set the initial chart node.

   • End the method.

See Also

Replacing SmartNavigation Images

GenDynABNElement

GenHTMLMenu

GetABNChartRowSet

GetABNTreeEffdt

GetABNTreeName

GetABNTreeSetid

GetABNTreeUserKey

GetABNInitialNode

GetABNNode

GetABNRelActnRowSet

GetABNReqParameters

LoadABN

Common Elements Used In This Section

This section discusses the fields that identify the different data sources that you use with SmartNavigation folders.

Application Navigation

This table describes the fields that appear in the Application Navigation group box:

Application Package Parameters

The Application Package Parameters group box appears when any of these conditions are met:

• Dynamic Hierarchy is selected as a data source.

• Rowset is selected as the data source and Application Package is selected as the PeopleCode type.

• Tree is selected as the data source and Application Package is selected as the PeopleCode type.

This table describes the fields that appear in the Application Package Parameters group box

iScript Parameters

The iScript Parameters group box appears when any one of these conditions are met:

• Tree as a data source and iScript as the PeopleCode type.

• Rowset as the data source and iScript as the PeopleCode type.

This table describes the fields appear in the iScript Parameters group box:

Tree Properties

The Tree Properties group box appears when you select Tree as the data source.

This table describes the fields that appear in the Tree Properties group box:

Defining SmartNavigation Folders

Access the Folder Administration page (Select PeopleTools, Portal, Structure and Content. Click the Add Folder link).

To configure SmartNavigation folders:

1. Enter a name, label and other identifying information.

2. In the Application Navigation group box, select a data source and define the data source parameters.

   See Defining Dynamic Hierarchy Folders.

   See Defining Rowset-Based SmartNavigation Folders.

   See Defining Tree-Based SmartNavigation Folders.

3. (Optional) To use a nondefault chart navigation page, deselect the Default Chart Navigation Page check box and enter a value in the Folder Navigation Object Name field.

   Important! If the node is a remote content site, then you must clear the Default Chart Navigation Page field and then enter a remote content reference in the Folder Navigation Object field. Otherwise, the portal cannot generate the correct URL for the SmartNavigation folder. You also must enable single signon.

4. Set folder permissions.

   See Setting Folder Permissions.

5. Save the folder.

See Also

Implementing Single Signon

Defining Dynamic Hierarchy Folders

Access the Folder Administration page (Select PeopleTools, Portal, Structure and Content Click the Add Folder link).

To define dynamic hierarchy folders:

1. Enter a name, label, and any other identifying information for the folder.

2. Select Dynamic Hierarchy as the data source.

3. Specify the content site node.

4. Enter the parameters of the application package PeopleCode program that serves as the data source for this folder.

   See Understanding Data Sources: Dynamic Hierarchy.

5. (Optional) Enter the style sheet that provides alternate images for SmartNavigation menu items.

   See Replacing SmartNavigation Images.

6. (Optional) Specify any necessary folder attributes.

7. Set folder permissions.

   See Setting Folder Permissions.

8. Save the folder definition.

Defining Rowset-Based SmartNavigation Folders

Access the Folder Administration page (Select PeopleTools, Portal, Structure and Content Click the Add Folder link).

To define rowset-based SmartNavigation folders:

1. Enter a name, label, and any other identifying information for the folder.

2. Select Rowset as the data source.

3. Specify the content site node.

4. In the PeopleCode Type field, select which type of PeopleCode program defines the data source. Select Application Package or iScript.

5. Enter either the iScript or application package parameters that define the rowset.

   See iScript Parameters.

   See Application Package Parameters.

   Note. If you use an iScript, you must grant permissions to the web library and iScript for users who will access the SmartNavigation folder.

   See Setting Web Library Permissions.

6. (Optional) Select Display as Content Reference so that the SmartNavigation folder appears and functions as a content reference instead of a folder.

7. (Optional) Deselect the Default Chart Navigation Page check box and select a custom folder navigation object.

   Complete this step only if you want to replace the SmartNavigation chart page with a custom navigation page.

8. (Optional) Specify any necessary folder attributes.

9. Set folder permissions.

   See Setting Folder Permissions.

10. Save the folder definition.

Defining Tree-Based SmartNavigation Folders

Access the Folder Administration page (Select PeopleTools, Portal, Structure and Content Click the Add Folder link).

1. Enter a name, label, and any other identifying information for the folder.

2. Select Tree as the data source.

3. Specify the content site node.

4. In the PeopleCode Type field, select which type of PeopleCode program defines the data source. Select Application Package or iScript.

5. Enter either the iScript or application package parameters that define the rowset.

   See iScript Parameters.

   See Application Package Parameters.

   Note. If you use an iScript, you must grant permissions to the web library and iScript for users who will access the SmartNavigation folder.

   See Setting Web Library Permissions.

6. (Optional) Select Display as Content Reference so that the SmartNavigation folder appears and functions as a content reference instead of a folder.

7. (Optional) Deselect the Default Chart Navigation Page check box and select a custom folder navigation object.

   Complete this step only if you want to replace the SmartNavigation chart page with a custom navigation page.

8. (Optional) Specify any necessary folder attributes.

9. Set folder permissions.

   See Setting Folder Permissions.

10. Save the folder definition.

Administering Content References

This section discusses how to:

• Define content references.

• Create related links.

• Set content reference permissions.

• Review content reference permissions.

• Test content references.

• Define content reference links.

• Set content reference link security.

Pages Used to Administer Content References

Defining Content References

Access the Content Ref Administration page (PeopleTools, Portal, Structure and Content. Navigate the portal registry hierarchy until you are in the parent folder for the content reference; then click the Add Content Reference link.)

Note. Many of the fields described in this section appear only when you enter certain field values.

Many of these fields are similar to fields on the Folder Administration page.

When you save a content reference that points to a PeopleSoft component or script on the default local node, the security settings for the content reference are inherited automatically from the menu or script security settings. Any permission lists or roles that you enter on the Content Reference Security page before saving the content reference are deleted and replaced by those of the component or script. These new security settings are also propagated up the folder hierarchy. This ensures that the content reference is visible and all folders are viewable, enabling users to navigate to the component.

Warning! Do not add internal component-based PeopleSoft content references using the Content Ref Administration page. Use the registration wizard instead so that information is consistent between PeopleSoft Application Designer and the portal. Any changes made to the menu definition in PeopleSoft Application Designer and not made to the portal content reference definition break the content reference. The portal navigation system uses the portal registry, not the internal location of menu definitions in PeopleSoft Application Designer.

See Using the Registration Wizard.

This table describes the fields that appear on the Content Ref Administration page:

URL Information

The fields that appear in this group box are based on the selection that you make in the URL Type field.

Pagelet Attributes

The Pagelet Attributes group box enables you to manage pagelet behavior and appearance.

See Managing Pagelet Attributes.

Content Reference Attributes

Content reference attributes provide a framework to specify and store free-form information about a content reference. For example, you can use content reference attributes to specify and store keywords, help information, related content properties, and related links for content references.

In addition, portal-aware applications can use content reference attribute information for application-specific processing. Portal-aware applications are those that:

• Know about the portal registry and API.

• Know how to get information from a content reference.

• Contain code that can access the properties of content references and do something meaningful with the information.

Links

This grid appears only if content reference links that connect to this content reference exist. Click Link Definition to view the definition of each listed content reference link.

Available Content Reference Attributes

This table describes the content reference attributes that your PeopleTools portal recognizes:

Content Reference Type Parameters

This table summarizes the valid combinations of usage type, storage type, and URL type or key HTML content supported for content references:

See Also

Defining Folders

Understanding Portal Templates

Managing General Portal Settings

Configuring Pagelet Time-out Settings

Using Predefined Homepage HTML Objects

Administering Server-Based Caching

Overriding Page Encoding

Creating Related Links

You can create related links for a portal page using the RELLINK content reference attribute. You can create related links to external sites, to internal sites, and to other portal pages.

Note. Related links can be implemented with your choice of template on the content reference. Using the PeopleTools Related Links template displays the related links for the content reference, but not the portal menu navigation.

To create related links:

1. Define the RELLINK content reference attribute.

2. Create related links groups.

3. Create related links for each group.

4. Test the related links.

In this sample page, you see the results of using the related links template and adding the RELLINK attribute on a given content reference:

This table describes the page elements shown in the sample page:

Defining the RELLINK Content Reference Attribute

To define a related link content reference attribute:

1. Access the Content Ref Administration page (PeopleTools, Portal, Structure and Content. Navigate to the appropriate content reference; then click the Edit link.)

2. Enter RELATEDLINKS_TEMPLATE. in the Template Name field.

3. In the Name field of the Content Reference Attributes region, enter RELLINK.

   After you enter this value and move out of the field, the Attribute Information link changes to Edit Related Links.

4. Verify that the Translate check box is selected.

5. Enter a label for the related links attribute.

Note. You do not need to enter any information in the Attribute Value field. After you create the related link group and the related links, the system populates this field with all defined attributes as a string.

Creating Related Link Groups

Access the Related Links Group (PORTAL_RLNK_ADM) page.

To create a related link group:

1. In the Related Link Groups Label field, enter a name.

   This name is the heading under which you place related links.

2. To create additional related link groups, click Add and repeat step 1.

Creating Related Links

To create a link:

1. In the Related Links region on the Related Links Group (PORTAL_RLNK_ADM) page, enter a name in the Related Link URL Label field.

   This name appears as a link under the group name.

2. If you're linking to an internal site, select a node name from the list.

   If you're linking to an external site, leave this field blank.

3. In the Related Link URL field, enter URL information for the link.

   If the link is to an internal site, enter the URL or URI. The URL or URI can be to an internal site, to a portal, and so on. If you specified a value for the Portal URI Text field on the node definition, you can enter a specific document name as the target. The name is appended to the URI text for a full URL.

   If the link is to an external site, enter the URL.

4. To define additional links for the group, click Add and repeat steps 2 and 3.

5. Click OK to save the entry and return to the Content Ref Administration page.

   The Attribute Value field is populated with an XML-type formatted string. This string contains all the related link data and is stored in the PORTAL_ATTR_VAL field of the PSPRSMATTRVAL record for the content reference specified in the PORTAL_OBJNAME field. The following example shows a generated XML-type formatted string:

   <GRPLBL>Worklist Pages
   		<URLLBL>Worklist Details</URLLBL>
   		<CP>Portal</CP>⇒
   		<URL>ICType=Panel&Menu=WORKLIST&Market=GBL&PanelGroupName=⇒
   WORKLIST_DETAILS
   		</URL>
   		<URLLBL>Worklist Monitor</URLLBL>
   		<CP>Portal</CP>⇒
   		<URL>ICType=Panel&Menu=WORKFLOW_ADMINISTRATOR&Market=⇒
   GBL&PanelGroupName=WF_MONITOR_01
   		</URL>
   	</GRPLBL>
   
   	<GRPLBL>Tasks
   		<URLLBL>Task List Summary</URLLBL>
   		<CP>Portal</CP>
   		<URL>ICType=Panel&Menu=PORTAL_COMPONENTS&Market⇒
   =GBL&PanelGroupName=EO_PE_TASK_LIST⇒
   		</URL>
   </GRPLBL>

Testing Related Links

You should test related links to view how the page appears to users, ensure that the labels are correct, and verify that the links function properly. To test related links, click Test Content Reference on the Content Ref Administration page just above the URL Information region.

Note that:

• If the portal cache is enabled on the web server, the related link template does not appear for a content reference page accessed from the menu until the cache expires.

• Related link URLs are displayed only when a user has security access to the URLs.

  To grant security access to a related link URL, register the related link URL as a separate content reference and associate permission lists with it.

  If the related link is not separately registered, then it is treated as having public access.

  If a related link group contains no URLs to which the user has security access, the related link group is hidden. If the user does not have access to any of the related links associated with the target page, then the related links section of the template is hidden.

If the target page does not display any related links, ensure that:

• The application and portal databases are registered as content providers.

  Also check for data-entry errors.

• The templates are registered in PeopleSoft Application Designer with the correct names.

  If the templates are registered, check for data-entry errors.

• The correct related link template is specified for the target page.

  Also ensure that the value of the PORTAL_TEMPL_NAME field in the PSPRSMDEFN record displays a correct related link template

• The RELLINK string was saved on the target page in the content registry.

  Check whether an XML string appears in the Attribute Value field on the Content Ref Administration page. If not, then delete and reenter the RELLINK attribute for all the related link information.

• You assigned security in the registry to the user for the content references listed as related link URLs.

  If not, assign security using the Content Reference Security page for registered related link URLs.

Setting Content Reference Permissions

Access the Content Reference Security page (Select PeopleTools, Portal, Structure and Content.Click the Edit link for a content reference; then select the Security tab.)

This page is similar to the Folder Security page. You can specify the permission lists and roles that grant security access to the content reference.

Certain URL types inherit the security permission list and role authorizations from the referenced object. For these URL types, you can view, but not modify the security by using the Content Reference Security page. All fields except Public and Author Access are display-only. This is the list of URL types that inherit security authorization:

• PeopleSoft Component.

• Worklist.

• PeopleSoft Script.

When you save a content reference that points to a PeopleSoft component or script on the default local node, the security settings for the content reference are inherited automatically from the menu or script security settings. Any permission lists or roles that you entered on the Content Reference Security page before saving the content reference are deleted and replaced by those of the component or script. These new security settings are also propagated up the folder hierarchy. This ensures that the content reference is visible and all folders are viewable, enabling users to navigate to the component.

Note. If you copy, move, or add a content reference to a folder, the security settings of the content reference are propagated up the folder hierarchy. This ensures that the content reference is visible and all folders are viewable, and it enables users to navigate to the content reference. If you remove the content reference from that folder, the security settings that were applied when it was added to the folder are also removed from the folder hierarchy, without disturbing any settings still required for other content references remaining in that folder.

Note. Content reference links do not inherit cascaded security from folders.

See Also

Setting Folder Permissions

Using the Registration Wizard

Setting Up Permission Lists

Setting Up Roles

Reviewing Content Reference Permissions

You can use automated queries to discover the content references to which a given user, permission list, or role has access. Each query provides a different degree of detail about the properties of the content references.

Reviewing Content Reference Security by User

Access the User ID Queries page (PeopleTools, Security, User Profiles, User Profiles, User ID Queries).

This page contains several general-purpose security queries, along with the following links to content reference access queries for the selected user, which are described on the page:

• User ID's Content Reference Access.

• User ID's Content Reference (includes Portal) Access.

• User ID's Content Reference (includes Menu, Component and Market) Access.

• User ID's Content Reference (includes Portal, Menu, Component and Market) Access.

When you click one of the query links, a page appears in a new window, containing a grid with the information described for each content reference.

Reviewing Content Reference Security by Permission List

Access the Permission List Queries page (PeopleTools, Security, Permissions & Roles, Permission Lists, Permission List Queries).

This page is similar to the User ID Queries page, with the following equivalent links to content reference access queries for the selected permission list:

• Permission List's Content Reference Access.

• Permission List's Content Reference (includes Portal) Access.

• Permission List's Content Reference (includes Menu, Component and Market) Access.

• Permission List's Content Reference (includes Portal, Menu, Component and Market) Access.

When you click one of the query links, a page appears in a new window, containing a grid with the information described for each content reference.

Reviewing Content Reference Security by Role

Access the Role Queries page (PeopleTools, Security, Permissions & Roles, Roles, Role Queries).

This page is similar to the User ID Queries page, with the following equivalent links to content reference access queries for the selected role:

• Role's Content Reference Access.

• Role's Content Reference (includes Portal) Access.

• Role's Content Reference (includes Menu, Component and Market) Access.

• Role's Content Reference (includes Portal, Menu, Component and Market) Access.

When you click one of the query links, a page appears in a new window containing a grid with the information described for each content reference.

Testing Content References

After creating or modifying a content reference and setting up permissions, test the content reference.

1. Click Home in the portal navigation header

2. Use the Menu pagelet or the Main Menu to navigate to the content reference.

3. Click the content reference.

You can also click the Test Content Reference on the Content Ref Administration page.

Note. The Test Content Reference link appears on the Content Ref Administration page when the usage type of the content reference type is set to Target only.

Defining Content Reference Links

Access the Select a Content Reference or Content Reference Link page (Select PeopleTools, Portal, Structure and Content. Navigate the portal registry hierarchy into the parent folder in which you want the link to appear. Click the Add Content Reference Link link that appears after the Content References group box.)

Click the folder icons to navigate the tree structure until you find the target of the link. Click the link and the Content Reference Link Administration page appears.

PeopleSoft portals store content references based on their URLs, so you can't register two different content references that specify the same URL. Content reference links overcome this limitation by enabling you to define more than one menu item that invokes a given URL. You define a content reference link like any other content reference, but instead of specifying a URL, you specify an existing content reference as its destination. At runtime, clicking the content reference link on the portal menu connects to the destination content reference by URL.

Note. To the user, a content reference link looks and works the same as a content reference on the portal menu.

A content reference link can point to:

• A content reference of usage type Target.

• Another content reference link.

You can define a content reference link in the same locations that you can define a content reference of usage type Target. Multiple content reference links can connect to a single destination content reference.

By connecting one content reference link to another content reference link, you can create a chain of redirection, which always ends in a content reference of usage type Target. You don’t need to know what the ultimate destination is when you define your new content reference link, and you can duplicate the property settings of the content reference link to which it connects rather than those of the ultimate destination. However, Oracle recommends that you limit your use of chains of content reference links because they impose processing overhead on your portal when selected.

Warning! If you delete a destination content reference or content reference link, all content reference links that connect to it are also deleted. This behavior propagates back through any content reference link chain.

Target Information

Link Information

If you omit values in following fields, their values are inherited from the destination content reference:

• Label.

• Long Description.

• Product.

• Sequence number.

• Object owner identifier.

• No Template.

• Template Name.

• Valid from date.

• Valid to date.

URL Information

These fields are display-only and reflect the URL information of the content reference that you are linking to.

See URL Information.

Content Reference Attributes

If the destination content reference has defined content reference attributes, they appear in this grid. You can copy them from the grid to the Content Reference Link Attributes group box using the following page elements:

Content Reference Link Attributes

Content reference link attributes and content reference attributes share the same page fields.

You can define content reference link attributes directly in this group box, or you can copy an attribute from the destination content reference using the Content Reference Attributes grid, and modify it to suit your purposes.

At runtime, the content reference link attributes defined here are combined with the content reference attributes defined at the link destination, and they are applied together.

Important! If a content reference link attribute defined here has the same name as a content reference attribute defined at the link destination, but a different attribute value, the value defined here takes precedence and is applied at runtime.

Content reference link attributes are independent and separate from the content reference attributes at the link destination. Modifying one has no effect on the other.

Setting Content Reference Link Permissions

Access the Content Reference Link Security page (Click the Security tab on the Content Reference Link Administration page.)

The fields on this page are disabled because content reference links inherit the security settings of the destination object. The inherited security settings propagate upward through the folder hierarchy from the content reference link.

See Also

Setting Content Reference Permissions

Managing Folders and Content References

This section discusses how to:

• Copy folders and content references.

• Move folders and content references.

• Delete folders and content references.

• Synchronize portal object security.

• Register components in multiple portals.

• Register components multiple times.

Pages Used to Manage Folders and Content References

Copying Folders and Content References

Access the Copy Object to a Different Portal Registry page (Select PeopleTools, Portal, Structure and Content, Portal Objects, Content Ref Administration. Click the Copy Object button).

To copy an object:

1. Navigate to the portal registry to which you want to copy the object.

   Click the portal name to copy the object to root level. To expand the folders and navigate further into the registry structure, click the folder icon (not the folder name).

   Important! Clicking the folder name starts the copying process.

2. (Optional) If you are copying a folder, the Recurse subfolders? check box appears. Select this check box to copy the folder and all the subfolders and content references within it.

3. Click the folder name to copy the object into that folder.

4. Click the Yes - Copy button to proceed.

Warning! If you attempt to copy an object to a location that already contains an object of the same name and type, the newly copied object replaces the existing object. For example, if you copy a folder and subfolders to another portal where a subfolder by that name already exists, the existing subfolder is deleted and replaced with the subfolder from the source portal. No warning message appears.

Moving Folders and Content References

Access the Select New Parent Folder page (PeopleTools, Portal, Structure and Content, Portal Objects, Content Ref Administration Click the New Parent Folder button).

The current parent folder is shown in bold type, and the folder tree is expanded just enough to show the location of the current parent folder. All other folders are shown collapsed. You can expand the tree to show content references, which are displayed as tree leaves and appear in normal text.

To move a folder or content reference to a new parent folder:

1. Navigate to the new parent folder by clicking the appropriate folder icons with plus signs.

   Note. When navigating, do not click the folder name unless it’s the name of the new parent folder that you want to select. Once you click a folder name, as opposed to the icon, the folder name that you selected becomes the new parent folder.

2. Select the new parent folder by clicking the folder name.

3. Click Save.

Note. When you move a content reference that points to a component or script at the default local node, its security settings are cascaded up to its new parents all the way up to the root folder. In addition, when you move a folder, its security settings (not including security inherited from a subordinate object) are cascaded up to its new parent, all the way up to the root folder. This ensures that the folder or content reference is accessible in its new location.

Deleting Folders and Content References

To delete a folder or content reference:

1. Select PeopleTools, Portal, Structure and Content.

2. In the portal registry, navigate to the folder or content reference that you want to delete.

3. Click the Delete button next to the object that you want to delete.

   All child folders and child content references are deleted when you delete the selected folder. Make sure that no critical dependencies exist for these objects before deleting the parent folder.

Warning! Do not delete folders or content references that are delivered with PeopleTools. These default objects have special significance to your portal. Changing them could make your portal unusable.

When you delete a content reference or a content reference link, all content reference links that connect to it are also deleted. This behavior propagates back through any content reference link chain.

Synchronizing Portal Object Security

Access the Portal Security Synchronization page (PeopleTools, Portal, Portal Security Sync).

The hierarchical relationships and dependencies between objects in the portal registry determine what security settings each object must have. The portal won't work correctly if these security relationships aren't maintained. Here are some examples of these relationships:

• A folder that is not public or hidden must have at least the level of access that its immediate child objects (folders, content references, and content reference links) have.

• A content reference link must have exactly the same level of access as the object (content reference or content reference link) to which it links.

• A content reference that represents a PeopleSoft component or iScript must have exactly the same level of access as the object that it represents.

Portal object security settings can become unsynchronized when you move portal objects from one database to another using the Project Copy feature in PeopleSoft Application Designer. When you merge projects this way, if the projects contain any portal objects with identical names, the security settings of the portal objects in the last project copied overwrite the security settings of portal objects copied earlier. Also, when a copied portal object doesn't overwrite an existing object, it changes the structure of the resulting portal registry hierarchy.

Use the Portal Security Synchronization page to reinstate the correct security relationships between objects in the portal registry after you copy a project that contains portal objects.

This page enables you to run the Application Engine program PORTAL_CSS from the standard menu navigation. You can use this feature on local portals only, not on portals on remote databases. In addition, from any local portal, you can run this program against another local portal.

To synchronize portal object security, specify a local portal in the Portal Name field and click Run. The portal objects are synchronized in the following way:

1. The security settings of each content reference are compared to the component or iScript that it represents, and updated to match.

2. The security settings of each content reference link are compared to the content reference or content reference link to which it connects, and updated to match.

3. The security settings of each content reference and content reference link are propagated to its parent folder, in addition to the parent folder's existing settings.

   None of the parent folder's existing security access is reduced.

   Note. The settings aren't propagated if the parent folder is public or hidden.

4. The security settings of each folder are propagated to its parent folder, in addition to the parent folder's existing settings.

   None of the parent folder's existing security access is reduced.

   Note. The settings aren't propagated if the parent folder is public or hidden.

The following warning messages may appear when security synchronization cannot occur:

• No permissions in PSAUTHITEM for object %1

• Cref %1 points to Menu: %2, Component: %3 which doesn't exist.

  Note. When this message appears, you need to delete the invalid content reference .

The security administrator and portal administrator are responsible for determining why an object has no security or why an object does not exist.

Delete Invalid Security Option

When you move portal objects from one database to another, roles and permission lists assigned to folders and content references on the source database may not exist on the target database and therefore become invalid. Select the Delete Invalid Security check box on the Portal Security Sychronization page to remove nonexisting roles and permission lists from folders and content references.

Note. When the Delete Invalid Security option is selected, the PORTAL_CSS process runs more slowly because it checks every role and permission list on every portal registry structure. When a nonexisting role or permission list is found on the portal registry structure, it is removed from that portal registry structure.

Registering Components in Multiple Portals

After you use Registration Wizard to register a new component in a portal, you may need to register the component in other portals. You can register components in multiple portals in two ways:

• Use Registration Wizard again.

  Select the second option: Add this component to a portal registry. Then reenter the content reference label, long description, and sequence number (if not 1) to match the other portal’s entry.

• Copy the component to other portals.

  When you have copied your component to another portal, open that portal to verify that it was copied as anticipated.

See Copying Folders and Content References.

See Also

Changing Default Portals

Registering Components Multiple Times Within a Portal

The portal registry does not allow a URL to be registered more than once. When you define a content reference, the component name is part of the URL. If you must register the same component URL in more than one location, add a unique character to the parameter field. (Be sure that you really must register a URL twice because this creates upgrade and maintenance concerns.) See the following example, in which the additional numeric character 1 is added to the Additional Parameter field:

See Also

Registering Components in Multiple Portals

Managing General Portal Settings

This section discusses how to manage general portal settings.

Page Used to Manage General Portal Settings

Managing General Settings for Portals

Access the General Settings page (PeopleTools, Portal, General Settings).

Use this page to manage the settings for the portal that you're signed in to. To modify other portals, use the Portal Definitions page.

Note. You must sign out of the portal and sign in again before your changes take effect.

See Administering Portal Definitions.

Folder Navigation

You enter the default folder navigation values for the current portal on this page. Enabling folder navigation at the portal level enables folder navigation for all standard folders and SmartNavigation in the portal. You can subsequently disable folder navigation at the individual folder level

Folder navigation is not enabled unless you select the Is Folder Navigation Enabled check box on both the Portal Definition and General Settings pages. The Is Folder Navigation Enabled check box is selected by default in the standard PeopleTools portals.

See Adding and Editing Portal Definitions.

Note. If you disable and then re-enable folder navigation at this level, folder navigation is re-enabled for all folders. All overrides at the individual folder level are cleared.

Portal Search Options

Use the fields in this group box to enable system-level search options.

Search Results Page

Enter the names of the menu definition, component definition, and market of the Search Results page. This group box is disabled when the Display global search in header check box is selected.

Navigation Options

Favorites Options

Menu Text Options

Disable Drop-down Menu Sort

Enter the PeopleSoft language codes of the languages for which you want to remove the drop-down menu sort functionality at the system level. The drop-down menu sort is disabled for these languages by default: Japanese, Korean, Thai, Simplified Chinese, and Traditional Chinese.

Enter PeopleSoft language codes in a comma-separated list. Select PeopleTools, Utilities, International, Languages to see all PeopleSoft language codes.

Header Frame Options

This group box sets the number of header frame rows if you are using the PeopleTools default template. The value entered for this field determines the size of the header frame. The default value for the PeopleTools portal is 65 and the default value for the Application Portal is 100.

Node Templates

Configure node-specific template information.

See Also

Using Menu Pagelets

Managing Portal Objects

The Portal Objects folder is of special significance to the portal. This section discusses how to:

• View Portal Objects folder settings.

• Manage templates.

• Add and edit templates.

• Delete templates.

Pages Used to Manage Portal Objects

Viewing Portal Objects Folder Settings

Access the Structure and Content page (Select PeopleTools, Portal, Structure and Content. In the Folders group box, click the Edit link for Portal Objects).

Understanding Templates

Templates are stored in the HTML catalog and are edited through the portal administration pages. For the portal to process templates properly, they must be referenced in the Templates folder within the Portal Objects folder. Storing templates in the HTML catalog enables them to be upgraded like other objects.

Templates are stored in the HTML catalog according to the following naming convention: Template names always begin with the literal PR_. Here's an example name: PR_PORTALNAME_CONTENT REFERENCE ID

The following example shows a sample template:

Templates can be larger than the maximum size permitted by the HTML catalog. Such templates are automatically divided into several files in the HTML catalog. In this case, a letter is appended to each HTML object that makes up the template, as shown here:

PR_EMPLOYEE_123456789_A

PR_EMPLOYEE_123456789_B

See Also

Working with Portal Templates

Adding and Editing Templates

Access the Content Ref Administration page (Select PeopleTools, Portal, Structure and Content. Then click these links in succession: Portal Objects, Templates).

To add a new template, click Add Content Reference in the Content References region at the bottom of the Content Ref Administration page.

To edit an existing template, click the Edit link next to the template that you want to edit in the Content References region at the bottom of the Content Ref Administration page.

See Defining Content References.

The fields for adding a dynamic template are the same as for any content reference, except for additional iScript parameter fields. These fields are enabled only if the storage type is set to Remote by URL.

If the URL Type field is set to PeopleSoft Script, the iScript Parameters group box appears. Select the record name, PeopleCode event name, field name, and PeopleCode function name that stores the iScript that the content reference accesses to build the template.

See Also

Defining Folders

Defining Content References

Deleting Templates

You delete templates the same way that you delete folders and content references.

See Deleting Folders and Content References.

Note. Do not delete the DEFAULT_TEMPLATE portal template. This template has special significance to your portal and must always be available. Deleting this template could make your portal inoperative. Oracle recommends that you not delete any template unless you are fully aware of how it's used within the portal.

Reviewing Menu Item Information

This section lists common elements used in the section and discusses how to:

• View menu item details.

• View menu folder structure information.

• View menu security details.

Common Elements Used in This Section

Pages Used to Review Menu Item Information

Viewing Menu Item Details

Access the Menu Item Detail page (PeopleTools, Portal, View Menu Item Detail).

Use this page to review the portal registry information for a menu item. The details that appear include the exact users and the roles and permission lists that allow access to a given menu item.

Note. The Accessible Permissions, Accessible Roles, and Accessible Users scroll areas are populated only if the access type is set to permission list.

See Defining Content References.

Accessible Permissions

This section displays the permission list name and description for all permission lists that can access this menu item.

Note. If the component or iScript is using a local node with no extra parameters, the permission lists are automatically populated based on the menu object component security.

Accessible Roles

Displays the role name and description for all roles that can access this menu item.

Accessible Users

Displays the user ID and description for all users that can access this menu item.

Viewing Menu Folder Structure Information

Access the Menu Folder Structure page (PeopleTools, Portal, View Menu Folder Structure).

Use this page to view a list of content references for a selected portal registry folder. You see the contents of one or several menu folders.

Objects Tab

Select the Objects tab.

Details Tab

Select the Details tab.

User ID

If the Auth Access check box is selected, this field displays the author's user ID.

Viewing Menu Security Details

Access the Menu Security page (PeopleTools, Portal, View Menu Security).

Use this page to view a list of folders or content references that a user ID, role, or permission list can access.

Note. The Seq Nbr (sequence number) column is hidden in this illustration, and because of the large number of objects, not all are shown.

Object Security

Select the level of object security for the menu information that you want to see.

Warning! To prevent unexpected errors and inordinately long retrieval times, do not select the ALLPAGES permission list in conjunction with the Show All folder option. Always narrow your folder options if you select the ALLPAGES permission list.

Folder Visibility

Select the level of visibility for the menu information that you want to see.

Permission Lists

If either the Role object security option or the Show Top Level Only folder visibility option is selected, then this scroll area appears, displaying the permission lists that are associated with each menu item.

Building Registry Search Indexes

This section discusses how to:

• Associate keywords with content references.

• Build search indexes for PeopleSoft applications.

Note. If you use PeopleSoft Application Portal, registry search implementation is different. Enterprise Search documentation supersedes PeopleTools Search documentation.

See PeopleSoft Application Portal 9 PeopleBook: Application Portal Technology, Configuring the Application Portal Search Infrastructure

Pages Used to Build Registry Search Indexes

Associating Keywords with Content References

Access the Content Ref Administration page (PeopleTools, Portal, Structure and Content Click the Edit link for the appropriate content reference.)

The search index derives keywords from the content reference labels and long descriptions. You can add additional keywords to a content reference by adding portal KEYWORD attributes. This is very useful if synonym-type keywords exist that are not mentioned in the title or description, for example, P.O. versus Purchase Order.

Note. Attribute values must be separated with a comma and a space.

Building Search Indexes for PeopleSoft Applications

Access the Build Search Index page (PeopleTools, Portal, Build Registry Search Index).

You can build a search index from the portal administration pages and schedule the build process using PeopleSoft Process Scheduler. Each time that you build the search index, the index is entirely rebuilt, and any previous entries are overwritten.

Note. Only content references can be indexed.

The process for building a search index for a portal application is fairly easy because data in the portal registry is already in a known format and this data is used to build the search index. When you build a search index from the portal administration pages, an Application Engine program calls a C++ program, PORTAL_INDEX, which reads from the portal registry. The C++ program then generates the bulk insert files to create the search index. The following illustration represents this process:

Building a search index process

To build a search index:

1. Select or add a run control ID.

   You can use any run control ID; however, you may want to use a portal name to associate the run control ID with the registry for which you are building the search index.

2. Select the All Installed Languages check box to build the index for all installed languages.

3. Select the language code for which you want to build the search index.

   The default language code is the base language.

4. Click Run to launch the build process.

   PeopleSoft Process Scheduler initiates an Application Engine program named PORTAL_INDEX. Click the Process Monitor link to view the status of the index build. Click Report Monitor to review output.

See Also

Configuring Verity Search and Building Verity Search Indexes