Disabling Delivered Products or Subjects

If your organization does not need help for a particular subject, you can remove the corresponding help from the PeopleSoft Online Help.

To disable subjects:

  1. Delete, rename, or move both the subject folder and the subject TOC file from the product family folder.

    For example, to remove the subject “Getting Started with PeopleTools,” delete the tgst folder and the tgst.html file from the docroot/eng/pt folder.

    This ensures that the files will not accidentally become visible to users.

    See Subject Folder Level for information about how to locate this folder.

    Note: To disable an entire category, remove the subject folders and subject TOC files for all of the subjects within the category.

  2. Remove the subject link from the product family navigation page.

    To do this, modify the docroot/language/product family/index.html file that is located in the same product family folder as the subject that you are disabling.

    Example: help-PB/eng/pt/index.html

    This file includes the entire list of products and subjects tagged as an unordered list (ul). Each category is a list item (li) within the ul. The subject links are in a second ul nested in the li for the category. To remove a single subject, comment out the entire li element that is the parent of the subject link, including the beginning and end tags (<li>...</li>). In the following example, the “Getting Started with PeopleTools” subject is commented out (highlighted in bold).

    <div class="treeDivTop2nd" id="dv_li_prodTree1">Products</div>
    <ul id="sbjul_id" class="ListBullet psc_hidden" role="group" aria-hidden="true">
    <li class="treeParent" role="treeitem" aria-expanded="false" tabindex="-1" id="tpchd_d3e24" aria-label="General Information">
    <span class="sbparent2">General Information</span><ul class="ListBullet  psc_hidden" role="group"><li class="treeParent" aria-expanded="false" tabindex="-1" role="treeitem" id="lisbj_d3e29" aria-labelledby="spnsbj_d3e29">
    <span class="sbparent2" id="spnsbj_d3e29"><a tabindex="-1" target="_top" id="a_d3e29" href="tacs.html">Accessibility Guide</a></span>
    </li><li class="treeParent" aria-expanded="false" tabindex="-1" role="treeitem" id="lisbj_d3e30" aria-labelledby="spnsbj_d3e30">
    <span class="sbparent2" id="spnsbj_d3e30"><a tabindex="-1" target="_top" id="a_d3e30" href="tupa.html">Applications User’s Guide</a></span>
    </li><!--<li class="treeParent" aria-expanded="false" tabindex="-1" role="treeitem" id="lisbj_d3e31" aria-labelledby="spnsbj_d3e31">
    <span class="sbparent2" id="spnsbj_d3e31"><a tabindex="-1" target="_top" id="a_d3e31" href="tgst.html">Getting Started with PeopleTools</a></span>
    </li>--></ul></li><li class="treeParent" role="treeitem" aria-expanded="false" tabindex="-1" id="tpchd_d3e32" aria-label="Development Tools">

    To remove subject links for an entire category, comment out the li element for the entire category, including the beginning and end tags. In the following example, the “General Information” subject is commented out (highlighted in bold). Notice that the commented out code includes the ul that contains all of the subjects in the category.

    <div class="treeDivTop2nd" id="dv_li_prodTree1">Products</div>
    <ul id="sbjul_id" class="ListBullet psc_hidden" role="group" aria-hidden="true">
    <!--<li class="treeParent" role="treeitem" aria-expanded="false" tabindex="-1" id="tpchd_d3e24" aria-label="General Information">
    <span class="sbparent2">General Information</span><ul class="ListBullet  psc_hidden" role="group"><li class="treeParent" aria-expanded="false" tabindex="-1" role="treeitem" id="lisbj_d3e29" aria-labelledby="spnsbj_d3e29">
    <span class="sbparent2" id="spnsbj_d3e29"><a tabindex="-1" target="_top" id="a_d3e29" href="tacs.html">Accessibility Guide</a></span>
    </li><li class="treeParent" aria-expanded="false" tabindex="-1" role="treeitem" id="lisbj_d3e30" aria-labelledby="spnsbj_d3e30">
    <span class="sbparent2" id="spnsbj_d3e30"><a tabindex="-1" target="_top" id="a_d3e30" href="tupa.html">Applications User’s Guide</a></span>
    </li><li class="treeParent" aria-expanded="false" tabindex="-1" role="treeitem" id="lisbj_d3e31" aria-labelledby="spnsbj_d3e31">
    <span class="sbparent2" id="spnsbj_d3e31"><a tabindex="-1" target="_top" id="a_d3e31" href="tgst.html">Getting Started with PeopleTools</a></span>
    </li></ul></li>--><li class="treeParent" role="treeitem" aria-expanded="false" tabindex="-1" id="tpchd_d3e32" aria-label="Development Tools">
  3. Disable context-sensitive help for the disabled subject folder.

    To do this, modify the docroot/language/product family/helpid.txt file that is located in the same product family folder as the subject folder that you are disabling.

    Example: help-PB/eng/pt/helpid.txt

    Note: Make a backup copy of the helpid.txt file before making any changes, so that you can roll back to the previous version, if necessary.

    Delete all destinations that contain the subject folder name. If a context ID has multiple destinations, remove the path and all associated titles and separators. If doing so leaves only one destination for a context ID, remove the titles for the remaining destination, as well.

    Note: To disable an entire category, repeat this step to delete all destinations for all subject folders within the category.

    The following example shows how to remove destinations for the tupa subject folder. The removed destinations have been crossed out to show that they should be deleted.

    ICCopyCust	tupa/task_PersonalizingPages-0714c7
    USER_CHANGE_PSWD	tupa/task_ChangingYourPassword-0714cf
    CHANGE_PASSWORD	tupa/task_ChangingYourPassword-0714cf	PeopleSoft Applications User’s Guide	Changing Your Password	Changing Your Password	;tsec/task_WorkingWithPasswords-c076d8		Security Administration	Working With Passwords	Changing Passwords
    

    The resulting file looks like this:

    CHANGE_PASSWORD	tsec/task_WorkingWithPasswords-c076d8		
  4. Re-create the context-sensitive help index.

    See Including Multiple Online Help Sites for PeopleSoft 9.2 and PeopleTools 8.53 and Later.

  5. Recrawl the help files to generate a new search index that excludes the removed subject folder.

    If you are using Elasticsearch, see PeopleSoft 9.2 Application Installation for your database platform, ”Installing PeopleSoft Online Help.” If you use a different search engine, see the documentation for your chosen search engine.

    Note: Some search engines have an option to automatically recrawl a site. If you have enabled that option, you do not need to recrawl the site manually.