PeopleSoft Enterprise Portal 9.1 PeopleBook: Portal and Site Administration

Using the Portal Registry Load Process

This chapter provides overviews of the Registry Load Application Engine process (EO_PE_R_LOAD) and portal registry load files. It also discusses how to:

Create a portal registry load file.
Start the portal registry load message.
Run the Registry Load process.

Note. The information in this chapter is for system administrators who implement and maintain the PeopleSoft Enterprise Portal.

Understanding the Portal Registry Load Process

The Portal Registry Load process is a file-based method to bulk-load content and folder references into the portal registry.

Loading data into the portal registry involves two staging tables:

EO_PE_LOAD_DTL
EO_PE_LOAD_FLDR

The PORTAL_REG_LOAD Enterprise Integration Point (EIP) delivers both an application message and a file layout in the form of a comma-separated value (CSV) file. You can:

Use your own application programming interfaces (APIs) to match the PORTAL_REG_LOAD message format.
Export the data to a spreadsheet, save it as a CSV file, and follow the steps we provide for the inbound flat-file utility.

See Running the Portal Registry Load.

For the inbound flat-file definition, use the layout and message combination: PORTAL_REG_LOAD.

The result of the flat-file utility is a published PORTAL_REG_LOAD message. When the portal subscribes to the message, you see the data in the tables EO_PE_LOAD_DTL and EO_PE_LOAD_FLDR.

Note. The message subscription was set to generate a subscription ID. This subscription ID was used to populate the Process Instance field in the EO_PE_LOAD_DTL and EO_PE_LOAD_FLDR records.

After the file data is in the staging tables, run the Registry Load process to load the data into the portal registry.

Note. To research the technical details of any integration point used by PeopleSoft applications, refer to the Interactive Services Repository that can be found in the Documentation section of the My Oracle Support website.

Understanding the Portal Registry Load Files

The inbound flat-file utility requires a CSV file. To work with the Registry Load process, the data in the file must be in a specific order. We deliver two sample files to provide a basis for creating your own inbound files for the Registry Load process.

Delivered Sample File Name	Usage
PORTAL_REG_LOAD_SAMPLE.xls	Microsoft Excel spreadsheet file with column headings. This file contains registry data for sample folders, sample pagelets, and sample target pages.
PORTAL_REG_LOAD_SAMPLE.csv	Comma-separated value file without column headings. This file is created by deleting the column heading row from PORTAL_REG_LOAD_SAMPLE.xls and saving the file as type CSV (*.csv). The resultant data is in the format that is required by the Registry Load process.

Delivered Sample File Name

Usage

PORTAL_REG_LOAD_SAMPLE.xls

Microsoft Excel spreadsheet file with column headings.

This file contains registry data for sample folders, sample pagelets, and sample target pages.

PORTAL_REG_LOAD_SAMPLE.csv

Comma-separated value file without column headings.

This file is created by deleting the column heading row from PORTAL_REG_LOAD_SAMPLE.xls and saving the file as type CSV (*.csv). The resultant data is in the format that is required by the Registry Load process.

Note. The delivered files are samples only. PORTAL_REG_LOAD_SAMPLE.csv can be loaded into a testing demonstration portal database. The Registry Load process does not overwrite existing registry content references. After the file data is loaded, you must delete it manually from the portal registry to reload the same data.

The PORTAL_REG_LOAD_SAMPLE.xls file contains column headings that describe the data required for that column. The column data reflects the data that is entered when you register a content reference in the portal.

External Uniform Resource Locators (URLs), PeopleSoft components, and PeopleSoft iScripts are the only types of content that can be registered as content references using the registry load file. Only homepage pagelets and target pages can be registered using the registry load file. Each row in the file represents a different content reference.

Note. Templates and template components cannot be registered using the portal registry load file. These types of content references must be registered online.

With the Registry Load process, content is registered down through six folder levels. The process starts at the first level and works its way through the folders that are listed for the content reference. The content reference is registered under the lowest level folder that is not blank. If a specified folder label is not found in the registry, the registry load process creates this folder. The object name for created folders is formatted to match the uppercase value of the label. If this object name already exists, a numeric value is appended to make the object name unique in the portal registry. If no folder is specified for a particular content reference row, the content reference is registered at the root level.

The columns in the file must be in the exact order and format as delivered in the sample files for use by the Registry Load process. The following table explains the format and use of each column. Failure to provide a value for the required columns results in an error status for that content reference row during the Registry Load process. Content reference rows with a status of E in the staging table are not registered. You can view the errors for your data using the View Registry Load Data page.

Note. You can use the View Registry Load Data page before or after you run the Registry Load process to see what is in the staging tables.

Column Heading	Format	Use	Required?
Portal Name	30 characters, uppercase, no spaces.	This value must match the portal definition object name. The valid values are EMPLOYEE, CUSTOMER, PARTNER, or SUPPLIER	Required
Content Provider	30 characters, mixed case, no spaces.	This value must match the exact spelling and case of an existing content provider node name. This is the content provider node for the content reference. Delivered content provider nodes include BP, CRM, EPM, ELM, ERP, GFHA, HRMS, LOCAL_NODE, SA, and SAHA.	Required for components and iScripts
Portal Template	30 characters, uppercase, no spaces.	This value must match a registered template object name. This template is used by the content reference. You must specify the template object name, not the template label.	Optional
Product	4 characters, mixed case, truncated after 4 characters.	Optional value that is stored with the content reference registry entry. Select this value in the registry load process to limit the rows in this file that are to be registered as content references.	Optional
Category	30 characters, uppercase, no spaces.	Used for user organization of the load file. Select this value in the Registry Load process to limit the rows in this file that are to be registered as content references.	Optional
URL Type	1 character, uppercase	Used to define the type of content reference target page. Values are: S: iScript C: Component X: External	Required
Usage Type	1 character, uppercase	Used to define the use of the content reference target page. Values are: P: Pagelet T: Target	Required
Hidden	1 character, uppercase	Specifies whether the content reference is hidden in the menu navigation. Values are: N: Not hidden Y: Hidden	Required
Fldr 1 Seq (Folder 1 sequence)	4 digits, numeric	Specifies the display order of the level 1 folder.	Optional
Fldr 1 Name	30 characters, free-form	Level 1 folder label.	Optional
Fldr 1 Desr (folder 1 description	254 characters, free-form	Level 1 folder description.	Optional
Fldr 2 Seq	4 digits, numeric	Specifies the display order of the level 2 folder.	Optional
Fldr 2 Name	30 characters, free-form	Level 2 folder label.	Optional
Fldr 2 Desr	254 characters, free-form	Level 2 folder description.	Optional
Fldr 3 Seq	4 digits, numeric	Specifies the display order of the level 3 folder.	Optional
Fldr 3 Name	30 characters, free-form	Level 3 folder label.	Optional
Fldr 3 Desr	254 characters, free-form	Level 3 folder description.	Optional
Fldr 4 Seq	4 digits, numeric	Specifies the display order of the level 4 folder.	Optional
Fldr 4 Name	30 characters, free-form	Level 4 folder label.	Optional
Fldr 4 Desr	254 characters, free-form	Level 4 folder description.	Optional
Fldr 5 Seq	4 digits, numeric	Specifies the display order of the level 5 folder.	Optional
Fldr 5 Name	30 characters, free-form	Level 5 folder label.	Optional
Fldr 5 Desr	254 characters, free-form	Level 5 folder description.	Optional
Fldr 6 Seq	4 digits, numeric	Specifies the display order of the level 6 folder.	Optional
Fldr 6 Name	30 characters, free-form	Level 6 folder label.	Optional
Fldr 6 Desr	254 characters, free-form	Level 6 folder description.	Optional
Cref Seq (content reference sequence	4 digits, numeric	Specifies the display order of the content reference in the lowest level folder.	Optional
Cref Name	30 characters, free-form	Content reference label.	Required
Cref Desr	254 characters, free-form	Content reference description.	Optional
Menu Name	30 characters, uppercase, no spaces	Menu name that stores the component. Used only by components.	Required for components.
Market	3 characters, uppercase, no spaces	Market associated with the component (usually GBL). Used only by components.	Required for components.
Panel group	18 characters, uppercase, no spaces	Component name that stores the pages. Used only by components.	Required for components.
Record Name	15 characters, uppercase, no spaces	Record name that stores the iScript. The record must begin with WEBLIB_. Used only by iScripts.	Required for iScripts.
Field Name	18 characters, uppercase, no spaces	Field name that stores the iScript. Used only by iScripts.	Required for iScripts.
Pcode Event Type (PeopleCode event type)	14 characters, mixed case, no spaces	PeopleCode function event that stores the iScript (usually FieldFormula). Used only by iScripts.	Required for iScripts.
Pcode Function Name	30 characters, mixed case, no spaces	PeopleCode function name that is used to invoke the iScript. This value might contain appended query string parameters if length permits. The function must begin with iScript. Used only by iScripts.	Required for iScripts.
Portal Object Name	30 characters, uppercase, no spaces	Object name for the content reference. If this column is blank, the value in the content reference label column (Cref Name) is in uppercase and used.	Optional
Default Column	1 digit, numeric	Defines the default column for the pagelet in the homepage layout. If this column is blank, the default value is 1. Used only by pagelets. Values are: 1: First column. 2: Second column	Optional
Edit URL Content Provider	30 characters, mixed case, no spaces	Content provider for the edit URL that is used to access the Pagelet Personalization page. The edit URL is listed in the External URL/Edit URL/Related Link column. If no edit URL is specified, leave this column blank. Used only by pagelets.	Optional
External URL/Edit URL/Related Link	Unlimited long character, free-form	Use of this column depends on the URL type and the usage type of the content reference: Component or iScript Pagelets: (Optional). The URL that is used to access the pagelet personalization page. The Edit URL value for a PeopleSoft personalization page must be of the following form (replacing MENU, MKT, and COMPONENT name with the PeopleSoft values: For an 8.44 content provider: c:/MENU.COMPONENT.MKT For an 8.1x content provider: ICType=Panel&Menu=MENU&Market=MKT_NAME&PanelGroupName=COMPONENT Component or iScript Targets: (Optional). The URL that is used to access the pagelet personalization iScript. The Edit URL value for a PeopleSoft personalization page must be of the following form (replacing RECORD, FIELD, EVENT, FUNCTION name with the PeopleSoft values). For an 8.4x content provider: s/RECORD.FIELD.EVENT.FUNCTION For an 8.1x content provider: ICType=Script&ICScriptProgramName=RECORD.FIELD.EVENT.FUNCTION External Targets: (required). URL that is used to access the external content reference. If no content provider is listed for this content reference, state the complete URL http://... If a content provider is used, state only the remaining portion of the URL.	Required for External URLs
Keyword List	254 characters, free-form	List of keywords, delimited by spaces, that are used by the search engine index to return this content reference when a user invokes the portal search. You can enclose keywords in quotes for the search to handle the keywords as a single phrase.	Optional
Permission Lists	254 characters, uppercase, spaces allowed	List of up-to-30-characters-long permission lists, delimited by semicolons, that are used to secure access to this content reference.	Required

See Reviewing the Registry Load Data.

Creating a Portal Registry Load File

To be usable by the Registry Load process, the number of columns and format in your registry load file must match those in the delivered PORTAL_REG_LOAD_SAMPLE.xls file.

To create a portal registry load file:

Save PORTAL_REG_LOAD_SAMPLE.xls with a different name.
Replace the existing rows with your data. The number of rows of data is not limited.

Note. Do not put commas or tabs in any of the Microsoft Excel file cells, including the description fields. Commas and tabs disrupt the data stored as a CSV file.
Save the file with your data.
Delete the row that contains the column headings.
Save the file again, with the file type CSV (*.csv).
Place the file in a directory that is accessible to the application server for the portal database.

Running the Portal Registry Load

This section discusses how to:

Set up the portal registry load message.
Define inbound file processing.
Run a process request.
Monitor application messages.

Pages Used to Start the Portal Registry Load Message

Page Name	Definition Name	Navigation	Usage
Node Definition - Transactions	IB_NODETRXLIST	PeopleTools, Portal, Node Definitions, Transactions	Attach Application Message transactions to a message node definition.
File Inbound	EO_FILE_INBOUND	Enterprise Components, Integration Definitions, Inbound File Rule	Define inbound file processing.
Inbound File Publish	EO_FILETOMSG	Enterprise Components, Integration Definitions, Initiate Processes, Inbound File Publish	Initiate file-to-message processing. The file-to-message processing function reads the file rowset and publishes it as a message.
Registry Load Data	EO_PE_REG_LOAD	Portal Administration, Navigation, View Registry Load Data	Check the data in the PS_EO_PE_LOAD_DTL and PS_EO_PE_LOAD_FLDR staging tables.

Setting Up the Portal Registry Load Message

To set up the portal registry load message:

In PeopleSoft Application Designer, access the PORTAL_REGISTRY message channel.
Navigate to File, Definition Properties to display the Message Channel Properties panel.
Click the Use tab.
Click Run in the Message Channel Status group box.
Click OK to save the channel.
In PeopleSoft Application Designer, access the PORTAL_REG_LOAD message.
Navigate to File, Definition Properties and click the Use tab.
Select the Active option in the Status group box.
Click OK to save the message.
Use your browser to log in to your PeopleSoft Enterprise Portal database. Access the Node Definitions page.

Select the local default message node, delivered as PSFT_PA.
Click the Transactions tab. Insert the Inbound Asynchronous request message PORTAL_REG_LOAD, and the Outbound Asynchronous message PORTAL_REG_LOAD.
Click Save to save the attached message transactions.

Defining Inbound File Processing

To define inbound file processing:

Access the File Inbound page (Enterprise Components, Integration Definitions, Inbound File Rule).
In the Inbound File field, enter the directory information for the file location on the application server machine.

Note. The inbound file PORTAL_REG_LOAD_SAMPLE.csv must reside in a directory that is accessible to the application server.
Select the Active value in the Status drop-down list box.
Clear the Create Message Header and Create Message Trailer options.
In the File Layout group box, select PORTAL_REG_LOAD for the Definition Name and Message Name fields.

Running the Inbound File Publish Process

To run the Inbound File Publish Application Engine process (EOP_PUBLISHF):

Access the Inbound File Publish page (Enterprise Components, Integration Definitions, Initiate Processes, Inbound File Publish).
Enter a request ID and description.
In the Process Frequency group box, select one of the following: Once, Always, or Don't Run.
Select the file identifier that you created on the File Inbound page.
Click Save.
Click Run. Record the process instance number.
Click the Process Monitor link to monitor the status of the process.

Monitoring Application Messages

To monitor application messages:

Access the Application Message Monitor page.
Select the Pub Contracts tab.
Select a publish node.
Select a channel name.
Select the message name.
Click Refresh.
Check the Status field to see if Done is displayed for the published message.
Select the Sub Contracts tab.
Click Refresh.
Check the Status field to see if Done is displayed for the message subscription contract.
Access the Registry Load Data page to check the data in the EO_PE_LOAD_DTL and EO_PE_LOAD_FLDR staging tables.
Enter in the inquiry fields specific to your loaded data. Leave the Load Status field blank.
Run the Registry Load process.

Running the Registry Load Process

This section provides an overview of Registry Load process prerequisites and discusses how to:

Run the Registry Load process.
Review and correct errors.

Note. The user running the Registry Load process should have the role of PeopleSoft Administrator. This will ensure that they have the necessary security to successfully load any and all content references.

Understanding Registry Load Process Prerequisites

Before you can run the Registry Load process, perform these tasks:

Configure and start PeopleSoft Process Scheduler for the application server.
Set up a run control ID.

Pages Used to Run the Registry Load Process

Page Name	Definition Name	Navigation	Usage
Run Registry Load	EO_PE_RUN_LOAD	Portal Administration, Navigation, Run Registry Load Click Add a New Value.	Run the Registry Load process.
Registry Load Data	EO_PE_REG_LOAD	Portal Administration, Navigation, View Registry Load Data	Review and correct loaded data or errors.
Registry Load Folders	EO_PE_FLDR_SEC	Click the View Folders link on the Registry Load Data page.	View the folder hierarchy for the folders that were created by the Registry Load process.

Running the Registry Load Process

Access the Run Registry Load page (Portal Administration, Navigation, Run Registry Load).

To run the Registry Load process:

Select the Register Content option.
Leave the Registry Load Limit field clear or enter 1000 to limit the number of rows that are loaded.
Select the Update Folder Permissions option to update the parent folders with their children's content reference permission lists.

Updating the folder permissions can be done at any time. The Registry Load process uses the portal registry data to update the folder permissions for the entire portal registry. It does not use the data in the staging tables.
Define the portal registry definition that matches your staged registry data in the Portal Name field.

The default portal definition is EMPLOYEE.
Enter an effective date.
Enter an expiration date.
Click Run.
After the process runs, view and correct errors to the data in the staging tables using the Registry Load Data page. Rerun the process as needed.

Reviewing the Registry Load Data

Access the Registry Load Data page (Portal Administration, Navigation, View Registry Load Data).

Portal Name

Enter the portal name that was specified when you ran the process.

Load Status

Select the load status of the rows that you want to view. Values are:

Error in Load Data: Content references were marked in error during the load process and were not registered.

Not Registered: The load process did not pick up the content references. For rows that were processed but have a Not Registered status, check to see if the content references object name already exists in the portal registry.

Successfully Registered: Load data was successfully entered into the portal registry.

Leave this field clear to view all rows of the staging tables, including those rows that have not been processed.

Search

Click to retrieve applicable registry load data to the page.

View Folders

Click to access the Registry Load Folders page, where you can view the folder hierarchy. The page displays the folder created as well as the folder reference.

Registry Load Details

Error Detail

Click for rows that are returned with the load status criteria set to Error in Load Data. A message box displays to provide you with the data that prevented the data row from being registered. Types of errors include:

Invalid portal name. Use the prompt button to see valid values.
Blank content reference name (label).
Blank URL type (component, iScript, or external).
Incomplete data required for each URL type (for example, a menu name for a component URL type).
Invalid content provider.
Invalid template name.

Portal Name	Enter the portal name that was specified when you ran the process.
Load Status	Select the load status of the rows that you want to view. Values are: Error in Load Data: Content references were marked in error during the load process and were not registered. Not Registered: The load process did not pick up the content references. For rows that were processed but have a Not Registered status, check to see if the content references object name already exists in the portal registry. Successfully Registered: Load data was successfully entered into the portal registry. Leave this field clear to view all rows of the staging tables, including those rows that have not been processed.
Search	Click to retrieve applicable registry load data to the page.
View Folders	Click to access the Registry Load Folders page, where you can view the folder hierarchy. The page displays the folder created as well as the folder reference.