talk@lists.collectionspace.org

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

View all threads

Re: [Talk] Default reports on CSpace

LK
Lam K Voong
Thu, Jun 23, 2016 6:11 PM

Hello James,

You can download iReport here:
http://community.jaspersoft.com/project/ireport-designer/releases

As Megan and Chris have mentioned, there will be a number of new reports
included with the v4.4 release.

However, if you would like to install new or custom reports, the wiki page
you found on how to run reports (
https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports) is
a good resource to get you started.  As the page mentions, to install new
reports, you will need:

  1. a .jrxml or .jasper file (report file generated by iReport)
    1. an XML payload file to create the report record
  2. a curl command to create the report record in CollectionSpace using
    the XML paylload file

I hope this helps! Good luck!

  • Lam

Message: 3
Date: Wed, 22 Jun 2016 16:16:16 +0000 (UTC)
From: James Keeline james@keeline.com
To: Chris Hoffman chris_h@berkeley.edu
Cc: Talk talk@lists.collectionspace.org
Subject: Re: [Talk] Default reports on CSpace
Message-ID:
861242300.2455118.1466612176989.JavaMail.yahoo@mail.yahoo.com
Content-Type: text/plain; charset="utf-8"

It is quite possible that the six reports would be a great starting place.
May I note that the links to Jasper on the documentation are no longer
functional? ?As such it was not clear which software to download from?
http://community.jaspersoft.com/?though I suppose it is the free Jasper
Studio based on what I see in the documentation.
One of my colleagues has some experience with Jasper and will be looking
at this a bit today. ?However, if there is a way to install these reports
and get them running on our system, that would be great. ?We have a
training session on Friday with key museum staff so we are working to get
things in place for that. ?Thus, today and tomorrow are the ideal times for
us to work on this. ?I greatly appreciate any help.
I will note that this museum has been pleasantly undemanding on feature
requirements. ?They do appreciate simplicity whenever possible. ?That is
one of the reasons that we hid many of the fields in the object record
form. ?This proved to be valuable information that I'll document for the
next implementation we are involved with.?James D. Keeline

   From: Chris Hoffman <chris_h@berkeley.edu>

To: James Keeline james@keeline.com
Cc: Talk talk@lists.collectionspace.org
Sent: Wednesday, June 22, 2016 9:01 AM
Subject: Re: [Talk] Default reports on CSpace

Hi James,
Out of the box, CollectionSpace only comes with one default report, on the
Acquisition record. ?However, a member of the Berkeley team, Lam Voong, is
working on a set of six reports that will be in the next release. ?There?s
definitely a way to get these installed in your environment, but I?ll let
sharper minds jump in here with the best approach!
Here?s the Jira:?https://issues.collectionspace.org/browse/CODE-37
Lam is updating those reports to handle situations where on cataloging
records are associated with the procedural record (e.g., a loan
transaction). That work is in this Jira:?
https://issues.collectionspace.org/browse/CSPACE-6948
There?s some new documentation about reports that should be in the next
release:? ?
https://wiki.collectionspace.org/display/UNRELEASED/User+Manual+-+Reporting
In terms of not having any requirements from the museum yet, hopefully the
six reports that Lam is working on will be a sufficient start. ?I suspect
the museum will want to modify those reports. ?Start with simple things
like adding their name and logo and removing fields. ?Then move on to
adding fields they want to display. ?Once you start adding fields, you get
into the whole SQL query business, which for CollectionSpace is all sorts
of fun ;-)
Good luck,Chris

On Jun 21, 2016, at 4:41 PM, James Keeline james@keeline.com wrote:
Now that I have fixed the empty search in Persons >> Local Persons search
issue, I have not been asked to look at Reports.
I guess that there is an external application that is used for this
generally called Jaspersoft iReport Designer (?
https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports?).
I see also a Run Report?on the upper right of certain pages. ?However, the
select box is empty. ?How do we get that populated as a starting point.
Unfortunately our museum does not have a wish list of reports and data per
them so it is going to be a little difficult to create everything from
scratch. ?
I got the impression that there were at least a few pre-defined reports.
?If so, how may I access / activate them??James D. Keeline

Hello James, You can download iReport here: http://community.jaspersoft.com/project/ireport-designer/releases As Megan and Chris have mentioned, there will be a number of new reports included with the v4.4 release. However, if you would like to install new or custom reports, the wiki page you found on how to run reports ( https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports) is a good resource to get you started. As the page mentions, to install new reports, you will need: 1. a .jrxml or .jasper file (report file generated by iReport) - I'm not sure if you have access, but you can find .jrxml files on github: https://github.com/collectionspace/services/tree/master/services/report/3rdparty/jasper-cs-report/src/main/resources . - If you download any of the .jrxml files, you can open them in iReport and modify them to meet your needs. - The .jrxml file or the compiled .jasper file will need to be placed in the cspace/reports directory within the Tomcat installation directory. (If there is no .jasper file, when you run the report from the UI, it will generate a .jasper file from the .jrxml file.) 2. an XML payload file to create the report record - This file lets you supply the name of the report, reference to the .jasper file, the type of output file, procedural record type, etc. for the report record in reports_common and reports_common_fordoctypes. - Also on github, there is a script that generates the XML payload file and creates the report record when you supply a few parameters: https://github.com/collectionspace/Tools/blob/master/scripts/install_report_records.sh - Or, you can create this file by following the format described in https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports 3. a curl command to create the report record in CollectionSpace using the XML paylload file - See #2 and https://github.com/collectionspace/Tools/blob/master/scripts/create-report-records.sh for automation. - Or, you can issue the command in the format described in https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports I hope this helps! Good luck! - Lam > Message: 3 > Date: Wed, 22 Jun 2016 16:16:16 +0000 (UTC) > From: James Keeline <james@keeline.com> > To: Chris Hoffman <chris_h@berkeley.edu> > Cc: Talk <talk@lists.collectionspace.org> > Subject: Re: [Talk] Default reports on CSpace > Message-ID: > <861242300.2455118.1466612176989.JavaMail.yahoo@mail.yahoo.com> > Content-Type: text/plain; charset="utf-8" > > It is quite possible that the six reports would be a great starting place. > May I note that the links to Jasper on the documentation are no longer > functional? ?As such it was not clear which software to download from? > http://community.jaspersoft.com/?though I suppose it is the free Jasper > Studio based on what I see in the documentation. > One of my colleagues has some experience with Jasper and will be looking > at this a bit today. ?However, if there is a way to install these reports > and get them running on our system, that would be great. ?We have a > training session on Friday with key museum staff so we are working to get > things in place for that. ?Thus, today and tomorrow are the ideal times for > us to work on this. ?I greatly appreciate any help. > I will note that this museum has been pleasantly undemanding on feature > requirements. ?They do appreciate simplicity whenever possible. ?That is > one of the reasons that we hid many of the fields in the object record > form. ?This proved to be valuable information that I'll document for the > next implementation we are involved with.?James D. Keeline > > From: Chris Hoffman <chris_h@berkeley.edu> > To: James Keeline <james@keeline.com> > Cc: Talk <talk@lists.collectionspace.org> > Sent: Wednesday, June 22, 2016 9:01 AM > Subject: Re: [Talk] Default reports on CSpace > > Hi James, > Out of the box, CollectionSpace only comes with one default report, on the > Acquisition record. ?However, a member of the Berkeley team, Lam Voong, is > working on a set of six reports that will be in the next release. ?There?s > definitely a way to get these installed in your environment, but I?ll let > sharper minds jump in here with the best approach! > Here?s the Jira:?https://issues.collectionspace.org/browse/CODE-37 > Lam is updating those reports to handle situations where on cataloging > records are associated with the procedural record (e.g., a loan > transaction). That work is in this Jira:? > https://issues.collectionspace.org/browse/CSPACE-6948 > There?s some new documentation about reports that should be in the next > release:? ? > https://wiki.collectionspace.org/display/UNRELEASED/User+Manual+-+Reporting > In terms of not having any requirements from the museum yet, hopefully the > six reports that Lam is working on will be a sufficient start. ?I suspect > the museum will want to modify those reports. ?Start with simple things > like adding their name and logo and removing fields. ?Then move on to > adding fields they want to display. ?Once you start adding fields, you get > into the whole SQL query business, which for CollectionSpace is all sorts > of fun ;-) > Good luck,Chris > > > On Jun 21, 2016, at 4:41 PM, James Keeline <james@keeline.com> wrote: > Now that I have fixed the empty search in Persons >> Local Persons search > issue, I have not been asked to look at Reports. > I guess that there is an external application that is used for this > generally called Jaspersoft iReport Designer (? > https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports?). > I see also a Run Report?on the upper right of certain pages. ?However, the > select box is empty. ?How do we get that populated as a starting point. > Unfortunately our museum does not have a wish list of reports and data per > them so it is going to be a little difficult to create everything from > scratch. ? > I got the impression that there were at least a few pre-defined reports. > ?If so, how may I access / activate them??James D. Keeline > >
AR
Aron Roberts
Tue, Jun 28, 2016 12:17 AM

Hi James,

Chris Hoffman wrote:

Once you start adding fields, you get into the whole SQL query business,

which for CollectionSpace is all sorts of fun ;-)

To also help with getting started on that, here's a somewhat gentle,
iterative introduction to SQL querying in CollectionSpace:

https://wiki.collectionspace.org/display/~aronr/Getting+started+with+SQL+queries+of+the+CollectionSpace+databases

Beyond that, the SQL queries within the 'canned' reports that Chris
mentioned - the existing Acquisition Summary report and the six additional
reports that Lam added for v4.4 - are excellent examples to adapt and learn
from. Once again, here's the link that Lam provided to those:

https://github.com/collectionspace/services/tree/master/services/report/3rdparty/jasper-cs-report/src/main/resources

Finally, as per these comments by John and Richard, it's our intention to
also provide a higher-level query interface for reporting, in a future
CSpace version:

https://issues.collectionspace.org/browse/CSPACE-6879?focusedCommentId=51801&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-51801

Cheers,
Aron

On Thu, Jun 23, 2016 at 11:11 AM, Lam K Voong lkv@berkeley.edu wrote:

Hello James,

You can download iReport here:
http://community.jaspersoft.com/project/ireport-designer/releases

As Megan and Chris have mentioned, there will be a number of new reports
included with the v4.4 release.

However, if you would like to install new or custom reports, the wiki page
you found on how to run reports (
https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports)
is a good resource to get you started.  As the page mentions, to install
new reports, you will need:

1. a .jrxml or .jasper file (report file generated by iReport)
   - I'm not sure if you have access, but you can find .jrxml files on
   github:
   https://github.com/collectionspace/services/tree/master/services/report/3rdparty/jasper-cs-report/src/main/resources
   .
   - If you download any of the .jrxml files, you can open them in
   iReport and modify them to meet your needs.
   - The .jrxml file or the compiled .jasper file will need to be
   placed in the cspace/reports directory within the Tomcat installation
   directory.  (If there is no .jasper file, when you run the report from the
   UI, it will generate a .jasper file from the .jrxml file.)
   2. an XML payload file to create the report record
   - This file lets you supply the name of the report, reference to
   the .jasper file, the type of output file, procedural record type, etc. for
   the report record in reports_common and reports_common_fordoctypes.
   - Also on github, there is a script that generates the XML payload
   file and creates the report record when you supply a few parameters:
   https://github.com/collectionspace/Tools/blob/master/scripts/install_report_records.sh
   - Or, you can create this file by following the format described in
   https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports
3. a curl command to create the report record in CollectionSpace using
the XML paylload file
   - See #2 and
   https://github.com/collectionspace/Tools/blob/master/scripts/create-report-records.sh
   for automation.
   - Or, you can issue the command in the format described in
   https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports

I hope this helps! Good luck!

  • Lam

Message: 3
Date: Wed, 22 Jun 2016 16:16:16 +0000 (UTC)
From: James Keeline james@keeline.com
To: Chris Hoffman chris_h@berkeley.edu
Cc: Talk talk@lists.collectionspace.org
Subject: Re: [Talk] Default reports on CSpace
Message-ID:
861242300.2455118.1466612176989.JavaMail.yahoo@mail.yahoo.com
Content-Type: text/plain; charset="utf-8"

It is quite possible that the six reports would be a great starting place.
May I note that the links to Jasper on the documentation are no longer
functional? ?As such it was not clear which software to download from?
http://community.jaspersoft.com/?though I suppose it is the free Jasper
Studio based on what I see in the documentation.
One of my colleagues has some experience with Jasper and will be looking
at this a bit today. ?However, if there is a way to install these reports
and get them running on our system, that would be great. ?We have a
training session on Friday with key museum staff so we are working to get
things in place for that. ?Thus, today and tomorrow are the ideal times for
us to work on this. ?I greatly appreciate any help.
I will note that this museum has been pleasantly undemanding on feature
requirements. ?They do appreciate simplicity whenever possible. ?That is
one of the reasons that we hid many of the fields in the object record
form. ?This proved to be valuable information that I'll document for the
next implementation we are involved with.?James D. Keeline

   From: Chris Hoffman <chris_h@berkeley.edu>

To: James Keeline james@keeline.com
Cc: Talk talk@lists.collectionspace.org
Sent: Wednesday, June 22, 2016 9:01 AM
Subject: Re: [Talk] Default reports on CSpace

Hi James,
Out of the box, CollectionSpace only comes with one default report, on
the Acquisition record. ?However, a member of the Berkeley team, Lam Voong,
is working on a set of six reports that will be in the next release.
?There?s definitely a way to get these installed in your environment, but
I?ll let sharper minds jump in here with the best approach!
Here?s the Jira:?https://issues.collectionspace.org/browse/CODE-37
Lam is updating those reports to handle situations where on cataloging
records are associated with the procedural record (e.g., a loan
transaction). That work is in this Jira:?
https://issues.collectionspace.org/browse/CSPACE-6948
There?s https://issues.collectionspace.org/browse/CSPACE-6948There?s
some new documentation about reports that should be in the next release:? ?
https://wiki.collectionspace.org/display/UNRELEASED/User+Manual+-+Reporting
In terms of not having any requirements from the museum yet, hopefully
the six reports that Lam is working on will be a sufficient start. ?I
suspect the museum will want to modify those reports. ?Start with simple
things like adding their name and logo and removing fields. ?Then move on
to adding fields they want to display. ?Once you start adding fields, you
get into the whole SQL query business, which for CollectionSpace is all
sorts of fun ;-)
Good luck,Chris

On Jun 21, 2016, at 4:41 PM, James Keeline james@keeline.com wrote:
Now that I have fixed the empty search in Persons >> Local Persons search
issue, I have not been asked to look at Reports.
I guess that there is an external application that is used for this
generally called Jaspersoft iReport Designer (?
https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports?
).
I see also a Run Report?on the upper right of certain pages. ?However,
the select box is empty. ?How do we get that populated as a starting point.
Unfortunately our museum does not have a wish list of reports and data
per them so it is going to be a little difficult to create everything from
scratch. ?
I got the impression that there were at least a few pre-defined reports.
?If so, how may I access / activate them??James D. Keeline

Hi James, Chris Hoffman wrote: > Once you start adding fields, you get into the whole SQL query business, which for CollectionSpace is all sorts of fun ;-) To also help with getting started on that, here's a somewhat gentle, iterative introduction to SQL querying in CollectionSpace: https://wiki.collectionspace.org/display/~aronr/Getting+started+with+SQL+queries+of+the+CollectionSpace+databases Beyond that, the SQL queries within the 'canned' reports that Chris mentioned - the existing Acquisition Summary report and the six additional reports that Lam added for v4.4 - are excellent examples to adapt and learn from. Once again, here's the link that Lam provided to those: https://github.com/collectionspace/services/tree/master/services/report/3rdparty/jasper-cs-report/src/main/resources Finally, as per these comments by John and Richard, it's our intention to also provide a higher-level query interface for reporting, in a future CSpace version: https://issues.collectionspace.org/browse/CSPACE-6879?focusedCommentId=51801&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-51801 Cheers, Aron On Thu, Jun 23, 2016 at 11:11 AM, Lam K Voong <lkv@berkeley.edu> wrote: > Hello James, > > You can download iReport here: > http://community.jaspersoft.com/project/ireport-designer/releases > > As Megan and Chris have mentioned, there will be a number of new reports > included with the v4.4 release. > > However, if you would like to install new or custom reports, the wiki page > you found on how to run reports ( > https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports) > is a good resource to get you started. As the page mentions, to install > new reports, you will need: > > 1. a .jrxml or .jasper file (report file generated by iReport) > - I'm not sure if you have access, but you can find .jrxml files on > github: > https://github.com/collectionspace/services/tree/master/services/report/3rdparty/jasper-cs-report/src/main/resources > . > - If you download any of the .jrxml files, you can open them in > iReport and modify them to meet your needs. > - The .jrxml file or the compiled .jasper file will need to be > placed in the cspace/reports directory within the Tomcat installation > directory. (If there is no .jasper file, when you run the report from the > UI, it will generate a .jasper file from the .jrxml file.) > 2. an XML payload file to create the report record > - This file lets you supply the name of the report, reference to > the .jasper file, the type of output file, procedural record type, etc. for > the report record in reports_common and reports_common_fordoctypes. > - Also on github, there is a script that generates the XML payload > file and creates the report record when you supply a few parameters: > https://github.com/collectionspace/Tools/blob/master/scripts/install_report_records.sh > - Or, you can create this file by following the format described in > https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports > 3. a curl command to create the report record in CollectionSpace using > the XML paylload file > - See #2 and > https://github.com/collectionspace/Tools/blob/master/scripts/create-report-records.sh > for automation. > - Or, you can issue the command in the format described in > https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports > > > I hope this helps! Good luck! > > - Lam > > > >> Message: 3 >> Date: Wed, 22 Jun 2016 16:16:16 +0000 (UTC) >> From: James Keeline <james@keeline.com> >> To: Chris Hoffman <chris_h@berkeley.edu> >> Cc: Talk <talk@lists.collectionspace.org> >> Subject: Re: [Talk] Default reports on CSpace >> Message-ID: >> <861242300.2455118.1466612176989.JavaMail.yahoo@mail.yahoo.com> >> Content-Type: text/plain; charset="utf-8" >> >> It is quite possible that the six reports would be a great starting place. >> May I note that the links to Jasper on the documentation are no longer >> functional? ?As such it was not clear which software to download from? >> http://community.jaspersoft.com/?though I suppose it is the free Jasper >> Studio based on what I see in the documentation. >> One of my colleagues has some experience with Jasper and will be looking >> at this a bit today. ?However, if there is a way to install these reports >> and get them running on our system, that would be great. ?We have a >> training session on Friday with key museum staff so we are working to get >> things in place for that. ?Thus, today and tomorrow are the ideal times for >> us to work on this. ?I greatly appreciate any help. >> I will note that this museum has been pleasantly undemanding on feature >> requirements. ?They do appreciate simplicity whenever possible. ?That is >> one of the reasons that we hid many of the fields in the object record >> form. ?This proved to be valuable information that I'll document for the >> next implementation we are involved with.?James D. Keeline >> >> From: Chris Hoffman <chris_h@berkeley.edu> >> To: James Keeline <james@keeline.com> >> Cc: Talk <talk@lists.collectionspace.org> >> Sent: Wednesday, June 22, 2016 9:01 AM >> Subject: Re: [Talk] Default reports on CSpace >> >> Hi James, >> Out of the box, CollectionSpace only comes with one default report, on >> the Acquisition record. ?However, a member of the Berkeley team, Lam Voong, >> is working on a set of six reports that will be in the next release. >> ?There?s definitely a way to get these installed in your environment, but >> I?ll let sharper minds jump in here with the best approach! >> Here?s the Jira:?https://issues.collectionspace.org/browse/CODE-37 >> Lam is updating those reports to handle situations where on cataloging >> records are associated with the procedural record (e.g., a loan >> transaction). That work is in this Jira:? >> https://issues.collectionspace.org/browse/CSPACE-6948 >> There?s <https://issues.collectionspace.org/browse/CSPACE-6948There?s> >> some new documentation about reports that should be in the next release:? ? >> https://wiki.collectionspace.org/display/UNRELEASED/User+Manual+-+Reporting >> In terms of not having any requirements from the museum yet, hopefully >> the six reports that Lam is working on will be a sufficient start. ?I >> suspect the museum will want to modify those reports. ?Start with simple >> things like adding their name and logo and removing fields. ?Then move on >> to adding fields they want to display. ?Once you start adding fields, you >> get into the whole SQL query business, which for CollectionSpace is all >> sorts of fun ;-) >> Good luck,Chris >> >> >> On Jun 21, 2016, at 4:41 PM, James Keeline <james@keeline.com> wrote: >> Now that I have fixed the empty search in Persons >> Local Persons search >> issue, I have not been asked to look at Reports. >> I guess that there is an external application that is used for this >> generally called Jaspersoft iReport Designer (? >> https://wiki.collectionspace.org/display/DOC/How+to+add+and+run+reports? >> ). >> I see also a Run Report?on the upper right of certain pages. ?However, >> the select box is empty. ?How do we get that populated as a starting point. >> Unfortunately our museum does not have a wish list of reports and data >> per them so it is going to be a little difficult to create everything from >> scratch. ? >> I got the impression that there were at least a few pre-defined reports. >> ?If so, how may I access / activate them??James D. Keeline >> >> > _______________________________________________ > Talk mailing list > Talk@lists.collectionspace.org > > http://lists.collectionspace.org/mailman/listinfo/talk_lists.collectionspace.org > >