Page tree
Skip to end of metadata
Go to start of metadata

I. Install the Report Designer

To install the Report Designer, follow the Report Designer installation guide that includes instructions on “Setting up a Local Reporting Environment”:

           http://knowledge25.collegenet.com/display/Series25/JReport Designer Installation Instructions

II. Select the required catalog file (25LIVE_WS.cat)

  1. Open the Report Designer from the Windows Start menu, JReport 13 update 1 program folder.

    From the Welcome dialog window, in the section labeled Open:, click to choose the item, Catalog…



    If this window is not presented to you, choose:Select File > Catalog Management > Open Catalog…
    …from the Report Designer main menu.

  2. From the Open Catalog File dialog, navigate to your Report Designer installation directory and find the 25LIVE\Reports folder that has been installed as part of the local reporting directory structure. Select the 25LIVE_WS.cat file located in this directory.

    For example: C:\JReport\Designer\25LIVE\Reports



    This “Reports” folder is your local reports working directory. The catalog file “25LIVE_WS.cat” stores shared report resources as well as the report files themselves.

    You should only need to select this 25LIVE_WS.cat file once. Each time you open the Report Designer, it will remember the last catalog file you were working with.

III. Run a report from within the Report Designer

Included with your local reporting directory is a copy of each of the standard reports created so far. To run one of these reports from the Report Designer, you must be logged into 25Live. This establishes an active user session that has an associated session_id used to provide authentication for web services requests.

  1. Within 25Live, go to the Reports > Other Reports tab.
  2. Find the report called JReport Run. Fill in values for the following report parameters:
    Start Date
    End Date
    Event Search
    Location Search

    This report allows you to select a representative set of parameters that can be applied when running most any report. It is recommended that you set modest parameter values to make the report design and testing experience more efficient.
  3. Run the report. The report is designed to return XML formatted data and to be opened in a browser.
  4. Highlight and copy the value contained in the element name <r25:report_run_url>. The element contains a URL value that can be used to run a report directly from the JReport Designer.

    For Example:
    http://tiamat.unival.com/25live/data/devt/run/report.xml?report_id=-173&report_run_id=2190&otransform=jreport_run.xsl&session_id=5C3C673BEC9C5692D2AE5D2DC1380EF5

    Only copy the values within element tags <r25:report_run_url> and </r25:report_run_url>. Do not copy the tags themselves.

  5. From the Report Designer menu, select File > Open. A list of available report (.cls) files is presented in the Open Report dialog. Select EvListReport.cls from the list of reports.

  6. From the report design editor, notice there are two tabs, Design and View, near the top of the window.

  7. To run the report, click the View tab. The Enter Parameter Values dialog window is presented.

  8. Paste the r25:report_run URL value from step 4 into the P_REPORT_RUN input box. Click the OK button. The report results will be delivered in the view tab.

For instructions on outputting report results to different formats, see the “Additional preview formats” section of Creating Custom Reports Using the 25Live Interactive Report Designer.

Additional Topics

Running event object specific reports from the Report Designer

Reports such as the Event Confirmation Detail (Per Event) and Invoice (Per Event) are designed to run for one specific event. These types of reports may be referred to as event object specific reports. When these reports are run from 25Live, an ID number identifying the event is recorded as a parameter value in an element called <r25:num_parm1>. When running an event object specific report directly in the Report Designer, an event_id value must be included in the parameter set <r25:num_parm1> element.

1. Start by identifying the reference number (example: 2013-AAASBA) of an event. This reference number can be used to retrieve the content of xml in a browser.

2. In a browser window, construct the WebServices URL that will return the event.xml data for this event.

For Example:
https://25live.collegenet.com/25live/data/your_school_abbrev/run/event.xml?event_locator=2013-AAASBA

3. When the xml request is returned to the browser window, notice the <r25:event_id> element in the third row of the XML.

The event_id in this example is 12518.

<r25:events pubdate="2013-08-09T09:51:29-04:00">

<r25:event xl:href="event.xml?event_id=12518" id="BxJDMTI1MTg=" crc="0000005E" status="est"><r25:event_id>12518</r25:event_id>
<r25:event_name>Test Event</r25:event_name>

4. From 25Live, go to Reports > Other Reports, and select the JREPORT RUN . Type your event_id value into the report parameter called Numeric Parm 1.

5.  Run the report and open the XML formatted results in a browser. Highlight and copy the value contained in the element name <r25:report_run_url> just as you did before in the previous example.

6. From the Report Designer menu, select File > Open. Select cls from the list of reports.

7. To run the report, click the View Paste the r25:report_run URL value into the P_REPORT_RUN input box. Click the OK button.

The report results will be delivered in the view tab.

Running location object specific reports from the Report Designer

Reports such as the Daily Room Sheet (Per Room) are designed to run for one specific location. These types of reports may be referred to as location object specific reports. When these reports are run from 25Live, an ID number identifying the location is recorded as a parameter value in an element called <r25:num_parm1>. When running a location object specific report directly in the Report Designer, a space_id value must be included in the parameter set <r25:num_parm1> element.


  • Start by identifying the short name of a selected location. This short name can be used to retrieve the content of xml in a browser.


  • In a browser window, construct the WebServices URL that will return the xml data for this location. The URL will look something like this.


For Example:

https://25live.collegenet.com/25live/data/your_school_abbrev/run/space.xml?short_name=ARTS 101


  • When the xml request is returned to the browser window, notice the <r25:space_id> element in the third row of the XML.


For Example:

The space_id in this example is 1.

<r25:spaces pubdate="2015-07-06T19:29:18-04:00" engine="accl">

                          <r25:space crc="00000053" status="est" xl:href="space.xml?space_id=1">

                                          <r25:space_id>1</r25:space_id>

                                          <r25:space_name>ARTS 101</r25:space_name>


  • From 25Live, go to Reports > Other Reports, and select the JREPORT RUN Type your space_id value into the report parameter called Numeric Parm 1.


  • Run the report and open the XML formatted results in a browser. Highlight and copy the value contained in the element name <r25:report_run_url> just as you did before in the previous example.


  • From the Report Designer menu, select File > Open. Select cls from the list of reports.


Note:  Make sure you select the DailyRoomSheetPerRoom version of the Daily Room Sheet report. As mentioned, this report is designed to run for a single location, whereas the DailyRoomSheet.cls is designed to run for group of spaces returned by a location search.


  • To run the report, click the View Paste the r25:report_run URL value into the P_REPORT_RUN input box. Click the OK button.

The report results will be delivered in the view tab.

Related Topics

  • No labels