All parameters below are configured by the IFS Installer.
Any Enterprise Explorer form is a possible entry point for navigating into the documentation. By pressing F1 or clicking the Help from the menu the user will get to the Online Documentation. The link between the application to the documentation is the Base Address for HTML help, a setting in the System parameters (Solution Manager). The value is set to http://<server>:<port>/ifsdoc/documentation if the checkbox is selected in the IFS Installer form Setup Documentation. In runtime a language code provided by the client is added at the end for the complete URL.
There are a number of URL:s configured to connect the different parts of the documentation.
The Online Documentation (stored in <ifs_home>/ifsdoc/documentation/<language>/OnlineDocSettings/local/general.xml):
| Link | Setting |
|---|---|
| from OnlineDoc to IEE | <setting name="eeLink">http://<server>:<port>/client/runtime/Ifs.Fnd.Explorer.application</setting> |
| from OnlineDoc to TechDoc | <setting name="f1Link">http://<server>:<port>/ifsdoc/f1doc/</setting> |
| from OnlineDoc to TM | <setting name="eLearningLink">../<language>/IFSTrainingMaterial.htm</setting> |
| from search field to search server | <setting name="searchserver">http://<server>:<port>/solr/ifsdoc_<language>/</setting> |
The Technical Documentation (stored in<ifs_home>/ifsdoc/f1doc/common/general.xml):
| Link | Setting |
|---|---|
| from TechDoc to IEE | <setting name="eeLink">http://<server>:<port>/client/runtime/Ifs.Fnd.Explorer.application</setting> |
| from TechDoc to TM | <setting name="ifsapp_doctm_path">http://<server>:<port>/ifsdoc/documentation/en/</setting> |
| from search field to search server | <setting name="searchServer">http://<server>:<port>/solr/techdoc/</setting> |
A user accessing the OnlineDoc from the IEE will get the documentation in the same language as used in the client, if a translation is available. If the documentation is unavailable on that language, the user should be redirected to the English version of OnlineDoc.
This functionality can be achieved using a symbolic link on the web server file system. The symbolic link needs to be created manually, one for each needed additional language. When the IFS Installer has completed the documentation installation, the symbolic links can be manually created.
Later on, if a translated documentation is to be installed, the IFS Installer looks for a possible symbolic link for that language and removes it.
Example: The installed languages for IEE is English and Swedish. The OnlineDoc documentation is available only in English. A symbolic link can be created in command prompt in the folder <ifs_home>/ifsdoc/documentation: