IBM TRIRIGA Version 10.5.0

Creating help records

You can customize the system help for users by creating specialized help records.

About this task

Ensure that help text, topic titles, and keywords are all written in the language that is specified in the help record. A separate help record is required for each language that you support.

You can show only the text in the help record or the entire help record. If you show the entire help record, users see the related topics and related documents and can search help topics. In the FULL_HELP_OBJECT property of the TRIRIGAWEB.properties file, you can specify how the help record is displayed.

Procedure

Go to Tools > System Setup > System > Help and select Add.
Specify the module or application name that the help text applies to. You can also create a help record for a navigation item, such as the Employees page that is displayed when you navigate to Portfolio > People > Employees. To create a help record for a navigation item, specify Manager as the form name, and ensure that the module or business object in the Module/Application Name field is defined in the master detail query. You define master detail queries in the Report Manager application.
Define the language of the help text and any keywords.
Specify a topic, which provides a short description of the help text. The topic is what users see when they search for keywords.
Write the help text.
Optional: Specify any related documents or related help topics to link to or from the help topic.
Create and save the help record.

Feedback