Step 4: Automatically create documentation for your client

In PPM Customizing Toolkit, you can automatically create a documentation including the configurations of your PPM client. The Create client documentation program extracts the most important XML configuration files for PPM and creates HTML files that you can view in a browser.

The application is available in the Programs component of the Client module. The files of your documentation are saved under <installation directory>\ppmmashzone\server\bin\work\data_ppm\custom\<client>\docu.

You can document the configuration of the following elements of your client:

Procedure

  1. Select the Run program tab in the Programs component of the Client module.
  2. Select the Create client documentation program and click button_start_program Run program in the toolbar.

The program creates the <client>.html documentation, e.g., My_Project.html in your client's docu directory.

You can open the html file and view it in a browser.

Apart from the documentation described above, you can also generate technical documentation for your client's configuration. The Create technical client configuration program generates documentation with technically relevant content, e.g., a list of all the attributes and calculated attributes, process instance-independent measure series, relations, non-registered measures and dimensions. The documentation is stored as HTML pages in your client's docu directory under <client>_tech.html.