There may be references to other Oracle Outside In Technology SDKs within this manual. To obtain complete documentation for any other Oracle Outside In product, see:
and click on Outside In Technology.
This chapter includes the following sections:
The updated list of supported formats is linked from the page http://www.outsideinsdk.com/. Look for the data sheet with the latest supported formats.
A new callback, EX_CALLBACK_ID_BEGINPAGE, indicates that a new page of output is about to be created.
Support for redactions has been added. A redaction is a "highlight" that intentionally hides data from the document. It is specified similarly to a style highlight, but without a style specified. The EXRedactText export function has been added to accept a data structure that defines a redaction. In the C structure, the options SCCOPT_REDACTIONS_ENABLED, SCCOPT_SHOW_REDACTION_LABELS, SCCOPT_REDACTION_COLOR, SCCOPT_REDACTION_LABEL_FONT_NAME, and SCCOPT_REDACTION_LABEL_FONT_SIZE let you define the content and appearance of a redaction label. Equivalent options have also been added for Java and .NET.
Support for margin text has been added. The C options SCCOPT_MARGIN_TEXT_FONT_NAME, SCCOPT_MARGIN_TEXT_FONT_SIZE, and SCCOPT_MARGIN_TEXT_LINE let you define the content and appearance of the margin text. Equivalent options have been added for Java and .NET.
The EXExportStatus function status information has been expanded to include five new flags: bTypeThreeFont, bUnsupportedShading, bInvalidHTML, bVectorObjectLimit, and bInvalidAnnotationNotApplied. These same values have been added to the enumerations for the ExportStatus Class (.NET) and ExportStatus Class (Java).
Two new sections have been added to the .NET chapter: Option Interface allows you to retrieve information about Outside In options; and OutsideInCastException Class is thrown when an invalid value is provided as an option value. The new section Option Interface has been added to the Java chapter.
A new C option, SCCOPT_VECTOROBJECTLIMIT, allows you to set a limit on the number of objects that will be generated in an SVG drawing. This is also available as .NET (VectorObjectLimit) and Java (VectorObjectLimit).
— Two new fields are available for OIT.view.info, "filename" and "libversion."
— New fields were added for the option OIT.document.setOptions.
— The description for OIT.document.textSelection has been updated.
— A new version of the option OIT.document.textRangehas been added.
— The option OIT.highlights.style was added.
— The option OIT.highlights.redact was added.
— The option OIT.highlights.type was added.
— The option OIT.highlights.label was added.
— The option OIT.highlights.addNote was added.
— There are new values available for the type parameter of OIT.highlights.autoHighlight.
— A new function was added to OIT.highlights.serialize to accept highlight IDs or arrays of highlight IDs.
— New options were added to OIT.highlights.setOptions.
— The option OIT.highlights.hideComment can now collapse an anchored note to an icon.
— The events move, remove, and comment were added to OIT.highlights.addEventListener.
— The option OIT.attachments.setOptions was added.
The following sections provide an overview of the Web View Export SDK:
The architecture of Outside In Web View Export consists of two major components:
An export module (EXH5) with a robust API similar to other Outside In export products, which produces high-quality renditions of input documents.
The export module is a loadable library with a rich API for controlling its behavior and certain aspects of the output. Versions of the API are available for C, Java, and .NET programs.
Detailed reference documentation for the API can be found at the following locations:
The Web View Export browser-side API consists of a global object that provides a set of functions that allow a script writer to customize the navigation and interactive behavior of the Web View Export output. Outside In Web View Export allows custom scripts to be referenced from within the HTML5 renditions, which enables use of the browser-side API and integration into a web application.
Customizing the Web View Export Output
See Web View Export C/C++ Options for the C API of the Web View Export Module.
The descriptions below are intended to add context to some of the new options that have been added specifically for the Web View Export product.
Partitioning of Content Between Output Files (Output Paging)
It is likely that an application would not want to render large documents as a single HTML output file. The Web View Export export module provides an “output paging" option that allows a document be rendered to separate HTML files for each page, allowing for faster random access in a browser.
Extending Output with Custom Scripts
The following terms are used in this documentation.
Someone integrating this technology into another technology or application. Most likely this is you, the reader.
The file the developer wishes to export.
The output file being written.
Data Access Module
The core of Oracle Outside In Data Access, in the SCCDA library.
Data Access Submodule (also referred to as "Submodule")
This refers to any of the Oracle Outside In Data Access modules, including SCCEX (Export), but excluding SCCDA (Data Access).
Document Handle (also referred to as "hDoc")
A Document Handle is created when a file is opened using Data Access (see Data Access Common Functions). Each Document Handle may have any number of Subhandles.
Subhandle (also referred to as "hItem")
Any of the handles created by a Submodule's Open function. Every Subhandle has a Document Handle associated with it. For example, the hExport returned by EXOpenExport is a Subhandle. The DASetOption and DAGetOption functions in the Data Access Module may be called with any Subhandle or Document Handle. The DARetrieveDocHandle function returns the Document Handle associated with any Subhandle.
Each Oracle Outside In product has an sdk directory, under which there is a subdirectory for each platform on which the product ships. Under each of these directories are the following three subdirectories:
redist: Contains only the files that the customer is allowed to redistribute. These include all the compiled modules, filter support files, .xsd and .dtd files, cmmap000.bin, and third-party libraries.
sdk: Contains the materials necessary to develop software that uses the Web View Export export module, as well as demonstration code for instructional purposes.
In the root directory of the SDK deliverable, there are two files:
README: Explains the contents of the sdk, and that makedemo must be run in order to use the sample applications.
makedemo (either .bat or .sh – platform-based): This script will either copy (on Windows) or Symlink (on Unix) the contents of …/redist into …/sdk/demo, so that sample applications can then be run out of the demo directory.
If you load more than one OIT SDK, you must copy files from the secondary installations into the top-level OIT SDK directory as follows:
redist – copy all binaries into this directory.
sdk – this directory has several subdirectories: common, demo, lib, resource, samplecode, samplefiles. In each case, copy all of the files from the secondary installation into the top-level OIT SDK subdirectory of the same name. If the top-level OIT SDK directory lacks any directories found in the directory being copied from, just copy those directories over.