Contents

Title and Copyright Information

Send Us Your Comments

Preface

Documentation Accessibility

Related Documents

What's New in Oracle HTML DB?

Oracle HTML DB Release 1.6 New Features

Part I Getting Started with Oracle HTML DB

1 What is Oracle HTML DB?

About Oracle HTML DB

About Application Builder

About SQL Workshop

About Data Workshop

2 Quick Start

Understanding Oracle HTML DB User Roles

Logging in to Oracle HTML DB

Requesting a Workspace

Logging in to a Workspace

Resetting Your Password

Logging Out of Your Workspace

About the Oracle HTML DB User Interface

Navigating Using Breadcrumb Menus

Accessing Online Help

Creating an Application Using the Create Application Wizard

Running Your Application

3 Running a Demonstration Application

Viewing and Installing a Demonstration Application

Running a Demonstration Application

Running an Application from Demonstration Applications

Running an Application from the Workspace Home Page

Understanding Sample Application

About the Home Page

About the Customers Page

About the Products Page

About the Orders Page

About the Charts Page

About the Admin Page

Viewing Pages in Printer Friendly Mode

Modifying a Demonstration Application

About the Developer Toolbar

Editing a Demonstration Application

Viewing Underlying Database Objects

Part II Using Oracle HTML DB

4 Managing Data with Data Workshop

About Data Workshop

Importing a Text File

Importing an XML Document

Importing Spreadsheet Data

Exporting to a Text File

Exporting to an XML Document

5 Managing Database Objects with SQL Workshop

About SQL Workshop

About Transaction Support

About Unsupported SQL*Plus Commands

Viewing Database Objects

Using the SQL Command Processor

About Command Termination

Using Explain Plan

Viewing Database Objects

Querying by Example

Managing Database Objects

Creating Database Objects

Dropping Database Objects

Restoring Dropped Database Objects

Using the SQL Script Repository

Managing Script Files in the SQL Script Repository

Uploading and Creating Script Files

About Script Termination

Using Parameters in a Script

Including SQL Queries in a Script

Exporting a Script File

Accessing Saved Commands in the SQL Archive

Accessing the SQL Command History

Managing Control Files

Viewing the Control File Run History

Viewing Control File Job Status

Managing Tables

Managing User Interface Defaults

Viewing Tables Utilizing User Interface Defaults

Editing a Column Attributes

Editing Column-level Defaults

Viewing the Column Definition Report

Applying User Interface Defaults to a Table or View

Comparing User Interface Defaults Across Applications

About Exporting and Importing User Interface Defaults

Browsing the Data Dictionary

6 Application Builder Concepts

About the Workspace Home Page

What is Application Builder?

What is a Page?

About Page Rendering

About Page Processing

About Shared Components

Lists of Values

Navigation Bars

How Page Processing and Page Rendering Work

Understanding Conditional Rendering and Processing

Current Page In Expression 1

PLSQL Expression

Verifying User Identity

Controlling Access to Controls and Components

Understanding Session State Management

Understanding Session IDs

Viewing Session State

Managing Session State Values

Referencing Session State

Setting Session State

Clearing Session State

Clearing Cache by Item

Clearing Cache by Page

Clearing Cache for an Entire Application

Clearing Cache for the Current User Session

About Bind Variables

Using Bind Variables in Regions Based on a SQL Query or LOV

Using Bind Variables in PL/SQL Procedures

Understanding URL Syntax

Using f?p Syntax to Link Pages

Calling a Page Using an Application and Page Alias

Calling a Page from a Button URL

Using Substitution Strings

Built-in Substitution Strings

APP_UNIQUE_PAGE_ID

AUTHENTICATED_URL_PREFIX

BROWSER_LANGUAGE

CURRENT_PARENT_TAB_TEXT

HTML DB SCHEMA OWNER

PRINTER_FRIENDLY

PUBLIC_URL_PREFIX

SYSDATE_YYYYMMDD

WORKSPACE_IMAGES

7 Using Application Builder

Accessing Application Builder

About the Application Builder Home Page

Editing Application Attributes

Application Definition

Session Management

Application Availability

Global Notifications

Virtual Private Database (VPD)

Static Substitution Strings

Application Template Defaults

Wizard Template Defaults

Application Comments

Viewing a Page Definition

Understanding the Page Definition

Additional Page Definition Features

Object References

Using the Developer Toolbar

Editing a Page Definition

Accessing a Page Definition

Accessing a Summary View of Controls, Components, and Application Logic

Copying or Creating a New Control or Component

Editing Page Attributes

Page Identification

Primary Display Attributes

Page Header, Footer and Text Attributes

On Load JavaScript

Duplicate Page Submission Checks

Configuration Management

Understanding Page Rendering Controls

Page Computations

Understanding Page Processing Controls

Understanding Validations

Understanding Branching

Creating a Page Computation

Editing Computation Attributes

Defining a Computation Point and Computation Source

Creating Conditional Computations

Creating a Page Process

Editing Process Attributes

Working with Shared Components

Accessing Shared Components

About Themes and Templates

How Themes and Page Templates Effect User Interface

Viewing Application Reports

About the Database Object Dependencies Report

About the Region Source Report

8 Building an Application

Creating an Application

Creating a New Application

Deleting an Application

Adding Additional Pages

Creating a Page from Application Builder

Creating a Page from the Page Definition

Creating a Page from the Developer Toolbar

Creating a Page Group

Assigning Pages to a Page Group

Viewing the Page Group Report

Locking and Unlocking Page

Accessing Alternative Locked Pages Views

Deleting a Page

Creating Reports

Creating a Report Using a Wizard

Editing Report Attributes

Controlling Report Pagination

Including Pagination After the Rows in a Report

Including Pagination Before the Rows in a Report

Enabling Column Sorting

Exporting a Report as a CSV or XML File

Creating a Column link

Defining an Updatable Column

Defining a Column as a List of Values

Controlling When Columns Display

Controlling Column Breaks

Creating a Form Using a Wizard

Creating a Tabular Form

Building a Master Detail Form

Creating a Form Manually

Processing a Form

Creating an Automatic Row (DML) Processing Process

Creating a Process that Contains One or More Insert Statements

Using a PL/SQL API to Process Form Values

Populating Forms

Validating User Input in Forms

About Error Messaging

Creating Charts

About SVG Plug-in Support

About Creating Charts

Creating a New Chart

Adding a Chart to an Existing Page

Adding a Chart to a New Page

Editing Chart Attributes

Understanding Chart CSS Classes

Referencing a Custom Cascading Style Sheet

Specifying Custom CSS Styles Inline

Enabling Asynchronous Updates

Displaying Charts in Other Languages

Creating Buttons

Creating a Button Using a Wizard

Creating an HTML Button

Creating Multiple Buttons

Understanding the Relationship Between Button Names and REQUEST

About Branching with Buttons

Displaying Buttons Conditionally

Creating a Page Level Item

About Item Naming Conventions

About Item Types

Referencing Item Values

Displaying Conditional or Read-only Items

Creating an Application Level Item

Accessing Application Item History

Populating an Alternative Date Picker Format

Defining PICK_DATE_FORMAT_MASK as an Application Substitution String

Defining an Application Level Item Named PICK_DATE_FORMAT_MASK

Creating Lists of Values

Creating Named LOVs at the Application Level

About Static LOVs

About Popup LOVs

Referencing Session State within a LOV

Accessing LOV Reports

Bulk Update LOV Data Values

Subscribed LOVs

LOV Utilization

LOV Change History

Creating Calendars

About Creating Calendars

Supported Calendar Substitution Strings

Creating a New Calendar

Adding a Calendar to an Existing Page

Adding a Calendar to a New Page

Converting an Easy Calendar to a SQL Calendar

Editing a Calendar Title

Editing Calendar Attributes

Accessing the Calendar Attributes Page

Calendar Display

Calendar Interval

Utilizing Shortcuts

About Shortcut Types

Text with JavaScript Escaped Single Quotes

Message with JavaScript Escaped Single Quotes

Defining Shortcuts

Accessing Shortcut Reports

Subscribed Shortcuts

Shortcut History

Incorporating JavaScript into an Application

About Referencing Items Using JavaScript

How to Incorporate JavaScript Functions

Incorporating JavaScript in the HTML Header Attribute

Including JavaScript in a .js File in the Page Template

Calling JavaScript from a Button

Creating Dependent Select Lists

Creating a Help Page

Creating a Help Page and Region

Defining Help Text

About the Item Help Text Report

Creating a Help Navigation Bar Icon

9 Controlling Page Layout and User Interface

Understanding Page Layout

Displaying Components on Every Page of an Application

How Item Attributes Affect Page Layout

Customizing Regions

Creating a Region

How Region Attributes Affect Page Layout

Controlling Region Positioning

Specifying a Region Header and Footer

Enabling Users to Customize a Page

Incorporating Content from Other Web Sites

Managing Themes

Accessing the Themes Page

Changing Default Templates in a Theme

Creating a New Theme

Switching an Active Theme

Copying a Theme

Deleting a Theme

About Exporting and Importing Themes

Changing a Theme Identification Number

Viewing Theme Reports

Viewing All Templates in a Theme

Viewing Theme Template Counts

Viewing File References

Viewing Class References

Viewing Template Substitution Strings

Customizing Templates

About Cascading Style Sheets

Selecting a Default Page Template

Selecting a Page Level Template within a Theme

Selecting a Page Level Template for a Specific Page

Viewing Templates

Creating a New Template

Viewing Template Reports

Editing Templates

Button Templates

Button Template Attributes

Calendar Templates

Calendar Template Attributes

Label Templates

Label Template Attributes

List Template Attributes

Breadcrumb Style Menu Navigation

Menu Template Attributes

Supported Page Template Substitution Strings

Page Template Attributes

Popup LOV Templates

Popup List of Values Template Attributes

Region Templates

Region Template Attributes

Report Templates

About Generic Column Templates and Named Column Templates

Report Column Template Attributes for Generic Column Templates

Report Column Template Attributes for Named Column Templates

About Using JavaScript in Column Templates

Optimizing a Page for Printing

Setting a Print Mode Template for an Application

Using f?p Syntax to Toggle to Print Mode

Using Custom Cascading Style Sheets

Uploading Cascading Style Sheets

Referencing an Uploaded Cascading Style Sheet in the Page Template

Uploading Images

Referencing Images

Uploading Static Files

Creating a Multiple Column Layout

Creating Regions in Multiple Columns

Creating a Multiple Column Page Template

Rendering HTML Using Custom PL/SQL

10 Adding Navigation

Creating a Navigation Bar

Creating a Navigation Bar Entry

Managing Navigation Bar Entries

About Template Support

Using Tab Manager

Accessing Tab Manager

Creating a New Tab from the Page Definition

Editing Multiple Tabs at Once

Accessing Tab Reports

Standard Tab Utilization

Standard and Parent Tab History

Controlling Flow Using Branches

About Breadcrumb Menus

Creating a Menu

Adding Options to a Menu

Adding a Menu to a Page

About Creating a Dynamic Menu

Editing Multiple Menu Names Simultaneously

Accessing Menu Reports

Menu Utilization Report

Recent Menu Option Changes

Creating a List

Adding Items to a List

Adding a List to a Page

Editing Multiple List Entries Simultaneously

Accessing List Reports

List Utilization

List Definition and List Entry History

Accessing Tree Reports

Tree Utilization

11 Debugging an Application

About Tuning Performance

Reviewing Session State

Accessing Debug Mode

Enabling SQL Tracing and Using TKPROF

Monitoring Application and Page Resource Use

Viewing Oracle HTML DB Reports

Debugging Problematic SQL Queries

Removing Controls and Components to Isolate a Problem

12 Deploying an Application

About the Oracle HTML DB Application Development Life Cycle

System Development Life Cycle Methodologies to Consider

About Deploying an Application in Oracle HTML DB

Deployment Options to Consider

Whether to Copy the Workspace

Whether to Copy the Database

About the Application ID

Whether to Install a New Oracle HTTP Server

Deploying an Application to Another Oracle HTML DB Instance

How Exporting an Application Works

About Managing Database Objects

Exporting an Application and Related Files

Exporting an Application

Exporting a Page in an Application

Exporting Cascading Style Sheets

Exporting Images

Exporting Static Files

Exporting Script Files

Exporting Themes

Exporting User Interface Defaults

Importing Export Files

Installing Files from the Export Repository

About Publishing the Application URL

Using Build Options to Control Configuration

Creating Build Options

Viewing Build Option Reports

13 Managing a Development Workspace

Understanding Administrator Roles

About the Workspace Administration List

Changing Your Password

Monitoring Workspace and User Activity

Viewing Workspace and User Activity Reports

Viewing Application Changes by Developer and Day

Purging Log Files

Purging the Developer Activity Log

Purging the External Clicks Log

Viewing Application and Schema Reports

Managing Session State and User Preferences

Managing Session State and User Preferences for the Current Session

Purging Recent Sessions by Age

Viewing Session Details Prior to Removing Session State

Viewing Preferences for a Specific User

Purging Preferences for a Specific User

Creating New User Accounts

Editing Existing User Accounts

Changing a User Password

Managing Groups

Creating and Editing Groups

Viewing Group Assignment Reports

Adding Users to and Removing Users from a Group

Managing Development Services

Viewing Current Workspace Status

Requesting a Database Schema

Requesting Additional Storage

Requesting Service Termination

14 Managing Security

Escaping Special Characters Rendered from Session State

Understanding Security

Using the Security Navigation List

Establishing User Identity Through Authentication

Understanding How Authentication Works

Creating an Authentication Scheme

Using the Authentication Scheme Repository

Viewing the Current Authentication Scheme for an Application

About Preconfigured Authentication Schemes

About DAD Credentials Verification

About HTML DB Account Credentials

About LDAP Credentials Verification

About Single Sign-On Server Verification

About Creating an Authentication Scheme from Scratch

About Session Management Security

Building a Login Page

About Deep Linking

Providing Security Through Authorization

How Authorization Schemes Work

Creating an Authorization Scheme

About the Evaluation Point Attribute

About Resetting Authorization Scheme State

Attaching an Authorization Scheme to an Application, Page, or Components

Attaching an Authorization Scheme to an Application

Attaching an Authorization Scheme to a Page

Attaching an Authorization Scheme to a Control or Component

Viewing Authorization Scheme Utilization Reports

15 Advanced Programming Techniques

Sending E-mail from an Application

Sending E-mail Using a Background Job

Sending E-mail Manually by Calling HTMLDB_MAIL

Accessing Data with Database Links

Using Collections

About the HTMLDB_COLLECTION API

About Collection Naming

Creating a Collection

About the Parameter p_generate_md5

Truncating a Collection

Deleting a Collection

Deleting All Collections for the Current Application

Deleting All Collections in the Current Session

Adding Members to a Collection

About the Parameters p_generate_md5 and p_clob001

Updating Collection Members

Deleting a Collection Member

Determining Collection Status

Merging Collections

Managing Collections

Obtaining a Member Count

Resequencing a Collection

Verifying Whether a Collection Exists

Adjusting Member Sequence ID

Sorting Collection Members

Clearing Collection Session State

Running Background PL/SQL

Understanding the HTMLDB_PLSQL_JOB Package

About System Status Updates

Using a Process to Implement Background PL/SQL

Implementing Web Services

Understanding Web Service References

Accessing the Web Service References Page

Specifying an Application Proxy Server Address

Creating a Web Service Reference

Creating a Web Service Reference by Searching a UDDI Registry

Creating a Web Service Reference by Specifying a WSDL Document

Using the Web Service Reference Repository

Testing a Web Service Reference

Creating an Input Form and Report on a Web Service

Creating a Form and Report Directly After Creating a Reference

Creating a Form and Report by Adding a New Page

Creating a Form on a Web Service

Creating a Form Directly After Creating a Reference

Creating a Form by Adding a New Page

Invoking a Web Service as a Process

Displaying Web Service Results in a Report

Editing a Web Service Process

Viewing a Web Service Reference History

Managing User Preferences

Viewing User Preferences

Setting User Preferences

Setting User Preferences Using a Page Process

Setting the Source of an Item Based on a User Preference

Setting User Preferences Programatically

Resetting User Preferences Manually

Resetting Preferences Using a Page Process

16 Managing Globalization

About Translating an Application and Globalization Support

About Language Identification

Rule for Translating Applications in Oracle HTML DB

How Translated Applications Are Rendered

About Translatable Components

About Shortcuts that Support Translatable Messages

About Dynamic Translation Text Strings

About Translating Templates

Specifying the Primary Language for an Application

Using Format Masks for Items

Translating Applications for Multibyte Languages

Understanding the Translation Process

Navigating to the Translate Application Page

Mapping Primary and Target Application IDs

Seeding and Exporting Text to a Translation File

Seeding Translatable Text

Exporting Text to a Translation File

Translating the XLIFF File

Uploading and Publishing a Translated XLIFF Document

Translating Messages Used in PL/SQL Procedures

Defining Translatable Messages

HTMLDB_LANG.MESSAGE API

Translating Data that Supports List of Values

Defining a Dynamic Translation

HTMLDB_LANG.LANG API

About Oracle HTML DB Globalization Codes

17 Oracle HTML DB APIs

CHANGE_CURRENT_USER_PW Procedure

CLEAR_APP_CACHE Procedure

CLEAR_PAGE_CACHE Procedure

CLEAR_USER_CACHE Procedure

COUNT_CLICK Procedure

CREATE_USER Procedure

CREATE_USER_GROUP Procedure

CURRENT_USER_IN_GROUP Function

EDIT_USER Procedure

EXPORT_USERS Procedure

FETCH_APP_ITEM Function

FETCH_USER Procedure

FIND_SECURITY_GROUP_ID Function

FIND_WORKSPACE Function

GET_ATTRIBUTE Function

GET_CURRENT_USER_ID Function

GET_DEFAULT_SCHEMA Function

GET_EMAIL Function

GET_FILE Procedure

GET_FILE_ID Function

GET_FIRST_NAME Function

GET_GROUPS_USER_BELONGS_TO Function

GET_GROUP_ID Function

GET_GROUP_NAME Function

GET_LAST_NAME Function

GET_USERNAME Function

GET_NUMERIC_SESSION_STATE Function

GET_PREFERENCE Function

GET_SESSION_STATE Function

GET_USER_ID Function

GET_USER_ROLES Function

IS_LOGIN_PASSWORD_VALID Function

IS_USERNAME_UNIQUE Function

PUBLIC_CHECK_AUTHORIZATION Function

REMOVE_PREFERENCE Procedure

REMOVE_SORT_PREFERENCES Procedure

REMOVE_USER Procedure

RESET_PW Procedure

RESET_AUTHORIZATIONS Procedure

SET_EMAIL Procedure

SET_FIRST_NAME Procedure

SET_LAST_NAME Procedure

SET_USERNAME Procedure

SET_PREFERENCE Procedure

SET_SESSION_STATE Procedure

STRING_TO_TABLE Function

TABLE_TO_STRING Function

URL_ENCODE Function

PUSH_QUEUE Procedure

CHECKBOX Function

DATE_POPUP Function

DISPLAY_AND_SAVE Function

HIDDEN Function

MD5_CHECKSUM Function

MD5_HIDDEN Function

MULTI_ROW_UPDATE Procedure

SELECT_LIST Function

SELECT_LIST_FROM_LOV Function

SELECT_LIST_FROM_LOV_XL Function

SELECT_LIST_FROM_QUERY Function

SELECT_LIST_FROM_QUERY_XL Function

TEXT_FROM_LOV Function

TEXT_FROM_LOV_QUERY Function

RADIOGROUP Function

POPUP_FROM_LOV Function

POPUP_FROM_QUERY Function

POPUPKEY_FROM_LOV Function

POPUPKEY_FROM_QUERY Function

HTMLDB_APPLICATION

Referencing Arrays

Referencing Values Within an On Submit Process

Converting an Array to a Single Value

HTMLDB_CUSTOM_AUTH

APPLICATION_PAGE_ITEM_EXISTS Function

CURRENT_PAGE_IS_PUBLIC Function

DEFINE_USER_SESSION Procedure

GET_COOKIE_PROPS Procedure

GET_LDAP_PROPS Procedure

GET_NEXT_SESSION_ID Function

GET_SESSION_ID_FROM_COOKIE Function

GET_USERNAME Function

GET_SECURITY_GROUP_ID Function

GET_SESSION_ID Function

GET_USER Function

IS_SESSION_VALID Function

LOGIN Procedure

LOGOUT Procedure

POST_LOGIN Procedure

SESSION_ID_EXISTS Function

SET_USER Procedure

SET_SESSION_ID Procedure

SET_SESSION_ID_TO_NEXT_VALUE Procedure

Part III Administration

18 Managing an Oracle HTML DB Hosted Service

What is an Oracle HTML DB Administrator?

Logging in to Oracle HTML DB Administration Services

Determining the HTML DB Engine Schema

Managing the Schemas Associated with a Workspace

Understanding Oracle Default Schema Restrictions

Creating a Workspace

About Workspace Provisioning

Specifying a Provisioning Mode

Creating a Workspace Without a Request

Viewing Workspace Reports

Managing Service and Change Requests

Viewing a Pending Service or Change Request

Viewing a Pending Request from the Notifications List

Viewing a Request from the Workspace Utilization Report

Viewing Requests from the Service Requests Page

Viewing Requests from the Change Requests Page

Approving a Service or Change Request

Deleting an Existing Request

Managing Users in an Oracle HTML DB Instance

Purging Inactive Workspaces

Identifying Inactive Workspaces

Removing the Resources Associated with Inactive Workspaces

Deleting Inactive Workspaces

Removing a Workspace

Exporting and Importing a Workspace

Deleting SQL Workshop Logs

Deleting Page View Activity Log Entries

Deleting Developer Activity Log Entries

Deleting Click Counting Log Entries

Deleting the HTML DB Mail Log Entries

Managing Session State

Purging Sessions by Age

Viewing Session Details Before Purging

Viewing Session Statistics Before Purging

Monitoring Activities

Managing Environment Preferences

Accessing the HTML DB Environment Preferences Page

About SERVICE_REQUEST_FLOW

Configuring Oracle HTML DB to Send Mail

Restricting User Access by IP Address

Disabling Access to Oracle HTML DB Administration Services

Disabling Access to Oracle HTML DB Internal Applications

Managing Application Build Status

Managing E-mail

Viewing the Mail Queue

Viewing the HTML DB Mail Log

Creating a Site-Specific Tasks List

Adding a New Task

Editing an Existing Task

Deleting a Task

A Available Conditions

Conditions Available in Oracle HTML DB

Index