Admin Reports Search

Admin Reports Search
Summary	Adds search features and results table columns to the Admin>>Reports>>Search page, and tweaks the Admin>>Reports>>Edit form so that it can both edit existing reports and add new reports.
Validation
Mod Updated	2 Nov 2021
Download link	v13.0.0.6.zip TNG 13.0 TNG 13.1.0 v12.0.0.4b.zip TNG 12.0 See the Revision History for older versions
Download stats
Author(s)	Robin Richmond
Homepage	this page
Mod Support	My Mod Support form or TNG Community Forums
Contact Developer	My Mod Support form
Latest Mod	13.0.0.6
Min TNG V	9.2.2
Max TNG V	13.1
Files modified	admin_reports.php, admin_editreport.php, admin_addreport.php, English cust_text.php May Install rrshared_innermodmenu3.php, rrshared_modsettingsblocks3.php, rrshared_wikilogo.gif
Related Mods	Reports Action Queries, Reports-Floating Editor, Reports-Floating Results
Notes

Purpose of the Mod

To improve the usability of the Admin>>Reports>>Search page.

1. Field Buttons have been added to the Search string and to the Results Per Page Field
2. A new radio button set lets you specify that matching reports must have or must not have a direct SQL query.
3. A new 'Result per Page' field lets you specify a value that is different from the TNG System Variable

• Four new columns to the results table provide details about each report:
  1. # of Display fields in the report definition,
  2. # of Criteria elements in the report definition,
  3. # of Sort fields in the report definition, and
  4. A 'Direct SQL' column that indicates whether the report contains a direct SQL statement, and that displays the entire SQL query when you hover over a 'Yes' in the 'Direct SQL' column

Mod Conflicts

No known incompatibilities. This mod is compatible with Reports Action Queries, which is the only other published mod that claims to modify the Admin>>Reports>>Search page.

Dependencies

This mod saves data that can be used by the utility mod Show Mod Names, but is not dependent onShow Mod Names. There are no known dependencies on other mods.

Related Mods

• Inner Mod Menu
  • This mod defines an "Inner Mod Menu" that that pulls down information about the mod from the label "Mod Information" on the right end of the Admin Reports page's "inner menu" (just below the tab menu). Most of my Admin mods have (or will have) Inner Mod Menus. In all cases, the menu appears only if the Inner Mod Menu mod has been installed. See a visualization below.
• I have written three other mods that affect reports:
  1. Reports-Floating Editor makes better use of large computer screens when reports are being edited (at Admin>>Reports>>Edit). It allows the blocks of form fields that build the report to float side-by-side on the computer screen so that more of them can be seen at once. It also can unclutter the screen significantly by hiding either the report-building fields or the direct SQL field, since they can't really be used together. Reports-Floating Editor affects only the Report Editor, admin_editreport.php.
  2. Reports Action Queries allows SQL Action Queries to be run in the TNG Reports system. It affects the Admin>>Reports>>Search page (admin_reports.php) and showreport.php.
  3. Reports-Floating Results allows narrow reports to wrap into side-by-side report columns so that more data can be seen on the screen or printed page. It affects only showreport.php.

Installation

[Show Installation Details]

Requirements

• A working TNG installation.
• An installed current version of the Mod Manager.
• You should backup files listed in the panel on the right.

Procedure

1. Remove and delete previous version of this mod.
2. Backup the files updated by this mod. They are listed in the panel at the upper right.
3. Download the .zip file, Extract its .cfg file to the mods folder.
4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files.

Problems?

1. Try using the Mod Manager Remove capability
2. Contact me through My Mod Support form.

[Hide Details]

Visualizations

BEFORE The unmodified Admin>>Reports>Search screen

AFTER Highlighting the new elements in the form and the results table The new 'Add New' button is disabled, since there is no value in the 'Search For' field. (The 'Add New' button has no benefit over the 'Add New' tab unless there is a search string. The new 'Results per page' field whose default value is the TNG system parameter (or the last value you specified for this field. Four new columns in the results table. The 'Search for' and 'Results per page' fields have attached "field buttons", most of which are shaded out. See the Field Buttons mod and a visualization below. The red words "Update Query" in this screen shot are a glimpse of the Reports Action Queries mod.

AFTER Showing pop-up SQL Code The SQL code pops up when you hover over a cell in the Direct SQL? column. It pops up right above the information about the record it applies to. The width of the SQL code block varies with the page width, but at some widths, the SQL code block might be cut off on the left. When that happens, just drag the right edge of the browser window to make it a little bigger or smaller.

AFTER Field Buttons If you have not installed the Field Buttons mod, the field buttons will not appear at all (even when they would otherwise be shaded out). The Field Buttons mod is completely optional. The 'Search for' field can have an 'X' button and/or an 'R' button. The 'X' button is visible when there is a search string. You can click it to clear the search string value. The 'R' button is visible if the search string value has changed since the screen was loaded. You can click it to restore the initial value. The 'Results per page' field can have 'R' 'D', and/or 'A' buttons. The 'R' button works the same way as it does with the 'Search for' field. The 'D' button is visible when the 'Results per page' value different from the TNG system parameter 'Max Search Results'. You can click it to set that default value. The 'A' button is visible when the 'Results per page' value is not 'all' (which, as you would expect, that all of the search matches should be displayed on one page). You can click on it to set the value 'all'. See the Field Buttons Wiki article for more information.

Revision History

Mod Version	TNG Version	Date	Note
13.0.0.6	13.0 - 13.1	02Nov2021	Moved the warnings (both types of reports, no content) into the Name, Description column & placed the counts of each of the three report parameters item in the results table
13.0.0.5	13.0 - 13.1	30Sep2020	Changed one target location search string to accommodate a new isset() function call in TNGv13
12.0.0.4b	12.0 - 12.3	28Mar2020	This is a very minor change, with no changes to the functionality of the Admin Reports search page. This version updates the mod to version 5 of my shared mod include files. It also displays a "What has changed" message for this mod in the Admin Reports Search Inner Mod Menu.
12.0.0.4a	12.0 - 12.2+	15Dec2019	No Functional Changes - Upgraded to version 3 of the shared mod libraries
12.0.0.4	12.0 - 12.2+	2Oct2019	Added field buttons and the inner mod menu
11.0.0.3, 12.0.0.3	11.*, 12.0+	13May2018	Restored the normal 'Add New' tab, removed the 'Add New' button from earlier versions, and brought a copy of the mod into compliance with TNGv12.
Admin Reports List 10.1.0.1	10.1-11.1 (at least; I believe that it should work for TNGv9 and TNGv10.0)	4May2017	Visible changes: Added 2 more display columns: The # of criteria elements, and the # of display fields, Added a pop-up to the Direct SQL column that shows the stored SQL query. Plus these internal changes: Makes sure that all fields are initialized in the Add New Report form. Fixed a JavaScript comment that was formatted like a PHP comment, and was showing up on the screen. Added (optional) Show Mod Names functionality Changed admin_addreport.php, which creates a new report, so that it redirects to the report editor rather than to back to the search page.
9.2.2.1 download	9.2.2 - 10.1 (at least; I believe it works at least through TNGv11.1)	17Jan2015	Initial release.

Sites using this mod

If you download and install this mod, please add your site to the table below.

URL	User	Note	Mod-Version	TNG-Version	User-language
Robin Richmond's Genealogy Database	Robin Richmond	Mod developer	13.0.0.6	13.1	English
DJCM.DK	Claus Martinussen		9.2.2.1	10.1.3	Danish, English
Wortelboer Genealogy	Bernard Wortelboer		9.2.2.1	10.1.3	Dutch, English