HomeReports in EvergreenEditing and Creating TemplatesThe Template Editor

4.1. The Template Editor

All reports within Evergreen begin with creating a template.  Templates identify a report’s:


Template Editor Window  

The Template Editor window is divided into two sections; the Database Source Browser (upper pane) and the Template Configuration section (lower pane). Within the two panes, there are several smaller sub-panes.


 

 

 

 

 

 

 

 



 

Each sub-pane has a specific purpose as noted in the graphic below:


The Database Source Browser

The Database Source Browser displays a list of data sources and allows you to select fields which will display as columns within a report.   It also enables you to select fields for filtering and selection criteria.

 

The Database Source Browser is made up of several parts:

  1. Sources pane – ‘where to find your data’
  2. Field Name pane – ‘what fields to include in the report’
  3. Field transform pane – ‘how you want the field to be viewed’

Sources Pane

This contains a tree view of the source database table and its links to other tables.  If the linked database table contains references to other tables, then those can also be expanded in the tree view.








When a table name is highlighted in the Source Name textbox, the fields of that table are displayed in the Field Name pane.

 

Field Name Pane

Once a table is selected in the Source Name textbox, the table’s fields are listed in the Field Name pane.  The Field Name pane displays the field name and data type of each field.  Any of these fields can be selected for display or filter. 








When a field is highlighted, the Field Transform textbox displays transforms that can be applied to the data.


Field Transform Pane

This pane contains a list of available field transforms for the field that is highlighted in the Field Name pane.   For example, when ‘Daytime Phone” is highlighted, the Field Transform Pane displays the available, valid choices for displaying the field in a report.  These choices are – count (phone numbers can be counted), First 5 characters (the first five characters can be displayed), First Value (the first digit of a phone can be displayed), etc. 

For all field transforms, the “raw data’ output type generally displays the field “as it was typed into the database.”  Appendix B lists all transform definitions within Evergreen.

 

 





The Template Configuration Pane

The Template Configuration pane (bottom half of the Template Editor Window) lists the title of the report template, a report description, the fields that have been selected for a report, as well as any filters/criteria for running a report.  


The Template Configuration Pane is made up of several parts: 

  1. Name and Description Fields
  2. Documentation URL field
  3. Displayed Fields tab 
  4. Base filters tab
  5. Aggregate filters tab 
  6. Source specifier pane 

Name And Description Text Fields









The name and description of the new template should be entered into this pane.  The ‘Description’ field is optional, but it is a good practice to describe the display fields, filters, transforms, and operators used in the template for ease of reference. 

 

 The Name field must contain a name that is unique to the template folder in order to save the template.

Documentation URL

You can add a link to local documentation that can help staff create a report template. To add documentation to a report template, click Admin → Local Administration → Reports, and create a new report template. A new field, Documentation URL, appears in the Template Configuration panel. Enter a URL that points to relevant documentation.

Reports1

The link to this documentation will also appear in your list of report templates.

Reports2a


Displayed Fields Tab

 This tab lists the fields that will be displayed in the report’s output.  The pane shows the column header that will appear in the output which can be changed by highlighting the field and clicking “Alter Display Header”.







 


The “Field Transform” column shows how the data will be displayed.  To change the transform for a field, highlight the field and click “Change Transform”.  The column picker (to the far right of the box) allows you to display “Field Name” and “Field Transform Type” columns.  The “Field Name” column is especially useful in identifying fields after the Display Name has been altered.

 

The “Move Up” and “Move Down” buttons determine the order of the columns in the final output; the field that is listed first will display in the first column of the output.

Base and Aggregate Filters Tabs

Within Evergreen, the filter tabs determine

 

  1. What information will be needed/asked when a report is run; for example, a date range
  2. What values will be used as defaults when running a report; for example, if the report listed all active patrons, the report’s base filter would set the Active? Field to true.


The Base Filter Tab filters upon a single piece of information.  For example, a base filter is set up for a report that includes a date range, each row of information within the database will be compared to the date range and either included or excluded from the report.  In the example below, the report “Count Items by Circulation Modifier” has a base filter where the flag Is Deleted is set to FALSE.  When the report is run, each item’s deleted flag will be reviewed and excluded from the report.

 

 









The Filter Field column displays the friendly name of the field; this name cannot be changed, but is useful for verifying that the filters have been correctly chosen.

 

The Field Transform column displays the transform currently applied to the field; the transform determines how the field will ‘look’ when it is compared against the user-specified value. 

 

The Operator column displays the type of comparison that will be made.  The Change Operator button allows the user to choose different operators, such as “In List,” “Equal to,” “On or Before,” etc...

 

The Value column displays any parameters that have been set up for this filter.  Values can be set or removed using the “Change Value” and “Remove Value” buttons. 

 

The column picker ( to the far right of the box) also allows the user to display Field Name, Data Type,  and Field Transform Type columns.

 

Aggregate Filter Tab

The Aggregate Filters tab lists fields that have been selected to be filtered across numerous items/patron rows, etc.  For example, a report for all items that have more than 10 holds for the month is needed.  An aggregate filter would be needed to create this report, where the aggregate filter includes a “count of the number of holds over a given number”.  The reports program will sum all the rows of items and then apply that sum to display the rows of items that meet the criteria.

Source Specifier

This pane displays the data sources that are are used as Displayed Fields or Base or Aggregate Filters.  When a single source is highlighted with the Displayed Fields tab, only fields from that table are visible in the Displayed Fields, Base filters, and Aggregate Filters tabs.

 








**To select a source, click on it.  To ‘re-display’ all data sources, click CTRL-CLICK.

Field Hints

Descriptive information about fields or filters in a report template can be added to the Field Hints portion of the Template Configuration panel. For example, a circulation report template might include the field, Circ ID. You can add content to the Field hints to further define this field for staff and provide a reminder about the type of information that they should select for this field.

To view a field hint, click the Column Picker, and select Field Hint. The column will be added to the display.

Reports2

To add or edit a field hint, select a filter or field, and click Change Field Hint. Enter text, and click Ok.

Reports3


Knowledge Tags

This page was: Helpful | Not Helpful