Using hooks in Rational ClearQuest Web

Rational® ClearQuest® Web software supports a subset of the full hook functionality, which a schema developer can set up.

Hooks created in the Rational ClearQuest schema run on the computers that run the Rational ClearQuest server. Keep in mind the following points when using hooks with Rational ClearQuest Web:
The following types of hooks are supported:

Special considerations for field hooks

The behavior of Value Changed and Validation field hooks depends on the form control type and property settings for the target fields. Review the following special considerations to understand when the hooks run, and how changes are made visible to users for different form control types.

Value Changed

A Value Changed field hook runs immediately after a user changes the value in the following form fields:

Field type Form control
REFERENCE
  • Combination box
  • Drop-down combination box
  • Drop-down list
REFERENCE_LIST List
SHORT_STRING
  • Drop-down combination box
  • Drop-down list
Note: These form controls require a web dependent field association in order for the Value Changed hook to run immediately.
A Value Changed hook runs the next time the browser communicates with the ClearQuest server when the hook is set on a SHORT_STRING field type with one of the following types of form controls:
  • Combination box
  • Drop-down combination box
  • Drop-down list

Moving between tabs on a form in the browser does not cause the browser to communicate with the Rational ClearQuest Server.

Validation field hooks

A Validation hook runs immediately on the ClearQuest Web client, but the form must be refreshed to see the results.

To create a Refresh button:

  1. Create a record script hook with no code inside it. Name the hook Refresh.
  2. Create a button on the form. Label the button Refresh.
  3. Right-click the button, and then click Properties.
  4. On the Button Hooks tab, in the Hooks area, select the Refresh record script from the Click Hook list.
  5. In the Enable for web area, select Click Hook.
The ClearQuest Web client user must click the Refresh button to see the results of the Validation hook.

Feedback