Previous Page Next Page

Inserting a UDO into a Report

A UDO can be inserted in the page report areas listed in Component placement.

To insert a UDO to a report:

1. Make sure the setenv.bat batch file in <install_root>\bin has been modified to includes the required classes.
2. Start JReport Designer, then create a new report, or open an existing report.
3. Do one of the following:
   • Drag the UDO button from the Components panel to the destination where you want to insert the UDO.
   • Click Insert > UDO or Home > Insert > UDO.
4. In the Insert UDO dialog, select a UDO as required from the UDO drop-down list. The list contains all UDOs that have been registered in the file setenv.bat.

   

5. Click OK in the dialog.
   • If you use menu command to insert the UDO, click the mouse button in the desired location to insert the UDO there.
   • If you take the dragging and dropping method to insert the UDO, the UDO will be inserted there upon clicking the OK button.

After a UDO has been inserted into a report, when you publish the report to JReport Server, be sure to include the class path in the setenv batch file in JReport Server (<server_root>\bin\setenv.bat).

Example: Using UDO to insert a quadrant chart into a banded object

JReport provides you with a demo UDO, with which you can insert a quadrant chart into a banded object. To use this demo UDO, four jar files are required: myudo.jar, jfreechart-1.0.13.jar, jfreechart-1.0.13-swt.jar, and jcommon-1.0.16.jar. The file myudo.jar is saved in <install_root>\help\samples\UDODemo\JQuadrantChart, and you can further edit it if you want. The last three jars can be downloaded from the website: http://www.jfree.org/jfreechart.

To insert a quadrant chart into a banded object using the demo UDO:

1. Append the four jars to the ADDCLASSPATH variable of the batch file setenv.bat.
2. Add the following to the file udo.ini in <install_root>\lib:

   Begin name=JQuadrantChart template=jet.udodemo.JQuadrantTmpl resultobject=jet.udodemo.JQuadrantRslt resultcreator=jet.udodemo.JQuadrantCrtr resultviewer=jet.udodemo.JQuadrantRndr objecteditor=jet.udodemo.JQuadrantDsgn End

3. Start JReport Designer and open the catalog file SampleReports.cat in <install_root>\Demo\Reports\SampleReports.
4. Create a page report with a standard banded object in it which is based on the query WorldWideSales in Data Source 1 of the catalog and is grouped by the Product ID field.
5. Click <New Summary...> in the Summaries node of the Data panel.
6. In the New Summary dialog, specify the Aggregate Function as Sum, add the field Price from the Products table to the Summary On text box, check the Static Summary radio button, specify the Group By field as Product ID from the Products table, and then click OK.

   

7. Enter Sum Price in the Summary Name dialog and click OK to create the summary.
8. Repeat steps 5 to 7 to create another summary Sum Cost, which uses Sum as the aggregate function, summarizes on the Cost field and is grouped by the Product ID field.
9. Resize the group header panel of the banded object and add the two summaries to the panel as follows:

   

10. Select the banded page header panel (BPH) and click Insert > UDO.

11. In the Insert UDO dialog, select JQuadrantChart from the UDO drop-down list, and then click OK.

12. Click the mouse button in the banded page header panel to insert the UDO there.

13. Keep the JQuadrantChart focused and go to the Report Inspector to define its properties as follows:

    • Column Name: Product ID
    • Quadrant Origin X: 750
    • Quadrant Origin Y: 200
    • X Values: Sum Price
    • Y Values: Sum Cost
14. Resize the banded page header panel, save the report and preview it. The report displays as follows:

    

Below are the special properties of this demo UDO. You can edit the property values to suit your requirements.

Previous Page Next Page