Show TOC

Function documentationProject Documentation Tab Page Locate this document in the navigation structure

 

You can assign only documents on this tab page.

Features

The required entry fields for documents are defined as follows:

  • If the document ID (from Knowledge Warehouse (KW)) is filled, no other fields require an entry. In this case, the remaining fields are ignored.

  • If the document ID is not filled, the file path or URL, name (title), and documentation type must be entered.

In addition to the required entry fields, you can specify document attributes. This means that the following fields are ready for input:

  • Document ID

    The document ID is a 32-character GUID and identifies the document in KW (logical info object, or loio for short). Only documents in standard project folders are accepted (the Folder field in the attributes dialog must contain the project name). It does not matter if the assignment still exists. See also the notes below on the document ID. The documentation type of the document must be valid (see the section below on the documentation type).

  • File Path

    The file path identifies a file in a directory, for example, on the local hard disk or on a server drive. Before it uploads the file, the system checks whether it exists.

  • URL

    The Uniform Resource Locator (URL) is the address of an object in the Internet. It consists of the transmission protocol, name and address of the server on which the object is located, directory path and file name. The system does not check the validity of a URL before uploading it.

  • Name

    The name of the document must be entered so that the assignments on the tab page can be found. The name and title are used synonymously in the document attributes.

  • Documentation Type

    The documentation type must be assigned to the project when the file is uploaded. The system expects the key rather than the name. The Project Administration tab page shows an overview of the assigned documentation types on the Project Standards tab page. The system also checks whether documentation types that can only be assigned once to each structure element are actually assigned only once.

  • Person Responsible

    The person responsible for the document must be a valid system user. If this field is empty, the system enters the user who carries out the upload.

  • Blueprint-Relevant

    The Blueprint-Relevant field indicates whether the document is to be included in the generation of the Business Blueprint document. This is indicated by the letter X.

  • Technical Name

    The technical name is optional and follows the standard naming conventions.

  • Priority

    The priority indicates the importance of the document and can remain blank. The priorities defined in the system can be selected as values. As with the documentation types, the system expects the key rather than the name. To see the valid keys in SAP GUI, under Adjust Local Layout, choose   Options   Expert   Display Keys in All Dropdown Lists  . The next time you open the attributes dialog for a document assigned to the project and choose the input help for the Priority field, you can see all the possible key values.

    You cannot set this attribute in the template for URLs, because attribute entries are ignored.

  • Keywords

    Keywords must exist in the system and are also expected as a key. You can specify multiple keywords for each input field by separating them with a comma. The Project Administration transaction (SOLAR_PROJECT_ADMIN) provides an overview of the existing keywords on the Project Standards tab page.

    You cannot set this attribute in the template for URLs, because attribute entries are ignored.

The following document attributes are set internally:

  • Status

    The status of a document must be initial because the document is being added to the project. If a status schema is assigned to the documentation type, the initial status in this schema is selected. Otherwise:

    • If the document is uploaded via the file path, the system sets the status IN_PROGRESS.

    • If the document is uploaded via the URL, the system sets the status RELEASED.

    This status always exists in the system (unless it has been deleted explicitly). In this case, an initial status cannot be found and the field remains blank.

  • Language

    The project language is used as the language for the document.

  • Folder

    The standard project folder is used as the folder.

Further Notes
  • You can use the document search function to find the document ID. To do so, choose the Find Document menu entry under Business Blueprint or Configuration. You can display the document ID on the result screen by choosing the Change pushbutton and adding the ID column to the columns displayed.

  • If a template file contains documents with an identical file path or URL, the document is uploaded to Knowledge Warehouse only once but assigned to each structure element specified. The information in the first relevant line is used as attributes. Entries in other lines are ignored.

  • Identical entries for structure elements are not allowed. If you attempt to assign the same document ID or file path or URL to a structure element more than once, a checking error will occur.

  • The KW context (enhancement release) is copied from the project.

  • If the documents are uploaded more than once using the same template file and document paths, several documents with the same name and attribute properties will be created in Knowledge Warehouse. Even though you can overwrite the assignments on the tab page as often as you need to, the documents themselves remain in KW and can be deleted explicitly if necessary (for example, to save space or for reasons of clarity). To do so, use the deletion program SOLMAN_UNUSED_DOCUMENTS and set the number of hits to a reasonable value to prevent timeouts when deleting a large number of documents.