17.1 The Reports URL Syntax

This section provides quick reference information on formulating a URL for publishing a report. It covers two deployment types:

Oracle Reports Servlet
JSP

The information is largely the same for both Windows and UNIX environments. Differences are noted.

17.1.1 Oracle Reports Servlet

The syntax for the URL to run a report through Oracle Reports Servlet (rwservlet) is:

http://web_server.domain_name:port/alias/rwservlet?parameters

Table 17-1 lists and describes the components of the URL.

Table 17-1 Components of a URL That Calls Oracle Reports Servlet

Component	Description
`web_server`	The name you gave the Oracle HTTP Server when you installed it.
`domain_name`	Your organization's domain name.
`port`	The port number on which the Oracle HTTP Server listens for requests. When no port is specified, the default is used (80).
`alias`	The virtual path that stands in for the absolute path to the files a URL will access.
`rwservlet`	Invokes Oracle Reports Servlet.
`?`	Identifies the beginning of the command line options.
`parameters`	All the command line options, or the key to the key map file where command line options are specified.

The URL that calls Oracle Reports Servlet (rwservlet) could look like this:

http://neptune.world.com:80/reports/rwservlet?keyname

where keyname refers to a command listed under a unique header (the key name) in the cgicmd.dat key map file (for more information, see Section 17.13, "Using a Key Map File"). Note that this works differently for JSP files, which use the keyword/value pair cmdkey=value to specify key names for command lines that are stored in the cgicmd.dat file.

When you use Oracle Reports Servlet (rwservlet), you can also execute JSP report files if the JSP files contain paper layouts. When you run the report, specify Oracle Reports Servlet (rwservlet) in the URL and call the JSP with the command line option: report=myreport.jsp.

For example:

http://neptune.world.com:80/reports/rwservlet?report=myreport.jsp&destype=cache&desformat=html

You'll find more information about command line keywords and values in Appendix A, "Command Line Keywords".

17.1.2 JSP

The syntax for a JSP-based report URL is:

http://web_server.domain_name:port/alias/myreport.jsp?parameters

Table 17-2 lists and describes the components of the JSP-based report URL.

Table 17-2 Components of a JSP-based Report URL

Component	Description
`web_server`	The name you gave the Oracle HTTP Server when you installed it.
`domain_name`	Your organization's domain name.
`port`	The port number on which the Oracle HTTP Server listens for requests. When no port is specified, the default is used (80).
`alias`	The virtual path that stands in for the absolute path to the files a URL will access.
`myreport.jsp`	The report `*.jsp` file that you want this URL to execute.
`?`	Identifies the beginning of the command line options.
`parameters`	All the command line options, or the key to the key map file where command line options are specified.

The URL used to invoke a JSP-based report could look like this:

http://neptune.world.com:80/jsp/myreport.jsp?

You can specify a key in the URL that refers to a command in the cgicmd.dat file that contains additional command line parameters. In this case, you must use the name value pair: cmdkey=keyname. This can appear anywhere in your URL after the start of the query string (marked by a question mark). For example:

http://neptune.world.com:80/jsp/myreport.jsp?userid=scott/tiger@hrdb&cmdkey=key1

In your URL, use an ampersand (&) with no spaces to string parameters together.

When you use a JSP, you can also use Oracle Reports Servlet (rwservlet). When you run the report, specify Oracle Reports Servlet (rwservlet) in the URL and call the JSP with the command line option: report=myreport.jsp.

For example:

http://neptune.world.com:80/reports/rwservlet?report=myreport.jsp&destype=cache&desformat=html

For more information about command line keywords, see Appendix A, "Command Line Keywords"..