BackPrevious Topic  Next TopicNext

Inserting UDOs into a Page Report

This topic describes how you can insert UDOs in a page report. It also presents an example to show how you can insert a quadrant chart into a banded object using a UDO.

Note icon You can insert UDOs in banded panels in query-based page reports only.

  1. Make sure you have modified setenv.bat in <install_root>\bin to include the required classes.
  2. Start Designer.
  3. Create a new page report, or open an existing page report. The report should contain a banded object created using a query resource.
  4. Do one of the following:
    • From the Components panel, drag the UDO icon UDO icon in the Others category to the banded panel where you want to insert the UDO.
    • Navigate to Insert > UDO.
    • Navigate to Home > Insert > UDO.

    Designer displays the Insert UDO dialog box.

    Insert UDO dialog box

  5. The UDO drop-down list contains all the UDOs that you have registered in setenv.bat. Select the UDO you want to insert.
  6. Select OK in the dialog box.
    • If you use menu command to insert the UDO, select in the banded panel to place the UDO there.
    • If you use the dragging method to insert the UDO, Designer inserts the UDO there.

After you insert a UDO into a report, when you publish the report to Server, be sure to include its class path in the setenv batch file of Server too (<server_root>\bin\setenv.bat).

Back to top

Example: Using UDO to Insert a Quadrant Chart into a Banded Object

Report provides you with a demo UDO, with which you can insert a quadrant chart into a banded object. This demo UDO requires four JAR files: myudo.jar, jfreechart-1.0.13.jar, jfreechart-1.0.13-swt.jar, and jcommon-1.0.16.jar. You can get myudo.jar in <install_root>\help\samples\UDODemo\JQuadrantChart, and you can further edit it if you want. You can download the rest three JAR files from the website: www.jfree.org/jfreechart.

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

  1. Append the four JAR files to the ADDCLASSPATH variable of the setenv.bat batch file in <install_root>\bin.
  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 Designer.
  4. Navigate to File > Open Catalog.
  5. In the Open Catalog File dialog box, browse to open the catalog file SampleReports.cat in <install_root>\Demo\Reports\SampleReports.
  6. Navigate to File > New > Page Report to create a page report with a banded object in its first report tab.
  7. Define the banded object as follows:
    1. Use the query WorldWideSales in Data Source 1 of the catalog.
    2. Group it by Product ID.
    3. Apply the Basic style.
  8. In the Data panel, select <New Summary...> from the Summaries node.
  9. In the New Summary dialog box, select Sum from the Aggregate Function drop-down list, add the field Price from the Products table to the Summary On text box and Product ID to the Group By text box, and then select OK.

    New Summary

  10. Type Sum Price in the Summary Name dialog box and select OK to create the summary.
  11. Repeat steps 7 to 9 to create another summary Sum Cost, which uses Sum as the aggregate function, summarizes on the field Cost, and is grouped by Product ID.
  12. Resize the group header panel of the banded object and add the two summaries to the panel.

    Banded Object

  13. Select the banded page header panel (BPH) and select Insert > UDO.
  14. In the Insert UDO dialog box, select JQuadrantChart from the UDO drop-down list, and then select OK.
  15. Select in the banded page header panel to insert the UDO there.
  16. Keep JQuadrantChart focused and go to the Report Inspector to define its properties.
    • Column Name: Product ID
    • Quadrant Origin X: 750
    • Quadrant Origin Y: 200
    • X Values: Sum Price
    • Y Values: Sum Cost
  17. Resize the banded page header panel and save the report.
  18. Select the View tab to preview the report.

    UDO in Banded Page Header Panel

The following table lists the special properties of this demo UDO. You can edit the property values to suit your requirements.

Property Name Description
Chart Title Specifies the title of the quadrant chart.

Data type: String

Column Name Specifies the field whose values will be used as the values of the X axis, which can only be the outermost group-by field of the banded object.

Data type: String
Quadrant Font Bold Specifies whether to make the text in the quadrant chart bold. This property takes effect when you set Show Quadrant Text to "true" and specify some text for Quadrant1 Text, Quadrant2 Text, Quadrant3 Text, or Quadrant4 Text.

Data type: Boolean
Quadrant Font Color Specifies the color of the text in the quadrant chart. Choose a color from the drop-down list, type a hexadecimal RGB value (for example, 0xff0000), or select Custom from the drop-down list to specify the color. This property takes effect when you set Show Quadrant Text to "true" and specify some text for Quadrant1 Text, Quadrant2 Text, Quadrant3 Text, or Quadrant4 Text.

Data type: String
Quadrant Font Face Specifies the font of the text in the quadrant chart. Choose an option from the drop-down list. This property takes effect when you set Show Quadrant Text to "true" and specify some text for Quadrant1 Text, Quadrant2 Text, Quadrant3 Text, or Quadrant4 Text.

Data type: Enumeration
Quadrant Font Size Specifies the font size of the text in the quadrant chart. Type an integer value to change the size. This property takes effect when you set Show Quadrant Text to "true" and specify some text for Quadrant1 Text, Quadrant2 Text, Quadrant3 Text, or Quadrant4 Text.

Data type: Integer
Quadrant Origin X Specifies the value of the X axis for the origin point.

Data type: Float
Quadrant Origin Y Specifies the value of the Y axis for the origin point.

Data type: Float
Quadrant Separator Color Specifies the color of the lines used to separate the quadrants of the chart. Choose a color from the drop-down list, type a hexadecimal RGB value (for example, 0xff0000), or select Custom from the drop-down list to specify the color. This property takes effect only when the property Show Quadrant Separator is "true".

Data type: String
Quadrant Separator Width Specifies the width of the lines used to separate the quadrants of the chart. Type a numeric value to change the width. This property takes effect only when the property Show Quadrant Separator is "true".

Data type: Float
Quadrant1 Color Specifies the color for the first quadrant of the chart. Choose a color from the drop-down list, type a hexadecimal RGB value (for example, 0xff0000), or select Custom from the drop-down list to specify the color.

Data type: String
Quadrant1 Text Specifies the text to display in the first quadrant of the chart. This property takes effect only when the property Show Quadrant Text is "true".

Data type: String
Quadrant1 Transparency Specifies the transparency for the first quadrant of the chart, in percent. Type a numeric value to change the transparency.

Data type: Integer
Quadrant2 Color Specifies the color for the second quadrant of the chart. Choose a color from the drop-down list, type a hexadecimal RGB value (for example, 0xff0000), or select Custom from the drop-down list to specify the color.

Data type: String
Quadrant2 Text Specifies the text to display in the second quadrant of the chart. This property takes effect only when the property Show Quadrant Text is "true".

Data type: String
Quadrant2 Transparency Specifies the transparency for the second quadrant of the chart, in percent. Type a numeric value to change the transparency.

Data type: Integer
Quadrant3 Color Specifies the color for the third quadrant of the chart. Choose a color from the drop-down list, type a hexadecimal RGB value (for example, 0xff0000), or select Custom from the drop-down list to specify the color.

Data type: String
Quadrant3 Text Specifies the text to display in the third quadrant of the chart. This property takes effect only when the property Show Quadrant Text is "true".

Data type: String
Quadrant3 Transparency Specifies the transparency for the third quadrant of the chart, in percent. Type a numeric value to change the transparency.

Data type: Integer
Quadrant4 Color Specifies the color for the fourth quadrant of the chart. Choose a color from the drop-down list, type a hexadecimal RGB value (for example, 0xff0000), or select Custom from the drop-down list to specify the color.

Data type: String
Quadrant4 Text Specifies the text to display in the fourth quadrant of the chart. This property takes effect only when the property Show Quadrant Text is "true".

Data type: String
Quadrant4 Transparency Specifies the transparency for the fourth quadrant of the chart, in percent. Type a numeric value to change the transparency.

Data type: Integer
Show Quadrant Separator Specifies whether to show the lines used to separate the quadrants of the chart.

Data type: Boolean
Show Quadrant Text Specifies whether to show the text in the quadrants of the chart.

Data type: Boolean
X Values Specifies the field whose values you want to display as the values of the X coordinate. You can only use the fields with numeric values in the group header panel of the banded object.

Data type: String
Y Values Specifies the field whose values you want to display as the values of the Y coordinate. You can only use the fields with numberic values in the group header panel of the banded object.

Data type: String

Back to top

BackPrevious Topic  Next TopicNext