| Infor ERP LN Web Help Administration Pages |  |
| How to start the Web UI Administration Console To start the Web UI Administration Console, point your browser to the following URL: http://<hostname>:<port>/<webtop-root>/servlet/admin The initial administration password is `webtop`. It is strongly advised to change this password. The various Web UI Administration Console options are described further in this chapter. Web UI Administration pages for Infor ERP LN Web Help Change Admin Password Use this page to change the administrator password. Change Configuration Directory By default the Web UI configuration files are stored in the "config" directory directly under web application install directory. If you want to reuse Web UI configuration files across multiple installation, you can change the directory were the Web UI configuration files are stored. User profiles To set the user profile directory The user profile directory enables you to store the user-specific Web UI/ Web Help settings; the so-called User Profile files. The following is the default location for this directory: <webtop-config>/usercontexts/ You can change the User profile directory in the Web UI Administration Console to specify another location. Make sure that this directory exists. In addition, the Servlet Container must have write permission to this directory. Enable trace On the User Profile page, you can also switch tracing on or off. If tracing is on, extra debugging messages are written to the java console of the client browser. Since this has negative impact on the performance of the browser, tracing usually must be disabled. You can switch on tracing if support engineers must collect debugging information. Enable customize Web Help On the User Profile page, which you can reach from the Infor Web UI Administration menu, you can also switch the ability to customize the Web Help on or off. Users with this ability can customize the Web Help content, in other words, these users will have an extra button called Customize on their Help pages. To customize the Help page, the user can click this button. If the user clicks Customize, the following form appears: Customize Web Help form Click the eye icon to hide a specific Help item. If you click a pencil icon, you can add Help text to, or replace Help text for, the following: General Help A specific Help item In the Help editor that starts up when you click a pencil icon, the following rules apply: You must type Help in BEEM-XML. The list box at the top of the form enables you to select the position of the new help text: beginning, end, or replace. At the bottom of the form, some helper buttons are available to insert most used BEEM-XML markup. Customize Web Help editor The following factors determine where the customized help is stored: The <Package Version> of the original Help text is taken as the base. The customized help is stored on the Web server in: <Help Directory>/ <Package Version>_customize/… The customized Help remains when standard Help is updated. The customizations will be visible for all users. Note Because the customizations are stored on a location other than the default Help content, an update of the default Help will keep the customizations in place. Note You can only edit Help content for Infor ERP Baan5.0c and Infor ERP LN 6.1 or higher only if the help server as defined in the User Data Template (ttams1110m000) session is the same as the Infor ERP LN Web UI Web server. Languages The Languages page enables you to change the default language. Install the .zip file that contains the language files and then install the .zip file that contains the translated Help. You can download the most recent translations from the Infor Support Web site. Logging The Logging page enables you to set the level of logging. In addition, you can specify the log file to which the log information is written. Note that, after you submit the changes, the changes take some time to take effect. Compression By default, messages between the browser and the Web server are compressed if the message size exceeds 10 bytes. Depending on the network bandwidth, you might want to adjust this setting. However, Infor recommends that you use this default setting. Company logos You might want to change the company logo used in Infor ERP LN Web Help. In this administration page, you can upload a new logo. On Linux and UNIX systems, users must set the environment variable DISPLAY because some operations are performed on the uploaded images. To install Infor ERP Help files For Infor ERP LN 6.x, the corresponding online Help file is delivered on the Infor ERP LN 6.x Application installation media. The Enterprise Server-related online Help files are delivered on the Enterprise Server installation media. The path on the installation media is, for example, the following: /webhelp/erpln_B61Ua4stnd_en_xmlhelp.zip Updates for Infor ERP LN 6.1 online Help are available on solution number 142197. For Infor ERP Baan5.0c, the online Help documents are available on solution number 131624. To make Help documents accessible from Infor ERP LN Web Help, these documents must be installed on the Web server system on which the Infor ERP LN Web Help runs. You must choose the appropriate language and the correct localization file. First, determine the language and then decide on the version. Subsequently, select the .zip archive that contains both. To identify the .zip files, you use an encoding that consists of: A project ID A project sub-ID (optional) A project version, and sub-version (optional) A language code (refer to the Language table) xmlhelp.zip As a result, the format is as follows: <project id> [_ <project sub-id> ]_ <project version>_[ sub-version ]_ <language code>_xmlhelp.zip
File Name Convention
[ ] | Optional
project ID | The Help project ID or product name, for example: erp, webtop, or enterprise_server.
project subID | Identifies a part of a larger project
project version | The version, for example, 71a or 1.1
Sub version | The Service Pack or update number, for example, SP11.
language code | The language code, for example, en or ja.
xmlhelp.zip | Indicates that module is a zipped Help module.
Language Table
Language Code | Infor Language ID | Description
--- | --- | ---
ZH-CN | o | Simplified Chinese
ZH-TW | n | Traditional Chinese
DA | 7 | Danish
DE | 3 | German
EN | 2 | US English
ES | 5 | Spanish
FI | f | Finnish
FR | 4 | French
IT | 6 | Italian
JA | j | Japanese
KO | k | Korean
NL | 1 | Dutch
NO | 8 | Norwegian
PT-PT | P | Portuguese (European)
PT-BR | p | Portuguese (Brazilian)
SV | 9 | Swedish
Note The following procedure described in the "General installation procedure" section is mandatory. General installation procedure You must run an installation procedure to ensure that the online Help topics are installed at the correct location on the Web server system. To install the Help content, take the following steps: Insert the Infor ERP distribution installation media. Start the Web UI Administration Console to log on: http:// <hostname>: <port>/ <webhelp-root>/servlet/admin In the Infor Web UI Administration panel, click Infor Web Help. Then click Help content: Help Content Click browse in the Install Help Content group and browse to the zip file that contains the Help content. Click upload to install the content. The "Installing Help content. Please wait…" message appears. When the installation process finishes, the OK message appears. Note You can browse directly to the stand-alone Infor ERP LN Web Help through the following URL: http:// <hostname>: <port>/ <webhelp-root>/webhelp For example: http://saturn/webtop84/webhelp Note After the installation, check whether the Web Help is correctly displayed: To test the stand-alone Infor ERP LN Web Help, use the URL mentioned. To test context-sensitive Help, open an Infor ERP session and press F1. Help content directory The Help content directory can be a directory different from the Help directory of Infor ERP LN Web UI itself. This can be useful in the following cases: The Web UI WAR file is unzipped. In this case, you cannot use the Help directory to place the content in, because this directory is inside the WAR file. A new version of Infor ERP LN Web Help is installed regularly. In Web UI Administration Console, you can set the help content directory: In the Infor Web UI Administration panel, click Infor Web Help. Then click Help content. Set a different directory in the Help Content Directory group box. For example: C:\WebHelp. By default, the Help content directory is <webapp>. A new release of Infor ERP LN Web Help can overwrite the existing Help. Infor recommends that you place the Help content in a separate Help content directory. Important! When you install a new Web UI version, the corresponding WebHelp is installed in the default Help content directory <webapp>\ Help. After the installation, complete the following steps: Start the Web UI Administration Console and set the separate Help content directory again, such as C:\WebHelp. See steps 1 and 2 in the previous procedure. Copy the help files from the default Help content directory to the separate Help content directory. For example, copy the files from <webapp>\ Help to C:\WebHelp\help. Advanced topic: update index The Help content, which is located in the Help content directory, consists of several .xml files. These .xml files are converted to .html at the moment a user requests Help on a particular topic. Because .xml files can be changed in, deleted from, or added to the Help content, the full text search index must be updated to reflect these changes. Using this administration page, the system looks for changed, deleted, and added files and updates the index automatically. Advanced topic: rebuild index Using this administration page, the full text search index of installed Help content is deleted and rebuilt. Because this process is very time consuming, Infor recommends that you perform a rebuild only if the text search in the Help content appears to be corrupted. Advanced topic: fallback scenarios You can create some fallback scenarios in regard to language and version. If you cannot find Help for some version and language, you can fall back to other versions and/or languages. By setting the fallback scenario, Infor ERP LN Web Help can prioritize fallback to another version and/or another language. Infor ERP LN Web Help can handle various fallback scenarios. The fallback order options are: Language: If Help is unavailable for the desired language, return help in the default language, or return an error if the default is also nonexistent. Version: Only search for a different version, according to the defined fallback. Language. Version: Search first for another language and then search in the version according to the defined fallback. Version. Language: Search first for another version and then search in the default language. None: Return an error immediately if requested Help for the specific version and specific language is unavailable. For examples of these fallback scenarios, refer to the following sections. Note You can set or change the definitions for the fallback scenarios in the Fallback Scenarios page. To open this page, in the Infor Web UI Administration panel, click Infor Web Help. Then click Fallback scenarios. Fallback Scenarios page - Example setting This section describes the settings shown in the following figure: Fallback scenarios If the user wants session Help for a specific session in version B61Uastnd and language Dutch, and if this Help is unavailable, Infor ERP LN Web Help first turns to the default language because the fallback order requires that language be searched first. If the requested Help page does not exist in the default language, Infor ERP LN Web Help turns to version B61a because B61Uastnd falls back to B61a. B61Uastnd falls back to B61a because the fallback is defined as from baanerp.B61Uastnd to B61a. Example - Version fallback In a language, you can set up the following structure:
Version | Explanation
--- | ---
B61Oacust1 | Customization version from customer. Empty.
B61Uastnd | Partly updated.
B61a | Full version.
To enable a proper fallback, you must create the following fallback rules:
Fallback from projectid.version | to version
--- | ---
baanerp.B61Oa* | B61Uastnd
baanerp.B61Uastnd | B61a
If a B61Oacust1 user requests Help, Web Help searches through the Help versions in the following order: B61Oacust1 B61Uastnd B61a When the requested Help page is found, Web Help stops searching in other versions. Example: Language and Version fallback The following table shows a sample VRC structure for ERP LN FP3:
Version Name | Explanation | Version in English | Version in example language
--- | --- | --- | ---
B61Oa3 cust1 | Customization VRC | Empty | Empty
B61Ua3 stnd | Latest Help for FP3 | Full version (including B61a) | Partly updated (excluding B61a)
B61a | Latest base Help for ERP LN | Full version | Full version
To enable a proper fallback, you must create the following fallback rules:
Fallback from projectid.version | to version
--- | ---
baanerp.B61Oa3* | B61Ua3stnd
baanerp.B61Ua3stnd | B61a
The following table shows how Web Help searches through the Help versions if a user requests Help in version B61Oa3cust1 and language Dutch. The search order depends on the fallback scenario setting.
Fallback scenario | Search order
language-version | B61Oa3cust1-nl B61Oa3cust1-en B61Ua3stnd-nl B61Ua3stnd-en B61a-nl B61a-en
version-language | B61Oa3cust1-nl B61Ua3stnd-nl B61a-nl B61Oa3cust1-en B61Ua3stnd-en B61a-en
version | B61Oa3cust1-nl B61Ua3stnd-nl B61a-nl
language | B61Oa3cust1-nl B61Oa3cust1-en
When the requested Help page is found, Web Help stops searching in other versions. Note: Because B61Ua3stnd-en contains all English FP3 text, a fallback from that version to another language will never be used; therefore, set Fallback scenario to version-language. Note: After the installation of ERP LN, check whether ERP LN will display the correct Web Help versions. To do this, complete the following steps: Start the User Data (ttaad2500m000) session and find out to which package combination(s) and user data template(s) the users are linked. To find out which VRCs are linked to this package combination, use the Packages by Package Combination (ttaad1121m000) session. These VRCs determine the help version ERP LN will search for. For example, if the package combination contains B61O a3 cust1 VRCs, ERP LN searches for the B61Oa3cust1-<language code> help version. Start the User Data Template (ttams1110m000) session. View the template to which the users are linked and check whether the Help server is correctly defined. Verify whether the Help version ERP LN searches for is present on the Help server. Start the Web UI Administration Console and check if the Help version ERP LN searches for is included in the fallback path. Related topics Introduction How to Deploy Infor ERP LN Web Help Instructional Deployment Example |