01.02.2013 Views

Publishing Reports to the Web - Downloads - Oracle

Publishing Reports to the Web - Downloads - Oracle

Publishing Reports to the Web - Downloads - Oracle

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

17.1.3 How <strong>to</strong> Submit a Job<br />

The Event-Driven <strong>Publishing</strong> API<br />

The ADD_PARAMETER function has a third—optional—attribute, called MODE. MODE<br />

determines whe<strong>the</strong>r a parameter will be overwritten or an error raised in <strong>the</strong> event<br />

that a parameter with <strong>the</strong> same name already exists. To specify that an error will be<br />

raised in <strong>the</strong> event of duplicate names, use <strong>the</strong> constant CHECK_FOR_EXISTANCE.<br />

This is <strong>the</strong> default value for <strong>the</strong> MODE attribute. To specify that a parameter will be<br />

overwritten in <strong>the</strong> event of duplicate names, use <strong>the</strong> constant OVERWRITE_IF_<br />

EXISTS.<br />

17.1.2.2 Remove_Parameter<br />

Use REMOVE_PARAMETER <strong>to</strong> remove a parameter from a parameter list. Call <strong>the</strong><br />

procedure, and pass <strong>the</strong> parameter list from which you want <strong>to</strong> remove a parameter<br />

along with <strong>the</strong> name of <strong>the</strong> parameter you want <strong>to</strong> remove.<br />

For example:<br />

DECLARE<br />

myPlist SRW_PARAMLIST;<br />

BEGIN<br />

myPlist := SRW_PARAMLIST(SRW_PARAMETER('',''));<br />

srw.add_parameter(myPlist,'myParameter','myValue');<br />

srw.remove_parameter(myPlist,'myParameter');<br />

END;<br />

17.1.2.3 Clear_Parameter_List<br />

To remove ALL parameters from your list, use CLEAR_PARAMETER_LIST. For<br />

example:<br />

DECLARE<br />

myPlist SRW_PARAMLIST;<br />

BEGIN<br />

myPlist := SRW_PARAMLIST(SRW_PARAMETER('',''));<br />

srw.add_parameter(myPlist,'myParameter','myValue');<br />

srw.clear_parameter_list(myPlist);<br />

END;<br />

This will remove all parameters from your list.<br />

A parameter list contains all vital parameters for submitting a job. The job type<br />

determines which parameters are required on <strong>the</strong> list <strong>to</strong> enable <strong>the</strong> <strong>Reports</strong> Server <strong>to</strong><br />

process <strong>the</strong> request.<br />

The listed parameters are <strong>the</strong> same ones that you must specify when you submit a job<br />

from a browser <strong>to</strong> <strong>the</strong> <strong>Reports</strong> Servlet. In such a case, if <strong>the</strong> job is a report you will need<br />

at least <strong>the</strong> following parameters but may have more:<br />

■ GATEWAY provides <strong>the</strong> URL <strong>to</strong> <strong>the</strong> <strong>Reports</strong> Servlet you will use <strong>to</strong> process <strong>the</strong><br />

request.<br />

■ SERVER identifies <strong>the</strong> <strong>Reports</strong> Server <strong>to</strong> be used in conjunction with <strong>the</strong> servlet.<br />

■ REPORT identifies <strong>the</strong> report file <strong>to</strong> be run.<br />

■ USERID identifies <strong>the</strong> name and user ID of <strong>the</strong> person running <strong>the</strong> report.<br />

■ AUTHID provides authorization information in <strong>the</strong> event you are running against a<br />

secured server.<br />

Using Event-Driven <strong>Publishing</strong> 17-3

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!