The help system offers you various options for orientation and navigation. This page gives you an overview of the structure and functions of the help system. You will learn how to easily find the information you are looking for.
The following buttons are available in the help viewer.
Buttons |
Action |
|
Displays the Contents tab and the first topic. |
|
Selects the previous topic in the table of contents. |
|
Selects the next topic in the table of contents. If the next topic is a subordinated topic of the selected topic, the superordinate topic is expanded. |
|
Opens an e-mail with the reference to the selected help page in the subject and the link to the selected help page in the body. |
|
Opens the Print dialog to print the selected help page. |
|
Records the search text. |
|
Searches for the text entered in the search field. |
(Disabled) |
Searches for any word in the entered text that matches exactly. For example, if you search for modeling convent, the topics are found with modeling, but no topics with conventions. |
(Enabled) |
Searches for any word in the entered text that matches partially. For example, if you search for modeling convent, the topics are found both with modeling and with conventions. |
|
Collapses the table of contents. |
|
Expands the table of contents. |
The Contents tab contains the structure of the help topics as a tree.
The Contents tab provides access to general information, such as the purpose of the product described, basic information on operating the program and the online help system, or the structure of the program interface. You can expand and collapse the tree of the Contents tab using the Expand all and
Collapse buttons of the help viewer.
Representation of the user interface
To a certain extend, the tree of the Contents tab represents the user interface of the standard Classic view of ARIS Connect. Depending on the license you are using, you will find the topics Work in the portal, Use the Catalog, Collaborate with users, Search content, and Use the repository in this order, which corresponds to the arrangement of the program components.
This makes it easy to assign the contents of the help to the program interface.
Procedures and concept descriptions
The tree provides also specific information such as procedures and concept descriptions.
Thematically grouped
Procedure descriptions show you how you can use the functionality of the program. They are provided with actively formulated headings such as Create model. Related topics are grouped thematically.
Use case oriented
If possible, the procedure pages are arranged in such a way that they result in a use case. The following simple example shows the use case for groups: create group, manage group contents and, if no longer required, delete group.
Distinction between procedures and concepts
You will find concept descriptions under Valuable information. Headings of concept descriptions are formulated as questions or marked by "How to" formulations, which makes it easy to distinguish between concept descriptions and procedure descriptions.
The Index tab provides keyword links to the respective help pages in alphabetical order.
The alphabet is arranged above the keywords. For colored letters there are keywords. By clicking on these letters, you jump to the keywords that begin with this letter.
Click on a keyword to display the corresponding help page.
You can insert a search term in the search input field and execute the search.
The Search tab appears with the search result.
The search term is highlighted. You can extend the search by enabling the Match partial words check box to find every word of a term that partially matches.
The following buttons are available in the help viewer.
Buttons |
Action |
|
Displays the Contents tab and the first topic. |
|
Selects the previous topic in the table of contents. |
|
Selects the next topic in the table of contents. If the next topic is a subordinated topic of the selected topic, the superordinate topic is expanded. |
|
Opens an e-mail with the reference to the selected help page in the subject and the link to the selected help page in the body. |
|
Opens the Print dialog to print the selected help page. |
|
Records the search text. |
|
Searches for the text entered in the search field. |
(Disabled) |
Searches for any word in the entered text that matches exactly. For example, if you search for modeling convent, the topics are found with modeling, but no topics with conventions. |
(Enabled) |
Searches for any word in the entered text that matches partially. For example, if you search for modeling convent, the topics are found both with modeling and with conventions. |
|
Collapses the table of contents. |
|
Expands the table of contents. |
Click on a page to display it.
Help pages
A breadcrumb navigation is displayed above the help pages.
The breadcrumb represents the path in which a help page is stored in the content tree. This allows you to see the context of the information provided. You can click on the colored structure entries to navigate to a higher level.
The Contents tab contains the structure of the help topics as a tree.
The Contents tab provides access to general information, such as the purpose of the product described, basic information on operating the program and the online help system, or the structure of the program interface. You can expand and collapse the tree of the Contents tab using the Expand all and
Collapse buttons of the help viewer.
Representation of the user interface
To a certain extend, the tree of the Contents tab represents the user interface of the standard Classic view of ARIS Connect. Depending on the license you are using, you will find the topics Work in the portal, Use the Catalog, Collaborate with users, Search content, and Use the repository in this order, which corresponds to the arrangement of the program components.
This makes it easy to assign the contents of the help to the program interface.
Procedures and concept descriptions
The tree provides also specific information such as procedures and concept descriptions.
Thematically grouped
Procedure descriptions show you how you can use the functionality of the program. They are provided with actively formulated headings such as Create model. Related topics are grouped thematically.
Use case oriented
If possible, the procedure pages are arranged in such a way that they result in a use case. The following simple example shows the use case for groups: create group, manage group contents and, if no longer required, delete group.
Distinction between procedures and concepts
You will find concept descriptions under Valuable information. Headings of concept descriptions are formulated as questions or marked by "How to" formulations, which makes it easy to distinguish between concept descriptions and procedure descriptions.
Help pages offer information as text, but also via videos, and illustrations.
Quick videos visualize described processes for certain functions. This enables you to follow basic and complex functions directly in the program. As the name Quick video says, the information is given in a short time.
Task-related processes are presented in video tutorials.
Due to the complexity of the topics, video tutorials run for several minutes. If you click on a video tutorial link, you will be redirected to the ARIS Community web site where the videos are stored.
Help pages often provides See also links. These links allow you to jump to content-related help pages.
Help pages of related topics are grouped thematically under superior pages in the content tree.
The Contents tab contains the structure of the help topics as a tree.
The Contents tab provides access to general information, such as the purpose of the product described, basic information on operating the program and the online help system, or the structure of the program interface. You can expand and collapse the tree of the Contents tab using the Expand all and
Collapse buttons of the help viewer.
Representation of the user interface
To a certain extend, the tree of the Contents tab represents the user interface of the standard Classic view of ARIS Connect. Depending on the license you are using, you will find the topics Work in the portal, Use the Catalog, Collaborate with users, Search content, and Use the repository in this order, which corresponds to the arrangement of the program components.
This makes it easy to assign the contents of the help to the program interface.
Procedures and concept descriptions
The tree provides also specific information such as procedures and concept descriptions.
Thematically grouped
Procedure descriptions show you how you can use the functionality of the program. They are provided with actively formulated headings such as Create model. Related topics are grouped thematically.
Use case oriented
If possible, the procedure pages are arranged in such a way that they result in a use case. The following simple example shows the use case for groups: create group, manage group contents and, if no longer required, delete group.
Distinction between procedures and concepts
You will find concept descriptions under Valuable information. Headings of concept descriptions are formulated as questions or marked by "How to" formulations, which makes it easy to distinguish between concept descriptions and procedure descriptions.
If you select a parent page, you can access the skip links to open the corresponding help page.
Skip links are listed under the Topics section. They are at the beginning of the main content, so that screen readers have immediate access to the topics for reading aloud.
Footer links
Jumps to the Legal Notices web page of Software AG.
Jumps to the How to contact Software AG web page.
Jumps to the Impressum web page of Software AG.
Jumps to the ARIS web page of Software AG.
For more information that goes beyond the application help, see the technical documentation.
Technical documents are available on: