Publishing Reports to the Web - Downloads - Oracle

The Event-Driven Publishing API
■ The SRW-Package contains all relevant functions and procedures for submitting
jobs, checking job status, and cancelling jobs, as well as manipulating parameter
lists.
■ The ParamList-Type defines a parameter list. A parameter list is the main vehicle
for passing values when submitting a job. A parameter list is required for each job
submission. It must contain several key parameters.
■ The ParamList-Object is required for such features as Advanced Queuing, where
a parameter list must be stored in the database so that it may be passed along with
a message.
These API elements are discussed in more detail in the following sections.
The API is installed together with OracleAS Reports Services Security and OracleAS
Portal, but neither is required. Installation scripts are also available separately should
you want to install the API into a database that does not also hold Oracle Portal:
■ srwAPIins.sql installs the Events-Driven Publishing API.
■ srwAPIgrant.sql grants access privileges to the API. Run this script for each
user to whom you will grant access to the API. If everyone may have access, you
can run this once and grant access to PUBLIC.
■ srwAPIdrop.sql removes the API.
17.1.2 Creating and Manipulating a Parameter List
A parameter list is a PL/SQL variable of type SRW_PARAMLIST. A variable of this type
is an array of 255 elements of type SRW_PARAMETER, which itself consists of two
attributes: NAME and VALUE. The API provides procedures for manipulating
parameter lists, including:
■ Add_Parameter
■ Remove_Parameter
■ Clear_Parameter_List
These procedures allow you to manipulate your parameter lists. They are discussed
briefly in this section. You'll find more information in the Oracle Reports API
documentation.
Note: Look for upcoming information about Reports APIs on the
Oracle Technology Network, (http://otn.oracle.com).
17.1.2.1 Add_Parameter
Whenever you use a parameter list for the first time, it must be initialized before you
can add parameters to it. For example:
DECLARE
myPlist SRW_PARAMLIST;
BEGIN
myPlist := SRW_PARAMLIST(SRW_PARAMETER('',''));
srw.add_parameter(myPlist,'myParameter','myValue');
END;
Both attributes of a parameter (NAME and VALUE) are of type VARCHAR2 and may
not exceed a length of 80 characters for the NAME and 255 characters for the value.
17-2 Oracle Application Server Reports Services Publishing Reports to the Web