Adding an Oracle stored procedure

Suppose that the Oracle stored procedure is defined as follows:

Package SHDEMO as type curtype is ref cursor;
end SHDemo;
Procedure empquery (param1 in varchar2, cur OUT SHdemo.curtype)
as
lcur shdemo.curtype;
begin
  open lcur for select * from EMP WHERE JOB = param1;
  cur:=lcur;
end empquery;

1. Start JReport Designer and open the catalog to which you want to add the stored procedure.
2. In the Catalog Browser, right-click the data source the stored procedure is to be added, then select Add User Defined Data Source.
3. In the Name field of the Add User Defined Data Source dialog, 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 any of the following three:
   • DRIVER=oracle.jdbc.driver.OracleDriver&URL="jdbc:oracle:thin:@222.222.222.45:1521:orcl815"&USER=scott&PSWD=tiger&OWNER=SCOTT&PROCNAME=empquery&SQL={call empquery(?,?)}&REFCURSORINDEX=2&PARAMVALUE=@job1
   • DRIVER=oracle.jdbc.driver.OracleDriver&URL="jdbc:oracle:thin:@222.222.222.45:1521:orcl815"&USER=scott&PSWD=tiger&OWNER=SCOTT&PROCNAME=empquery&SQL={call empquery(?,?)}&REFCURSORINDEX=2&INPARAMVALUE=@job1,varchar,1
   • OWNER=SCOTT&PROCNAME=empquery&SQL={call empquery(?,?)}&REFCURSORINDEX=2&PARAMVALUE=@job1
6. Click OK, and the UDS class will be added into the catalog.

Formats of the PARAMETER string

In the Add User Defined Data Source dialog, the format of the PARAMETER string is in either of the following. You can choose one according to your requirement. 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 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

Substitute the words in lower case according to your requirements.

Where:

• 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(?, ?)}.
• 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 catalog to substitute the parameter values, then '\\' will automatically be added to escape the comma. And 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:

oracle.jdbc.driver.OracleDriver=@driver, jdbc:oracle:thin:@dbserver:1521:orcl=@url, scott=@user,

The PARAMETER string will then be either of the following:

• 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.

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