JavaScript Report






Run the report generator with  ⟶  Reports  ⟶  Report Script Editor 
The report library is based on JavaScript and HTML for maximum flexibility.
Select an example report from the library using

Augean Script Editor interface displaying the Choose Script dialog, allowing genealogists to select pre-built templates like List Persons to begin building custom JavaScript reports.





Report Filters

By default, all persons are included in the report,
Add a search filter to restrict the persons /families to included in the report.
Add a search filter
Clear the search filter
Max Size   Limits the size of each collection in the report. ( Collection of Persons / Families / Sources / Media / Notes )

 Restricting the size of the report, helps as we debug and build the script.
Large collections of Persons / Families / Sources / Notes / Media can be a resource hog on the browser.
Setting the Max Size as 3, will restrict the size of each collection to 3.
When you want to include everything set the size to a large number.

The search filter will only include persons shown in the filter table.
In this example, we use the search filter "@portrait sitch" and to filter on persons who have a portrait and the name 'sitch'
See also  Searching 


In this example, we use to filter on  Francis Friend, born before 1900 with media 
The filter only returns 2 persons, so just 2 persons will be included in the report.

Report Script Editor alongside the Filters pane in Augean, demonstrating how to optimize performance and target specific research by limiting custom genealogy report data using search filters.


Show the report in a new window
Show the report in a new browser tab

The generated report shows only those persons in the current filter

Generated custom HTML genealogy report displayed in a web browser, showing interactive features where clicking an ancestor reveals detailed pop-ups of their source media and records.


 The report is interactive, click on each person, and a window will appear showing the person.




Report Variables

views the list of report variables that may be included in the report.

Report Variables reference dialog in the Augean tool, helping users find the correct JavaScript variables to programmatically extract specific GEDCOM data for their custom family history reports.


views the report macros (shortcuts).

Report Macros panel in the Augean scripting tool displaying coding shortcuts that map to JavaScript print commands, simplifying the process of generating HTML tables for custom reports.


 The macro HR adds a horizontal line in the report.

Report Macros search tool in Augean showing the HR shortcut mapping to the HTML horizontal rule tag, aiding users in visually formatting their custom genealogy reports.




Fixing Errors

If you encounter an error, it may be caused by incorrect JavaScript.
Click on to show the line where the error is.
Click on to debug the script, and show the actual JavaScript after the  Report Pre-Processor  has run.
Viewing the JavaScript can help identify the error.

Augean scripting debugging workflow showing a syntax error in the code editor alongside the Report Pre-Processor view and error log to help genealogists identify and fix broken JavaScript.


Fix the report by placing the string in quotes.

Corrected JavaScript code snippet in the Augean Script Editor, illustrating how to properly wrap HTML tags in single quotes to resolve syntax errors during custom report generation.