talk@lists.collectionspace.org

WE HAVE SUNSET THIS LISTSERV - Join us at collectionspace@lyrasislists.org

View all threads

Re: [Talk] Generic Reporting templates for a Core CollectionSpace installation?

CS
C Space
Fri, Dec 16, 2016 6:19 PM

Aron and John,

Thank you both for your extensive and in-depth responses to our question.
There is certainly plenty here to keep us busy for a while.

Much appreciated!

On Fri, Dec 16, 2016 at 7:45 AM, John B Lowe jblowe@berkeley.edu wrote:

Dear C,

Indeed, the "sample reports that ship with CollectionSpace v4.4" that
Aron mentions are a great place to start on making your own reports.

There are a couple other things you might wish to be aware of:

  • There are a few gotchas and obsolete suggestions contained the the Talk
    emails and even in the wiki pages. I'll point out a couple of the items,
    and hopefully others will chime in.

    • you shouldn't copy any .jasper file(s) into the reports directory
      of your CSpace tenant: instead you should place the source .jrxml file(s)
      there and let the CSpace service do the compilation. (The principal danger
      here is that the version of JasperSoft studio you used to create the report
      and its .jasper file may be different and the version of the Jaspersoft
      engine deployed in CSpace may be different, with unexpected consequences.
      Also, it's an unnecessary waste of time to try to manage the .jasper files.)

    • Indeed, contrary to what the docs and email say, you should ensure
      that any .jasper files for your report(s) in the CSpace tenant's reports
      directory are removed -- if you leave an old one there, a new .jasper
      based on your spiffy revised .jrxml file will not be compiled by the
      server and you'll be mystified when you continue to get the same old
      results.

    • there are tools (shell scripts) to do the "installation" of reports
      (i.e. POSTing the required payloads), so you don't have to write the XML
      yourself and create the curl commands.  Indeed, the helper suite contains
      scripts to install, delete, list, etc. reports on your server.

    • you'll probably want to manage the "source code" (.jrxml files) for
      your reports in GitHub; if so, there is a whole wrapper around the
      development and deployment process that you may wish to consider. See
      further below for the UCB approach to this.

    • when you are developing reports locally on your dev system using
      JasperSoft studio, you'll need to ensure that you get correct values for
      database and user -- the values shown in the documents, "nuxeo" and
      "reader", may or may not work -- I feel certain that on a v4.4 deployment
      these values are not valid.  I'm pretty sure that the values will be
      something like "nuxeo_tenant" and "reader_tenant" (where "tenant" is the
      value of your installed tenant). Similarly, you'll need to find out the
      magic "tenant id number" to use in your queries.

  • the instructions for how to configure your Postgres server to accept
    connections from your local dev machine to develop reports using JasperSoft
    Studio are pretty specific to a particular type of CSpace deployment. If
    you are wearing both the system administrator AND report designer hats, you
    can make the suggested config changes (and probably other changes as well);
    otherwise you may need to recruit the help of whoever manages your server
    and get them to make the configuration changes, poke holes in firewalls,
    etc. (Here at Berkeley, for example, we are required to access the Postgres
    servers using "IP tunnels", and a completely different process is required
    to connect.)
  • For reports at UCB, we have developed a process for managing the reports
    we have created, including a detailed checklist and a description of the
    helpers:

https://github.com/cspace-deployment/Tools/blob/master/
reports/iReportBestPractice.md

You may wish to make your own fork of the GitHub repo containing the
CSpace sample reports, in which case you can use substitute your repo
names, etc. in the checklist.

Also note that we at UCB have created 130+ reports, some of them quite
exotic, which might give you inspiration for some of your reports -- as
you'll have noticed, the SQL for reports can get extremely complicated, so
having some "worked examples" can ease the pain.

You can see the reports for the 5 UCB deployments, and the helper scripts,
here:

https://github.com/cspace-deployment/Tools/tree/master/reports

Good Hunting,

John

On Thu, Dec 15, 2016 at 3:59 PM, Aron Roberts aron@socrates.berkeley.edu
wrote:

This June 2016 thread on reporting, from the Talk list, might be a place
to start:
http://lists.collectionspace.org/pipermail/talk_lists.collec
tionspace.org/2016-June/002682.html

As mentioned in that thread, these are the sample reports that ship with
CollectionSpace v4.4, as one possible starting place when looking for
templates:
https://github.com/collectionspace/services/tree/v4.4/
services/report/3rdparty/jasper-cs-report/src/main/resources

Aron Roberts
UC Berkeley

P.S. Of possible relevance, as well:

The user manual pages on reporting, on the CSpace wiki:
https://wiki.collectionspace.org/display/DOC/User+Manual+-+Reporting

Lam Voong's note here, which provides an overview of how to install and
run reports within the CollectionSpace UI itself:
http://lists.collectionspace.org/pipermail/talk_lists.collec
tionspace.org/2016-June/002702.html

Peter Murray's wiki page on how to run reports against a CollectionSpace
installation in Jaspersoft Studio, per Richard Millet's note:
http://lists.collectionspace.org/pipermail/talk_lists.collec
tionspace.org/2016-June/002686.html

And a gentle (albeit not extensive) introduction to the SQL queries used
in reports:
http://lists.collectionspace.org/pipermail/talk_lists.collec
tionspace.org/2016-June/002728.html

On Thu, Dec 15, 2016 at 2:43 PM, C Space cspace@bpoc.org wrote:

Hey all,

Are there generic reporting templates floating around somewhere in the
wiki? If so, could you point us in the right direction?

Thanks!


Talk mailing list
Talk@lists.collectionspace.org
http://lists.collectionspace.org/mailman/listinfo/talk_lists
.collectionspace.org

Aron and John, Thank you both for your extensive and in-depth responses to our question. There is certainly plenty here to keep us busy for a while. Much appreciated! On Fri, Dec 16, 2016 at 7:45 AM, John B Lowe <jblowe@berkeley.edu> wrote: > Dear C, > > Indeed, the "sample reports that ship with CollectionSpace v4.4" that > Aron mentions are a great place to start on making your own reports. > > There are a couple other things you might wish to be aware of: > > * There are a few gotchas and obsolete suggestions contained the the Talk > emails and even in the wiki pages. I'll point out a couple of the items, > and hopefully others will chime in. > > - you *shouldn't* copy any .jasper file(s) into the reports directory > of your CSpace tenant: instead you should place the source .jrxml file(s) > there and let the CSpace service do the compilation. (The principal danger > here is that the version of JasperSoft studio you used to create the report > and its .jasper file may be different and the version of the Jaspersoft > engine deployed in CSpace may be different, with unexpected consequences. > Also, it's an unnecessary waste of time to try to manage the .jasper files.) > > - Indeed, contrary to what the docs and email say, you should ensure > that any .jasper files for your report(s) in the CSpace tenant's reports > directory are *removed* -- if you leave an old one there, a new .jasper > based on your spiffy revised .jrxml file will *not* be compiled by the > server and you'll be mystified when you continue to get the same old > results. > > - there are tools (shell scripts) to do the "installation" of reports > (i.e. POSTing the required payloads), so you don't have to write the XML > yourself and create the curl commands. Indeed, the helper suite contains > scripts to install, delete, list, etc. reports on your server. > > - you'll probably want to manage the "source code" (.jrxml files) for > your reports in GitHub; if so, there is a whole wrapper around the > development and deployment process that you may wish to consider. See > further below for the UCB approach to this. > > - when you are developing reports locally on your dev system using > JasperSoft studio, you'll need to ensure that you get correct values for > database and user -- the values shown in the documents, "nuxeo" and > "reader", may or may not work -- I feel certain that on a v4.4 deployment > these values are not valid. I'm pretty sure that the values will be > something like "nuxeo_tenant" and "reader_tenant" (where "tenant" is the > value of your installed tenant). Similarly, you'll need to find out the > magic "tenant id number" to use in your queries. > > - the instructions for how to configure your Postgres server to accept > connections from your local dev machine to develop reports using JasperSoft > Studio are pretty specific to a particular type of CSpace deployment. If > you are wearing both the system administrator AND report designer hats, you > can make the suggested config changes (and probably other changes as well); > otherwise you may need to recruit the help of whoever manages your server > and get them to make the configuration changes, poke holes in firewalls, > etc. (Here at Berkeley, for example, we are required to access the Postgres > servers using "IP tunnels", and a completely different process is required > to connect.) > > * For reports at UCB, we have developed a process for managing the reports > we have created, including a detailed checklist and a description of the > helpers: > > https://github.com/cspace-deployment/Tools/blob/master/ > reports/iReportBestPractice.md > > You may wish to make your own fork of the GitHub repo containing the > CSpace sample reports, in which case you can use substitute your repo > names, etc. in the checklist. > > Also note that we at UCB have created 130+ reports, some of them quite > exotic, which might give you inspiration for some of your reports -- as > you'll have noticed, the SQL for reports can get extremely complicated, so > having some "worked examples" can ease the pain. > > You can see the reports for the 5 UCB deployments, and the helper scripts, > here: > > https://github.com/cspace-deployment/Tools/tree/master/reports > > Good Hunting, > > John > > > On Thu, Dec 15, 2016 at 3:59 PM, Aron Roberts <aron@socrates.berkeley.edu> > wrote: > >> This June 2016 thread on reporting, from the Talk list, might be a place >> to start: >> http://lists.collectionspace.org/pipermail/talk_lists.collec >> tionspace.org/2016-June/002682.html >> >> As mentioned in that thread, these are the sample reports that ship with >> CollectionSpace v4.4, as one possible starting place when looking for >> templates: >> https://github.com/collectionspace/services/tree/v4.4/ >> services/report/3rdparty/jasper-cs-report/src/main/resources >> >> Aron Roberts >> UC Berkeley >> >> P.S. Of possible relevance, as well: >> >> The user manual pages on reporting, on the CSpace wiki: >> https://wiki.collectionspace.org/display/DOC/User+Manual+-+Reporting >> >> Lam Voong's note here, which provides an overview of how to install and >> run reports within the CollectionSpace UI itself: >> http://lists.collectionspace.org/pipermail/talk_lists.collec >> tionspace.org/2016-June/002702.html >> >> Peter Murray's wiki page on how to run reports against a CollectionSpace >> installation in Jaspersoft Studio, per Richard Millet's note: >> http://lists.collectionspace.org/pipermail/talk_lists.collec >> tionspace.org/2016-June/002686.html >> >> And a gentle (albeit not extensive) introduction to the SQL queries used >> in reports: >> http://lists.collectionspace.org/pipermail/talk_lists.collec >> tionspace.org/2016-June/002728.html >> >> >> On Thu, Dec 15, 2016 at 2:43 PM, C Space <cspace@bpoc.org> wrote: >> >>> Hey all, >>> >>> Are there generic reporting templates floating around somewhere in the >>> wiki? If so, could you point us in the right direction? >>> >>> Thanks! >>> >>> _______________________________________________ >>> Talk mailing list >>> Talk@lists.collectionspace.org >>> http://lists.collectionspace.org/mailman/listinfo/talk_lists >>> .collectionspace.org >>> >>> >> >> _______________________________________________ >> Talk mailing list >> Talk@lists.collectionspace.org >> http://lists.collectionspace.org/mailman/listinfo/talk_lists >> .collectionspace.org >> >> >