How to use this manual

We believe that this manual is easy to use and that it will be easy for you to quickly find the information you are looking for.

However, as this is a complex web application that isn't necessarily intuitive for everyone from the beginning, we would like to give you some tips on how to use this manual.

1. Accessing the User Manual

The user manual is available in an online version and in a local version. While the online version always describes the current release of the Workflow, the local version covers the release version you have installed. A PDF version of the user manual is available for download separately for each release.

1.1. Online Version

Open the online version of the user manual via in your web browser. The online version always describes the current version of the Workflow.

1.2. Local Version

Open the local version of the user manual - suitable for the Workflow version you have installed and in the language selected by the user - directly via the help function of the Workflow in the action bar.

User manual local version

A local version of the user manual is only available as of version 1.8. Corresponding PDF versions are therefore only available starting from version 1.8 in the download area of the online manual.

2. User Manual structure

2.1. Language version

The manual is currently available in the following languages:

2.2. User Manual structure

The manual is structured as follows:

Language version –> Chapter –> Section –> Article

2.2.1. Chapters

The landing page of the manual shows all available chapters:

Figure 1: Landing page of the available chapters in the User Manual

User Manual Chapters

A condensed list of all chapter content can be found here: Chapter overview

2.2.2. Sections

When you open a Chapter, you are taken to another overview page. While the list of sections of the chapter is displayed in the Available Articles [1] area on the left, the hierarchical structure of the entire chapter is displayed on the right [2].

Figure 2: List of sections and hierarchical structure of the selected chapter


For ease of use, you will find Breadcrumb navigation [3] above the displayed content, similar to the Workflow.

Below the section available Articles you can download the complete content of the chapter »Quickstart« as a PDF [4].

2.2.3. Articles

By clicking on a heading in the section Topics [6], the Articles available in the section [7] are displayed. Select the article you are interested in by clicking on the listing. For example, clicking on Contact & Feedback we can see the Article content on the right side of the page [5].

Figure 3: This is how an Article page looks after choosing a Topic

Article page after chossing a topic

The Breadcrumb navigation [8] and Create Article PDF button [9] are always visible. Additionally you can use the links "< Prev: xxxxxx" at the end of an article. [10] and "Next: xxxxxx >" [11] can be toggled back or forth linearly in the Chapter (also across chapters).

3. Search by Keyword or Topic

Of course, you can read the entire manual from beginning to end, but you can also navigate through the chapter and section overviews. Use the integrated search function if you want to find results quickly.

Simply enter a term [12] that you know or assume will be dealt with in the Workflow and you will receive a list of hits. Perhaps you will come across correlations that you may not have seen before...

Figure 4: Overview page after entering a search term

Search by Keyword or Topic

The Search Results list [13] shows all Articles, their topicality, their location in the manual hierarchy and a short text excerpt with the highlighted Keyword [14]. Below the search field you will find the number of hits found and a function to reset the search [15].

The Filter Search Results view [16] does not show an overview of the manuals in the search, but serves to restrict (filter) the search to specific manuals.

If the search returns too many hits or if you know in exactly which chapter the information should be contained, then simply select the relevant chapter(s) using the checkboxes [17, 18]. The number of results and the Search Results list are immediately reduced to results only from these areas [19].

Figure 5: Filtered overview page showing only results from the selected Chapter.


Search by Keyword or Topic

Search inside an Article

Of course you can always use the browser's internal search function using (CTRL)/(CMD)+F to search for a term in the page currently being displayed. This will make it easier for you to find the information you are looking for, especially with very large articles...