Working with the Custom.xml File

PPM users often create unique, site-specific documents relating to the product and its use within the enterprise.

You can host these site-specific documents on the PPM Server and make these documents These products typically include documentation is available from the PPM Download Center only (and not installed on the PPM Server). available to all PPM users, while having them isolated on a separate Web page. See Figure 4-5. Custom documentation page. Alternatively, these documents can be included on the PPM Documentation Library home page.

Your choice of topics depends on the needs of your PPM users and what documents have been developed for your site. Some examples are:

  • Lists of PPM contacts

  • Processes and procedures for using PPM

  • Microsoft PowerPoint presentations

  • Conversion guides

  • Guidelines for PPM application configuration, development, and use

Figure 4-5. Custom documentation page

To include or modify site-specific documentation so that it is accessible from the Custom Documentation link in the Supplemental Information section of the PPM Documentation Library home page:

  1. Copy the <PPM_Home>/pdf/Custom/Custom.xml file to a "working" location, where the <PPM_Home> placeholder represents the path where your PPM instance was installed. For example: xyzserver/E$/PPMServer.

    Remember that you should have a backup copy of this file stored in a safe location.

  2. Edit the temporary version of the XML file and ensure that it conforms to the DTD, as described in Working with the Custom.xml File.

    Remember that this file must include at least one group in each left and right section.

    You must include the <document> element for each document you want displayed and it must be included in a group or subgroup.

    In rare cases, an existing group or subgroup may not include any documents, so then you can remove the <group> or <subhead> elements.

    Alternatively, when there are several documents within a group, you may want to divide the group into subgroups. Conversely, when a collection of subgroups contains very few documents, you may want to remove the subgrouping.

    For example, assume that your site has the following documents that you want to have accessible from the PPM Documentation Library:

    Title

    Filename

    Who to talk to about PPM Center

    who.pdf

    Guidelines for managing resource pools

    respool.doc

    Converting your version 7.5 work plans to 8.0

    workplans.htm

    Using HP Project Management

    Project.ppt

    Configuring Portlets

    Portlets.vid

    Analyzing Performance

    perf.ppm

    One possible presentation of this information would be as follows:

    <?xml version="1.0" ?>
    <!DOCTYPE custom SYSTEM "../Custom.dtd">
    <custom>
      <leftsection>
        <group>
          <head>
    <htitle>General Information</htitle></head>
          <document>
    <dtitle>Who to talk to about PPM Center</dtitle>
    <dfn>who.pdf</dfn>
    <dtype>pdf</dtype>
    </document>
          <document>
    <dtitle>Guidelines for managing resource pools</dtitle>
    <dfn>respool.doc</dfn>
    <dtype>doc</dtype>
    </document>
          <document>
    <dtitle>Converting your version 7.5 work plans to 8.0</dtitle>
    <dfn>workplans.htm</dfn>
    <dtype>htm</dtype>
    </document>
        </group>
      </leftsection>
      <rightsection>
        <group>
          <head>
    <htitle>Training</htitle></head>
          <subhead>
    <stitle>Bob Wilkens, instructor</stitle></subhead>
          <document>
    <dtitle>Using HP Project Management</dtitle>
    <dfn>Project.ppt</dfn>
    <dtype>ppt</dtype>
    </document>
          <document>
    <dtitle>Configuring Portlets</dtitle>
    <dfn>Portlets.vid</dfn>
    <dtype>vid</dtype>
    </document>
          <subhead>
    <stitle>HP Support (during April on-site visit)</stitle>
    </subhead>
          <document>
    <dtitle>Analyzing Performance</dtitle>
    <dfn>perf.ppm</dfn>
    <dtype>unknown</dtype>
    </document>
       </group>
      </rightsection>
      <title>XYZ Company</title>
    </custom>
  3. Save and close the file.

  4. Copy the updated XML file to its original location on the PPM Server, overwriting the existing file.

    You should also place a copy of this updated file in a safe location where it does not overwrite the original (or any previously updated) file.

  5. Ensure that each of the files you specified exists in the appropriate directory on the PPM Server.

  6. Verify your changes by opening the PPM Documentation Library page and clicking Custom Documentation in the Supplemental Information group to view your changes.

    Caution: Test the updated page using both Internet Explorer and Mozilla Firefox.

    The resulting custom documentation page would be similar to Figure 4-5. Custom documentation page.

Tip: If you ever want to discontinue listing site-specific product documents, create an empty Custom.xml file, as described in Working with the Custom.xml File.

Use of this file will remove the Custom Documentation link in the Supplemental Information group.

If the Cameo.xml file does not include any documents and Custom.xml file does not include any documents, the Supplemental Information group is not displayed.