Previous Page Next Page

Oracle Stored Procedure UDS

Due to the unique nature of Oracle stored procedures, you cannot add them directly into a JReport catalog. As a substitute, JReport has developed the user data source API which can use stored procedures in Oracle. The class is named OracleProcedureUDS, in the package jet.datasource.oracle. The UDS class is already included in JReport Designer and JReport Server; therefore, you do not need to write any Java code or modify the classpath.

To add a stored procedure into a JReport catalog, take the following steps:

1. Start JReport Designer and open the catalog to which you want to add it.
2. In the Catalog Manager, right-click the catalog data source the stored procedure is to be added, then select New User Defined Data Source. The New User Defined Data Source dialog appears.

   

3. In the Name field, specify a name for the UDS.
4. In the Class Name field, input the UDS class jet.datasource.oracle.OracleProcedureUDS.
5. In the Parameter box, enter the parameter as required.
6. Click OK, and the UDS class will be added into the catalog.

Formats of the parameter string

In the New User Defined Data Source dialog, the format of the parameter string is one of the following types. You can choose one according to your requirements. When the stored procedures used in Oracle have different names, either of the following two formats can be used. However, when the stored procedures used in Oracle have the same names, you can only use the second parameter string. In addition, when you use the second parameter string, the parameter value only contains value. You need to add the data type and index of the parameter value in the user defined data source class.

• DRIVER=drivername&URL=url&USER=user&PSWD=password&OWNER=owner&PROCNAME=procname&SQL=sql&REFCURSORINDEX=index&PARAMVALUE=value1,value2,value3&OUTPARAMINDEX=index1,index2
• DRIVER=drivername&URL=url&USER=user&PSWD=password&OWNER=owner&PROCNAME=procname&SQL=sql&REFCURSORINDEX=index&INPARAMVALUE=value1,datatype1,index1;value2,datatye2,index2;…Valuen,datatypen,indexn&OUTPARAM=datatype1,index1;… datatypen,indexn

If you do not want to specify the connection information in the parameter string, you can also write the parameter as follows:

• OWNER=owner&PROCNAME=procname&SQL=sql&REFCURSORINDEX=index&PARAMVALUE=value1,value2,value3&OUTPARAMINDEX=index1,index2
• OWNER=owner&PROCNAME=procname&SQL=sql&REFCURSORINDEX=index&INPARAMVALUE=value1,datatype1,index1;value2,datatye2,index2;…Valuen,datatypen,indexn&OUTPARAM=datatype1,index1;… datatypen,indexn

In this case, the default connection defined on the data source, to which the stored procedure UDS is added will be used. Only when the information of the default connection and that of the stored procedure UDS match, can the stored procedure UDS be added successfully. You can change the connection at runtime via datasource.xml, Engine API or Server API in JReport Server.

The following explains the lower-case words in the parameter strings in detail. Substitute them according to your requirements.

• drivername - The name of JDBC driver, for instance: oracle.jdbc.driver.OracleDriver.
• url - A database URL of the form jdbc:subprotocol:subname, for instance: jdbc:oracle:thin:@dbserver:1521:orcl.
• user - The database user on whose behalf the Connection is being made, for instance: scott.
• password - The user's password, for instance: tiger.
• owner - The owner of the procedure, for instance: scott. It can also be left empty.
• procname - The name of the Stored Procedure, for instance: getAuthor.
• sql - The SQL statement used to call the procedure or function. For instance, with regards to procedure: {call getAuthor(?, ?)} and for function: {? = getAuthor(?, ?)}. When a stored procedure is defined in Package/Package Body, the package name should be contained in the stored procedure name.
• index - The index of the output parameter with data type equal to Ref Cursor. The start index is 1.
• valueX - The value of the parameters separated by ',' and the data types must correspond to the ones defined in the DBMS. If valueX should contain a set of constant string values, for example, 10, 20, and 30 together serve as valueX, you will need to use '\\' to escape the comma.

  For example, if the PARAMVALUE part of the parameter string is as follows:
  ...&PARAMVALUE=10\\,20\\,30,30\\,10\\,23,,a,

  Then the parameter values will be parsed as follows:
  ParaValue1 =10,20,30
  ParaValue2 =30,10,23
  ParaValue3 =null
  ParaValue4 =a
  ParaValue5 =null

  Or, instead of typing the parameter values one by one in the above parameter string, you can also use the parameters and constant level formulas in the current catalog data source to substitute the parameter values, then '\\' will automatically be added to escape the comma. It is recommended to use the parameters and constant level formulas to control one input parameter value of the oracle stored procedure. For example,
  ...&PARAMVALUE=@PARAM1,30\\,10\\,23,,a,

  In this case, in the Create/Edit Parameter dialog, the prompt value of parameter PARAM1 must be typed as follows:
  10,20,30

• datatypeX - The name of the data type mapping to JDBC. The name is the same as the static variable name in java.sql.types.
• IndexX - The index of the input parameter. It is natural number and integer.

Below is an example of the parameter string:

DRIVER=oracle.jdbc.driver.OracleDriver&URL="jdbc:oracle:thin:@dbserver:1521:orcl"&USER=scott&PSWD=tiger&OWNER=SCOTT&PROCNAME=getAuthor&SQL={call getAuthor(?, ?, ?}&REFCURSORINDEX=2&PARAMVALUE=0.5,1999-7-10

If you want to change the connection dynamically, you can define the parameters in this way:

• DRIVER=@driver&URL=@url&USER=@user&PSWD=tiger&OWNER=SCOTT&PROCNAME=getAuthor&SQL={call getAuthor(?, ?,?}&REFCURSORINDEX=1&PARAMVALUE=0.5,1999-7-10
• DRIVER=@driver&URL=@url&USER=@user&PSWD=tiger&OWNER=SCOTT&PROCNAME=getAuthor&SQL={call getAuthor(?, ?,?}&REFCURSORINDEX=1&INPARAMVALUE=0.5,number,2;1999-7-10,date,3

You can change the parameter dynamically to suit your requirements.

Troubleshooting

If you get an "ArrayOutOfBound" error or a "Not all variables are bound" error while importing a stored procedure, you can check the following points:

• Make sure the OWNER is correct.
• If your stored procedure is defined in Package/Package Body and the PROCNAME argument does not contain package name, but the call argument contains.
• Make sure that your REFCURSORINDEX has been set correctly.

  For example, if you have defined that the Out cursor is the third argument in your stored procedure, then REFCURSORINDEX should be 3.

When you get a NegativeArraySizeException error while running a report designed with a stored procedure, you can check whether some UDS columns return a negative scale (right-click the UDS column, select Properties, and then check Scale). If yes, it means that your original table column called by the stored procedure is likely to be of a Float data type. This returns the wrong Scale for the UDS column. Follow the steps below to modify the UDS column's scale:

1. Open the Catalog Manager.
2. Click Options on the toolbar.
3. In the Options dialog, select Catalog in the Category box, uncheck the option Forbid editing data object properties, and then click OK.
4. Highlight the UDS column name that you are having the problem with and click Show Properties on the toolbar to show the Properties sheet. Now you can change the property values, such as SQL type, precision, and scale to the correct values. For instance, you can change the negative scale of the problematic column to the correct value.

The following are some specific examples of adding Oracle stored procedures UDS to a catalog:

Example 1: Stored Procedures Defined Outside of a Package

Example 2: Stored Procedures Declared and Defined in a Package and Package Body

Example 3: Functions Defined Outside of a Package

Example 4: Functions Declared and Defined in a Package and Package Body

Previous Page Next Page