Dynamic Search Styles

Dynamic Search Styles

Overview

Use the Dynamic Search Style management form to create search styles. A Search Style displays the Objects that appear on the Search page, these include search criteria and labels, and when initiated, launches an SQL query.
The Dynamic Search Style Management tool consists of two parts:

  • Available Styles (by Sequence): The Available Styles list box displays the existing search queries or Styles. To view the details on a style, highlight it in the list.
  • Styles: The Styles tab displays details on the selected object. Details include a list of the linked objects and the SQL query.

Linked Objects

The linked objects are listed in the order that they appear on the Web page.
To modify an Object Sequence:
Linked Objects: Linked Objects appear on the Web page in the order they are listed in the sequence.

  • Click Up to move the object towards the top of the list; so that it is performed nearer to the beginning of the sequence.
  • To move the object towards the end of the list, click Down. When moved down it is performed closer to the end of the sequence.
  • Click Add to open a secondary form where you can select objects to add to the sequence.
  • Highlight the object or objects that you want to add. Then, click Add on the secondary form.
  • To remove an object from an object sequence, highlight the object, in the Linked Objects list box and click Remove

Read More...

Creating a Style

To create a new style:

  1. Click New to clear the form.
  2. In the Code field, enter a string, with a maximum of 15 characters, to identify the style in the database.
  3. From the Key to Retrieve drop-down menu, select the reference ID to retrieve in the search.
  4. In the English Short Description field (or the Short Description field of your first language), enter a description to a maximum of 25 characters.
  5. In the English Long Description field, enter a description to a maximum of 50 characters.
  6. Repeat steps 4 and 5 for the French, Spanish (or your second language) fields.
  7. Select the objects to link to the style, using the Add button.
  8. Define the order of the Object Sequence, using the Up and Down buttons.
  9. Compose your query in the Query edit box, or copy and paste it from another application.
  10. Click Add, under the Available Styles list box to add it to the list.

Modifying a Style

To modify an existing style:

  1. Highlight the style in the Available Styles list box.
  2. Make your change on the form.
  3. Click Save to resave the style with the new parameters that have been search.

Deleting a Style

To delete a style:

  1. Highlight the object in the Available Styles list box.
  2. Click Delete.

Create a Dynamic Search Style Query

NOTE: A basic understanding of Structured Query Language (SQL) queries is a prerequisite for this example.

Design the Query

In the following example we will create a query that will perform a search by Parcel ID (P_ID). This query will use an object that was created in an earlier example in this document. See Create a Parcel ID Object.
In the database, the table that is being searched is called PC_PARCEL. In addition we will also retrieve information from other columns in that table. The additional information that would be of value would be the Tax Map Number, Subdivision, the Effective Year, and Inactive Year.
A basic SQL query would consist of three parts, a SELECT statement, a FROM statement, and a WHERE clause.
The following is our example statement…
SELECT PC_PARCEL.P_ID, PC_PARCEL.TAX_MAP, PC_PARCEL.SUBD,
PC_PARCEL.LOT, PC_PARCEL.EFFECTIVE_YEAR,
PC_PARCEL.INACTIVE_YEAR FROM PC_PARCEL WHERE
PC_PARCEL.P_ID=pcparcelidseg
The SELECT statement indicates the columns that are to be displayed in the
Results pane.
The FROM statement will indicate the table that the columns are to be selected from.
The WHERE clause is used as a filter for the results, i.e. we say “WHERE” PC_PARCEL.P_ID is equal “=” to the pcParcelID2 object.
The pcParcelID2 object is a search object that was created in the Search Objects Management form. See Create a Parcel ID Object.
Creating the Query in GNA
To build the Query in Govern New Administration (GNA)…

  1. In GNA select Setup > Search Configuration > Manage Styles.
  2. To start a new entry, click Clear All Entries.
  3. In the Code field, enter pcParcelID2.
  4. In the English Short and Long Description fields, enter By Parcel ID2.
  5. Enter Par ID de la Properiete in the French Short and Long Description fields.
  6. In the Linked Objects (by sequence) field, click Add (1); this will display an Available Objects screen (2).
  7. In the Available Objects screen, select the parcel ID object that was created in the Create a Parcel ID Object example , Parcel ID Seg. Click Add.
  8. You will be returned to the Search Styles Management form.

At this stage you are ready to enter the query that was designed earlier. If you find the Query field space too restrictive when typing, one method you can use is to create the query in a text editor. After typing in the statements, copy and
paste it into the Query parameter.
Type in the query as follows:

SELECT PC_PARCEL.P_ID, PC_PARCEL.TAX_MAP, PC_PARCEL.SUBD,
PC_PARCEL.LOT, PC_PARCEL.EFFECTIVE_YEAR,
PC_PARCEL.INACTIVE_YEAR FROM PC_PARCEL WHERE
PC_PARCEL.P_ID=

When we compare the above statement to the one that was create earlier, the object called pcParcelID2 has been left out. The reason for this is that when we want to include objects that are in the Govern system, the Search Styles Management form can take care of the entry and append any required special characters that the system may require.
To specify the Parcel ID object in your query…

9. Place your cursor immediately after the “=” sign (1) in your query statement, under the Linked Objects (by sequence) field (2), double-click on the Parcel ID Seg.
10. The object name is addded to the query; click Save.

NOTE: In the above final statement you will note that there is no space before or after the “=” sign. This is one of thesyntax rules that should be followed when creating queries.

For a list of SQL query rules that should be followed in GNA, see SQL Syntax Rules for GNA.

Viewing Results in MS Govern

When the style has been saved, it can be seen in Govern.
To view the Search Style in MSGovern.NET…
1. Open a Profile in MSGovern.NET.
2. From the Ribbon, select Views tab; Predefined Searches > Search Styles > By Parcel ID 2.

3. Click the Predefined Searches tab to display the Search form.
4. The search form will display your object (A) and when you perform a search, the columns that you had requested in your query will be displayed.

Query Result Column Titles

As seen above (B), when results are displayed, the titles used for the requested columns are those of the database tables. When keeping an enduser in mind, column names used in the table, although acceptable for a database programmer, usually do not offer too much value to an end-user. For example, a column titled ”P_ID” is more understandable if it were called “Parcel ID”, or “SUBD” if it were called “Subdivision”.

Change Column Titles with an Alias

To customize the display of the column titles in our query results,’ display titles that are descriptive to the user will involve the use of an Alias. The syntax for using an alias in our SELECT statement is as follows…

SELECT PC_PARCEL.P_ID AS ‘Parcel ID’

The SELECT statement is used to indicate the columns that are to be displayed in the query results. AS is used to designate the alias name to be used for the resulting column title.
NOTE: When using AS ensure that the alias name is surrounded by an opening and closing single quote, e.g. ‘Alias_Name’.
If one were to modify the following Dynamic Search query for a search by Inspector, the following statement…

SELECT PC_PARCEL.P_ID,
PC_PARCEL.TAX_MAP,
PM_INSPECTIONS.INSPECTION_DATE,
PM_INSPECTIONS.STATUS,
NA_NAMES.NAME_INDEX
FROM PC_PARCEL,
PC_LK_PARCEL_INSP,
PM_INSPECTIONS,
NA_NAMES
WHERE PC_PARCEL.P_ID=PC_LK_PARCEL_INSP.P_ID
AND PC_LK_PARCEL_INSP.IN_ID=PM_INSPECTIONS.IN_ID
AND PC_LK_PARCEL_INSP.MASTER_DEPT=PC_LK_PARCEL_INSP.DEPT
AND PC_LK_PARCEL_INSP.MASTER_DEPT=department
AND PM_INSPECTIONS.NA_ID=NA_NAMES.NA_ID
AND NA_NAMES.NAME_INDEX LIKE @ininspector_0

…can be rewritten with aliases using the AS statement…

SELECT PC_PARCEL.P_ID AS ‘Parcel No.’,
PC_PARCEL.TAX_MAP AS ‘Tax Map No.’,
PM_INSPECTIONS.INSPECTION_DATE AS ‘Inspection Date’,
PM_INSPECTIONS.STATUS,
NA_NAMES.NAME_INDEX AS ‘Inspector Name’
FROM PC_PARCEL,
PC_LK_PARCEL_INSP,
PM_INSPECTIONS,
NA_NAMES
WHERE PC_PARCEL.P_ID=PC_LK_PARCEL_INSP.P_ID
AND PC_LK_PARCEL_INSP.IN_ID=PM_INSPECTIONS.IN_ID
AND PC_LK_PARCEL_INSP.MASTER_DEPT=PC_LK_PARCEL_INSP.DEPT
AND PC_LK_PARCEL_INSP.MASTER_DEPT=department
AND PM_INSPECTIONS.NA_ID=NA_NAMES.NA_ID
AND NA_NAMES.NAME_INDEX LIKE @ininspector_0

Column Titles That Should Not Be Used

It should be noted that when you select an alias name for your column titles, it should not be the same as one of Govern’s Keywords.
For example in the above, the obvious column title of ‘Parcel ID’ was not used, instead ‘Parcel No.’ was used. The reason for the change is that ‘Parcel ID’ is a system reserved keyword.
Refer to Govern for .NET Keywords for a list of KEYWORDS THAT SHOULD NOT be used.
To use the above modified query in Govern.NET, in GNA either create a new query or for this example, modify an existing query.
1. Select Setup > Dynamic Search Configuration > Dynamic Search Styles…
2. In the Web Search Styles Management form, select an existing style, or create a new style. See Creating a Dynamic Search Style Query for details.
3. Modify the query statements in the Query parameter.
4. Click Save to save the modifications.
In Govern.NET…
5. Perform an Inspector search in Govern.NET; specify By Inspector (1).
6. Enter a required name in the parameter (2) or directly click Search for Results (3).
7. You will note that the column names are using the specified alias titles.

NOTE: Alias names are not case sensitive, titles are presented in capital letters

Dynamic Search Queries on the Web

The process to create queries that are to be accessible on the web is the same as creating Dynamic Search queries. The major difference is in the location where the aliases are to be defined.
For Web searches column titles are defined in the resource file. This allows for the re-use of the column titles in other searches. For example if the P_ID is defined as Parcel No., it will always display as Parcel No. whenever it is used.
This approach centralizes the definitions and minimizes the chances of error when multiple aliases have to be defined in each search style.
To make the entries into the resource file, you will need to use the Govern Resource Editor. The Resource Editor is included in GNA. Under Setups / Editors > Editors > Resource File Editor. See Resource File Editor for details about using the Resource File Editor.

NOTE: The Resource File is located in the root directory of the deployment folder and should only be edited by a system administrator.

Modifying Web Search Result Column Headings

To make alias entries in the Resource File…

  1. In GNA, select Setups /Editors > Editors > Resource File Editor.
  2. In the Resource File Editor select File > Open…
  3. Navigate to the root directory of your deployment; in the ResourceFiles folder, select the GovernNet.en.resources resource file.
NOTE: Editing Resource files should only be done by qualified individuals with Administrator privileges.

In the Resource File, the function that you will be looking for is called WEB_CO_SEARCHPANEL. This function is located in the Web (WB) module of the Resource File.

4. In the column on the left hand side; click on the “+” beside WB to expand it and view all the functions within the module, or perform a search for the string with the find menu option. See
5. When the WEB_CO_SEARCHPANEL function has been located, click to select it; the keys will be displayed in the pane on the right hand side.

Format for Entering the Alias Key

When the keys for the aliases are entered into the function, they must be named in a format that the system is expecting. The format to be used is as follows:

COLmyHEADING_CH

Where myHEADING is the title of the column in the table. The entry is padded with “COL” on the left hand side and “_CH” on the right hand side. For example if we wanted to enter a column title called SUBD, the entry would be COLSUBD_CH the alias title to be used will be Division.
NOTE: The COL and _CH padding are mandatory for your entry to be recognized by the system.

To make your entry you will need to use the Resource File Text Editor. In the Resource File Text Editor, the Label parameter will contain the “padded” key entry, and the alias that will be used is entered in the text section of the form.
To add an alias to the function…

  1. To add an alias to the WEB_CO_SEARCHPANEL function, on the left hand side, right click on the function name; select Add Entry… from the floating menu.
  2. In the Resource File Text Editor, enter the column name into the Label parameters.
  3. Enter the alias column name in the English String and other language parameters.
  4. Click OK to accept the change.

When entered, this aliased column title will be displayed online.

NOTE: Unlike the the column titles in Govern, titles will be displayed as they are entered, i.e. in both upper and lower cases.

 

NOTE: All column header aliases will apply to all search style queries containing the same field name or alias name. In addition, search style queries using aliases are required to use the alias name instead of the field name in the table.

See Also

Dynamic Search Objects
Dynamic Search Styles
Dynamic Search Groups

 

 

103-ED-015

 

0 votes, average: 0.00 out of 50 votes, average: 0.00 out of 50 votes, average: 0.00 out of 50 votes, average: 0.00 out of 50 votes, average: 0.00 out of 5 (0 votes, average: 0.00 out of 5)
You need to be a registered member to rate this.
Loading...

Dynamic Search Groups

Dynamic Search Groups

Overview

The Dynamic Search Group management tool is used to group together multiple Dynamic Search Styles. The Dynamic Search Group management tool consists of two parts:

  • Available Groups: The existing groups appear in the Available Groups list box (1). To view the details on a group, highlight it in the list.
  • Search Groups: The Search Groups tab displays details on the selected group (2).

Groups

Creating a Group

To create a group:

Read More...

Click New to reset the form; so that you can enter new data.

  1. In the Code field, enter a string, with a maximum of 15 characters, to identify the style in the database.
  2. In the English Short Description field (or the Short Description field of your first language), enter a description to a maximum of 25 characters.
  3. In the English Long Description field, enter a description to a maximum of 50 characters.
  4. Repeat steps 4 and 5 for the French, Spanish (or second) language fields.
  5. Select the styles to link to the group, using the Add button.
  6. Click Add, under the Available Groups list box to add it to the list.

Modifying a Group

To modify a group:

  1. Highlight the group in the Available Groups list box.
  2. Make your change on the form.
  3. Click Save.

Changing the Style Order

To change the order of the linked styles:

  • Click Up to move the style towards the top of the list; so that it is performed nearer to the beginning of the sequence.
  • Click Down to move the style towards the end of the list; so that it is performed closer to the end of the sequence.
  • Click Add to open a secondary form where you can select styles to add to the group.
  • Highlight the style or styles that you want to add and click Add on the secondary form.
  • To remove a style, highlight it in the Linked Styles list box and click Remove.

Deleting a Group

To delete a group:

  1. Highlight the object in the Available Group list box.
  2. Click Delete.

See Also

Dynamic Search Objects
Dynamic Search Styles
Dynamic Search Groups

 

103-ED-016

 

0 votes, average: 0.00 out of 50 votes, average: 0.00 out of 50 votes, average: 0.00 out of 50 votes, average: 0.00 out of 50 votes, average: 0.00 out of 5 (0 votes, average: 0.00 out of 5)
You need to be a registered member to rate this.
Loading...

Govern Search

Govern Search

Overview

In Govern, basic searches are preset queries that are submitted to the database. The search process is one of the key functions in Govern. The search function allows you to retrieve datasets from the database. Further actions such as creating permits, attaching messages, generating licenses, generating mailing lists, etc. can then be performed on the records in these datasets. The Predefined Searches pane is the main user interface for performing searches on the database. In addition other search methods and tools have been added to Govern to enhance the user experience. See Advanced Search, Quick Search and Saved Datasets, and Ribbon Search.

Predefined Searches

Predefined Searches are queries that have been preset for the user. When a search is performed, you are querying the database based upon your specified criteria. For example, a search by Parcel ID (P_ID) will return all records with a P_ID or a P_ID that matches a specified parameter. As searches can produce numerous results, these results can be controlled with the value specified in the Max. Records parameter in the User Registry. For example when the Max. Records parameter is used, i.e. a value of 25 is specified, only the first 25 records are used. If there are more records, they are discarded. Additional sorting can occur, but only on the records obtained. See Sorting Search Results by Column Heading below for details.

Search Pane Command Buttons

Begin the Search

Click this icon to perform your search based upon your selected criteria.

Select / Deselect All

When search results are obtained, they are listed in the search pane. By default the results are all selected. Click the Deselect All icon to deselect all results; this will allow you to select only select records.

NOTE: The Select All and Deselect All icons alternate depending on whether all search results are selected, or deselected.

Clear

Click Clear to clear the Search Results pane of all records.

Load Selected Parcel(s)

When this icon is selected, the search results records are transferred to the Dataset Treeview pane.

TIP: When you enter information into any of the search parameters, clicking Enter will start the search and automatically load results to the Treeview.

Clear and Save to External Tables

Click to save the search results to one of the three (3) External tables (i.e. PM_EXTERNAL, NA_EXTERNAL, and PC_EXTERNAL).

Append to External Tables

To add or append the currently listed search results to the results that are listed in the Dataset Treeview pane, click this icon.

Print

Click Print to display the Print dialog box and print out the results of your query to your default Windows printer.

Export to Excel

Click to export the results of your query to a Microsoft Excel file that has not been formatted. See Export Search Query Results to a Microsoft Excel File below for details.

NOTE: This feature will only work when Microsoft Excel is installed on the system that Govern for Windows is installed on. Users must have a valid license for Microsoft Excel.

To restore the search form…

  1. Click the View tab in the Ribbon.
  2. Under the predefined Searches section select one of the Groups or Styles searches.
  3. When the search form appears, it will not be in auto-hide mode. Click the Auto Hide (Pin) icon to restore the form to auto-hide mode.

Export Search Query Results to a Microsoft Excel File

After performing a search query, you may want to perform further analysis on the records that were retrieved, e.g. review the tax map numbers or certificate numbers, etc.

To save search query results to a Microsoft™ Excel file…

  1. Move your pointer over the Predefined Searches auto-hide pane.
  2. Complete the necessary parameters and click the Search icon to perform a search.
  3. Click the Export to Excel button.
  4. When the save dialog box appears; specify the name of the Excel file and the location that it will be saved in.
  5. Once a name has been given, click Save to save the file.
  6. Next you will be given the option to open the file immediately in Excel; click Yes to open the file in Excel.

The records that are exported to Excel will not be formatted, i.e. only default fonts and alignments will be used.

NOTE: This feature requires that a version of Microsoft Excel must be installed on the same system that Govern for Windows is installed on. Users must obtain a valid license for Microsoft Excel.

Search Command button grouping

The Search Pane command buttons are grouped for clarity and to accommodate the command buttons for functionality that is related to the mobile version of Govern. There are two (2) groups of command buttons; Search-related, and Output-related buttons.

How to Search

The search process is one of the key functions in Govern. The search function allows you to retrieve datasets from the database.
To perform a search…
1. Click Pre-defined Searches in the Ribbon.
2. In the drop-down menu, click Groups search or Styles search.
3. In the Predefined Searches form, click Property Search to view the drop down menu.
4. Select Property Search (A).
5. Under Property Search are options to select a search criteria; select By Tax Map.

TIP: When using Predefined Searches press the Tab key to quickly move your cursor from field to field for quick entry.

 

NOTE: Users Accessing Govern Remotely
should note that parameters with field masks that are designed to accept hyphen separated entries entries, e.g. Telephone Numbers, Tax Maps, will display in OpenForms as a parameter with individual fields. These individual fields can be accessed with the Tab key.
The Field Mask for the above would look like the following “XXX-”XXX-XXX-X”, each of the grouped X’s are separated. Users that are accessing Govern over a Remote Link, e.g. VPN should pay attention to the tab sequence when pressing the Tab key to jump to the next parameter. Over a remote connection, in the Tax Map parameter, the tab key will not move the cursor to the next field of the Tax Map number, rather it will jump to Include the Inactive parameter. This behavior only applies to remote connections to Govern.

7. When the search is complete, the results are displayed in the Search Results pane.6. Click the Search icon.

NOTE: When you enter information into any of the search parameters, click Enter to start the search; search results will be automatically transferred to the Treeview.

 

NOTE: Only a maximum of 25 search results are displayed; this can be modified under Options > Max. Records.

Search Criteria

8. Click the option for Load to the Search Result. The results are loaded into the Dataset Treeview pane; you can also populate the Dataset Treeview automatically by selecting any parameter and clicking on Enter on your keyboard.
The Search Criteria will display the search parameters that have been configured with the Search Type.

Search Result Pane

When a search is performed, the Search Results pane displays the results in a grid below the Search and Search Criteria areas.

TIP: When you enter information into any of the search parameters, clicking Enter will start the search and force search results to automatically transfer to the Treeview.

Transfer Individual Files to the Treeview

At times you may require a single file to be loaded / displayed in the Dataset Treeview. This situation can arise when you have multiple results in your Search Query Results dataset. and the requirement is to look at each record one at a time.

To load a single record into the Dataset Treeview…

  1. Place your mouse pointer over the Pre-defined Searches auto-hide tab; complete the parameters to perform a search.
  2. Click the Search icon (A).
  3. In the Search Result pane (A), double-click on the individual record that you would like transferred to the Dataset Treeview pane (B).

When an individual file is transferred to the treeview, any previous dataset will be overwritten and replaced with the single file that was selected.

Sorting Search Results by Column Heading

Search results can be sorted based upon column headings, and in ascending and descending order.
To sort search results based on the column headings…

  1. Display the Predefined Searches pane.
  2. Perform a search; the results will be presented in the Search Results pane.
  3. Note the column that you would like to sort your results on; click on the column heading (A) to sort in ascending or descending order.

The direction of the arrowhead in the column head will indicate the direction of the sort. When the arrowhead is pointing upward, the sort is ascending, when the arrowhead is pointing downwards, the sort is descending. A click on the column heading will switch between ascending and descending.

The result will be sorted based on the column heading that you are using. When there are empty grids, i.e. NULL characters, those records are presented first when the sort is ascending, last if they are descending.

What’s New

Quick Search (Govern 6.0 Suite release 6.0.1707 / 6.1.1707)

As of release 6.0.1707 / 6.1 1707, an alternate search interface is available to the Govern user. The Quick Search differs from the traditional search interface in the sense that it bears a closer similarity to the search interface that is often associated with search engines. When correctly configured, this search interface is available through the Govern ribbon. In addition to the Quick Search feature is a new GNA editor. The Quick Search Index Configuration Editor is for configuring the Search Indexes that are used by the Quick Search. Click for Details on the Quick Search or the Quick Search Index Configuration Editor.

Hide Search Toolbox (Govern 6.0 Suite release 1503.341)

This is a User Interface feature that will disable the default behavior of a persistent Search Toolbox. Typically, after performing a search followed by a Load action, you have to click on a form, or Tree view pane to hide the Search Toolbox. Now a Load from a Search or a Load from a Saved Data set will immediately hide the Search toolbox. Exceptions that override this feature are, if after performing a search, you Append to the Tree view, the Search pane will not hide. This feature is enabled through a “toggle”, i.e. ON/OFF, button. Options (tab) > Hide Search Toolbox.

NOTE: This feature has no impact when the Search Toolbox pane is docked, i.e. fixed with the pin icon.

Related Topics

 

 

101-std-fea-004

 

0 votes, average: 0.00 out of 50 votes, average: 0.00 out of 50 votes, average: 0.00 out of 50 votes, average: 0.00 out of 50 votes, average: 0.00 out of 5 (0 votes, average: 0.00 out of 5)
You need to be a registered member to rate this.
Loading...