Maintaining the status help

The administrator can maintain HTML markup for the status selection in the forms, which displays an explanation (help text) of the selectable statuses. It is generated as an HTML file and checked in to the database as a BLOB. The contents of this HTML file is derived from the Status name and its Description.

Note: JustRelate does not provide any new status help content. Since the status help should pro­vide information for the users in your company, it makes more sense to create the help pages based on your internal processes.

The layout of the status help is determined by the HLP_PSA_STYLESHEET.CSS file in the database. If you want to change the layout, you can export this file from the database, modify it locally according to your wishes, and check it in to the database again to replace the existing BLOB.

Generating the status help

The status help can be generated for an existing process status.

  1. Open the Administration / Process definition menu.
  2. Select the process concerned.
  3. In the overview tree, mark the status for which you want to edit the help text.
  4. If necessary, make sure that the status name (Process status tab) and the status description (Help tab) are maintained in multiple languages.

You can generate the status help individually or for several statuses at once.

Generating the status help for one status

  • Switch to the Help tab.
  • Edit or create the help text in the Description field.
  • Click Generate.
  • The status help is automatically generated as two BLOBs in the maintained languages. You can immediately see the result in the help area.
  • Now click the globe icon at the Description field.
  • Remove the hash marks (###) of the second language and provide a translation.
  • Click Generate again to apply the changes.

To revise the status help, simply change the description text and follow the steps above.

Generating the status help for several statuses

  • In the process definition, switch to the Process status list (under General).
  • If necessary, check whether the status name and description are maintained in the required languages.
  • Mark all statuses for which you would like to have a status help.
  • In the function bar, click the Generate help function.

Help is now displayed for the respective process status in each form relating to the process being edited.

Note: More about the creation of BLOBs, how to handle them, and useful tips for saving BLOBs can be found in the PiSA cubes documentation, or obtained in an administrator training.