Purpose

To create and maintain the detail part of URL addresses for the Online User documentation

As required

Online User documentation is able to be accessed directly from the system. This is explained in the Online User Documentation Facility - Introduction.

The Online User Manual is displayed as individual 'Web' pages with each page equating to a file of information. The User Manual consists of thousands of these files. Each file has a unique physical location known as its URL (Uniform Resource Locator). Some URLs are divided into two parts: a Base URL and a Detail URL. This is fully explained under Maintain System Help Control Details.

This form is used to maintain the Detail URL part of each file's location. This facility provides the capability to target user documentation 'in context' (i.e. documentation relevant to the part of the system being used can be accessed automatically). This capability is maintained by linking the URL of the context documentation to the system form to which it relates. This can be further refined by linking the context URL to a block within a form. If both a form and block URL are specified, the block URL will take precedence.

All User Manual context URLs are predefined as part of the Online User Manual facility. Provision is made for institutions to define context URLs for the three remaining configurable Field Help form buttons (Link 1, Link 2 and Link 3). These can be used to access other web-based user documentation.

For example, this form (HLPF0020) consists of two blocks (System Form and System Block). In this case, it is sufficient when using the form in the system, to have one set of explanatory documentation to describe the use of both the form and the individual blocks. In some forms (such as the Record Enrolments form (ENRF3000) which is displayed over many blocks and many screens), explanation is sufficiently involved to make the use of a separate 'page' for each block a more efficient way to present user information. Use this form (HLPF0020) to query the URL details for System Form ENRF3000. The name of each block in ENRF3000 will be displayed. Select each block in turn to view the context URL for the block. Note that block URLs will override the displayed form URL.

The System Form block contains:

• System Form
• Context URL
• Link 1 URL
• Link 2 URL
• Link 3 URL

The System Block contains:

• Block
• Sequence
• Description
• Context URL
• Link 1 URL
• Link 2 URL
• Link 3 URL

Rules/Notes:

• Determine whether context sensitivity should apply at the block or form level.
• Determine the content of the detail URL. (In most cases this will be a directory/file path specifying the location of an html file but with the base URL omitted.)
• For context sensitivity at the form level:
  • Enter the detail URL for context sensitive User Manual entries in the Context URL field of the System Form block.
• For context sensitivity at the block level:
  • Select the block for which the detail URL is to be recorded.
  • Enter the detail URL for context sensitive User Manual entries in the Context URL field of the System Block block.
• Carry out steps 3. and/or 4. for the Link 1, 2and/or 3 fields where applicable. (optional.)
• Save.

Rules/Notes:

URL detail data is specific to, and must be recorded for, each system form.

Context URL refers to the URL accessed via the first button of each Field Help form.

Link 1, Link 2 and Link 3 URL refer to the fourth, fifth and sixth buttons of each Field Help form.

Buttons not defined in this form will not be displayed in the Field Help form.

• Select the data to be deleted.
• Delete record.
• Save.

Rules/Notes:

Deleting the detail URL of a button will cause that button to become inoperative in the Field Help form displayed for all fields within the specified form or block.

To modify a detail URL for a Field Help form button using the Maintain Online Help URL Details form:

• Select the data to be modified.
• Modify the data as required.
• Save.