Help files in the web app versions 7.2 and later can be delivered in two different ways: web-sourced help (https://docs.agileassets.com) or an HTML package that is hosted locally by the client. Information on the advantages of each delivery method is available at Help Documentation Delivery for 7.2+. This document shows how to enable web-sourced help in an internal or client instance of the web app.

System Settings

First, identify the base URL for the help content. For https://docs.agileassets.com, the base URL is https://docs.agileassets.com/display/_PK/PD10/. Other spaces use the following format: https://<URL>/display/_PK/<SPACE KEY>/

Use the following steps to make a configuration change through the UI to enable the web-based help:

  1. Open System > Settings > System Parameters and then select the System tab.
  2. Select the Use web-sourced help content check box. Enter the base URL in the field.
  3. Select Save Data.

Linking to a Page of Help Content

Use the following steps to activate the (question) button to link to a page of content

Page Key

Please note that we have had some issues with broken links when using the Page Key. Some applications will require the URL instead of the page key.
For the example below instead of change_pass you would use display/PD/Change+Password to access the https://confluence.agileassets.com/display/PD/Change+Password page.


The page that you are linking to must have a page key. The page key is configured by your system administrator. If it is already configured, you can see it on the content page in a lighter text next to the page title.

   

Manually Mapping a Help Page

  1. Open the page in the web app where you want to launch the help file.
  2. Activate Design Mode.
  3. Right-click or select Actions and select Change Control Properties.
  4. Select the top level of the tree in the left pane.
  5. Enter the Page Key that you identified earlier in the Web help page key field and select Ok.
  6. You must Log Out and Log In to see the changes.