Managing the Locally Installed PeopleSoft Online Library

This chapter provides an overview of the PeopleSoft Online Library website folders and discusses how to manage the PeopleSoft Online Library.

Understanding the PeopleSoft Online Library Website Folders

Before installing new PeopleSoft documentation over an existing website or changing how users access individual documentation types and books, you should understand the hierarchical folder structure of the website and how it corresponds to the organizational levels of the documentation on the site. This section discusses the:

• Global folder level.

• Language folder level.

• Documentation type folder level.

• Book folder level.

Global Folder Level

The top folder of the website (<docroot>) is the global level of the library.

The following example illustrates the global files and subfolders that are discussed in this section:

The global level contains three HTML files:

• index.htm

  This is the homepage for the PeopleSoft Online Library. When a user opens this file in a browser, JavaScript logic for this page determines the browser's language setting and redirects the user to a PeopleSoft Online Library homepage in that language, if it exists. If no language match is found, English is used as the default language.

• f1search.htm

  This file processes online help requests from the PeopleSoft applications. When a user requests help from an application page, a URL to <docroot>/f1search.htm is passed to the browser. The URL contains arguments that specify the help context ID and the user's preferred language. If that language exists on the PeopleSoft Online Library website, the documentation in that language is searched for a relevant help topic, and if one is found, the corresponding page is opened. If no language match is found, English is used as the default language.

• helptest.htm

  This file is used for testing and troubleshooting online help functionality.

• index_xxx.html

  This file provides a list of HTML and PDF files for the product line. Secure Enterprise Search uses this file to build a full-text index. The xxx represents the product line and version number. For example, the delivered file for PeopleTools 8.52 is named index_pt852pbr0.html.

Utility Folders

The global level also includes the following utility folders that contain files that are used at the global level or shared by subsequent levels of the PeopleSoft Online Library:

• htm

  This folder contains common HTML files that are used in the PeopleSoft Online Library interface.

• img

  This folder contains graphic files.

• styles

  This folder contains cascading style sheet (CSS) files.

• js

  This folder contains JavaScript files.

These utility folders also appear at lower levels in the library folder hierarchy. While it's not important to list or describe most of the files in these folders, one thing is important to understand: Each level of the library has at least one JavaScript file that stores information about the structure of the level below it. At the global level, the key JavaScript file is <docroot>/js/langs.js, which stores information about the languages that have been installed in the PeopleSoft Online Library.

See Managing Language Support.

Language Folder Level

Below <docroot> are folders representing each installed documentation language: eng (English), fra (French), por (Portuguese), and so on. These folders represent the language level of the website.

The following example illustrates the language files and subfolders that are discussed in this section:

The language level is essentially the top of the PeopleSoft Online Library site as far as users are concerned. When a user navigates to <docroot>/index.htm, that user is redirected to the appropriate language folder, based on his or her browser language. The files at and below the language level (PeopleBooks and other document types, website display labels, CSS files, accented character conversion routines, and so on) are all language specific.

Utility Folders

The language level includes the following utility folders that store files that are used at the language level or shared by subsequent levels of the PeopleSoft Online Library:

• styles

  This folder contains CSS files.

• js

  This folder contains JavaScript files. Information about the documentation type level of the website (which is the next level below the language level) is stored in the following JavaScript files:

  • <docroot>/eng/js/doctypes.js

    This file specifies which documentation types appear on the PeopleSoft Online Library homepage.

  • <docroot>/eng/js/helptypes.js

    This file specifies which documentation types support online help.

  The js folder at the language level also includes several *labels.js files that contain translatable text variables that are used throughout the PeopleSoft Online Library.

Documentation Type Folder Level

Each language folder includes the <docroot>/eng/psbooks folder, which contains PeopleBooks. This is the documentation type level of the website, and PeopleBooks is the only documentation type that is currently available.

Note. In the remainder of this document, the example file paths use eng (English) as the language folder.

The following example illustrates the documentation type files and subfolders that are discussed in this section:

The files that are stored at the PeopleBooks documentation type level are used for the PeopleBooks homepage and copyright information and to provide backwards compatibility with previous versions of PeopleBooks.

Utility Folders

The PeopleBooks documentation type level includes the following utility folders that store files that are used at this level or shared by subsequent levels of the PeopleSoft Online Library:

• img

  This folder contains graphics files.

• styles

  This folder contains CSS files and information about how PeopleBooks appear on the homepage. The homepage displays PeopleBook titles in a hierarchical list based on book suites or categories. This hierarchy is controlled by two files:

  • TopTOCStyle.xml

    This file specifies the hierarchy and categories in which PeopleBook titles appear on the PeopleBooks homepage.

  • content.css

    This file contains the related stylesheet information.

• js

  This folder contains JavaScript files. Information about the book level of the PeopleSoft Online Library (which is the next level below the documentation type level) is stored in the following JavaScript files:

  • <docroot>/eng/psbooks/js/booklist.js

    This file specifies which books within a documentation type appear on the documentation type homepage.

  • <docroot>/eng/psbooks/js/helplist.js

    This file specifies which books within a documentation type are to be used for context-sensitive help.

Book Folder Level

Below the PeopleBooks documentation type level are folders for the individual books. For example, the <docroot>/eng/psbooks/fapy folder contains the PeopleSoft Payables PeopleBook. Because PeopleBooks are the only delivered documentation type, the information in this section applies to PeopleBooks and the psbooks folder.

The following example illustrates the book files and subfolders that are discussed in this section:

The files at the book level in the PeopleBooks documentation type comprise both the content and the online interface of an individual PeopleBook. Book.htm and chapter.htm are framesets that display the content of the book, which appear in the Document pane of the PeopleSoft Online Library. Idxdata.htm and tocdata.htm contain the index and table of contents of the book, which appear in the Reference pane of the PeopleSoft Online Library. The JavaScript file (xxxxfiles.js) contains an array that lists the order of the individual HTML files that make up the content of the book. This array is used by the navigation features of the PeopleBook Library interface.

Content Folders

Three of the subdirectories below the book level store content-related files:

• htm

  This folder contains the individual HTML files that make up the content of the book.

• img

  This folder contains graphics that are referenced by the HTML files.

• (optional) pdf

  This folder contains Adobe Acrobat files containing other book content, such as report sample files.

Utility Folders

The book level contains only one utility folder: contextids. This folder contains JavaScript files for online help support.

Managing the PeopleSoft Online Library

This section discusses how to:

• Install new PeopleSoft documentation.

• Manage language support.

• Manage individual PeopleBooks and integrated documentation.

Installing New PeopleSoft Documentation

Before installing new or additional PeopleSoft documentation, decide if you want to combine your existing documentation with the new documentation. If so, your installation guide contains instructions for merging existing documentation with new documentation. You may also need to reconfigure Secure Enterprise Search to perform full-text searching on the new documentation.

See PeopleTools 8.52 Installation for <your database platform>, Appendix: Installing PeopleBooks.

Managing Language Support

You control PeopleSoft Online Library language support by editing the <docroot>/js/langs.js file, which defines an array of language codes and their corresponding language names. This array is used by the PeopleSoft Online Library homepage (<docroot>/eng/index.htm) and the PeopleBooks Library homepage (<docroot>/eng/psbooks/index.htm) to display a table of alternate language links that you click to open the corresponding homepage in a new language. The following example shows the location of the alternate language links on the right side of the Navigation pane:

The languages array is also used during a PeopleSoft application help request to match the help documentation language to the preferred language of the user.

To disable a language in the PeopleSoft Online Library:

1. Open <docroot>\js\langs.js for editing.

   The file text looks something like this:

   languages = new Array(
    "cfr||fc||Français du Canada",
    "eng||en||English",
    "esp||es||Español",
    "fra||fr||Français"
    "dut||nd||Nederlands",
    
   );
   

   Each of the array elements contains three values, separated by double pipes (“||”):

   • The language code (also the language folder name).

   • The browser language code.

   • The language name as it should appear in the PeopleSoft Online Library.

2. To disable support for an installed language on your site, precede the appropriate line with a double slash (//) to comment it out.

   Here's an example, with the new double slash in bold:

   languages = new Array(
    "cfr||fc||Français du Canada",
    "eng||en||English",
    "esp||es||Español",
    "fra||fr||Français",
    ​//"dut||nd||Nederlands",
    
   );
   

3. Remove the trailing comma from the last uncommented line in the array definition.

   Here's an example, with the deleted comma crossed out:

   languages = new Array(
    "cfr||fc||Français du Canada",
    "eng||en||English",
    "esp||es||Español",
    "fra||fr||Français",
    ​//"dut||nd||Nederlands",
    
   );
   

4. Save the file.

Note. The order of the array elements determines the order of the language links on the homepages, with the exception of Francais du Canada. For formatting purposes, this link always appears either in the third table column or last in the list.

Managing Individual PeopleBooks and Integrated Documentation

This section provides overviews of documentation management and context-sensitive online help and discusses how to:

• Manage browsing.

• Manage context-sensitive online help.

• Manage full-text searching.

Understanding Documentation Management

For each PeopleBook within a particular language directory in the PeopleSoft Online Library, you can disable browsing and context-sensitive online help and full-text searching. You can also enable these features for customized documentation that you integrate into the library. The customized documentation may be preexisting internal documentation or new content that you’ve written to supplement PeopleBooks.

To integrate documentation into the library, you add books to the PeopleBooks folder structure. Avoid modifying existing PeopleBooks files or using a copy of an existing PeopleBook to make your changes. Although tempting at first, this approach can lead to substantial overhead for you, because every change you make to the delivered content may render the table of contents or keyword index obsolete. Updating a PeopleBook table of contents and keyword index is a time-consuming, manual task. Also, consider that:

• PeopleSoft documentation that is delivered with a service pack overwrites the existing documentation.

  Note. If you add customized books to the existing PeopleBooks folder structure, they will not be overwritten with updated documentation as long as their book-level folder names are different from the delivered book-level folders.

• To keep pace with new browsers and web servers, Oracle might need to modify JavaScript code and content files to accommodate different document object models.

One situation where it might make sense to modify the delivered PeopleBooks files is if you make minor application modifications. In this case, instead of fully integrating your documentation into the PeopleSoft Online Library, you can update the appropriate PeopleBooks help topic to insert a link that jumps to your customized documentation. You can include the documentation within the PeopleSoft Online Library and only enable it for browsing (but not context-sensitive online help) or you can store the documentation in another location.

If your application modifications are major and the PeopleBooks documentation for an application page is now largely obsolete, you may want to disable the PeopleBook file as well as enabling your own.

Important! If you decide to disable a book, you should disable all features for that book (browsing, context-sensitive online help, and full-text searching) and delete or move the folder that contains the book files to ensure that people cannot accidentally access the files.

Understanding Context-Sensitive Online Help

This section discusses how the context-sensitive online help works, to aid you in troubleshooting if your context sensitivity doesn't work as expected.

When you request help from an application, the software generates a URL and passes it to your default web browser. This URL is generated by resolving two variables into a string value that is stored in the system. Here is an example of the syntax of the string, with variables wrapped in percent signs (%):

http://docroot/f1search.htm?ContextID=%CONTEXT_ID%&LangCD=%LANG_CD%

Your installation documentation contains instructions for setting the value of the system help string.

You can see that the string is a URL pointing to the f1search.htm page, which is in the <docroot> level of the library site. During the help call, the variables are resolved as follows:

• %CONTEXT_ID% is replaced with the name of the page from which help is called.

• %LANG_CD% is replaced with the user’s preferred language code, for example ENG (English) or FRA (French).

Using the preceding syntax example, if a German user calls help from the PeopleSoft Enterprise Components Options page, the resulting URL looks like this, with the resolved values (PSOPTIONS and GER) in bold:

http://docroot/f1search.htm?ContextID=PSOPTIONS&LangCD=GER

When the help URL is passed to a browser, the f1search.htm page opens, and the JavaScript logic inside uses the two passed arguments (Context ID and LangCD) to load the appropriate context ID lookup files. These files map valid application context IDs to locations in the documentation. The lookup file contents are searched and, when a match is found for the ContextID value, f1search.htm redirects the browser to the related location. If multiple matches are found, a pop-up window displays a list of help topic links from which the user can choose.

Because of the depth of the PeopleSoft Online Library folder structure, the process of loading the lookup files is complex. The following JavaScript sequence of events occurs when f1search.htm is opened:

1. Validate the LangCD value that is passed to f1search.htm against <docroot>/js/langs.js to see if the preferred language exists in the library.

   If not, substitute ENG (English).

2. Once the language (<langdir>) is determined, load <langdir>/js/helptypes.js to see which documentation types are enabled as context-sensitive help.

3. For each path (<typepath>) in helptypes.js, load <langdir>/<typepath>/js/helplist.js to determine which books within this documentation type are enabled for context sensitivity.

4. For each book (<bookpath>) in helplist.js, load <langdir>/<typepath>/<bookpath>/contextids/x.js, where x is the first character of the ContextID value that is passed.

The following example assumes that you have PeopleTools PeopleBooks installed and that your internal documentation is integrated as a separate documentation type:

1. A user with the language preference set to English clicks help on the USER_PREF page.

2. The following URL is passed to f1search.htm:

   http://docroot/f1search.htm?ContextID=USER_PREF&LangCD=ENG

3. The language code of the user’s preferred language is validated against <docroot>/js/langs.js to see if that language exists in the library.

   <docroot>/js/langs.js:
   
   		languages = new Array(
   			"cfr||fc||Fran&ccedil;ais&nbsp;du&nbsp;Canada",
   			"eng||en||English"
   		);

   See Managing Language Support.

4. Once the language (<langdir>) is determined, <langdir>/js/helptypes.js is loaded.

   eng/js/helptypes.js:
   
   		helptypes = new Array(
   			"psbooks||PeopleBooks",
   		);

5. For each path (<typepath>) in helptypes.js, <langdir>/<typepath>/js/helplist.js is loaded.

   eng/psbooks/js/helplist.js:
   
   		helpnames[helpnames.length]="psbooks/pt||PeopleTools 8.52:⇒
    Security Administration";
   

6. For each book (<bookpath>) in helplist.js, <langdir>/<typepath>/<bookpath>/contextids/x.js is loaded, where x is the first character of the ContextID value passed to f1search.htm.

   eng/psbooks/pt/contextids/j.js:
   		bookmarks[bookmarks.length] = "USER_PREF||psbooks/pt/htm/ptcom001.htm#F1ID_Job_⇒
   Data1";
   		bookmarks[bookmarks.length] = "USER_PREF||psbooks/pt/htm/ptcom001.htm#F1ID_Job_⇒
   Data2";
   ...
   
   eng/my_documentation_type/my_pt_book/contextids/j.js:
   		bookmarks[bookmarks.length] = "USER_PREF||my_documentation_type/my_pt_book/htm⇒
   /xxxxx.htm#MYF1ID_USER_PREF";
   

7. Once all lookup files are searched and a match is found for the context ID, the browser is redirected to the location that is specified in the lookup file.

   If multiple matches result, as in this example, a pop-up window displays the choices and the user can decide which help topic to select. The following example shows how the pop-up window appears for the preceding code example:

Managing Browsing

You control the ability to browse through a list of available PeopleBooks by editing the <docroot>/eng/psbooks/js/booklist.js file. This file specifies which PeopleBook titles appear on the PeopleBooks homepage. You can integrate customized books so that they appear on the PeopleBooks homepage, or you can disable books so that they no longer appear. .

The syntax of the booklist.js doesn't contain an explicit array declaration, only array element assignments. Here is some sample JavaScript code from booklist.js:

booknames[booknames.length]="psbooks/tpsq||PeopleTools 8.52:⇒
 PeopleSoft Query";
booknames[booknames.length]="psbooks/tsum||PeopleTools 8.52:⇒
 PeopleSoft Setup Manager";
 
function getTitle(strProdCode, strDocType) {
 strProdCode = strProdCode.toLowerCase(); ...

The lines preceding the function getTitle declaration are the array assignment lines that define the PeopleBook titles that users can browse in the library.

To integrate customized documents into the PeopleBooks folder structure and enable them for browsing:

1. Create a new book folder below the psbooks folder in the library site.

   For example: <docroot>/eng/psbooks/procedures

2. Add the folder name and display name of the new book to the <docroot>/eng/psbooks/js/booklist.js file.

   Here's an example, with the new Internal Procedures book in bold:

   booknames[booknames.length]="psbooks/tpsq||PeopleTools 8.52:⇒
    PeopleSoft Query";
   booknames[booknames.length]="psbooks/tsum||PeopleTools 8.52:⇒
    PeopleSoft Setup Manager";
   ​
   booknames[booknames.length]="psbooks/procedures||Internal Procedures";
   ​ 
   function getTitle(strProdCode, strDocType) {
    strProdCode = strProdCode.toLowerCase(); ...
   

   Include the new book before the function getTitle declaration in the file. Be sure to add a semicolon at the end of the line with the new book.

3. Copy the book files into the new folder.

   Important! If you want the files in the new folder to be available for context-sensitive online help the content files must reside exactly one folder level below each book folder that is defined in booklist.js. Using the preceding code example, the content files would have to reside in psbooks/procedures/htm.

4. Create a homepage called index.htm at the top folder level of the new book.

   This step ensures that the automated link to your documentation from the PeopleBooks homepage works. If you already have a homepage that you don’t want to rename, you can insert JavaScript into index.htm to automatically redirect users to your homepage.

5. Add the book, and a category, if necessary, to the <docroot>/eng/psbooks/styles/TopTOCStyle.xml file.

   This file specifies the hierarchy and categories in which book titles appear on the PeopleBooks homepage. If you only add a book title to the booklist.js file, it will appear at the bottom of the book hierarchy on the homepage, below all of the other books.

   The TopTOCStyle.xml file specifies the order and hierarchy of books, as well as the CSS classes or styles that provide the formatting for the books. The CSS classes are defined in the <docroot>/eng/psbooks/styles/content.css file.

   This table describes the elements and attributes that you use within the TopTOCStyle.xml file:

   Element Type	Attributes
   Heading	Contains the category title and nested book elements, as well as other nested heading elements, to create a hierarchy of categories. The following attributes are available: class: Specify the CSS class that is defined in content.css. style: You can specify the CSS styles here instead of using a class from content.css.
   Book	The following attributes are allowed: bookcode (required): Specify the folder name of the new book. prefix: Enter characters to add in front of the book title (for example, to add bullets or other symbols). class: Specify the CSS class that is defined in content.css. style: You can specify the CSS styles here instead of using a class from content.css. sortas: Use this value to change the sort order of book titles. For example, to force a book to the top of the sort order, set the sortas attribute to 0 for that book and set it to 1 for all other books. This value is also used in Japanese translations of PeopleBooks to specify the sort order of book titles.

   Here's an example, with the new Internal Documents category and procedures book in bold:

   <top_toc>
   		<heading expandable="no" class="SUBTOPIC">
       	<book bookcode="atpb"/>
       	<book bookcode="tupa"/>
     	</heading>  
   		<heading  class="TOPICHEADING1">
      		PeopleTools PeopleBooks
   			<book bookcode="tgst"/>
   			<heading  class="TOPICHEADING2">
   				Development Tools
   				<book bookcode="tfeed"/>
       		<book bookcode="tgbl"/>
   				<book bookcode="tapd"/>
       		<book bookcode="tpcr"/>
   			</heading>
   			<heading  class="TOPICHEADING2">
   				Reporting and Analytic Tools
   				<book bookcode="tprs"/>
   				<book bookcode="ttrm"/>
       		<book bookcode="tace"/>
       		<book bookcode="tsqr"/>
       		<book bookcode="tsql"/>
       		<book bookcode="trws"/>
   			</heading>
   		​<heading  class="TOPICHEADING1">
       	Internal Documents
   			<book bookcode="procedures"/>
   		</heading>
   ​</top_toc>
   

In the preceding example, the new Internal Documents title will appear as an expandable section at the bottom of the list of PeopleBooks, and the Internal Procedures book will appear below the Internal Documents title. The following example illustrates how this appears in the browser:

To remove a title from the PeopleBooks homepage, comment it out of the <docroot>/eng/psbooks/js/booklist.js file by preceding that line with a double slash (//). Make sure that the remaining lines all end with a semicolon.

Here's an example, with the double slash in bold:

booknames[booknames.length]="psbooks/tpsq||PeopleTools 8.52:⇒
 PeopleSoft Query";
booknames[booknames.length]="psbooks/tsum||PeopleTools 8.52:⇒
 PeopleSoft Setup Manager";

​//booknames[booknames.length]="psbooks/procedures||Internal Procedures";
 
function getTitle(strProdCode, strDocType) {
 strProdCode = strProdCode.toLowerCase(); ...

Note. You do not need to remove the book from the TopTOCStyle.xml file. That file only specifies the hierarchy. It does not affect which books actually appear on the homepage.

Note. If you disable browsing for a book, you should also disable context-sensitive online help and full-text searching and delete or move the folder that contains the book files to ensure that people cannot accidentally access the files.

Managing Context-Sensitive Online Help

Documentation that you add to the PeopleSoft Online Library can be used as context-sensitive help for PeopleSoft applications. If you have documented the features and uses of an application that you have modified or built, you can ensure that your users see that documentation when they call help from the application. You can also disable context sensitivity for individual PeopleBooks if you are replacing the help with customized documentation that you are integrating into the library.

Preparing and enabling your documentation for context sensitivity requires more steps than adding a link to your documentation on the PeopleSoft Online Library homepage. You must adhere to certain folder structures and file naming conventions. You might also need to add anchors to your documentation.

You control which books are available as context-sensitive online help by editing the <docroot>/eng/psbooks/js/helplist.js file. The syntax of helplist.js is similar to that of booklist.js, which controls browsing. The books that are listed in helplist.js are searched for a matching help topic during an online help request. Here is some sample JavaScript code from helplist.js:

helpnames[helpnames.length]="psbooks/famp||PeopleSoft Enterprise Asset Management⇒
 9.1 PeopleBook";
helpnames[helpnames.length]="psbooks/fsbk||PeopleSoft Enterprise Banks Setup and⇒
 Processing 9.1 PeopleBook";
helpnames[helpnames.length]="psbooks/sbil||PeopleSoft Enterprise Billing 9.1⇒
 PeopleBook";

To enable context sensitivity for a integrated book:

1. Make sure that your content files reside exactly one folder level below each book folder (for example, psbooks/procedures/htm).

2. (Optional) Add anchors to the content files.

   In a help lookup file, you can map a context ID (application page or panel name) to a particular location in your documentation. That location can be a file name or a combination of a file name and anchor name. Whether you want to specify an anchor name depends on the length of your documentation files. If you document only one application page per HTML file, anchors are probably not necessary. If you document many application pages in an HTML file (as in PeopleBooks), however, you definitely need anchors. Anchors place users as close to their requested information as possible when they call help.

3. Add a new line with the folder name and display name of the new book to the <docroot>/eng/psbooks/js/helplist.js file.

   Here's an example, with the new Internal Procedures book in bold:

   helpnames[helpnames.length]="psbooks/famp||PeopleSoft Enterprise Asset Management⇒
    9.1 PeopleBook";
   helpnames[helpnames.length]="psbooks/fsbk||PeopleSoft Enterprise Banks Setup and⇒
    Processing 9.1 PeopleBook";
   helpnames[helpnames.length]="psbooks/sbil||PeopleSoft Enterprise Billing 9.1⇒
    PeopleBook";
   ​helpnames[helpnames.length]="psbooks/procedures||Internal Procedures";
   ​

4. Below every book folder that you specify in helplist.js, create a contextids subfolder (for example, psbooks/procedures/contextids).

5. Within each contextids folder, add 37 files: a.js, b.js., c.js, and so on up to z.js, pce.js (used for PeopleCode) and 0.js, 1.js, 2.js, and so on up to 9.js.

   These are the context ID lookup files. The best way to create these folders and files is to copy them from a PeopleBooks folder, then edit the files so that they contain only this line:

   arraycount[arraycount.length] = bookmarks.length - 1;

6. Populate the lookup files.

   A help lookup file contains lines of JavaScript code that assign strings to an array. Each string contains the context ID for a help topic and the relative path to the help topic, separated by two pipes (“||”). The name of the lookup file reflects the first character of all of the context IDs that are stored inside. Here is an example of the syntax of these files:

   bookmarks[bookmarks.length] = "<contextID1>||<path_to_file>#<anchor_name1>";
   bookmarks[bookmarks.length] = "<contextID2>||<path_to_file>#<anchor_name2>";
   ...
   bookmarks[bookmarks.length] = "<contextIDN>||<path_to_file>#<anchor_nameN>";
   
   ​arraycount[arraycount.length] = bookmarks.length - 1;
   ​

   A context ID corresponds to the name of the application page at which the user clicks help. This context ID is used by f1search.htm to redirect the user to the correct help topic. Therefore, to create a context-sensitive link for a new application page called MY_APPS, you would insert this line into an m.js file:

   bookmarks[bookmarks.length] = "MY_APPS||psbooks/procedures/htm/intro_to_
   hr.htm#my_anchor";

   Adhere to these conventions when populating lookup files:

   • The first letter of the context ID in the string must correspond to the name of the lookup file.

     For example, MY_APPS would reside in m.js; JOB_DATA1 would reside in j.js.

   • All files must end with the arraycount line (shown in bold in the example at the beginning of this section), even if they contain no context ID strings.

   • The context ID lines in the lookup file must be sorted alphabetically.

   • All lookup files for a specific book must reside in the corresponding contextids subfolder for that book.

7. Populate the chapter list file.

   Each PeopleBook folder contains an xxxxfiles.js file, which contains JavaScript array member assignments. Each line corresponds to a chapter file that makes up the PeopleBook. Each line also contains the title of that chapter. This file is used internally for the PeopleBook navigation controls.

   See Book Folder Level.

   The chapter list file is also used during the online help call if a context ID is found in more than one lookup file. In this case, the titles of the destination files are pulled from their corresponding chapter list files; they appear in the online help pop-up window as links.

   If any possibility exists that the context IDs in your custom documentation will also be found in PeopleBooks, or found in multiple locations in your own documentation, then you must create chapter list files for your documentation. Certain browsers will generate an error if a chapter list file cannot be found for any of the books found to contain a matching help topic.

   You can copy an xxxxfiles.js file from any PeopleBook folder and modify it to match your files and file titles.

To exclude a book from being searched during online help requests, comment it out by preceding that line with a double slash (//). Make sure that the remaining lines all end with a semicolon.

Here's an example, with the double slash in bold:

helpnames[helpnames.length]="psbooks/famp||PeopleSoft Enterprise Asset Management⇒
 9.1 PeopleBook";
helpnames[helpnames.length]="psbooks/fsbk||PeopleSoft Enterprise Banks Setup and⇒
 Processing 9.1 PeopleBook";
helpnames[helpnames.length]="psbooks/sbil||PeopleSoft Enterprise Billing 9.1⇒
 PeopleBook";
​//helpnames[helpnames.length]="psbooks/procedures||Internal Procedures";

Note. If you disable context-sensitive help for a book, you should also disable browsing and full-text searching and delete or move the folder that contains the book files to ensure that people cannot accidentally access the files.

Managing Full-Text Searching

If you are using Secure Enterprise Search for full-text searching, you can disable search for a PeopleBook. You can also set up Secure Enterprise Search to crawl custom documentation that you integrate into the library. You control which files are included in full-text searching by editing the <docroot>/index_xxx.html file (for example, index_pt852pbr0.html), which tells Secure Enterprise Search which files to crawl. This file is delivered with your PeopleBooks, but you can also generate a new version of the file using an automated tool during the installation process, so it may have a different file name than the one that is delivered. The file lists links to each chapter-level HTML file that should be crawled, as illustrated in the following example:

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>PeopleBooks</title>
  </head>
<body>
<a href="eng/psbooks/tpcr/htm/tpcr24.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr11.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr13.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr28.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr05.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr16.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr29.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr42.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr37.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr44.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr25.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr23.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr31.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr14.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr01.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr15.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr46.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr08.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr36.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr48.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr49.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr43.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr02.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr04.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr47.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr26.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr20.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr40.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr35.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr17.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr19.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr12.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr10.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr30.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr09.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr33.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr06.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr38.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr45.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr21.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr18.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr41.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr03.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr34.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr39.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr27.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr22.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr07.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr50.htm"/><br/>
<a href="eng/psbooks/tpcr/htm/tpcr32.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd25.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd29.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd18.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd09.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd11.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd15.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd24.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd30.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd32.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd14.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd23.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd31.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd33.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd20.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd21.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd19.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd02.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd06.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd26.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd22.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd16.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd01.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd10.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd35.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd12.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd17.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd03.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd28.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd05.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd13.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd07.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd08.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd04.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd34.htm"/><br/>
<a href="eng/psbooks/tapd/htm/tapd27.htm"/><br/>
. . .
</body>
</html>

Note. The links may not be listed alphabetically.

To change which documents are included in full-text searching:

1. Remove or add documentation to the library folder structure, as needed.

   To disable a PeopleBook, move or delete the folder that contains the book files. To add your own custom documentation, set up a new book folder to hold your files.

   See Book Folder Level.

   Note. If you move or delete a book folder, you also need to disable browsing and context-sensitive help for the book to avoid broken links to the removed files.

2. Edit the index_xxx.html file using a text editor such as Notepad.

   Important! Make a copy of the index_xxx.html file before editing it so you can restore the original file, if needed.

   To disable a PeopleBook, remove all links that point to chapters in the book folder that you removed. For example, to remove the book that is stored in the tapd book folder, remove the books that are crossed out in the following example:

   <html>
     <head>
       <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
       <title>PeopleBooks</title>
     </head>
   <body>
   <a href="eng/psbooks/tpcr/htm/tpcr24.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr11.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr13.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr28.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr05.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr16.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr29.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr42.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr37.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr44.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr25.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr23.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr31.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr14.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr01.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr15.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr46.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr08.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr36.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr48.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr49.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr43.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr02.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr04.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr47.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr26.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr20.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr40.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr35.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr17.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr19.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr12.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr10.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr30.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr09.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr33.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr06.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr38.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr45.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr21.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr18.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr41.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr03.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr34.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr39.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr27.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr22.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr07.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr50.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr32.htm"/><br/>
   ​<a href="eng/psbooks/tapd/htm/tapd25.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd29.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd18.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd09.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd11.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd15.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd24.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd30.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd32.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd14.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd23.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd31.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd33.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd20.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd21.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd19.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd02.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd06.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd26.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd22.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd16.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd01.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd10.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd35.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd12.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd17.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd03.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd28.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd05.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd13.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd07.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd08.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd04.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd34.htm"/><br/>
   <a href="eng/psbooks/tapd/htm/tapd27.htm"/><br/>
   ​. . .
   </body>
   </html>

   To add custom documentation, add new links for each HTML file that you want to include for full-text searching. For example, if you added HTML files to a <docroot>/eng/psbooks/procedures folder, you might add the links that appear in bold in the following example:

   <html>
     <head>
       <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
       <title>PeopleBooks</title>
     </head>
   <body>
   <a href="eng/psbooks/tpcr/htm/tpcr24.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr11.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr13.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr28.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr05.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr16.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr29.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr42.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr37.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr44.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr25.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr23.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr31.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr14.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr01.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr15.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr46.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr08.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr36.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr48.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr49.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr43.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr02.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr04.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr47.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr26.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr20.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr40.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr35.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr17.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr19.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr12.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr10.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr30.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr09.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr33.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr06.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr38.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr45.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr21.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr18.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr41.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr03.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr34.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr39.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr27.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr22.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr07.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr50.htm"/><br/>
   <a href="eng/psbooks/tpcr/htm/tpcr32.htm"/><br/>
   ​<a href="eng/psbooks/procedures/htm/proc01.htm"/><br/>
   <a href="eng/psbooks/procedures/htm/proc02.htm"/><br/>
   <a href="eng/psbooks/procedures/htm/proc03.htm"/><br/>
   . . .
   </body>
   </html>

   Note. If you are making a lot of changes, or if you are adding custom documents that are not in HTML format (such as PDF), you should regenerate the index_xxx.html file automatically using the HTMLListGenerator.jar tool, which is described in your installation documentation.

   See PeopleTools 8.52 Installation for <your database platform>, Appendix: Installing PeopleBooks, Crawling a Source to Generate Full-Text Search.

3. Regenerate the full-text search index in Secure Enterprise Search:

   1. Log into the Secure Enterprise Search portal.

   2. Click the Schedules link at the top of the page.

   3. Scroll down to the source in which you are removing or adding documentation.

      You set up the source name when you configured Secure Enterprise Search to work with PeopleBooks.

   4. Click the Edit icon to the right of the source name.

   5. Under Update Crawler Recrawl Policy, select the Process All Documents option.

   6. Click Update Recrawl Policy.

   7. Click Finish.

   8. Click the Select option to the left of the source that you are updating and click Start.

   9. (Optional) Click the link in the Schedule column for the selected source to monitor the progress.