* xref:reports:introduction.adoc[Reports]
-** xref:reports:reporter_daemon.adoc[]
-** xref:reports:reporter_folder.adoc[]
-** xref:reports:reporter_create_templates.adoc[]
-** xref:reports:reporter_generating_reports.adoc[]
-** xref:reports:reporter_view_output.adoc[]
-** xref:reports:reporter_cloning_shared_templates.adoc[]
-** xref:reports:reporter_add_data_source.adoc[]
-** xref:reports:reporter_running_recurring_reports.adoc[]
-** xref:reports:reporter_template_terminology.adoc[]
-** xref:reports:reporter_template_enhancements.adoc[]
-** xref:reports:reporter_export_usingpgAdmin.adoc[]
+** xref:reports:reporter_daemon.adoc[Starting and Stopping the Reporter Daemon]
+** xref:reports:reporter_folder.adoc[Folders]
+** xref:reports:reporter_create_templates.adoc[Creating Templates]
+** xref:reports:reporter_generating_reports.adoc[Generating Reports from Templates]
+** xref:reports:reporter_view_output.adoc[Viewing Report Output]
+** xref:reports:reporter_cloning_shared_templates.adoc[Cloning Shared Templates]
+** xref:reports:reporter_add_data_source.adoc[Adding Data Sources to Reporter]
+** xref:reports:reporter_running_recurring_reports.adoc[Running Recurring Reports]
+** xref:reports:reporter_template_terminology.adoc[Template Terminology]
+** xref:reports:reporter_template_enhancements.adoc[Template Enhancements]
+** xref:reports:reporter_export_usingpgAdmin.adoc[Exporting Report Templates Using phpPgAdmin]
-== Introduction ==
+= Introduction =
+:toc:
+
Learn how to create and use reports in Evergreen.
-== Adding Data Sources to Reporter ==
+= Adding Data Sources to Reporter =
+:toc:
indexterm:[reports, adding data sources]
definition in _fm_IDL.xml_. You can use this method if you want to be able to
access this data source through directly through SQL or using other reporting tool.
-=== Create a PostgreSQL query, view, or table for your data source ===
+== Create a PostgreSQL query, view, or table for your data source ==
indexterm:[PostgreSQL]
where u.active = 't' and u.deleted <> 't';
------------------------------------------------------------
-=== Add a new class to fm_IDL.xml for your data source ===
+== Add a new class to fm_IDL.xml for your data source ==
Once you have your data source, the next step is to add that data source as a
new class in _fm_IDL.xml_.
copy of you local class definitions so that you can reapply the changes to
_fm_IDL.xml_ after Evergreen upgrades.
-=== Restart the affected services to see the new data source in the reporter ===
+== Restart the affected services to see the new data source in the reporter ==
The following steps are needed to for Evergreen to recognize the changes to
_fm_IDL.xml_
-== Cloning Shared Templates ==
+= Cloning Shared Templates =
+:toc:
indexterm:[reports, cloning]
[[reporter_creating_templates]]
-== Creating Templates ==
+= Creating Templates =
+:toc:
indexterm:[reports, creating templates]
is transformed and displayed, and the filters used will vary depending on your
needs.
-=== Choosing Report Fields ===
+== Choosing Report Fields ==
indexterm:[reports, creating templates, choosing reports fields]
image::media/create-template-23.png[create-template-23]
-= [NOTE] =
+[NOTE]
+======
Note the _Change Transform_ button in the bottom left hand pane. It has the same
function as the upper right _Field Transform_ pane for fields that have already
been added.
======
-=== Applying Filters ===
+== Applying Filters ==
indexterm:[reports, applying filters]
circulations for a specified time frame. The time frame in the template will be
configured so that you can change it each time you run the report.
-==== Using Base Filters ====
+=== Using Base Filters ===
indexterm:[reports, applying filters, base filter]
-== Starting and Stopping the Reporter Daemon ==
+= Starting and Stopping the Reporter Daemon =
+:toc:
indexterm:[reports, starting server application]
The reporter daemon periodically checks for requests for new reports or
scheduled reports and gets them running.
-=== Starting the Reporter Daemon ===
+== Starting the Reporter Daemon ==
indexterm:[reporter, starting]
start the daemon automatically at start up time.
=============
-=== Stopping the Reporter Daemon ===
+== Stopping the Reporter Daemon ==
indexterm:[reports, stopping server application]
-== Exporting Report Templates Using phpPgAdmin ==
+= Exporting Report Templates Using phpPgAdmin =
+:toc:
indexterm:[reports, exporting templates]
easily import this data into the templates folder to make it available in the
client.
-=== Dump the Entire Reports Template Table ===
+== Dump the Entire Reports Template Table ==
The data exported in this method can create issues importing into a different
system if you do not have a matching folder and owner. This is going to export
. Click _export_ button at the bottom
. A text file will download to your local system
-=== Dump Data with an SQL Statement ===
+== Dump Data with an SQL Statement ==
The following statement could be used to grab the data in the folder and dump it
[[reporter_folders]]
-== Folders ==
+= Folders =
+:toc:
indexterm:[reports, folders]
image::media/folder-1.png[folder-1]
[[reporter_creating_folders]]
-=== Creating Folders ===
+== Creating Folders ==
indexterm:[reports, folders, creating]
If it is not a shared folder there will be nothing after the folder name. You
may create as many folders and sub-folders as you like.
-=== Managing Folders ===
+== Managing Folders ==
indexterm:[reports, folders, managing]
[[generating_reports]]
-Generating Reports from Templates
-----------------------------------
+= Generating Reports from Templates =
+:toc:
indexterm:[reports, generating]
+
Once saved, reports stay there forever unless you delete them.
-=== Viewing and Editing Report Parameters ===
+== Viewing and Editing Report Parameters ==
New options to view or edit report parameters are available from the reports folder.
[[recurring_reports]]
-== Running Recurring Reports ==
+= Running Recurring Reports =
+:toc:
indexterm:[reports, recurring]
-== Template Enhancements ==
+= Template Enhancements =
+:toc:
-=== Documentation URL ===
+== 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.
image::media/2_7_Enhancements_to_Reports2a.jpg[Reports2a]
-=== Field Hints ===
+== 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.
-== Template Terminology ==
+= Template Terminology =
+:toc:
-=== Data Types ===
+== Data Types ==
indexterm:[reports, data types]
The information in Evergreen's database can be classified in nine data types, formats that describe the type of data and/or its use. These were represented by text-only labels in prior versions of Evergreen. Evergreen 3.0 has replaced the text labels with icons. When building templates in _Reports_, you will find these icons in the Field Name Pane of the template creation interface.
-==== timestamp ====
+=== timestamp ===
image::media/datatypes_timestamp.png[]
An exact date and time (year, month, day, hour, minutes, and seconds). Remember to select the appropriate date/time transform. Raw Data includes second and timezone information, which is usually more than is required for a report.
-==== link ====
+=== link ===
image::media/datatypes_link.png[]
A link to another database table. Link outputs a number that is a meaningful reference for the database but not of much use to a human user. You will usually want to drill further down the tree in the Sources pane and select fields from the linked table. However, in some instances you might want to use a link field. For example, to count the number of patrons who borrowed items you could do a count on the Patron link data.
-==== text ====
+=== text ===
image::media/datatypes_text.png[]
A field of text. You will usually want to use the Raw Data transform.
-==== bool ====
+=== bool ===
image::media/datatypes_bool.png[]
True or False. Commonly used to filter out deleted item or patron records.
-==== org_unit ====
+=== org_unit ===
image::media/datatypes_orgunit.png[]
Organizational Unit - a number representing a library, library system, or federation. When you want to filter on a library, make sure that the field name is on an org_unit or id data type.
-==== id ====
+=== id ===
image::media/datatypes_id.png[]
A unique number assigned by the database to identify each record. These numbers are meaningful references for the database but not of much use to a human user. Use in displayed fields when counting records or in filters.
-==== money ====
+=== money ===
image::media/datatypes_money.png[]
A monetary amount.
-==== int ====
+=== int ===
image::media/datatypes_int.png[]
Integer (a number)
-==== interval ====
+=== interval ===
image::media/datatypes_interval.png[]
A period of time.
[[field_transforms]]
-=== Field Transforms ===
+== Field Transforms ==
indexterm:[reports, field transforms]
[[viewing_report_output]]
-== Viewing Report Output ==
+= Viewing Report Output =
+:toc:
indexterm:[reports, output]
projects / evergreen / pines.git / commitdiff