Skip Headers

Oracle® HTML DB User's Guide
Release 1.5

Part Number B10992-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Feedback

Go to next page
Next
View PDF

Contents

Title and Copyright Information

Send Us Your Comments

Preface

Intended Audience
Organization
Related Documentation
Conventions
Documentation Accessibility

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 Oracle HTML DB User Interface
About Using the Tasks List
Other Sources of Information
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 Application Builder
Understanding Sample Application
About the Home Page
About the Orders Page
About the Products Page
About the Customers 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 Data
Importing a Text File
Importing an XML Document
Importing Spreadsheet Data
Exporting Data
Exporting to a Text File
Exporting to an XML Document

5 Using SQL Workshop to Manage Database Objects

About SQL Workshop
About Transaction Support
About Support for SQL*Plus Commands
Viewing Database Objects
Using the SQL Command Processor
About Command Termination
Using Explain Plan
Browsing Database Objects
Querying by Example
Viewing Database Objects by Object Type
Managing Database Objects
Browsing 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
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
Generating DDL
Managing Control Files
Viewing the Control File Run History
Viewing Control File Job Status
Managing Tables
Managing User Interface Defaults
Managing Tables Using UI Defaults
Applying UI Defaults to a Table or View
Exporting UI Defaults
Browsing the Data Dictionary

6 Application Builder Concepts

About Page Rendering and Page Processing
What is a Page?
How Application Builder Uses Templates
Page Templates
Region Templates
List Templates
Report Templates
Label Templates
Menu Templates
Popup List of Values Templates
How Page Processing and Page Rendering Work
Understanding Shared Components
About Standard Tabs and Parent Tabs
About Navigation Bars
About List of Values
About Menus
About Lists
About Templates
Understanding Conditional Rendering and Processing
Current Page In Expression 1
Exists
PLSQL Expression
Using Build Options to Control Configuration
Creating Build Options
Viewing Build Option Reports
Verifying User Identity
Controlling Access to 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_SESSION
APP_USER
IMAGE_PREFIX
WORKSPACE_IMAGES
APP_IMAGES
BROWSER_LANGUAGE
PRINTER_FRIENDLY
HOME_LINK
PROXY SERVER
REQUEST
SYSDATE_YYYYMMDD
DEBUG
APP_ID
APP_PAGE_ID
APP SCHEMA OWNER
SQLERRM
AUTHENTICATED_URL_PREFIX
LOGOUT_URL
PUBLIC_URL_PREFIX
CURRENT_PARENT_TAB_TEXT
APP_ALIAS
APP_UNIQUE_PAGE_ID

7 Using Application Builder

Understanding the Definition of a Page
Accessing Application Builder
About the Available Applications List
About the Edit Page List
About the Application Navigation Pane
Viewing a Page Definition
Using the Page Navigation Pane
Viewing Page Reports
About All Conditions
About Event View
About History
About Page Detail
About Related Pages
About Summary of All Pages
About Tree View
Using the Developer Toolbar
Creating an Application
Creating a New Application
Deleting an Application
Creating a New Page Using a Wizard
About SVG Charting Support
Creating a Page While Viewing the Page Definition
Creating a Page from the Developer Toolbar
Creating a Page Using a Wizard
Deleting a Page
Working with Templates
Viewing Existing Templates
About Cascading Style Sheets
Creating Custom Templates
Editing Templates
Editing Page Templates
Editing Region Templates
Editing Report Templates
Editing List Templates
Editing Label Templates
Editing Menu Templates
Editing Button Templates
Editing Popup LOV Templates
Viewing Application Attributes
Editing Application Attributes
About Application Definition
About Authorization
About Session Management
About User Interface Templates
About Template Defaults
About Globalization
About Application Availability
About Global Notifications
About Virtual Private Database (VPD)
About Static Substitution Strings
About Build Options
About Application Comments
Viewing Page Attributes
Editing a Page Definition
Managing Page Rendering Components
About Page
About Regions
About Buttons
About Items
About Page Computations
About Page Processes
About Page Processing Components
About Validations
About Branching
Editing Page Attributes
About Primary Page Attributes
About HTML Header
About Page Header, Footer and Text Attributes
About On Load JavaScript
About Security
About Duplicate Page Submission Checks
About Configuration Management
About On Error Text
About Page Help Text
About Comments
Running a Page

8 Building Application Components

Displaying Components on Every Page
Adding Navigation
Creating Tab Sets
About Template Support
Using Tab Manager to Manage Tab Information
About the Standard Tab Tasks List
Creating a Navigation Bar
Creating a Navigation Bar Entry
Creating Menus
Creating a Menu
Creating a Menu Template
Adding a Menu to a Page
About Creating a Dynamic Menu
Creating Trees
Creating Lists
Creating a List
Adding a List on a Page
About Creating a List Template
Creating a Branch
Creating Regions
Creating New Regions
Building a Form Using a Region
Building a Report Using a Region
About Regions Based on an URL
About Regions Based on PL/SQL Dynamic Content
Creating Buttons
Using the Create Button Wizard
Creating an HTML Button
Creating Lists of Values
Creating LOVs
Referencing Session State within a LOV
Inline Static LOV
Popup LOV
Creating Forms
Using a Wizard to Build a Form
Creating a Form Manually
Processing a Form
Creating an Automatic Row Processing Process
Creating a Process Containing One or More Insert Statements
Using a PL/SQL API to Process Form Values
Populating Forms
Validating User Input in Forms
Creating Reports
Using a Wizard to Create a Report
Managing Report Attributes
Accessing Report Attributes
Enabling Column Sorting
Exporting a Report
Creating a Column link
Defining Updatable Columns
Defining a Column as a List of Values
Controlling When Columns Display
Controlling Column Breaks
Creating a Report with Pagination
Creating Charts
Creating Calendars
Specifying Layout and User Interface
Creating a Multiple Column Layout
Creating Regions in Multiple Columns
Creating a Multiple Column Page Template
Using a LOV to Drive Another LOV
Specifying Print Preview Mode
Setting a Print Mode Template for an Application
Using f?p Syntax to Toggle to Print Mode
Utilizing Shortcuts
Defining Shortcuts
Creating a Help Page
Creating a Help Page and Region
Defining Help Text
Creating a Help Navigation Bar Icon
Sending E-mail from an Application

9 Debugging an Application

About Tuning Performance
Remembering to Review Session State
Accessing Debug Mode
Enabling SQL Tracing and Using TKPROF
Monitoring Application and Page Resource Use
Viewing Page Reports
Debugging Problematic SQL Queries
Removing Components to Isolate a Problem

10 Managing an Application

Accessing Application Builder Utilities
Viewing Application Summary and Utilization Reports
Exporting and Importing Applications
How Exporting an Application Works
About Managing Database Objects
Exporting an Application and Related Files
Exporting Related Application Files
Importing Exported Application Files
Installing Files from the View Export Repository
Uploading CSS, Images, and Static Files
Understanding Security
Using the Security Navigation Pane
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 Component
Viewing the Authorization Scheme Utilization Report

11 Managing Your Development Workspace

Managing Users
Creating New User Accounts
Editing Existing User Accounts
Changing Your Password
Monitoring Users
Administering Session State and User Preferences
Managing Session State and User Preferences for the Current Session
Managing Recent Sessions
Viewing Workspace Reports
Monitoring Developer Activity
Managing Log Files
Managing Development Services
Viewing Current Workspace Status
Requesting a Database Schema
Requesting Additional Storage
Requesting Service Termination

12 Advanced Programming Techniques

Accessing Data with Database Links
Using Collections
Using the HTMLDB_COLLECTION API
About Collection Naming
Creating a Collection
Truncating a Collection
Deleting a Collection
Adding Members to a Collection
Updating Collection Members
Deleting a Collection Member
Determining Collection Status
Merging Collections
Managing Collections
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
Creating a Web Service
Invoking a Web Service as a Process
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

13 Oracle HTML DB APIs

HTMLDB_UTIL
CLEAR_APP_CACHE Procedure
CLEAR_USER_CACHE Procedure
COUNT_CLICK Procedure
GET_FILE Procedure
GET_NUMERIC_SESSION_STATE Function
GET_PREFERENCE Function
GET_SESSION_STATE Function
PUBLIC_CHECK_AUTHORIZATION Function
REMOVE_PREFERENCE Procedure
REMOVE_SORT_PREFERENCES Procedure
RESET_AUTHORIZATIONS Procedure
SET_PREFERENCE Procedure
SET_SESSION_STATE Procedure
STRING_TO_TABLE Function
TABLE_TO_STRING Function
URL_ENCODE Function
HTMLDB_ITEM
CHECKBOX Function
DATE_POPUP 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 Function
TEXT_FROM_LOV 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_NEXT_SESSION_ID Function
GET_SECURITY_GROUP_ID Function
GET_SESSION_ID Function
GET_USER Function
SESSION_ID_EXISTS Function
SET_USER Procedure
SET_SESSION_ID Procedure
SET_SESSION_ID_TO_NEXT_VALUE Procedure

Part III Administration

14 Administering Workspaces

About the Oracle HTML DB Administrator
Viewing Workspace Reports
Creating a Workspace
Specifying a Provisioning Mode
Managing a Service and Change Request
Viewing a Pending Service or Change Request
Approving a Service or Change Request
Creating a Workspace Without a Request
Managing Users in a Workspace
Managing the Schemas Associated with a Workspace
Removing a Workspace
Exporting and Importing a Workspace

15 Managing Services

Managing Logs
Deleting Developer Activity Log Entries
Deleting Click Counting Log Entries
Deleting SQL Workshop Logs
Deleting User Activity Log Entries
Managing Session State
Purging Sessions by Age
Viewing Session Details Before Purging
Viewing Session Statistics Before Purging
Monitoring Activities
Managing Engine Settings

16 Managing Globalization

About Translating an Application and Globalization Support
About Language Identification
How Translated Applications Are Rendered
About Translatable Components
About 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

A Available Conditions

Conditions Available in Oracle HTML DB

Index