In this section, you learn more about how to work with the Solution Documentation. Objective of this section is to understand the overview functions of the Solution Documentation, the display of the different views and the interaction between them.
The header is displayed at the top of Solution Documentation. The header description displayed on the left-hand side contains the solution and the branch name.
The Global functions
menu contains the following entries: Solution
, Scopes
, Reports
, Process Document
, Diagram Entities
, Settings
, File Download
.
See for further details the corresponding documents in this section.
If your branch is newly created or you are accessing an existing branch for the first time, only the first column of the hierarchy will be displayed. Otherwise the hierarchy for the last selected element will be displayed.
The link List
is highlighted. All other links are displayed standard. The splitter between list and attribute panel is displayed. You can resize or collapse the splitter to the right. The elements are displayed in a list. Only those elements are displayed which are found in the hierarchy under the last selected structure element. The last selected element is also displayed in the list and is explicitly selected. The attributes and the assignments for the selected element are displayed.
Enter a search term in the search field in the header. Choose Enter
or the search button Basic Search
.
The where-used list
link is displayed in the header on the left-hand side after Search Result
. If Solution Documentation is opened for the first time and where used is not executed, the link is displayed as disabled and No where-used list executed
is displayed as a tooltip. The where used is triggered from the context menu and is available for library elements (for example process step or transaction) or elements used in the library (for example documents or test configurations).
Select the link Reporting
in the header. If the link Reporting
is disabled execute a report.
Select dropdown menu with quick info Change Document
in the header (visible is the name of the currently selected change document). This dropdown menu is only available if the selected branch is change enabled. The Change Document
link is only available if the selected branch is change-enabled.
Select dropdown menu with quick info Branch
in the header (visible is the name of the currently selected branch). A list with all branches created for the selected solution is displayed.
Select dropdown menu with quick info Site
in the header (visible is the name of the currently selected site). This dropdown menu is only available if the selected branch is site enabled.
Select dropdown menu with quick info System Role
in the header (visible is the name of the currently selected system role). If your branch is newly created or you are accessing an existing branch for the first time, the default system role is displayed. The name of the selected system role is displayed in the header.
Select dropdown menu with quick info View
in the header (visible is the name of the currently selected view).
The dropdown menu History
contains a list of elements that have been selected recently (the latest selected elements come first). A structure element is added to the history if it is selected in the browser view only. Selecting an element in a Value Chain Diagram
does not add the element to the list; navigating inside the diagram does, however. A diagram element (process diagram, interface diagram, or collaboration diagram) is added when it is opened (in browser view). In case of multiple selected elements, only the first selected element is added. The history list is limited to 30 entries. The history can be cleared via Global functions
menu, item Settings
, option Delete navigation history
. When a diagram (value chain diagram, process diagram, interface diagram, or collaboration diagram) is opened up, the suffix [Diagram]
is added to the corresponding entry in the history list.
The dropdown list Favorites
can be used to navigate to elements that have been added as favorites.
The Back
button is located at the left hand side of the header. It allows to navigate one step back in the history list. When choosing Back
the latest entry in the history list is deleted (popped from the list). If the history list is empty, the button Back
is inactive.
The bread crumb is displayed in the lower area of the header and is available for the Browser
, List
, and Search Result
view. It contains all selected structure elements including the root element Solution
. In browser and list view, the bread crumb can be used for navigation and displays the navigation path to the last selected structure element. In search result view, the bread crumb displays the search path from the last selected structure element. In case of multiple selection of structure elements, only the first element from the selected elements will be considered for display.