CODE
Oracle Code Library
JOBS
Find Or Post Oracle Jobs
FORUM
Oracle Discussion & Chat
PSOUG Home Code Snippets Oracle Reference Oracle Functions PSOUG Forum Oracle Blogs Bookmark and Share
 
 Search the Reference Library pages:  

Free
Oracle Magazine
Subscriptions
and Oracle White Papers

Oracle DBMS_REPORT

Version 11.1
 
General Information
Purpose A framework for helping server components build XML from within the kernel
Source {ORACLE_HOME}/rdbms/admin/dbmsrep.sql

Constants
Name Data Type Value
CONTENT_TYPE_XML NUMBER 1
CONTENT_TYPE_HTML NUMBER 2
CONTENT_TYPE_TEXT NUMBER 3
CONTENT_TYPE_BINARY NUMBER 4
SHARED_DIRECTORY_OBJECT VARCHAR2(64) 'ORAREP_DIR'
Data Types TYPE ref_string_idspec IS TABLE OF VARCHAR2(32767) INDEX BY VARCHAR2(32767);
Dependencies SELECT name FROM dba_dependencies WHERE referenced_name = 'DBMS_REPORT'
UNION
SELECT referenced_name FROM dba_dependencies WHERE name = 'DBMS_REPORT';
Security Model Execute is granted to PUBLIC
 
BUILD_GENERIC_TAG
Undocumented function for internal use only dbms_report.build_generic_tag(
tag_name   IN VARCHAR2,
tag_inputs IN UNDEFINED)
RETURN XMLTYPE;
TBD
 
BUILD_REPORT_REFERENCE_STRUCT
Builds a report ref string given the necessary inputs dbms_report.build_report_reference_struct(
component_name IN VARCHAR2,
report_name    IN VARCHAR2,
id_param_val   IN ref_string_idspec)
RETURN VARCHAR2;
TBD
 
BUILD_REPORT_REFERENCE_VARG
Builds a report ref string given the necessary inputs dbms_report.build_report_reference_varg(
component_name IN VARCHAR2,
report_name    IN VARCHAR2,
id_param_val   IN UNDEFINED)
RETURN VARCHAR2;
exec build_report_reference_varg('cname','rname','foo','1','bar','2');
 
CLEAR_FRAMEWORK
Undocumented function for internal use only dbms_report.clear_framework(component_name IN VARCHAR2 := NULL);
TBD
 
CREATE_SHARED_DIRECTORY
Changes the location of the directory object used for loading files into the framework. See the  SHARED_DIRECTORY_OBJECT constant
above. This function should be called once per directory whenever
STORE_FILE will be used with the SHARED_DIRECTORY_OBJECT.
dbms_report.create_shared_directory(dirname IN VARCHAR2);
TBD
 
DROP_SHARED_DIRECTORY
Drops the directory object used to
find xslts and schemas on disk and load them into the database. See the
SHARED_DIRECTORY_OBJECT constant. Call whenever clients are done reading from the directory.
dbms_report.drop_shared_directory;
exec dbms_report.drop_shared_directory;
 
FORMAT_REPORT
Transforms an XML document into another format, as declared through one of the register_xxx_format calls above dbms_report.format_report(
report              IN  XMLTYPE,
format_name         IN  VARCHAR2,
format_content_type OUT NUMBER)
RETURN CLOB;
TBD
 
GET_REPORT
Undocumented function for internal use only dbms_report.get_report(
report_reference IN  VARCHAR2,
content_type     OUT NUMBER)
RETURN CLOB;
TBD
 
PARSE_REPORT_REFERENCE
Parses a report reference to reveal its constituent parts. Each one is returned as an OUT parameter, converted to lower case. dbms_report.parse_report_reference(
report_reference IN  VARCHAR2,
component_name   OUT VARCHAR2,
report_name      OUT VARCHAR2,
id_param_val     OUT ref_string_idspec);
TBD
 
REGISTER_COMPONENT
Registers a new component with the XML reporting framework. It should be called at database startup from within the dbms_report_registry package. dbms_report.register_component(
component_name   IN VARCHAR2,
component_desc   IN VARCHAR2,
component_object IN wri$_rept_abstract_t);
TBD
 
REGISTER_CUSTOM_FORMAT
Registers a custom format for an XML document. Allows components to format their document for viewing manually, by performing any kind of programmatic manipulation of the XML tree and outputting CLOB. dbms_report.register_custom_format(
component_name      IN VARCHAR2,
report_name         IN VARCHAR2,
format_name         IN VARCHAR2,
format_desc         IN VARCHAR2,
format_content_type IN NUMBER);
TBD
 
REGISTER_REPORT

Registers a report with the framework
dbms_report.register_report(
component_name IN VARCHAR2,
report_name    IN VARCHAR2,
report_desc    IN VARCHAR2,
schema_id      IN NUMBER);
TBD
 
REGISTER_TEXT_FORMAT
Registers a format mapping for a text report. Text reports are created by first transforming an XML document to HTML using an XSLT provided by the component, and then turning the HTML to formatted text using the framework's own internal engine. Prior to calling this function the XSLT should have been stored in XDB by  calling STORE_FILE. After a format has been registered it can be used by calling FORMAT_REPORT. dbms_report.register_text_format(
component_name     IN VARCHAR2,
report_name        IN VARCHAR2,
format_name        IN VARCHAR2,
format_desc        IN VARCHAR2,
html_stylesheet_id IN NUMBER,
text_max_linesize  IN NUMBER := 80);
TBD
 
REGISTER_XSLT_FORMAT
Registers a format mapping for a report via XSLT. Prior to calling this function the XSLT should have been stored in XDB by calling STORE_FILE. After a format has been registered it can be used by calling FORMAT_REPORT. dbms_report.register_xslt_format(
component_name      IN VARCHAR2,
report_name         IN VARCHAR2,
format_name         IN VARCHAR2,
format_desc         IN VARCHAR2,
format_content_type IN NUMBER := CONTENT_TYPE_HTML,
stylesheet_id       IN NUMBER);
TBD
 
STORE_FILE
Stores a file in the framework.  should be called by dbms_report_registry during database creation. File names
are unique by component.
dbms_report.store_file(
component_name IN VARCHAR2,
filename       IN VARCHAR2,
directory      IN VARCHAR2 := SHARED_DIRECTORY_OBJECT)
RETURN NUMBER;
TBD
 
TRANSFORM_HTML_TO_TEXT
Undocumented function for internal use only dbms_report.transform_html_to_text(
document     IN XMLTYPE,
max_linesize IN POSITIVE)
RETURN CLOB;
TBD
 
VALIDATE_REPORT
applies the XML schema registered with the framework corresponding to the report specified to verify that it was built correctly dbms_report.validate_report(report IN XMLTYPE);
TBD
 
Related Topics
 
 
Home      :      Code Library      :      Sponsors      :      Privacy      :      Terms of Use      :      Contact Us [57 users online]    © 2010 psoug.org