Help and search

In the Alfabet user interface, documentation is available via a Help   button in the masthead of the Alfabet application. Depending on the configuration of the server alias of the Alfabet Web Application, users can access the web-based online help, the ticketing system for reporting issues, and the ideas portal for suggesting changes.

In addition, context-sensitive help is available for preconfigured versions of Alfabet. The context-sensitive help consists of an FAQ-like short help that is available in a help panel embedded in the product. The context-sensitive help is part of the Alfabet database and stored in a database table.

The online help for Alfabet is also publicly available under https://documentation.alfabet.com

A full-text search for the help is available in the help window on the of Alfabet user interface. This search is available in pre-configured versions of of Alfabet. For on-premise installation, the search and context sensitive help snippets are only available after explicit implementation. click for more information about the implementation of help.

Changes in the server alias fields:

• Overview > Help Server: Enter https://documentation.alfabet.com to link to the official Alfabet online help. The link will then be available via the Help   button on the user interface.

  The URL must not end with a slash!

  You can alternatively install the help locally. Help files can be provided by Software GmbH. You can also generate your own help and link it. The help must have a sub-folder for each language used for the Alfabet user interface. The sub-folder names must be en for English, de for German, fr for French, pl for Polish, and pr for Portuguese. It must contain an index.html file as landing page.

  Provide the URL ending with the folder above the language sub-folders.

• Overview > Suggestions and Ideas URL: You can enter a URL to a portal for users to suggest changes. The link will then be available via the Help   on the user interface. The official Software GmbH portal URL is https://alfabet-software-ag.ideas.aha.io/.
• Overview > Report an Issue URL: You can enter a URL to a ticketing system to report issues. The link will then be available via the Help   on the user interface.
• Overview > Search Index Directory: If you would like to enable the full-text search either for the help or for searching for objects in the Alfabet database, create a search index directory on the local file system and enter the path to the directory for which the