Oracle® OHS mod_plsql OWA_UTIL Package Overview

• BIND_VARIABLES

  Creates complex HTML structures, prepares a SQL query and binds up to 25 variables to it

• CALENDARPRINT

  Prints calendars in HTML format either from a given SQL query or a given cursor/p>

• CELLSPRINT

  Various routines for printing HTML tables in many forms based on a SQL query or a given cursor

• CHOOSE_DATE

  Shows 3 HTML select items (day, months, year) through which the user can select a date. No validation by default: It's possible to select invalid dates such as 30 February 2014

• DATETYPE

  index-by table of varchar2(10). Represents a date type. Use by the function owa_util.todate

• GET_CGI_ENV() function

• GET_CGI_ENV( 'DAD_NAME' )

  The name of the DAD (Database Access Descriptor) used for this call

• GET_CGI_ENV( 'DOCUMENT_TABLE' )

  Specifies the table to be used for storing documents when file uploads are performed. This is set up in the DAD's PlsqlDocumentTable parameter

• GET_CGI_ENV( 'DOC_ACCESS_PATH' )

  Specifies the virtual path that is used for accessing uploaded documents for this DAD. This is set up in the DAD's PlsqlDocumentPath parameter

• GET_CGI_ENV( 'GATEWAY_INTERFACE' )

  The version of CGI used, e.g. CGI/1.1

• GET_CGI_ENV( 'GATEWAY_IVERSION' )

  The version of the OHS PL/SQL Gateway

• GET_CGI_ENV( 'HTTP_ACCEPT' )

  Comma-separated list of MIME types that the client accepts, e.g. text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8

• GET_CGI_ENV( 'HTTP_ACCEPT_ENCODING' )

  Comma-separated list of encodings that the client accepts, e.g. gzip, deflate

• GET_CGI_ENV( 'HTTP_ACCEPT_LANGUAGE' )

  Comma-separated list of languages that the client accepts, e.g. de-DE

• GET_CGI_ENV( 'HTTP_HOST' )

  The OHS / IAS application server's virtual hostname and domain from the URL

• GET_CGI_ENV( 'HTTP_USER_AGENT' )

  The client program and platform, typically the browser, e.g. Mozilla/5.0 (Windows NT 5.1) AppleWebKit/534.57 (KHTML, like Gecko) Version/6.1 Safari

• GET_CGI_ENV( 'PATH_ALIAS' )

  Path alias for the called DAD if set in the DAD with the PlsqlPathAlias parameter

• GET_CGI_ENV( 'PATH_INFO' )

  Path info from the URL request, i.e. the stored procedure name

• GET_CGI_ENV( 'PLSQL_GATEWAY' )

  Which PL/SQL gateway that is used e.g. WebDb

• GET_CGI_ENV( 'REMOTE_ADDR' )

  The client IP address

• GET_CGI_ENV( 'REMOTE_USER' )

  The client user e.g. the username specified in the DADs PlsqlDatabaseUsername

• GET_CGI_ENV( 'REQUEST_CHARSET' )

  Set to the default character set in use, which can be overridden by the DAD's PlsqlNlsLang parameter, default UTF8

• GET_CGI_ENV( 'REQUEST_IANA_CHARSET' )

  The IANA (Internet Assigned Number Authority) equivalent of the REQUEST_CHARSET variable, defaults to UTF-8

• GET_CGI_ENV( 'REQUEST_METHOD' )

  HTTP request method, ie GET or POST

• GET_CGI_ENV( 'REQUEST_PROTOCOL' )

  HTTP

• GET_CGI_ENV( 'SCRIPT_NAME' )

  Virtual path from the URL excluding the procedure name, e.g. /pls/scott

• GET_CGI_ENV( 'SCRIPT_PREFIX' )

  The mod_plsql prefix from the virtual path, excluding the DAD name, e.g. /pls

• GET_CGI_ENV( 'SERVER_NAME' )

  The server name or IP address

• GET_CGI_ENV( 'SERVER_PORT' )

  The server's HTTP port, eg 80

• GET_CGI_ENV( 'SERVER_PROTOCOL' )

  HTTP version of the server e.g. HTTP/1.1

• GET_CGI_ENV( 'SERVER_SOFTWARE' )

  Name and version of the application server, e.g. Oracle-Application-Server-10g/10.0.1.0.0 Oracle-HTTP-Server

• GET_CGI_ENV( 'WEB_AUTHENT_PREFIX' )

  default null

• GET_OWA_SERVICE_PATH

  Environment

• GET_PROCEDURE

  Debugging

• HTTP_HEADER_CLOSE

  Closes the HTTP response header section. Must always be called before any HTP.x or HTF.x calls

• IDENT_ARR

  PL/SQL index-by table of type varchar2(30), the size of object names in Oracle. Useful datatype for handling multiple HTML form input parameters of limited size

• IP_ADDRESS

  Queries the environment

• ITE

  If-Then-Else "macro", smart shorthand notation

• LISTPRINT

  Prints HTML list box

• MIME_HEADER

  Sets the Content-Type HTTP response header to given MIME type and optionally closes the HTTP response header section. Must be called before any HTP or HTF calls

• NUM_ARR

  PL/SQL index-by table of NUMBER

• PRINT_CGI_ENV

  Prints all name-value pairs in the CGI environment which OWA has made available to PL/SQL

• REDIRECT_URL

  Redirects to another URL. Must be called before any HTP or HTF calls

• SHOWPAGE

  Shows a page's output via DBMS_OUTPUT, for debugging purposes. Called after the stored procedure has been called manually, both from SQL*Plus

• SHOWSOURCE

  Shows the source code for a given stored procedure. By default, this procedure cannot be invoked through mod_plsql. For more information please refer to the section Advanced PL/SQL Web Topics

• SIGNATURE

  HTML and HTTP utilities

• STATUS_LINE

  HTML and HTTP utilities

• TABLE%

  Various routines for printing HTML tables based on a SQL query

• TABLEPRINT

  Creates complex HTML structures

• TODATE

  Represents dates

• VC_ARR

  PL/SQL index-by table of VARCHAR2(32000). Useful datatype for handling multiple large HTML form input parameters

• WHO_CALLED_ME

  Determines from where the procedure was called