Enabling online help

To enable online help for your NexJ deployment, place the help files on an end user accessible server and ensure that the correct channel connection is set.

Place the generated help files on an HTTP server that your end users can access.
- For a production deployment, use an HTTP server that is independent of the NexJ Model Engine you are running. This allows for easier documentation updates as it does not tie help to your deployment.
- For a temporary or test deployment, you may choose to deploy the help files on NexJ Model Engine by placing them in the following directory in your model: meta/web.
Configure the Help channel using NexJ Studio.
- If you are deploying the help files on an independent server, specify the secure user-accessible URL for the server that hosts the help. For example, enter https://intranet.example.com/nexj-help/
- If you are deploying the help files on NexJ Model Engine, specify the server and directory. If you specified meta/web in your model directory, then the online path is /nexj/. For example, to enable online help residing on the http://www.example.com server, specify http://www.example.com/nexj/.
For details about configuring channels, see Configuring channel connections.
The suggested configurations for all channels are included in Channel connection settings. Suggested help channel configuration is described in Table 4.

Note: The default name for the NexJ CRM help file is nexj-contact-help-en.pdf. NexJ CRM references the file using the set-help-file-name function in the ContactBrokerPortlet screen. If the help file's name is customized on your webserver, open the ContactBrokerPortlet screen in the Presentation layer and edit the text in the Script tab.