Understanding the Portal Registry Load Files

The Registry Load process 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 data files for the Registry Load process. The sample portal registry load files can be found in the PS_APP_HOME\data folder.

Note: If the PeopleSoft Interaction Hub files were not installed in a separate PS_APP_HOME location, then these files will be found in PS_HOME\data instead.

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 resulting data is in the format that is required by the Registry Load process.

Note: The delivered files are samples only. You can load portal_reg_load_sample.csv into a test or demo database. The Registry Load process does not overwrite existing registry entries. After the file data is loaded, you must delete the folder and content reference definitions manually from the portal registry in order 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.

Each row in the file represents a different content reference. PeopleSoft components, PeopleSoft iScripts, and external URLs are the only types of content that can be registered as content references using the registry load file. In addition, only homepage pagelets and target pages can be registered using the registry load file.

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 can registered to a depth of 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 Registry Load Data Page.