This document is under construction.  Please feel free to direct discussion to the PINES-DEV or OPEN-ILS-DEV mailing lists.  If anyone would like to help us with documentation, please inquire at feedback@open-ils.org

====== The report interface ======

First, access the reporting interface from Admin -> Local System Administration -> Reports

===== Creating sub-folders =====

Then, in the "My Folders" box, create a sub-folder in Templates.  Do this by clicking on the "Templates" link.  Note that "Templates" will appear with a document icon next to it; this means that it is a folder that does not yet contain anything.  The icon will change in a few steps.

{{:evergreen-user:creating_template_folder1.jpg|Step 1}}
{{:evergreen-user:creating_template_folder2.jpg|Step 2}}

Then enter a label for your folder in the Folder Name field and click "Create Sub Folder".

{{:evergreen-user:creating_template_folder3.jpg|Step 3}}

An "Action Complete" alert should appear.  After clicking through that alert, the screen should refresh and your sub-folder should be under My Folders -> Templates.  Note that the icon for "Templates" has changed from a document icon to a folder icon; this means it contains something.  Click on the brown triangle to expand the Templates folder and view the sub folders.

{{:evergreen-user:creating_template_folder4.jpg|Step 4}}

Now repeat these steps and create sub-folders for both the "Reports" folder and the "Output" folder in the "My folders" box.  A good practice is to create a sub-folder of the same name in each of the 3 top-level folders.

{{:evergreen-user:creating_template_folder6.jpg|Step 5}}

===== Creating Templates =====

==== The different parts of template creation ====

Select the sub-folder you just created from the My Folders -> Templates folder.

{{:evergreen-reports:template_step1.jpg|Step 1}}

Click on the "Create a new Template for this folder" link.

{{:evergreen-reports:template_step2.jpg|Step 2}}

From this screen you will create the actual template.  I'll go through each part of the interface very briefly and then go into details.

{{:evergreen-reports:template_step3.jpg|Step 3}}

This is where you enter the name of your template.

{{:evergreen-reports:template_step3_name.jpg|Step 3a}}

This is where you enter a description for your template.

{{:evergreen-reports:template_step3_desc.jpg|Step 3b}}

This is where you choose the type of template (ie. circ, patron, inhouse use, etc.)  We'll revisit this dropdown menu in a moment.

{{:evergreen-reports:template_step3_type.jpg|Step 3c}}

These are the different objects and fields that you can choose for both selection (filter) criteria and report output.  This list changes based on the type of template you have selected.

{{:evergreen-reports:template_step3_attributes.jpg|Step 3f}}

This box will list the fields you choose to display in your report.

{{:evergreen-reports:template_step3_display.jpg|Step 3d}}

This box will list the fields you wish to filter on.

{{:evergreen-reports:template_step3_filters.jpg|Step 3e}}

This box lists special filter criteria on summarized (aggregated) information.

{{:evergreen-reports:template_step3_agg_filters.jpg|Step 3f}}

==== The template types ====

{{:evergreen-reports:template_types.jpg|Template Types}}

Here we will go over the different Template Types and create sample reports for each.  The first three we should go over is Item, Bibliographic Record, and ILS User.  These "entity archetypes" (abstract representations of objects, things, people) are often included in other template types, such as Circulation and Hold Request.  If you learn the meaning of the different fields for those base entities, then it'll be easier later to create reports that reach across multiple entities.

  * [[evergreen-reports:ils_user|ILS User]]
  * [[evergreen-reports:item|Item]]
  * [[evergreen-reports:bibliographic_record|Bibliographic Record]]

  * [[evergreen-reports:hold_request|Hold Request]]
  * [[evergreen-reports:hold_transit|Hold Transit]]

  * [[evergreen-reports:in_house_use|In House Use]]
  * [[evergreen-reports:noncataloged_in_house_use|Non-cataloged In House Use]]

  * [[evergreen-reports:circulation|Circulation]]
  * [[evergreen-reports:noncataloged_circulation|Non-cataloged Circulation]]