Search Configuration
By default, search pages will be made up of a combination of General, Form, and Search Record fields, as applicable. The Search Page Configuration can be modified by using the Search Configuration tool.
Navigation: Main Menu > Manage GT eForms 3.x > GT Functional Setup > GT System Setup > Search Configuration
Search Page
Search Configuration is per family or search set. Each Form Type will have its own Search Configuration for the Add task. All Form Types in a family or search set will share a Search Configuration for each of the other tasks—Evaluate, Update, and View.
Add Family/Search Set
If no Add search record is configured on the Data tab of the Form Setup page, the following message will display:
Otherwise, the Search Configuration page will display:
Search Fields
By default, will display fields marked in the search record as search keys. Fields can be added, removed, and reordered as necessary.
Results Fields
By default, will display fields marked in the search record as list box items. Fields can be added, removed, and reordered as necessary. You may not add more than 20 Search Result fields.
| Field | Value/Use |
|---|---|
| Family/Search Set | Current Form Family/Search Set |
| Group Type | Either Family or Search Set |
| Form Type | Current Form Type |
| Search Task | Current Search Task |
| Customized | Automatically checked if default configuration is changed |
| Default | Revert configuration to default |
| Clear | First click – remove any rows with the show flag unchecked Second click – clear all configuration |
| Up | Move the selected row up |
| Down | Move the selected row down |
| Search Field Source | The type of field – only Search Record is valid for Add task |
| Field Name | The field to use and its label. Note: Will only show the first 50 characters of the field label |
| Show | Checked – will appear on the search page Unchecked – will be removed from search configuration |
| Sort Order (Results only) | Sort by this column. If selecting multiple, can specify priority (1, 2, 3) |
| Sort Direction (Results only) | Ascending or Descending |
| Plus (button) | Add a row (Limit: 20) |
| Minus (button) | Delete a row |
Evaluate/Update/View Family/Search Set
Search Configuration for the Evaluate, Update, and View tasks are shared across Form Types in a Family or Search Set. These Shared configuration screens are similar to the Add task configuration but include several additional options.
Search Fields
By default, this section will display a mix of fields beginning with General Fields Form ID, Form Type, and Form Status, then Search Record Fields marked in the search record as search keys, then Form Fields (up to a total of 8 fields). Can add, remove, and reorder fields as necessary. Available fields from Forms and Search Records will include fields from all Form Types in the Family or Search Set.
Results Fields
By default, will display a mix of fields beginning with General Fields Form ID, Form Type, and Form Status, then Search Record Fields marked in the search record as list box items, then Form Fields, followed by General Fields Original OprID, Original Date, Last OprID, Last Date. Can add, remove, and reorder fields as necessary. Available fields from Forms and Search Records will include fields from all Form Types in the Family or Search Set. You may not add more than 20 Search Result fields.
| Field | Value/Use |
|---|---|
| Family/Search Set | Current Form Family/Search Set |
| Group Type | Either Family or Search Set |
| Form Type | Current Form Type |
| Search Task | Current Search Task |
| Customized | Automatically checked if default configuration is changed |
| Default | Revert configuration to default |
| Clear | First click – remove any rows with the show flag unchecked Second click – clear all configuration |
| Copy from VWS/UPD/EVL | Copy all configuration from another Shared task in the same family/search set |
| Up | Move the selected row up |
| Down | Move the selected row down |
| Search Field Source | The type of field – General, Search Record, Form |
| Field Name | The field to use and its label |
| Show | Checked – will appear on the search page Unchecked – will be removed from search configuration |
| Sort Order (Results only) | Sort by this column. If selecting multiple, can specify priority (1, 2, 3) |
| Sort Direction (Results only) | Ascending or Descending |
| Plus | Add a row (Limit: 20) |
| Minus | Delete a row |
Advanced Section
| Field | Value/Use |
|---|---|
| Formlist Record | Defaults to 'G3FORMLIST' but can be changed to use a custom view to be defined as a base Form List record, which will control the fields that are available as “General” search field options. For example, this allows for fields like Form Type Descr to be searched on and returned in the search configuration without having to add that as a hidden field on forms. |
Saving a Search
This ability to save search criteria is available in GT eForms 3.58.01+. This allows end users to save their search criteria and reload those saved searches. By default, the button for “Save Search” will appear on all form search pages. To turn off this feature at the framework level, please take the following steps.
Navigate to Manage GT eForms 3.x > GT Functional Setup > GT System Setup > Form Installation Table.
Check for a value in the “System Application Package” field. If there is a value, add the following code to a SearchEvents class in the existing app package. If there is NOT a value, first create a new application package then add it to the System Application Package field and save the page. Then you can add the following code to a SearchEvents class in the new app package.
If you do not want to hide the Saved Search button for all forms in the environment, you can add the following code to a family app package or a search set app package instead to control which forms can use saved searches.
import G3SEARCH:Search;
class SearchEvents
method FormSearchInit(&_Search As G3SEARCH:Search);
end-class;
method FormSearchInit
/+ &_Search as G3SEARCH:Search +/
GetLevel0()(1).G3SEARCH_DRV.G3SVSRC_NAME.Visible = False;
GetLevel0()(1).G3SEARCH_DRV.G3SVSRC_SAVE.Visible = False;
GetLevel0()(1).G3SEARCH_DRV.G3SVSRC_DEL.Visible = False;
GetLevel0()(1).G3SEARCH_DRV.G3SVSRC_LOOKUP.Visible = False;
GetLevel0()(1).G3SEARCH_DRV.G3SVSRC_PB.Visible = False;
end-method;
Search Fields
The search fields available will be returned from the search fields set up in the search configuration in the Family/Search Set of the form type.
- Choose the search criteria and click Search to return the desired results.
- To save this search, click “Save Search”.
- Enter a name for your search and click Save.
- Once the search is saved a “Use Saved Search” dropdown will display on the page.
- When you choose your Saved search from the dropdown the search results will display. These results will update as forms are submitted and/or processed.
Modifying a Saved Search
You can add criteria to a saved search to refine results and save to add a new Saved Search
- Add additional search criteria and click Search
- The results returned will be modified based on the criteria chosen.
- To save the modified search click “Save Search”
- The box to enter the name of the search will display.
- Enter the name of the new search and click save.
- Your new Saved Search will be available in the dropdown
Deleting a Saved Search
- From the search page choose the Saved Search.
- The Delete Search button will display. Click Delete Search.
- The Saved Search will no longer be available.
Note: You can read about setting up Search Records for tasks in the Search Records By Task document in the Form Setup folder.