Reporting Workflows - Draft

Owned by Megan Forbes
Last updated: Jul 05, 2011 by Patrick Schmitz (Unlicensed)Version comment
2 min read

Reporting Administration Workflow

  1. User selects the Reporting Tab under the Administration menu item
  2. A list of all previously uploaded reports is available on the left, in alpha order

To create or edit:

  1. The create new button at the top right of the report list is selected
  2. A blank schema is created
  3. User fills in the title and description
  4. User enters in the filename for an existing report (which has previously been copied to the proper directory on the server).
  5. User selects one or more record types (objects and/or procedures) from which the report may be run
  6. User selects the checkbox or radio button for "Single Item," "List of Items," "Group of Items," or "No Context." Please note that only one checkbox or radio button may be selected.
  7. If "No Context" checkbox is selected, RUN button at the bottom of the form is activated

To run report from the Admin interface:

  1. User clicks on report name in left menu
  2. User selects RUN button at the bottom of the form
Definitions:
  • A "single item" report is a report run from the context of a single record. The report returned may be a record about that single procedure (e.g. a deed of gift for an acquisition) or about records related to that procedure (e.g. all the objects related to an intake).
  • A "list of items" report is a report run from a set of items selected from search results.
  • A "group of items" report is a report run from the Group procedure
  • A no context report is a report that comes from neither a single procedure nor search results (e.g. a list of all outstanding loans); these reports may be run from the administrative interface.

Note: For release 1.9, only "single item" and "no context" reports will be supported in the user interface.

Questions:

Until we're able to link up reporting with search results, should activation of "Run with Single" lead to deactivation of "Run with List"?

Answer (from Patrick): A report can currently only have a single invocation context (one of {single/list/group} and one {Document-Type}). However, in practice, any report that can run with a list can probably handle a list of 1. We can talk more about the details of this. My current thinking is that the user can create two report instances in CSpace, one for single, and one for list, both of which point to the same jasper report template. Does this seem too awkward?

Reporting Within Procedures Workflow

  1. User enters a procedure
  2. User selects a report from the dropdown on the right sidebar (reports available are configured via reporting admin)
  3. User selects "create button"
  4. Confirmation dialogue appears
  5. User confirms choice
  6. Report runs

Reporting from Search Results Workflow

  1. User runs a keyword or advanced search
  2. User selects (via checkbox) those records in the search results that should be included in the report
  3. User selects report type from dropdown on right side of search results page