Skip to main content

Form Key Update Utility

The GT Form Key Update Utility was created to provide an easy way to retroactively update form keys after form search configuration and/or form search records were changed.

Using the GT Form Key Update Utility after search setup changes are made, a user can specify certain form types, form families, and form IDs to retroactively update their search keys so that they match the new search setup.

Navigation: Main Menu > Manage GT eForms 3.x > GT Functional Setup > GT System Setup > Form Key Update Utility

Add a New Value

A Screenshot of the Form Key Update Add a new value window

The initial search page has two options: Find an Existing Value or Add a New Value. The table below details the Add a New Value option.

PAGE OBJECTFUNCTONALITY
Run Control IDEnter a unique value that will be used to identify this form
AddUse button to proceed to the next page

Find an Existing Value

A Screenshot of the Form Key Update Finding a new value window

Use the search parameters to find an existing Run Control ID.

PAGE OBJECTVALUE/USE
Run Control ID begins withEnter a unique value that will be used to identify this form
Case Sensitive CheckboxCheck this box to make the search case-sensitive
SearchExecutes a search based on the specified parameters

Parameters

A screenshot of the Parameters window

The Form Family and Form Type grid parameters are additive in nature, not increasingly restrictive. At least one form family or form type must be specified before running the form key update process. Unlike the Form Family and Form Type grids, the Form ID range fields are restrictive, and only forms in the specified range that also belong to the form types/families in the grids will be updated. The From FormID and To FormID fields must be populated before running the key update process.

PAGE OBJECTVALUE/USE
Form Family GridSpecify the form families that you would like to have updated.
Form Type GridSpecify the form types that you would like to have updated.
From FormIDEnter the starting form ID number for the desired range of forms.
To FormIDEnter the ending form ID number for the desired range of forms.
RunRuns the form key update process with the specified parameters.