Understanding the Library's Framework

Documentation that best suits the needs of your PPM users tends to fall into the following categories:

  • PPM "core" products (such as, Demand Management or system administration)

  • PPM supplemental products (such as, the Extensions or Migrators)

  • Customer provided (such as, in-house training or corporate process guides relating to PPM)

The PPM Documentation Library is segregated into three different Web pages to enable distribution of documents that correspond to these categories of documents. These are referred to as:

  • Library documents. These appear on the home page of the PPM Documentation Library and are accessed from the Product Information > Library menu (see Figure 4-1. Library documents for the default "home" page).

    The home page should always be customized to include pertinent documents.

  • Supplemental product documents. If documents are provided for this page, the home page will include the Additional Project and Portfolio Management Center Products link in the Supplemental Information section (see Figure 4-2. Supplemental product documents for a customized example).

    This optional "cameo" page is intended to provide access to documents related to the PPM supplemental products, such as Connectors, Accelerators, Migrators, Extensions, and other PPM-provided products.

    Depending on the amount of information presented on your PPM Documentation Library home page and the number of documents that you include on this page, you may want to include the supplemental product documents on the home page.

  • Custom documents. If documents are provided for this page, the home page will include the Custom Documentation link in the Supplemental Information section (see Figure 4-3. Custom, site-specific documents for a customized example).

    This optional custom page is intended to provide access to customer, or site-specific, documents.

    Depending on the amount of information presented on your PPM Documentation Library home page and the number of documents that you include on this page, you may want to include the site-specific documents on the home page.

Note: If no documents are provided for both the supplemental product documents and the custom documents, the Supplemental Information section will not be displayed on the "home" page.

Figure 4-1. Library documents

Figure 4-2. Supplemental product documents

Figure 4-3. Custom, site-specific documents

XML and their corresponding DTD files control the information displayed on these PPM Documentation Library pages. This data includes the names and information for each of the documents as well as the general organization and group details. This data is then rendered using JavaScript files deployed on the PPM Server. Each category (Web page) has its own separate XML file as follows:

  • Library.xml

  • Cameo.xml

  • Custom.xml

The structure of each of the XML files are similar; but, not necessarily identical. Before making changes to any XML file, it is important to understand the structure of the data and the resulting presentation of the information.

In addition to identifying the documents and customizing the XML files, the documents themselves must also be downloaded from the Micro Focus Software Product Manuals Web site (https://softwaresupport.hp.com/group/softwaresupport) and copied to the appropriate directories on the PPM Server.