Title and Copyright Information
Preface
- Audience
- Documentation Accessibility
- Diversity and Inclusion
- Related Documents
- Conventions
1 Changes in Release 24.1 for Oracle APEX App Builder User’s Guide
2 Quick Start
- 2.1 About Accessing Your Development Environment
- 2.2 Understanding Oracle APEX
- 2.3 Understanding the Workspace Home Page
- 2.4 APEX Menu Bar
- 2.5 Understanding App Builder
- 2.6 Changing Your Profile or Password
- 2.7 Editing User Preferences and Enabling Dark Mode
- 2.8 Using Oracle APEX Documentation
- 2.9 Using the App Gallery
3 App Builder Concepts
- 3.1 Understanding Applications
- 3.2 Running an Application or Page
- 3.3 How Does Page Processing and Page Rendering Work?
- 3.4 About Enabling Support for Bookmarks
- 3.5 How Oracle APEX Uses Templates
- 3.6 Understanding Session State Management
- 3.7 Managing Session State
  - 3.7.1 Viewing Session State
  - 3.7.2 Managing Session State Overrides
- 3.8 Understanding URL Syntax
- 3.9 Managing Session State Values
- 3.10 Using Substitution Strings
- 3.11 Using Template Directives
4 Managing Team Development
- 4.1 Getting Started with Team Development
- 4.2 Creating and Updating Issues
- 4.3 Viewing Your User Profile
  - 4.3.1 Viewing Your Issues
  - 4.3.2 Viewing Your Notifications
- 4.4 Managing Labels
- 4.5 Managing Milestones
  - 4.5.1 Creating Milestones
  - 4.5.2 Editing and Deleting Milestones
- 4.6 Managing Templates
  - 4.6.1 Creating Issue Templates
  - 4.6.2 Editing or Deleting Issue Templates
- 4.7 Using Team Development Utilities
- 4.8 Managing Feedback
5 Creating Applications
- 5.1 Choosing an Application Creation Method
- 5.2 Using the Simple Create Application Wizard
- 5.3 Using the Full Create Application Wizard
- 5.4 Creating an App Using Generative AI
- 5.5 Creating an Application from a File
- 5.6 Using Application Blueprints
- 5.7 Copying an Application
  - 5.7.1 Copying an Application by Running the Create Application Wizard
  - 5.7.2 Copying an Application from the Application Home Page
- 5.8 Creating a Working Copy to Merge, Refresh, or Compare
- 5.9 Creating Applications for Mobile Devices
- 5.10 Deleting an Application
  - 5.10.1 Deleting an Application from the Application Home Page
  - 5.10.2 Deleting an Application from the Edit Application Definition
- 5.11 Managing Application Attributes
- 5.12 Managing Application Logos
  - 5.12.1 Managing Logos in the User Interface Attributes
  - 5.12.2 Editing App Logos at Runtime
- 5.13 Managing Application Icons
- 5.14 Adding Developer Comments
- 5.15 Using the Find Icon
- 5.16 Adding Application Comments
- 5.17 Managing Application Groups
- 5.18 Using Application Utilities
- 5.19 Using Workspace Utilities
6 Managing Pages in an Application
- 6.1 Adding a New Page to an Application
- 6.2 About Copying Application Pages
- 6.3 Creating a New Page by Copying
- 6.4 Understanding Page Types in the Create Page Wizard
- 6.5 Managing Feature Pages
- 6.6 Creating Dialog Pages
- 6.7 About Deleting Application Pages
- 6.8 Managing Page Groups
- 6.9 Locking and Unlocking a Page
7 Editing Pages in Page Designer
- 7.1 About Page Designer
- 7.2 Understanding Page Designer UI Elements
- 7.3 Using Page Designer
- 7.4 Managing Page Attributes
- 7.5 Running a Page from Page Designer
- 7.6 Runtime Developer Toolbar
- 7.7 Deleting Pages
8 Developing Reports
- 8.1 Understanding Report Page Types
  - 8.1.1 Report Page Type Use Cases
  - 8.1.2 Comparison of Report Page Types
- 8.2 Creating a Report Using the Create Application Wizard
  - 8.2.1 Report Options When Running the Create Application Wizard
- 8.3 Creating a Report Using the Create Page Wizard
  - 8.3.1 Report Options When Running the Create Page Wizard
  - 8.3.2 Creating a Report on New Page
- 8.4 Creating a Report by Dragging and Dropping from the Gallery
- 8.5 Managing Cards
- 8.6 Managing Smart Filters
- 8.7 Managing Faceted Search
- 8.8 Managing Interactive Grids
- 8.9 Managing Interactive Reports
- 8.10 Managing Classic Reports
- 8.11 Managing Sorting with Order By Item
  - 8.11.1 Order By Item Sort Example
  - 8.11.2 Configuring Sorting with Order By Item
- 8.12 Printing Report Regions
- 8.13 Understanding BLOB Support in Forms and Reports
9 Developing Forms
- 9.1 Understanding Form Types
- 9.2 Creating a Form
  - 9.2.1 Creating a Form Using the Create Application Wizard
  - 9.2.2 Creating a Form Using the Create Page Wizard
- 9.3 Configuring Lost Update Detection
- 9.4 About Making an Interactive Grid Editable
- 9.5 Creating Master Detail Forms
- 9.6 Validating User Input in Forms
- 9.7 Understanding BLOB Support in Forms
10 Managing Application Components
- 10.1 Understanding Oracle JET Integration with Oracle APEX
  - 10.1.1 About Oracle JET
  - 10.1.2 How Oracle JET is integrated with Oracle APEX
- 10.2 Creating Calendars
- 10.3 Creating Charts
- 10.4 Creating Maps
- 10.5 Creating Help for Your Application
11 Using Themes and Theme Styles
- 11.1 Using Themes
- 11.2 Managing Themes and Subscriptions
- 11.3 Creating Custom Themes
- 11.4 Using Custom Cascading Style Sheets
  - 11.4.1 About Cascading Style Sheets
  - 11.4.2 Referencing an Uploaded Cascading Style Sheet in the Page Template
12 Controlling Page Layout
- 12.1 About Page Layout in Oracle APEX
- 12.2 Optimizing a Page for Printing
  - 12.2.1 Selecting a Printer Friendly Template for an Application
  - 12.2.2 Using f?p Syntax to Toggle to Printer Friendly Mode
- 12.3 Creating a Global Page to Display Components on Every Page
  - 12.3.1 Creating a Global Page
  - 12.3.2 Viewing or Editing a Global Page
- 12.4 Managing Regions
- 12.5 About Incorporating Content from Other Websites
- 12.6 About Managing Images
- 12.7 Rendering HTML Using Custom PL/SQL
13 Managing Application Controls
- 13.1 Managing Page Items
- 13.2 Managing Dynamic Actions
- 13.3 Managing Buttons
- 13.4 Managing Trees
- 13.5 About Incorporating JavaScript into an Application
14 Adding Navigation
- 14.1 About Using Lists as Navigation
- 14.2 Controlling Navigation Using Branches
  - 14.2.1 Creating a Branch
  - 14.2.2 About Branching Conditionally
- 14.3 Creating Breadcrumbs
- 14.4 Managing Tabs
- 14.5 Managing a Classic Navigation Bar
15 Managing Computations, Validations, and Processes
- 15.1 Understanding Page Computations
- 15.2 Understanding Validations
- 15.3 Understanding Page Processes
- 15.4 Understanding Application Processes
- 15.5 About Branches
- 15.6 Understanding Application Computations
- 15.7 Using the Attribute Dictionary
  - 15.7.1 About the Attribute Dictionary
  - 15.7.2 Accessing the Manage Attribute Dictionary
16 Managing Shared Components
- 16.1 Accessing the Shared Components Page
- 16.2 Shared Components Page
- 16.3 Using Shared Component Subscriptions
- 16.4 Managing Application Settings
- 16.5 Managing Application Items
- 16.6 Managing Component Settings
- 16.7 Creating Lists of Values at the Application-Level
- 16.8 Creating Lists
- 16.9 Adding Search to an Application
- 16.10 Using Shortcuts
- 16.11 Using Component Groups
- 16.12 Managing Email Templates
- 16.13 Managing Static Application Files
- 16.14 Managing Static Workspace Files
- 16.15 Printing a Report Region by Defining a Report Query
- 16.16 Formatting a Report Region or Report Query Using Report Layouts
17 Managing Application Data
- 17.1 Creating Applications with Data Loading Capability
- 17.2 About Using Collections
- 17.3 Managing REST Enabled SQL References
- 17.4 Managing REST Data Sources
- 17.5 Managing Remote Servers
- 17.6 Managing Web Credentials
- 17.7 Managing Generative AI in APEX
- 17.8 Accessing Data with Database Links
18 Upgrading Oracle APEX Applications
- 18.1 Reviewing Release Notes
- 18.2 Refreshing the Universal Theme
- 18.3 Updating App Compatibility Mode
- 18.4 Running Application Upgrade
- 18.5 Reviewing Old JavaScript
19 Extending Application Capabilities
- 19.1 Sending Email from an Application
- 19.2 Implementing Plug-ins
- 19.3 Understanding jQuery Support
  - 19.3.1 About Upgrading to jQuery 3.6.4
- 19.4 Manually Refreshing Oracle APEX Components
- 19.5 Managing Automations
20 Managing Workflows and Tasks
- 20.1 About Workflows
  - 20.1.1 About Workflow Versions
  - 20.1.2 About Workflow Definitions
  - 20.1.3 About Workflow Designer
  - 20.1.4 About the Workflow Console, Workflow Details, and Workflow Dashboard
  - 20.1.5 About the Workflow Runtime Engine
  - 20.1.6 States and Transitions
    - 20.1.6.1 Workflow States and Transitions
    - 20.1.6.2 Activity States and Transitions
  - 20.1.7 Example: Workflows
- 20.2 Creating a Workflow
  - 20.2.1 Creating a Workflow Parameter
  - 20.2.2 Creating a Workflow Variable
  - 20.2.3 Creating a Workflow Activity
  - 20.2.4 Adding a Workflow Connection
  - 20.2.5 Adding a Workflow Participant
- 20.3 Creating the Workflow Console, Workflow Details, and Workflow Dashboard Pages
- 20.4 Managing Workflow Versions
  - 20.4.1 Creating a Workflow Version
  - 20.4.2 Saving and Activating a Workflow Version
  - 20.4.3 Editing a Workflow Version
  - 20.4.4 Copying a Workflow Version
  - 20.4.5 Deactivating a Workflow Version
  - 20.4.6 Importing a New Application Version Containing Workflows
- 20.5 About Using Workflows in Page Processes
  - 20.5.1 Starting a Workflow Instance
  - 20.5.2 Terminating a Workflow Instance
  - 20.5.3 Suspending a Workflow Instance
  - 20.5.4 Resuming a Workflow Instance
  - 20.5.5 Retrying a Workflow Instance
- 20.6 Viewing the Workflow Instance ID in Debug Messages
- 20.7 About Workflow Reports
  - 20.7.1 Viewing the Workflow Utilization Report
  - 20.7.2 Viewing the Workflow History Report
- 20.8 Workflow Instance Retention
- 20.9 Workflow Substitution Strings
- 20.10 Workflow Views
  - 20.10.1 Workflow Metadata Views
  - 20.10.2 Workflow Runtime Views
- 20.11 About Workflow Keyboard Shortcuts
- 20.12 Frequently Asked Questions
- 20.13 About Tasks
  - 20.13.1 About Task States and Transitions
  - 20.13.2 Example: Approval Tasks and Action Tasks
- 20.14 Managing Tasks
  - 20.14.1 Managing Task Definitions
  - 20.14.2 Managing Task Details
  - 20.14.3 Managing Unified Task Lists
- 20.15 Creating Tasks from Task Definitions
  - 20.15.1 Example: Creating a Human Task from a Form Submission
- 20.16 About Creating Human Tasks Programmatically
- 20.17 About Creating a Task Definition Process Plug-in
- 20.18 About Task Retention and Task Purging
  - 20.18.1 Retrieving Tasks Before Purge
- 20.19 Substitution Strings and Bind Variables for Tasks
- 20.20 Runtime Views for Tasks
- 20.21 Troubleshooting Tasks
21 Managing Application Security
- 21.1 Understanding Administrator Security Best Practices
- 21.2 Understanding Developer Security Best Practices
- 21.3 Controlling Access to Applications, Pages, and Page Components
- 21.4 Establishing User Identity Through Authentication
- 21.5 Providing Security Through Authorization
22 Managing Application Globalization
- 22.1 Understanding Application Translation and Globalization Support
- 22.2 Specifying the Primary Language for an Application
- 22.3 Applying Format Masks to Items
- 22.4 About Translating Applications for Multibyte Languages
- 22.5 Understanding the Translation Process
- 22.6 Translating Default Reports for Interactive Reports and Interactive Grids
- 22.7 Translating Messages
- 22.8 Translating Data That Supports List of Values
  - 22.8.1 Defining a Dynamic Translation
- 22.9 Understanding Supported Globalization Codes
  - 22.9.1 Oracle APEX Globalization Codes
23 Managing Application Performance
- 23.1 About Best Practices to Improve Performance
- 23.2 Identifying Performance Issues
- 23.3 Utilizing Logs and Reports
- 23.4 About Utilizing Database Reporting
- 23.5 About Database Parameters that Impact Performance
- 23.6 About Limiting Resources
- 23.7 About Uploading Static Files to Your Web Server
- 23.8 Creating Custom Activity Reports Using APEX_ACTIVITY_LOG
24 Debugging an Application
- 24.1 Running Advisor to Check Application Integrity
- 24.2 Reviewing Session State
- 24.3 About Monitoring Application and Page Resource Use
- 24.4 Enabling SQL Tracing and Using TKPROF
- 24.5 Utilizing Debug Mode
- 24.6 About Removing Controls and Components to Isolate a Problem
25 Deploying an Application
- 25.1 System Development Life Cycle Methodologies to Consider
- 25.2 Understanding the Deployment Process
  - 25.2.1 About Suggested Environments
  - 25.2.2 Deployment Scenarios to Consider
- 25.3 Exporting and Importing from App Builder
- 25.4 How to Create a Custom Application
- 25.5 About Publishing an Application URL
- 25.6 Using Build Options to Control Configuration
- 25.7 Understanding One-Click Remote Application Deployment
  - 25.7.1 About One-click Remote Application Deployment
  - 25.7.2 Remotely Deploying an Application
26 Managing Application Legacy Components
- 26.1 Viewing Legacy Components in the Gallery
- 26.2 Managing Legacy Calendars
  - 26.2.1 Editing Legacy Calendar Attributes
  - 26.2.2 About Supported Legacy Calendar Substitution Strings
- 26.3 Managing Applications with Legacy Data Loading Capability
- 26.4 Managing Legacy Tabular Forms
- 26.5 Managing Legacy Web Services
A About Item Types
- A.1 Checkbox
- A.2 Checkbox Group
- A.3 Color Picker
- A.4 Combobox
- A.5 Date Picker
- A.6 Date Picker (jQuery) (Desupported)
- A.7 Display Image
- A.8 Display Map
- A.9 Display Only
- A.10 File Upload
- A.11 Geocoded Address
- A.12 Image Upload
- A.13 Hidden
- A.14 Markdown Editor
- A.15 List Manager
- A.16 Number Field
- A.17 Password
- A.18 Percent Graph
- A.19 Popup LOV
- A.20 QR Code
- A.21 Radio Group
- A.22 Rich Text Editor
- A.23 Select List
- A.24 Select Many
- A.25 Select One
- A.26 Shuttle
- A.27 Textarea
- A.28 Star Rating
- A.29 Switch
- A.30 Star Rating
- A.31 Text Field
- A.32 Text Field with Autocomplete
- A.33 Textarea
B Oracle APEX Limits
- B.1 Component Limits
C Directory Structure When Splitting Export Files into Separate Scripts
- C.1 Export Directory Structure
D Correlating APEX Sessions to Database Sessions
- D.1 About APEX Sessions and Database Sessions
- D.2 Session Attributes
- D.3 APEX Processes
- D.4 SQL Workshop
- D.5 Data Workshop
- D.6 Automations
- D.7 Installer
E Available Conditions
- E.1 What Are Conditions?
- E.2 Conditions Available in App Builder
F About Granted Privileges
- F.1 About Granting Privileges to Database Users
- F.2 Understanding Privileges Granted to PUBLIC
Index