Show TOC

Function documentationGenerating a Process Document

 

With this function, you can generate a process document. The process document is a Word document containing the complete content of a solution. Documents are included as links in the process document.

Prerequisites

For the generation of a process document you need scopes that are based on a view, for example the default view or own views. You can create own views from the view selector in the header line in Solution Documentation by choosing the New entry.

For example, you can create a view Business Processes which does not contain the library. Based on this view, you can create a scope with the menu item Scopes in the Global Functions menu. You can create a scope with and without Include Originals marked and with and without a structure filter. The indicator Include Originals adds all library elements that are referenced by the business processes structure, and that is typically what you want to have in a process document if you don not want to see all library elements. You can use structure filters to select all structure nodes, for example assigned to certain persons responsible, sites, or countries.

Activities

For the generation of a process document, proceed as follows:

  1. Select Process Document entry in the Global Functions menu.

  2. Select a scope.

  3. Select assignment group filters.

  4. Select document settings.

    • The option Process documentation relevant document types delivers all documents that have a documentation type which is marked as process documentation relevant in document type maintenance in solution administration.

    • The option Process documentation relevant documents delivers all documents that are marked as process documentation relevant in the document attributes.

  5. Select Generate.

The system generates a Word document with the following features:

  • The first page contains solution and branch name, name of the creator, creation time, and the name of the scope

  • It follows a table of contents with links to the chapters.

  • The first chapter lists the system landscape.

  • The second chapter lists the business process structure with assignments.

  • All visible non-initial attributes of each element are listed, hidden attributes are not listed.

  • If available, diagrams are included in the document as PNG file.

  • If available, other documents are included in the document as URLs. When you click the URL, the document opens. If the document has been changed after the generation of the process document, you can not see these changes as the link always reflects the frozen state during process document generation.

  • The third chapter shows the libraries. If the libraries are not part of the selected view in the scope definition but the scope has Include Originals flagged you see only those library elements that are referenced from the business process structure and the assignments.

If errors occurred during the generation, all errors are listed in an additional message section.