Try OpenEdge Now
skip to main content
WebClient Applications
Your End Users' Experience : Preparing documentation for end users

Preparing documentation for end users

You must provide documentation for your users that includes following information:
*You should inform users which installation types you support. If your application installer includes any of the System Tasks that require Administrator privileges, you should specify what they are. If your end users might take the option of granting specific write privileges to non-Administrators, you must detail exactly what privileges are required. For more information on these topics, see the WebClient installation types and the Granting write privileges .
*If your application uses the OpenEdge GUI for .NET, you should inform users what the appropriate versions of the .NET framework are for running your application. Explain what they need to do, based on the choice you made about including a .NET framework installer. If your WebClient installer launches a .NET Framework installer, tell your end users to accept the EULA and install the framework.For more information, see the .NET Framework.
*The end user's machine must run a Web browser that supports ActiveX controls or plug-in technology, such as Microsoft Internet Explorer 6 and Firefox 2 (or later versions).
*You should inform users that during WebClient installation they must provide the proxy host and port of any firewall on their system. For more information, see the WebClient Application Manager.
*You should warn users that during the WebClient and application installation they might be told to reboot their machines after the WebClient and application are installed.
*To run your application, users must have Web access. Even though the application is installed on a user's machine, WebClient Initializer checks the application configuration file on your Web site each time the application is run to verify whether there is a new version of WebClient or the application.
If their browser displays an alert box similar to the one shown, users must choose the Open it option to install or start the application:
Users can clear the Always ask before opening this type of file check box if they do not want to see this alert box the next time they launch the application from their browser.
Note: Clearing this check box turns off notification for all WebClient applications that the user launches from their browser.
*When users first install WebClient from your Web site, the browser might require them to download a setup player for the installer. When they download the player, a dialog prompts them to grant a certificate that allows the player to be installed. Advise your users that they must always choose to grant the certificate.
*You must tell users how to run the WebClient Application Manager to access the WebClient Initializer log file or make any post-installation changes to their application configuration. For more information see the WebClient Application Manager.
*If you use IntelliStream to install your application, tell your end users that, when uninstalling, they must first uninstall your WebClient application and then uninstall the WebClient itself.
*If your application performs HTTPS connections to a Web server that uses digital certificates signed by a private CA, you must provide your end users with documentation about your installation package for digital certificates. Your documentation should direct the end user to first download and install the WebClient and then immediately install the root digital certificates. Your documentation should also provide your end users with detailed information about how they would update the root digital certificates for the WebClient. Because each public or private PKI vendor has different procedures for installing and using digital certificates, you need to provide explicit directions for each PKI vendor you use. For more information, see Designing Security