Oracle Application Express Installation Guide

Oracle® Application Express
Installation Guide
Release 21.1
F38048-02
June 2021
Oracle Application Express Installation Guide, Release 21.1
F38048-02
Copyright © 2003, 2021, Oracle and/or its affiliates.
Primary Author: Terri Jennings
Contributors: Christina Cho, David Bliss, Salim Hlayel, Joel Kallman, Christian Neumueller, Marc Sewtz,
Jason Straub, Vlad Uvarov, Patrick Wolf
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,
transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is
prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software,
any programs embedded, installed or activated on delivered hardware, and modifications of such programs)
and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end
users are "commercial computer software" or "commercial computer software documentation" pursuant to the
applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use,
reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or
adaptation of i) Oracle programs (including any operating system, integrated software, any programs
embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle
computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the
license contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloud
services are defined by the applicable contract for such services. No other rights are granted to the U.S.
Government.
This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications that
may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you
shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its
safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.
Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are
used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc,
and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered
trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise
set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be
responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,
products, or services, except as set forth in an applicable agreement between you and Oracle.
Contents
Preface
Audience viii
Documentation Accessibility viii
Related Documents viii
Conventions ix
Third-Party License Information ix
1 Changes in Release 21.1 for Oracle Application Express Installation

Guide
2 Oracle Application Express Installation Requirements

2.1 Oracle Database Requirements 2-1
2.2 Checking the MEMORY_TARGET of the Target Database 2-2
2.3 Browser Requirements 2-3
2.4 Web Listener Requirements 2-3
2.5 Disk Space Requirement 2-3
2.6 Oracle XML DB Requirement 2-3
3 Oracle Application Express Installation Overview

3.1 About Oracle Application Express Architecture 3-1
3.2 About Accessing Oracle Application Express in Oracle Cloud 3-3
3.3 Understanding the Installation Process 3-3
3.3.1 About Planning Your Installation 3-4
3.3.2 About Patch Sets 3-5
3.3.3 About the Installation Scripts 3-5
3.3.4 About Accessing Oracle Application Express 3-5
3.3.5 Requesting a Workspace from the Sign In Dialog 3-7
3.3.6 Resetting Your Password from the Sign In Page 3-8
3.3.7 Recovering Your Workspace Name 3-9
iii
3.4 About the Oracle Application Express Runtime Environment 3-9
4 Upgrading from a Previous Oracle Application Express Release

4.1 About Release Numbering Conventions 4-2
4.2 Sample Upgrade Scenarios 4-2
4.3 Viewing the Oracle Application Express Release Number 4-2
4.4 Viewing the Oracle REST Data Services Release Number 4-3
4.5 About Installing the Oracle Application Express Release Included with the Oracle
Database 4-3
4.6 About Upgrading Existing Applications 4-4
4.7 About Testing Requirements 4-4
4.8 About Cleaning Up Your Environment 4-5
4.9 About Reverting to a Previous Release 4-5
5 Utilizing the Multitenant Architecture in Oracle Database 12c or Later

5.1 Understanding the Installation Choices 5-1
5.2 Installing Application Express into an Application Container 5-2
5.2.1 About Application Containers 5-3
5.2.2 Creating Application Container 5-3
5.2.3 Installing or Upgrading Application Express in an Application Container 5-3
5.2.4 Verifying the Application Container Installation 5-4
5.2.5 Creating an Application Seed 5-5
5.2.6 Creating an Application PDB from the Application Root Seed 5-6
5.2.7 Configure HTTP Access to the Application PDB 5-6
5.3 Installing Application Express into Different PDBs 5-7
5.3.1 Uninstalling Application Express from a CDB 5-7
5.3.2 Installing Application Express Locally in a PDB 5-8
5.3.3 Installing Application Express into a CDB 5-10
5.4 Plugging in a PDB When Application Express is Installed in the Root Container 5-12
5.4.1 Scenario 1: Plug-in Non-CDB with Application Express 5-12
5.4.2 Scenario 2: Plug-in PDB with a Common Application Express from Another
CDB 5-13
5.4.3 Scenario 3: Plug-in PDB with a Local Application Express from Another CDB 5-13
5.4.4 Scenario 4: Plug-in Non-CDB or PDB with No Application Express 5-14
5.4.5 Working with Incompatible Application Express Versions 5-15
5.4.5.1 Patching or Upgrading Application Express in the CDB 5-15
5.4.5.2 Patching or Upgrading Application Express in a PDB 5-16
5.5 Plugging in a PDB When Application Express Is Not in the Root Container of the
Target CDB 5-17
5.5.1 Scenario 1: Plug-in a Non-CDB with Application Express 5-18
iv
5.5.2 Scenario 2: Plug-in PDB with Common Application Express from Another CDB 5-19
5.5.3 Scenario 3: Plug-in PDB with a Local Application Express from Another CDB 5-19
5.5.4 Scenario 4: Plug-in a Non-CDB or PDB with No Application Express 5-19
6 Installing and Configuring Application Express and Oracle REST Data

Services
6.1 Performing Pre-installation Tasks for Oracle Application Express 6-2
6.2 Downloading and Installing Oracle Application Express 6-3
6.2.1 Installing Application Express 6-3
6.2.2 Creating or Updating Your Instance Administration Account 6-6
6.2.2.1 What Is an Instance Administrator? 6-6
6.2.2.2 About apxchpwd.sql 6-7
6.2.2.3 Running apxchpwd.sql 6-7
6.2.3 Restarting Processes 6-8
6.2.4 Configuring the APEX_PUBLIC_USER Account 6-8
6.2.4.1 About the APEX_PUBLIC_USER Account 6-8
6.2.4.2 Unlocking the APEX_PUBLIC_USER Account 6-9
6.2.4.3 Changing the Password for the APEX_PUBLIC_USER Account 6-9
6.2.4.4 About Password Expiration in Oracle Database 11g and Later 6-10
6.2.5 Configuring RESTful Services 6-10
6.3 Downloading and Installing Oracle REST Data Services 6-11
6.3.1 Downloading Oracle REST Data Services 6-12
6.3.2 About Configuring Oracle REST Data Services Behind a Reverse Proxy or
Load Balancer 6-12
6.3.3 Web Server HTTP POST Request Limits 6-13
6.4 Configuring Oracle REST Data Services 6-13
6.4.1 Copying the Images Directory 6-14
6.4.2 Validating the Oracle REST Data Services Installation 6-14
6.4.3 Configuring Static File Support 6-14
6.4.4 Securing Oracle REST Data Service 6-15
6.5 Enabling Network Services in Oracle Database 11g or Later 6-15
6.5.1 When and Why Network Services Must be Enabled 6-15
6.5.2 Granting Connect Privileges Prior to Oracle Database 12c 6-16
6.5.3 Granting Connect Privileges in Oracle Database 12c or Later 6-18
6.5.4 Troubleshooting an Invalid ACL Error 6-18
6.6 Performing Security Tasks 6-19
6.7 Controlling the Number of Concurrent Jobs 6-20
6.7.1 About Managing the Number of Concurrent Jobs 6-20
6.7.2 Viewing the Number of JOB_QUEUE_PROCESSES 6-20
6.7.2.1 Viewing JOB_QUEUE_PROCESSES in the Installation Log File 6-20
v
6.7.2.2 Viewing JOB_QUEUE_PROCESSES in Oracle Application Express 6-21
6.7.2.3 Viewing JOB_QUEUE_PROCESSES from SQL*Plus 6-21
6.7.3 Changing the Number of JOB_QUEUE_PROCESSES 6-21
6.8 About Running Oracle Application Express in Other Languages 6-22
6.9 Installing Translated Versions of Oracle Application Express 6-23
6.9.1 About Installing Translated Versions of Oracle Application Express 6-23
6.9.2 Installing a Translated Version of Oracle Application Express 6-23
6.10 Creating a Workspace and Adding Oracle Application Express Users 6-24
6.10.1 About Workspaces and Users 6-25
6.10.2 Signing In To Administration Services 6-25
6.10.3 Creating a Workspace Manually 6-26
6.10.4 Creating Oracle Application Express Users 6-27
6.10.5 Signing In to Your Workspace 6-29
6.11 Performing Post Installation Tasks for Upgrade Installations 6-30
6.11.1 About Removing Prior Oracle Application Express Installations 6-31
6.11.2 Verifying if a Prior Installation Exists 6-31
6.11.3 Removing Schemas and SYS Objects from Prior Installations 6-32
6.11.4 Removing Schemas from Prior Installations in a CDB 6-32
6.11.5 Fixing Invalid ACL in Oracle Database 11g or Later 6-32
6.12 About Performance Optimization Tasks 6-33
6.13 Converting Between Runtime and Full Development Environments 6-33
6.13.1 About Runtime and Full Development Environments 6-34
6.13.2 Converting a Runtime Environment to a Full Development Environment 6-34
6.13.3 Converting a Full Development Environment to a Runtime Environment 6-35
A Automating the Oracle Application Express Installation Process

A.1 About apxsilentins.sql A-1
A.2 Running apxsilentins.sql A-1
B Maximizing Uptime During an Application Express Upgrade
C Oracle Application Express Installation Troubleshooting

C.1 Reviewing a Log of an Installation Session C-1
C.2 Verifying the Validity of an Oracle Application Express Installation C-2
C.3 Removing the Oracle Application Express Release 21.1 Schema from a CDB C-2
C.4 Cleaning Up After a Failed Installation C-3
C.4.1 Reverting to a Previous Release After a Failed Upgrade Installation C-3
C.4.1.1 Verifying If You Have a Previous Release of Oracle Application Express C-4
C.4.1.2 Reverting the Images Directory C-4
vi
C.4.1.3 Reverting to a Previous Release C-4
C.4.1.4 Removing the Oracle Application Express Release Schema C-41
C.4.2 Removing Oracle Application Express from the Database C-43
C.5 About Images Displaying Incorrectly in Oracle Application Express C-43
C.6 About Page Protection Violation C-44
D Upgrading Oracle Application Express within Oracle Database Express

Edition
D.1 Upgrading to the Latest Oracle Application Express Release D-1
D.2 Understanding the Differences Between Later Oracle Application Express Releases D-3
D.2.1 User Interface Differences D-3
Index
vii
Preface
Preface
This guide explains how to install and configure Oracle Application Express.
• Audience
• Documentation Accessibility
• Related Documents
• Conventions
• Third-Party License Information
Audience
Oracle Application Express Installation Guide is intended for anyone responsible for
installing Oracle Application Express.
To use this manual, you must have administrative privileges on the computer where
you installed your Oracle database and familiarity with object-relational database
management concepts.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle
Accessibility Program website at http://www.oracle.com/pls/topic/lookup?
ctx=acc&id=docacc.
Access to Oracle Support

Oracle customers that have purchased support have access to electronic support
through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/
lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs
if you are hearing impaired.
Related Documents
For more information, see these Oracle resources:
• Oracle Application Express Release Notes
• Oracle Application Express App Builder User’s Guide
• Oracle Application Express End User’s Guide
• Oracle Application Express Administration Guide
• Oracle Application Express SQL Workshop Guide
viii
Preface
• Oracle Application Express API Reference

• Oracle Database Concepts
• Oracle Database Administrator’s Guide
• Oracle Database SQL Language Reference
• SQL*Plus User's Guide and Reference
Conventions
The following text conventions are used in this document:
Convention Meaning
boldface Boldface type indicates graphical user interface elements associated with an
action, or terms defined in text or the glossary.
italic Italic type indicates book titles, emphasis, or placeholder variables for which
you supply particular values.
monospace Monospace type indicates commands within a paragraph, URLs, code in
examples, text that appears on the screen, or text that you enter.
Third-Party License Information

Oracle Application Express contains third-party code. Please see the Oracle Application
Express Licensing Information User Manual for notices Oracle is required to provide.
Note, however, that the Oracle program license that accompanied this product determines
your right to use the Oracle program, including the third-party software, and the terms
contained in the following notices do not change those rights.
ix
1
Changes in Release 21.1 for Oracle
Application Express Installation Guide
All content in Oracle Application Express Installation Guide has been updated to reflect
release 21.1 functionality.
Deprecated and Desupported Features

Because the following features have been desupported so all related discussions have been
removed:
• Legacy Websheet applications
• REST Administration Interface
See "Deprecated Features" and "Desupported Features" Oracle Application Express Release
Notes.
1-1
2
Oracle Application Express Installation
Requirements
Before installing Oracle Application Express in a on-premises (or local) installation you must
verify your configuration meets the minimum installation requirements.
• Oracle Database Requirements

Oracle Application Express release 21.1 requires an Oracle Database release 12.1.0.2 or
later. Application Express runs on all database editions, including Enterprise Edition (EE),
Standard Edition (SE) and Express Edition (XE). Oracle Application Express can be
installed in single-instance database and in Oracle Real Application Clusters (Oracle
RAC) database.
• Checking the MEMORY_TARGET of the Target Database
Oracle Application Express requires the system global area (SGA) and program global
area (PGA) to be at least 300 MB.
• Browser Requirements
Oracle Application Express requires a JavaScript-enabled browser and supports the
current and prior major release of Google Chrome, Mozilla Firefox, Apple Safari, and
Microsoft Edge.
• Web Listener Requirements
Oracle Application Express requires access to the Web listener, Oracle REST Data
Services (ORDS) 19.x or later.
• Disk Space Requirement
Oracle Application Express disk space requirements are described in this section.
• Oracle XML DB Requirement
Oracle XML DB must be installed in the Oracle database that you want to use if you are
installing a full development environment. If you are using a preconfigured database
created either during an installation or by Database Configuration Assistant (DBCA),
Oracle XML DB is already installed and configured.
2.1 Oracle Database Requirements

Oracle Application Express release 21.1 requires an Oracle Database release 12.1.0.2 or
later. Application Express runs on all database editions, including Enterprise Edition (EE),
Standard Edition (SE) and Express Edition (XE). Oracle Application Express can be installed
in single-instance database and in Oracle Real Application Clusters (Oracle RAC) database.
If you are upgrading an Oracle Database version 12.1 CDB, you must download from My
Oracle Support the one off patch for bug 20618595. Search for 20618595 on the Patches tab.
2-1
Chapter 2
Checking the MEMORY_TARGET of the Target Database
2.2 Checking the MEMORY_TARGET of the Target

Database
Oracle Application Express requires the system global area (SGA) and program global
area (PGA) to be at least 300 MB.
Databases typically use automatic memory management, where the memory can be
controlled by the server parameter MEMORY_TARGET. If your database does not use
automatic memory management, consult the Oracle Database Administrator's Guide
to find out how to configure manual memory parameters (for example, SGA_TARGET,
PGA_AGGREGATE_TARGET, SHARED_POOL_SIZE) instead, for a similar result.
To check the MEMORY_TARGET of the target database:
1. Start the database:

SQL> STARTUP
2. If necessary, enter the following command to determine whether the system uses
an initialization parameter file (initsid.ora) or a server parameter file
(spfiledbname.ora):
SQL> SHOW PARAMETER PFILE;
This command displays the name and location of the server parameter file or the
initialization parameter file.
3. Determine the current values of the MEMORY_TARGET parameter:
SQL> SHOW PARAMETER MEMORY_TARGET
4. If the value is 0, your database is using manual memory management. Consult the
Oracle Database Administrator’s Guide to learn how to configure an equivalent
memory size using manual memory management, instead of continuing with the
steps that follow.
If the system is using a server parameter file, set the value of the MEMORY_TARGET
initialization parameter to at least 300 MB:
SQL> ALTER SYSTEM SET MEMORY_TARGET='300M' SCOPE=spfile;
5. If the system uses an initialization parameter file, change the value of the
MEMORY_TARGET parameter to at least 300 MB in the initialization parameter file
(initsid.ora).
6. Shut down the database:
SQL> SHUTDOWN
7. Restart the database:
SQL> STARTUP
See Also:
Oracle Database Administrator’s Guide
2-2
Chapter 2
Browser Requirements
2.3 Browser Requirements

Oracle Application Express requires a JavaScript-enabled browser and supports the current
and prior major release of Google Chrome, Mozilla Firefox, Apple Safari, and Microsoft Edge.
2.4 Web Listener Requirements

Oracle Application Express requires access to the Web listener, Oracle REST Data Services
(ORDS) 19.x or later.
Oracle REST Data Services (ORDS) is Java-based Web Server. ORDS features the ability to
emit RESTful web services, offers improved file upload capability, and is certified with Oracle
WebLogic Server and Apache Tomcat.
2.5 Disk Space Requirement

Oracle Application Express disk space requirements are described in this section.
Oracle Application Express disk space requirements are as follows:
• Free space for Oracle Application Express software files on the file system: 310 MB if
using English only download (apex_21.1_en.zip) and 705 MB if using full download
(apex_21.1.zip).
• Free space in Oracle Application Express tablespace: 220 MB
• Free space in SYSTEM tablespace: 100 MB
• Free space in Oracle Application Express tablespace for each additional language (other
than English) installed: 60 MB
2.6 Oracle XML DB Requirement

Oracle XML DB must be installed in the Oracle database that you want to use if you are
installing a full development environment. If you are using a preconfigured database created
either during an installation or by Database Configuration Assistant (DBCA), Oracle XML DB
is already installed and configured.
Tip:
The installer does a prerequisite check for Oracle XML DB and will exit if it is not
installed.
Tip:
The installation of Oracle XML DB creates the user ANONYMOUS. In order for
Oracle Application Express workspace provisioning to work properly, the
ANONYMOUS user must not be dropped from the database.
2-3
Chapter 2
Oracle XML DB Requirement
Tip:
For more information about manually adding Oracle XML DB to an existing
database, see "Administration of Oracle XML DB"in Oracle XML DB
Developer’s Guide
2-4
3
Overview
Oracle Application Express Installation Guide describes how to install Oracle Application
Express in a on-premises (or local) installation.
How you sign in and access Oracle Application Express depends upon your user role and
where Oracle Application Express resides. Oracle Application Express may reside in a local
on-premises Oracle Database or in an Oracle Cloud Service.
• About Oracle Application Express Architecture

Oracle Application Express uses a simple architecture in which pages are dynamically
generated using metadata stored within the Oracle Database.
• About Accessing Oracle Application Express in Oracle Cloud
Learn about accessing Oracle Application Express in Oracle Cloud.
• Understanding the Installation Process
Installing Oracle Application Express is a multiple step process. You follow the same
instructions for new or upgrade installations.
• About the Oracle Application Express Runtime Environment
Learn about the Oracle Application Express runtime environment.
See Also:
Upgrading from a Previous Oracle Application Express Release
3.1 About Oracle Application Express Architecture

Oracle Application Express uses a simple architecture in which pages are dynamically
generated using metadata stored within the Oracle Database.
About the Oracle Application Express Architecture

The Oracle Application Express architecture consists of a web browser, Oracle REST Data
Services (the web listener), and an Oracle Database containing Oracle Application Express.
The major advantage of this architecture is the separation of the mid-tier and the database
tier.
3-1
Chapter 3
About Oracle Application Express Architecture
Oracle Database with

Oracle Application Express
Database
Web Listener
Web Browser
Meta Data
The web listener, Oracle REST Data Services, functions as a communications broker
between the Web browser and the Oracle Application Express objects in the Oracle
database by mapping browser requests into database stored procedure calls.
Once fully installed, a Uniform Resource Locator (URL) is defined for both developers
and end users to access Oracle Application Express. Users require only a Web
browser and the required URL. No additional client software is required.
About Oracle REST Data Services

Oracle REST Data Services (formerly known as Oracle Oracle Application Express
Listener) is a J2EE application which communicates with the Oracle Database by
mapping browser requests to the Application Express engine database over a
SQL*Net connection.
Oracle REST Data Services is fully supported against Oracle WebLogic Server and
Apache Tomcat. In a production environment, you deploy Oracle REST Data Services
web archive files to a supported Java EE application server, like Oracle Web Logic
Server. Each deployment can be configured individually and serves the same purpose
as a mod_plsql Database Access Descriptor, which is to communicate with an Oracle
database.
Note:
There are licensing costs associated with Oracle WebLogic Server.
3-2
Chapter 3
About Accessing Oracle Application Express in Oracle Cloud
See Also:
• "Web Listener Requirements"

• "Installing and Configuring Application Express and Oracle REST Data
Services"
• "Installing Oracle REST Data Services" in Oracle REST Data Services
Installation, Configuration, and Development Guide
3.2 About Accessing Oracle Application Express in Oracle

Cloud
Learn about accessing Oracle Application Express in Oracle Cloud.
Oracle Application Express is installed and enabled in Oracle APEX Application Development
(APEX Service) and Oracle Autonomous Database Shared Exadata Infrastructure such as
Autonomous Transaction Processing and Autonomous Data Warehouse.
Oracle Application Express is available in Exadata Cloud Service and Database Cloud
Service in Oracle Cloud Infrastructure. However, you need to manually customize your
databases to install and enable Oracle Application Express by following the on-premises
installation process or using cloud tooling such as Terraform.
See Also:
• Get an Environment
• Welcome to Oracle APEX Application Development Service in Getting Started
with Oracle APEX Application Development
• Creating Applications with Oracle Application Express on Autonomous
Database in Using Oracle Autonomous Database on Shared Exadata
Infrastructure
• "Oracle Application Express (APEX) on Oracle Cloud Infrastructure Database"
white paper on the Oracle Cloud Infrastructure Technical White Papers page
3.3 Understanding the Installation Process

Installing Oracle Application Express is a multiple step process. You follow the same
instructions for new or upgrade installations.
• About Planning Your Installation

Learn about the steps needed to install Oracle Application Express.
• About Patch Sets
Patch sets provide bug fixes only. A point release includes bug fixes and incorporates all
current patch sets.
3-3
Chapter 3
Understanding the Installation Process
• About the Installation Scripts

You can install Oracle Application Express or update from previous release using
the same installation procedure and the installation scripts.
• About Accessing Oracle Application Express
You access the Oracle Application Express development environment, by signing
in to a shared work area called a workspace.
• Requesting a Workspace from the Sign In Dialog
Request a workspace from the Sign In dialog.
• Resetting Your Password from the Sign In Page
Reset your password by clicking a link on Oracle Application Express Sign In
page.
• Recovering Your Workspace Name
Recover your workspace name from the Oracle Application Express Sign In page.
See Also:
"Upgrading from a Previous Oracle Application Express Release"
3.3.1 About Planning Your Installation

Learn about the steps needed to install Oracle Application Express.
Oracle recommends you take the time to carefully plan your installation.
Installing Oracle Application Express involves the following steps:
1. Decide on a Full or Runtime Environment - Determine whether to install a full
development environment or runtime environment. A full development
environment provides complete access to the App Builder development
environment to develop applications. A runtime environment is the appropriate
choice for production implementations in which you want to run applications that
cannot be modified.
See "About the Oracle Application Express Runtime Environment."
2. Verify installation requirements- Before installing, verify your system meets the
minimum requirements.
See " Oracle Application Express Installation Requirements ."
3. Install the software - Install or upgrade Oracle Application Express by
downloading a ZIP file from the Oracle Application Express download page and
then downloading and installing Oracle REST Data Services (ORDS) as described
in "Installing and Configuring Application Express and Oracle REST Data
Services."
See Also:
3-4
Chapter 3
3.3.2 About Patch Sets

Patch sets provide bug fixes only. A point release includes bug fixes and incorporates all
current patch sets.
Patch sets are a mechanism for delivering fully tested and integrated product fixes. Patch
sets provide bug fixes only. Patch sets typically do not include new functionality and they do
not require certification on the target system. Patch sets include all of the libraries that have
been rebuilt to implement the bug fixes in the set. All of the fixes in the patch set have been
tested and are certified to work with each other.
In between major product releases, Oracle may offer a point release. A point release (for
example Oracle Application Express release 5.0.3) includes bug fixes and incorporates all
current patch sets. Typically, point releases do not introduce new functionality.
See Also:
3.3.3 About the Installation Scripts

You can install Oracle Application Express or update from previous release using the same
installation procedure and the installation scripts.
The installation script checks for the latest existing Oracle Application Express schema and
automatically copies the instance metadata, workspaces, and applications from the previous
schema into the current schema. The original schema associated with the previous release is
left completely unaltered. Following best practices, Oracle recommends that you create new
tablespaces for a new release of Oracle Application Express and follow the appropriate
installation instructions as outlined in this document.
3.3.4 About Accessing Oracle Application Express

You access the Oracle Application Express development environment, by signing in to a
shared work area called a workspace.
How you sign in and access Oracle Application Express depends upon your user role.
A workspace enables multiple users to work within the same Oracle Application Express
installation while keeping their objects, data, and applications private. Each workspace has a
unique ID and name. An instance administrator can create a workspace manually within
Oracle Application Express Administration Services or have users submit requests. Oracle
Application Express Administration Services is a separate application for managing an entire
Oracle Application Express instance.
Users are divided into four primary roles:
• Instance administrators are superusers that manage an entire hosted instance using a
separate application called Oracle Application Express Administration Services. Instance
administrators manage workspace provisioning, configure features and instance settings,
and manage security.
3-5
Chapter 3
• Workspace administrators can perform administrator tasks specific to a

workspace such as configuring workspace preferences, managing user accounts,
monitoring workspace activity, and viewing log files.
• Developers are users who sign in to a workspace and create and edit
applications.
• End users can only run existing applications.
If you are a developer, an administrator must grant you access to shared work area
called a workspace. If you are an Instance administrator, you must sign in to Oracle
Application Express Administration Services, determine whether to specify a
provisioning mode, create a workspace, and then sign in to that workspace.
About Specifying a Provisioning Mode

The Instance administrator determines how the process of provisioning (or creating) a
workspace works for a specific Oracle Application Express instance. To determine how
provisioning works, an Instance Administrator selects a Provisioning Methods on the
Instance Settings page:
• Manual - An Instance administrator creates new workspaces and notifies the
Workspace administrator regarding the Sign In credentials.
• Request - Users request a workspace. Once an administrator approves the
request, the user receives an email containing an email verification link. After the
user clicks the email verification link, the workspace is created.
• Automatic - Works similar to Request except requests are automatically
approved with no administrator review required
See Also:
"About Specifying How Workspaces Are Created" and "Selecting a
Workspace Provisioning Mode" in Oracle Application Express Administration
Guide
About Creating Workspaces and Users

Before you can develop or install applications, an administrator must create a
workspace and add Oracle Application Express users. To learn more contact your
administrator, or see the “Creating a Workspace and Adding Oracle Application
Express Users” section for your Web listener in this document.
3-6
Chapter 3
See Also:
• "Creating Workspaces in Administration Services" in Oracle Application

Express Administration Guide
• "Making a Service Request" in Oracle Application Express Administration Guide
• "Managing Requests" in Oracle Application Express Administration Guide
3.3.5 Requesting a Workspace from the Sign In Dialog

Request a workspace from the Sign In dialog.
Note:
This information does not apply to Oracle Cloud products such as Oracle Database
Cloud Service (Database Schema).
Your administrator determines how you request a new workspace. If your administrator has
set Provisioning Method to either Request or Automatic and has configured email, you can
request a workspace on the Sign In dialog.
1. To request a workspace from the Sign In dialog:
1. Navigate to the Oracle Application Express Sign in dialog.
2. Under Sign In, click Request a Workspace.
The Request a Workspace Wizard appears.
3. For Identification:
a. First Name - Enter your first name.
b. Last Name - Enter your last name.
c. Email - Enter the email address. A link to activate your workspace will be sent to this
email address.
d. Workspace - Enter a workspace name that name uniquely identifies your
development environment.
e. Click Next.
4. If defined, review and accept the service agreement and click Next.
5. Verify your request and click Submit Request.
Once you complete the Identification form, the following events occur:
a. You will receive an email containing a verification link.
b. When you click the verification link, the workspace is created.
c. You will receive another email containing Sign In credentials (that is, the workspace
name, username, and password).
Once you complete the Identification form, the following events occur:
3-7
Chapter 3
1. You will receive an email containing a verification link.

2. When you click the verification link, the workspace is created.
3. You will then receive another email containing Sign In credentials (that is, the
workspace name, username, and password).
See Also:
"About Specifying How Workspaces Are Created" in Oracle Application
3.3.6 Resetting Your Password from the Sign In Page

Reset your password by clicking a link on Oracle Application Express Sign In page.
Tip:
To reset your password from the Sign In page, you must provide your email
address and the workspace name.
1. To reset your password from the Sign In Page:

1. In a web browser, navigate to the Oracle Application Express Sign In page.
The Sign In page appears.
2. Under Sign In, click Reset Password.
3. In the Reset Password form, enter your email address, workspace name, and click
Reset Password.
You will receive an email confirming your workspace name and username and
containing a Reset Password URL link.
4. In the email, click the Reset Password URL link.
5. In the Change Password form:
a. New Password - Enter your new password.
Tip:
Passwords are case sensitive.
b. Confirm Password - Enter your new password again.

c. Click Apply Changes.
3-8
Chapter 3
About the Oracle Application Express Runtime Environment
Tip:
You can also reset your password within Oracle Application Express. See
"Changing Your Profile or Password" in Oracle Application Express App Builder
User’s Guide
3.3.7 Recovering Your Workspace Name

Recover your workspace name from the Oracle Application Express Sign In page.
If you cannot remember your workspace name, you can request a list of all workspace names
associated with your email address.
To find your workspace name:
1. In a web browser, navigate to the Oracle Application Express Sign In page.
2. On the Sign In page, click Reset Password.
3. Click Find My Workspace.
4. Enter your email address and click Find Workspace.
You will receive an email listing all workspaces associated with the email address you
provided.
3.4 About the Oracle Application Express Runtime Environment

Learn about the Oracle Application Express runtime environment.
As with any software development life cycle, Oracle strongly recommends that you have
different environments for development, testing/QA, and production. For testing and
production instances, Oracle Application Express supports the ability to install just a runtime
version of Oracle Application Express. This runtime environment minimizes the installed
footprint and privileges and improves application security since in a runtime instance
developers cannot inadvertently update a production application.
An Oracle Application Express runtime environment enables you to run production
applications, but it does not provide a Web interface for administration. A runtime
environment only includes the packages necessary to run your application, making it a more
hardened environment. You administer the Oracle Application Express runtime environment
using SQL*Plus or SQL Developer and the APEX_INSTANCE_ADMIN API.
See Also:
"About the Advantages of the Application Express Runtime Environment" in Oracle
Application Express App Builder User’s Guide
Scripts are provided to remove or add the developer interface from an existing instance. To
learn more, see one of the following for the corresponding type of installation:
3-9
Chapter 3
About the Oracle Application Express Runtime Environment
See also:
"Converting Between Runtime and Full Development Environments"
3-10
4
Upgrading from a Previous Oracle Application
Express Release
Upgrading Oracle Application Express creates new database objects in a new schema and
migrates the application metadata to the new release.
If you have Oracle Application Express release 20.x or earlier, following any of the installation
scenarios in this guide upgrades your Oracle Application Express instance to release 21,
creates Oracle Application Express 21.1 database objects in a new schema, and migrates
the application metadata to the new release.
• About Release Numbering Conventions

New releases of Oracle Application Express correlate to the calendar year.
• Sample Upgrade Scenarios
Common upgrade scenarios include upgrading from prior release and installing an Oracle
Database release which include Oracle Application Express.
• Viewing the Oracle Application Express Release Number
View your Oracle Application Express release number on the Workspace home page or
on the About Application Express page.
• Viewing the Oracle REST Data Services Release Number
View the Oracle REST Data Services release number on the About Application Express
page.
• About Installing the Oracle Application Express Release Included with the Oracle
Database
Learn about the Oracle Application Express release included with Oracle Database
releases.
• About Upgrading Existing Applications
Installing a new release of Oracle Application Express, updates existing applications to
the latest release, but does not alter application user interface or application components.
• About Testing Requirements
Determining the appropriate amount of regression testing when upgrading Oracle
Application Express depends upon the complexity, size, and number of applications you
are upgrading.
• About Cleaning Up Your Environment
Following the successful upgrade of all of the environments to the latest release of Oracle
Application Express, you should clean-up the environments.
• About Reverting to a Previous Release
You can revert to a previous release of Oracle Application Express.
4-1
Chapter 4
About Release Numbering Conventions
See Also:
• Understanding the Installation Process

• Maximizing Uptime During an Application Express Upgrade
4.1 About Release Numbering Conventions

New releases of Oracle Application Express correlate to the calendar year.
In 2018 and starting with release 18.1 and 18.2, Oracle Application Express introduced
correlating the release number to the calendar year.
In addition, Application Express now only offers full releases and no longer provides
patch set releases (such as 5.1.1). Eliminating patch set releases reduces downtime
when updating existing installations. Application Express architecture also enables
developers to revert releases if necessary.
Patch set exceptions (PSEs) may still be delivered for major defects. To learn more
about PSEs, visit the Oracle APEX 21.1 Known Issues page or the Prior Release
Archives for earlier releases.
4.2 Sample Upgrade Scenarios

Common upgrade scenarios include upgrading from prior release and installing an
Oracle Database release which include Oracle Application Express.
Table 4-1 lists common upgrade scenarios.
Table 4-1 Sample Upgrade Scenarios
Upgrade Scenarios Action

Upgrade from a prior Oracle Application Express Download the latest files from the
release Downloads page.
You install Oracle Database which include Oracle Download the latest files from the
Application Express. Downloads page.
4.3 Viewing the Oracle Application Express Release

Number
View your Oracle Application Express release number on the Workspace home page
or on the About Application Express page.
You can view the Oracle Application Express release number on the Workspace home
page or on the About Application Express page:
• Workspace home page:
– Sign in to Oracle Application Express.
4-2
Chapter 4
Viewing the Oracle REST Data Services Release Number
On the Workspace home page, the current release number displays in the bottom
right corner.
• About Application Express page:
– Sign in to Oracle Application Express.
– Click the Help menu in the upper right and select About.
On the About Application Express pag, the release number appears next to Product
Build.
4.4 Viewing the Oracle REST Data Services Release Number

View the Oracle REST Data Services release number on the About Application Express
page.
Oracle Application Express requires access to the Web listener, Oracle REST Data Services
(ORDS) 19.x or later.
1. To view the Oracle REST Data Services release number:
1. Sign in to Oracle Application Express.
2. Click the Help menu in the upper right and select About.
3. Under the CGI Environment section, find APEX_LISTENER_VERSION.
4.5 About Installing the Oracle Application Express Release

Included with the Oracle Database
Learn about the Oracle Application Express release included with Oracle Database releases.
Note:
Starting with Oracle Database 12c Release 2 (12.2), Oracle Application Express is
included in the Oracle Home on disk and is no longer installed by default in the
database.
Oracle Application Express is included with the following Oracle Database releases:
• Oracle Database 19c - Oracle Application Express Release 18.1.
• Oracle Database 18c - Oracle Application Express Release 5.1.
• Oracle Database 12c Release 2 (12.2)- Oracle Application Express Release 5.0.
• Oracle Database 12c Release 1 (12.1) - Oracle Application Express Release 4.2.
• Oracle Database 11g Release 2 (11.2) - Oracle Application Express Release 3.2.
• Oracle Database 11g Release 1 (11.1) - Oracle Application Express Release 3.0.
The Oracle Database releases less frequently than Oracle Application Express. Therefore,
Oracle recommends updating to the latest Oracle Application Express release available on
Oracle Technology Network. To learn more, see the installation instructions for the
appropriate Web Listener in your environment.
4-3
Chapter 4
About Upgrading Existing Applications
Note:
If upgrading Oracle Application Express from a release that ships with the
database, do not alter any Oracle Application Express files in the Oracle
home directory (for example, /u01/app/oracle/product/18.0.0/dbhome_1/
apex) .
4.6 About Upgrading Existing Applications

Installing a new release of Oracle Application Express, updates existing applications to
the latest release, but does not alter application user interface or application
components.
Once you upgrade an Oracle Application Express instance from a previous release,
existing applications will work without modification. However, to keep applications
maintainable, up-to-date, and to leverage new functionality, developers should perform
the steps outlined in Oracle Application Express App Builder User’s Guide.
See Also:
Upgrading Application Express Applications in Oracle Application Express
App Builder User’s Guide
4.7 About Testing Requirements

Determining the appropriate amount of regression testing when upgrading Oracle
Application Express depends upon the complexity, size, and number of applications
you are upgrading.
You should include the majority of complex pages, particularly those that incorporate
significant JavaScript or extensive PL/SQL computations or processes. Developers
should ensure pages which they manually update based on the Upgrade Application
or Advisor are also included in regression tests. Not all remaining pages have to be
included in regression testing. Oracle recommends you include a good representation
of different page types includes reports, charts, and forms. An application should
always be included in regression testing if its compatibility mode was modified post-
upgrade.
While regression testing of upgraded applications is imperative to minimize risk of
disrupting the end users, it is important that testing is not drawn out for an extended
period. As a general rule:
• Step 1: Upgrade your development environment first. Allow developers to review
the applications and make initial updates as needed.
• Step 2: Upgrade your QA/Test environment.
• Step 3: Upgrade applications from development are built into this environment.
• Step 4: Upgrade your production environment.
• Step 5: Build upgraded applications into this environment.
4-4
Chapter 4
About Cleaning Up Your Environment
4.8 About Cleaning Up Your Environment

Following the successful upgrade of all of the environments to the latest release of Oracle
Application Express, you should clean-up the environments.
Once you start developing with the newer release, the Oracle Application Express schema
associated with the prior release can be deleted. If you installed the prior release into a
separate tablespace, you can simply drop the specific tablespace. Oracle recommends
leaving the older Oracle Application Express schema(s) for a few weeks and then remove
them from the development, test, and production environments. This cleanup process
releases disk space and ensures that no one accesses an outdated schema using tools such
as SQL Developer or SQL*Plus.
4.9 About Reverting to a Previous Release

You can revert to a previous release of Oracle Application Express.
Because Oracle Application Express creates a new schema for each major release, reverting
back to a prior release is a relatively simple process. If you revert to a prior release, any
modifications made in the current Oracle Application Express instance are lost. The main
task is to switch the public synonyms and grants to point at the previous schema instead of
the new schema.
See Also:
Reverting to a Previous Release After a Failed Upgrade Installation
4-5
5
Utilizing the Multitenant Architecture in Oracle
Database 12c or Later
Learn about installation choices and different scenarios associated with copying and moving
pluggable databases introduced by the Oracle Database 12c or later multitenant architecture
with respect to Oracle Application Express (Application Express).
• Understanding the Installation Choices
Learn about the installation choices in Oracle Application Express.
• Installing Application Express into an Application Container
Learn about the application container that stores data and metadata for application back
ends.
• Installing Application Express into Different PDBs
You can install different versions of Oracle Application Express into different PDBs.
• Plugging in a PDB When Application Express is Installed in the Root Container
Learn about scenarios in which the target database has Application Express installed into
the root container, CDB$ROOT - the default installation option.
• Plugging in a PDB When Application Express Is Not in the Root Container of the Target
CDB
The scenarios in this section describe when Application Express is not installed in the
root container, CDB$ROOT, by explicitly removing it as described in "Uninstalling Application
Express from a CDB".
5.1 Understanding the Installation Choices

Learn about the installation choices in Oracle Application Express.
Oracle Database 12c Release 1 (12.1) introduces the multitenant architecture. This database
architecture has a multitenant container database (CDB) that includes a root container,
CDB$ROOT, a seed database, PDB$SEED, and multiple pluggable databases (PDBs). Each
pluggable database is equivalent to a separate database instance in Oracle Database
release 11g. The root container, CDB$ROOT, holds common objects that are accessible to
every PDB utilizing metadata links or object links. The seed database, PDB$SEED, is used
when creating a new PDB to seed the new database. The key benefit of the Oracle Database
12c or later multitenant architecture is that the database resources, such as CPU and
memory, can be shared across all of the PDBs. This architecture also enables many
databases to be treated as one for tasks such as upgrades or patches, and backups.
When configuring multitenant architecture, Oracle Application Express is installed in the root
container database by default in Oracle Database 12c Release 1 (12.1). In the default
installation the root container, CDB$ROOT, includes the APEX_040200 schema to store the
common database objects for the Application Express engine such as packages, functions,
procedures and views. The seed database, PDB$SEED, also includes the APEX_040200 schema
to store the tables that are part of the Application Express engine.
You can create a new PDB by copying PDB$SEED, which includes the APEX_210100 if Oracle
Application Express release 21.1 is installed common in the CDB. As such there are multiple
5-1
Chapter 5
Installing Application Express into an Application Container
copies of the Application Express engine tables and only single copies of the
Application Express engine packages, functions, procedures and views. Each PDB will
have the APEX_210100 schema and have its own copy of the Application Express
engine's tables so that it can hold the metadata for the Application Express
applications defined within that PDB.
Tip:
Oracle recommends removing Oracle Application Express from the root
container database for the majority of use cases, except for hosting
companies or installations where all pluggable databases (PDBs) utilize
Oracle Application Express and they all need to run the exact same release
and patch set of Oracle Application Express.
See Also:
"Installing Application Express into Different PDBs"
5.2 Installing Application Express into an Application

Container
Learn about the application container that stores data and metadata for application
back ends.
• About Application Containers
An application container is a CDB component that stores data and metadata for
application backends.
• Creating Application Container
To create a PDB within a CDB as an application container, you use the AS
APPLICATION CONTAINER clause of the create PDB command.
• Installing or Upgrading Application Express in an Application Container
• Verifying the Application Container Installation
Verify the application container by inpsecting the log file for ORA- or PLS- errors
and compiling invalid objects.
• Creating an Application Seed
An application seed is used to provision application PDBs with the application
root's applications pre-installed.
• Creating an Application PDB from the Application Root Seed
An application PDB is created by issuing the CREATE PLUGGABLE DATABASE
statement from the application root.
• Configure HTTP Access to the Application PDB
Configure a new application PDB for HTTP access.
5-2
Chapter 5
5.2.1 About Application Containers

An application container is a CDB component that stores data and metadata for application
backends.
Oracle Application Express can be installed into an application container using the
apxappcon.sql script. An application container consists of an application root where the
application is defined and one or more PDBs that share data and metadata about the
application from the application root. You can have multiple application containers within a
CDB and each container can have a different version of Oracle Application Express.
Patching or upgrading Oracle Application Express in an application container is simplified,
because these actions are done against the application root. When an application PDB
wishes to uptake the patch or upgraded version, it simply syncs with the application root.
Oracle Application Express continues to run in the application PDB at the existing version
until the application PDB syncs with the application root.
5.2.2 Creating Application Container

To create a PDB within a CDB as an application container, you use the AS APPLICATION
CONTAINER clause of the create PDB command.
To create Application Container:

1. Use the AS APPLICATION CONTAINER clause of the CREATE PLUGGABLE DATABASE
statement to create an application container.
2. Open the application container.
For Example:
CREATE PLUGGABLE DATABASE apex_approot1 AS APPLICATION CONTAINER admin

user admin IDENTIFIED
BY <admin_password> FILE_NAME_CONVERT=('pdbseed','apex_approot1');
ALTER PLUGGABLE DATABASE apex_approot1 open;
Note:
apex_approot1 and the admin user in the previous example can be any valid
ORACLE identifier.
5.2.3 Installing or Upgrading Application Express in an Application

Container
To install or upgrade Application Express in an Application Container:
1. Connect to Application Container.
2. Run apxappcon.sql.
apxappcon.sql installs Application Express as an application named APEX into the
application root.
5-3
Chapter 5
The script takes the exact same first four arguments as the apexins.sql script,
with the addition of a fifth parameter which is the password to use for the
APEX_PUBLIC_USER password. In an upgrade installation, the fifth argument is
ignored because the APEX_PUBLIC_USER database user will already exist.
For example:
ALTER SESSION SET CONTAINER = apex_approot1;
@apxappcon.sql SYSAUX SYSAUX TEMP /i/ P@ssw0rd!
5.2.4 Verifying the Application Container Installation

Verify the application container by inpsecting the log file for ORA- or PLS- errors and
compiling invalid objects.
To verify the Application Container installation:
1. Manually inspect the installation log file for ORA- or PLS- errors.
2. Compile invalid objects by running the following command:
For example:
ALTER SESSION SET CONTAINER=apex_approot1;
begin
sys.dbms_utility.compile_schema( 'APEX_210100', false );
sys.dbms_utility.compile_schema( 'FLOWS_FILES', false );
end;
/
3. Query dba_applications and dba_app_errors.
SQL> select app_name, app_version, app_status from dba_applications

where app_name = 'APEX';
APP_NAME APP_VERSION
APP_STATUS
------------------------------ ------------------------------
------------
APEX 21.1 NORMAL
SQL> select app_name, app_statement, errornum, errormsg from

dba_app_errors where app_name = 'APEX';
no rows selected
5-4
Chapter 5
5.2.5 Creating an Application Seed

An application seed is used to provision application PDBs with the application root's
applications pre-installed.
To create an Application Seed:
1. Connect to CDB$ROOT as sysdba.
2. Alter session and set container to the application root.
3. Use the AS SEED clause of the CREATE PLUGGABLE DATABASE statement to create an
application seed.
4. Sync the APEX application with the application seed.
5. Compile invalid objects.
6. Open the application seed in read only mode.
For example:
CREATE PLUGGABLE DATABASE as seed admin user admin identified by

<admin_password> file_name_convert=('pdbseed','apex_approot1_seed');
ALTER PLUGGABLE DATABASE apex_approot1$seed open;
ALTER SESSION SET CONTAINER=apex_approot1$seed;
ALTER PLUGGABLE DATABASE application APEX sync;
begin
sys.dbms_utility.compile_schema( 'APEX_210100', false );
sys.dbms_utility.compile_schema( 'FLOWS_FILES', false );
end;
/
ALTER PLUGGABLE DATABASE close immediate;
ALTER PLUGGABLE DATABASE open read only;
Note:
apex_approot1 and the admin user in the previous example can be any valid
ORACLE identifier.
5-5
Chapter 5
5.2.6 Creating an Application PDB from the Application Root Seed

An application PDB is created by issuing the CREATE PLUGGABLE DATABASE statement
from the application root.
The PLUGGABLE DATABASE is created from the application container seed so the APEX
application is already installed and ready for configuration.
To create an Application PDB from the Application Root Seed:
1. Connect to CDB$ROOT as sysdba.
2. Alter session and set container to the application root.
3. Use the CREATE PLUGGABLE DATABASE command to create a PDB from the
application seed.
For example:
CREATE PLUGGABLE DATABASE apex_pdb1 admin user admin identified by

<admin password>
file_name_convert=('apex_approot1_seed','apex_pdb1');
ALTER PLUGGABLE DATABASE apex_pdb1 open;
ALTER SESSION SET CONTAINER=apex_pdb1;
SQL> select app_name, app_version, app_status from dba_applications

where app_name = 'APEX';
APP_NAME APP_VERSION
APP_STATUS
------------------------------ ------------------------------
------------
APEX 21.1 NORMAL
Note:
apex_approot1 and the admin user in the previous example can be any
valid ORACLE identifier.
5.2.7 Configure HTTP Access to the Application PDB

Configure a new application PDB for HTTP access.
Configure the new application PDB for HTTP access by following the instructions
starting with the section "Downloading and Installing Oracle REST Data Services."
5-6
Chapter 5
Installing Application Express into Different PDBs
5.3 Installing Application Express into Different PDBs

You can install different versions of Oracle Application Express into different PDBs.
Providing Application Express is not installed in the container database, you can install a
local Application Express within each PDB as required. When Application Express is installed
locally there are no Application Express metadata linked objects and all packages, views, and
tables are created within the APEX_210100 schema, within each PDB where Application
Express is installed.
• Uninstalling Application Express from a CDB
Learn how to uninstall Application Express from a CDB.
• Installing Application Express Locally in a PDB
Learn how to install Application Express locally in a PDB.
• Installing Application Express into a CDB
5.3.1 Uninstalling Application Express from a CDB

Learn how to uninstall Application Express from a CDB.
To uninstall Oracle Application Express from a CDB:
Note:
Installing or removing Application Express from a CDB requires a local connection
to the database.
This section describes removing Application Express from a CDB. If you wish to
remove Oracle Application Express from the CDB that shipped with Oracle
Database 12.1, you should use apxremov_con.sqlfrom either $ORACLE_HOME/apex ,
or from a 4.2.6 APEX distribution.
1. Change to the apex directory in the location where you unzipped the distribution.
2. Start SQL*Plus and connect to the database where Application Express is installed as
SYS specifying the SYSDBA role. For example:
• On Windows:
SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password
• On UNIX and Linux:

$ sqlplus /nolog
3. Run apxremov.sql.
For example:
@apxremov.sql
5-7
Chapter 5
Note:
If you run apexremov.sql after PDBs have been added to the CDB, then
Application Express uninstalls from all of the PDBs, as well as CDB$ROOT
and PDB$SEED. Therefore, any applications defined in any of the PDBs
will be removed.
5.3.2 Installing Application Express Locally in a PDB

Learn how to install Application Express locally in a PDB.
Once you have removed Application Express from the container database by following
the instructions in "Uninstalling Application Express from a CDB," you can install
Application Express locally in a PDB.
To install Application Express locally in a PDB:
1. Change the apex directory in the location where you unzipped the distribution.
2. Start SQL*Plus and connect to the database where Application Express is
installed as SYS specifying the SYSDBA role. For example:
• On Windows:

$ sqlplus /nolog
3. Set the container to the PDB you want to install Application Express locally:
ALTER SESSION SET CONTAINER = <PDB_name>;
4. Select the appropriate installation option.
Full development environment provides complete access to the App Builder
environment to develop applications. A Runtime environment enables users to
run applications that cannot be modified.
Available installation options include:
• Full development environment - Run apexins.sql passing the following four
arguments in the order shown:
@apexins.sql tablespace_apex tablespace_files tablespace_temp

images
Where:
– tablespace_apex is the name of the tablespace for the Application
Express application user.
– tablespace_files is the name of the tablespace for the Application
Express files user.
5-8
Chapter 5
– tablespace_temp is the name of the temporary tablespace or tablespace group.

– images is the virtual directory for Application Express images. To support future
Application Express upgrades, define the virtual image directory as /i/.
For example:
@apexins.sql SYSAUX SYSAUX TEMP /i/
• Runtime environment - Run apxrtins.sql passing the following four arguments in
the order shown:
@apxrtins.sql tablespace_apex tablespace_files tablespace_temp images
Where:
– tablespace_apex is the name of the tablespace for the Application Express
application user.
– tablespace_files is the name of the tablespace for the Application Express files
user.
For example:
@apxrtins.sql SYSAUX SYSAUX TEMP /i/
5. Complete the appropriate steps in Installing Application Express and Configuring Oracle
REST Data Services.
Note:
Oracle Database SQL Language Reference for more information about SQL*Plus
When Application Express installs, it creates the following database accounts:

• APEX_210100 - This account owns the Application Express schema and metadata.
• FLOWS_FILES - This account owns the Application Express uploaded files.
• APEX_PUBLIC_USER - This minimally privileged account is used for Application Express
configuration with Oracle REST Data Services or Oracle HTTP Server and mod_plsql.
If you configured RESTful Web services, then these additional accounts are created:
• APEX_REST_PUBLIC_USER - The account used when invoking RESTful Services definitions
stored in Application Express.
• APEX_LISTENER - The account used to query RESTful Services definitions stored in
Application Express.
See Also:
"Installing and Configuring Application Express and Oracle REST Data Services"
5-9
Chapter 5
5.3.3 Installing Application Express into a CDB

To install Application Express into a CDB:
Note:
Installing or removing Application Express from a CDB requires a local
connection to the database.
1. Change your working directory to the apex directory in the location where you
unzipped the distribution.
2. Start SQL*Plus and connect to CDB$ROOT of the database where Application
Express is installed as SYS specifying the SYSDBA role.For example:
• On Windows:

$ sqlplus /nolog

• Full development environment. Run apexins.sql passing the following four
@apexins.sql tablespace_apex tablespace_files tablespace_temp

images
Where:
– tablespace_apex is the name of the tablespace for the Oracle Application
– tablespace_files is the name of the tablespace for the Application
Express files user.
– tablespace_temp is the name of the temporary tablespace or tablespace
group.
5-10
Chapter 5
Example:
• Runtime environment. Run apxrtins.sql passing the following arguments in the

order shown:
Where:
– tablespace_apex is the name of the tablespace for the Application Express
application user.
– tablespace_files is the name of the tablespace for the Application Express files
user.
Example:
4. Complete appropriate steps in Installing Application Express and Configuring Oracle

REST Data Services.
If you configured RESTful Web services, then these additional accounts are created:
stored in Application Express.
5-11
Chapter 5
Plugging in a PDB When Application Express is Installed in the Root Container
See Also:
• "Using SQL*Plus" in SQL*Plus User's Guide and Reference

• "Patching or Upgrading Application Express in the CDB"
• "About the Oracle Application Express Runtime Environment"
Services"
5.4 Plugging in a PDB When Application Express is Installed

in the Root Container
Learn about scenarios in which the target database has Application Express installed
into the root container, CDB$ROOT - the default installation option.
This section describes scenarios in which the target database has Application Express
installed into the root container, CDB$ROOT - the default installation option. Note there
are multiple scenarios related to where the database being plugged in originated from
and how Application Express was configured in the originating database.
• Scenario 1: Plug-in Non-CDB with Application Express
Plug-in a Non-CDB with Application Express.
• Scenario 2: Plug-in PDB with a Common Application Express from Another CDB
Plug-in a PDB with Application Express from another CDB.
• Scenario 3: Plug-in PDB with a Local Application Express from Another CDB
Plug-in a PDB with a local Application Express from another CDB.
• Scenario 4: Plug-in Non-CDB or PDB with No Application Express
Plug-in a Non-CDB or PDB if the Application Express is not installed.
• Working with Incompatible Application Express Versions
Learn how to work with the incompatible versions of Application Express.
5.4.1 Scenario 1: Plug-in Non-CDB with Application Express

If you are upgrading from a previous Oracle Database release, then you first need to
upgrade to a Oracle Database 12c non-CDB (or standalone database) or later and
then plug the database into your CDB. Alternatively, if you have configured a non-CDB
Oracle Database 12c or later , you may now want to plug this database into a CDB. In
both cases, the originating database has Application Express installed and was not
formerly a PDB.
As described in the Oracle Database Installation Guide for your operating system,
when plugging in a standalone database you need to run the $ORACLE_HOME/rdbms/
admin/noncdb_to_pdb.sql script. This script creates the necessary metadata linked
objects, instead of local objects and recompiles the database objects for all common
database options, including Application Express.
5-12
Chapter 5
After installing Application Express, you need to configure the Web listener for the PDB.
If the version of Application Express installed in the originating database (which is now a
PDB) is different from what is installed into the root container of the target, an error will be
raised when trying to open the PDB.
See Also:

Services"
• "Working with Incompatible Application Express Versions"
5.4.2 Scenario 2: Plug-in PDB with a Common Application Express from

Another CDB
If you are copying or moving a PDB from an existing Oracle Database 12c or later where the
originating CDB had Application Express installed in the root container, you will not need to
perform any additional steps, other than configuring the Web listener for the PDB.
This scenario assumes Oracle Application Express release 21.1 is installed and the
APEX_210100 schema within the PDB being plugged in already has the metadata linked
objects defined and will compile without error against the metadata linked objects within the
target CDB.
If the version of Application Express installed in the originating database is different from what
is installed in the root container of the target an error is raised when trying to open the PDB.
See Also:

Services"
• "Working with Incompatible Application Express Versions"
5.4.3 Scenario 3: Plug-in PDB with a Local Application Express from

Another CDB
Plug-in a PDB with a local Application Express from another CDB.
If you are copying or moving a PDB from an existing Oracle Database 12c or later where
Application Express was not installed in the root container but is installed locally, then you
need to perform additional steps before the PDB can be opened without errors.
APEX_210100 schema within the PDB being plugged in contains all of the Application Express
5-13
Chapter 5
database objects and has no metadata linked objects. Therefore, you need to
run $ORACLE_HOME/rdbms/admin/apex_to_common.sql to remove the common objects
and create the metadata links for the packages, views and so forth.
To replace local objects with metadata links in the PDB:
1. Change your working directory to $ORACLE_HOME/rdbms/admin.
• On Windows:

$ sqlplus /nolog
3. Set the container to the PDB to be configured:
ALTER SESSION SET CONTAINER = <PDB_name>;
4. Run apex_to_common.sql. For example:

@apex_to_common.sql
If the version of Application Express installed in the originating database is different

from what is installed in the root container of the target an error is raised when trying to
open the PDB.
See Also:
"Working with Incompatible Application Express Versions."
5.4.4 Scenario 4: Plug-in Non-CDB or PDB with No Application

Express
Plug-in a Non-CDB or PDB if the Application Express is not installed.
If you are plugging in a non-CDB, or copying or moving a PDB from another CDB, and
Application Express is not installed in the originating database or PDB then a warning
is raised in the alert log when opening the PDB in the target database.
In this scenario, the Application Express schema, such as APEX_210100 for Oracle
Application Express release 21.1, will not be present in the originating database or the
PDB being plugged in. In order to open the PDB without issue and be able to run
Application Express within the new PDB, you must install Application Express into the
originating database or PDB before attempting to plug in to the target database. You
should install the same version of Application Express into the originating database or
PDB as the version installed into the target database.
5-14
Chapter 5
5.4.5 Working with Incompatible Application Express Versions

Learn how to work with the incompatible versions of Application Express.
If the version of Application Express in the root container, CDB$ROOT, is not the same as the
Application Express version in the PDB then an error is raised every time the PDB is opened
preventing normal database operations within the PDB. The PDB can only be opened in
restricted mode by users with RESTRICTED SESSION privilege, until the versions are
compatible.
• Patching or Upgrading Application Express in the CDB
Learn how to patch or upgrade Application Express in the root container.
• Patching or Upgrading Application Express in a PDB
Learn how to patch or upgrade Application Express in a PDB.
5.4.5.1 Patching or Upgrading Application Express in the CDB

Learn how to patch or upgrade Application Express in the root container.
If the version of Application Express in the PDB is a later minor release version than the
version of Application Express in the root container (for example, the PDB contains
Application Express release 5.1.4 and the CDB contains Application Express release 5.1.3)
then you must patch the version of Application Express in the root container to be able to
open the PDB without error. If the major version of Application Express in the PDB is higher
than the version in the CDB (for example the PDB has Application Express release 19.2 and
the CDB has Application Express release 18.1) then you must upgrade the version of
Application Express in the CDB to be able to open the PDB without error.
To patch Application Express in the root container:
1. Download the appropriate patch from My Oracle Support.
2. Unzip and extract the installation files.
3. Change your working directory to where the installation files were extracted
• On Windows:

$ sqlplus /nolog
5. Run apxpatch_con.sql for example:
@apxpatch_con.sql
6. Follow the instructions outlined in the Patch Set Notes for updating the images directory.
5-15
Chapter 5
Tip:
To upgrade Application Express in the root container, see Reinstalling
Application Express into a CDB.
See Also:
"Installing Application Express into a CDB"
5.4.5.2 Patching or Upgrading Application Express in a PDB

Learn how to patch or upgrade Application Express in a PDB.
If the minor version of Application Express in the PDB is lower than the version of
Application Express in the root container (for example the PDB has Application
Express release 4.2.0 and the CDB has Application Express release 4.2.6) then it will
be necessary to patch the version of Application Express in the PDB. If the major
version of Application Express in the PDB is lower than the version in the root
container (for example, the PDB has Application Express release 4.2 and the CDB has
Application Express release 19.2) then the version of Application Express in the PDB
will need to be upgraded.
• Patching Application Express in a PDB
Learn how to patch Application Express in a PDB.
• Upgrading Application Express in a PDB
Learn how to upgrade Application Express in a PDB.
5.4.5.2.1 Patching Application Express in a PDB

Learn how to patch Application Express in a PDB.
To patch Application Express in a PDB:
1. Download the appropriate patch from My Oracle Support.
• On Windows:

$ sqlplus /nolog
5-16
Chapter 5
Plugging in a PDB When Application Express Is Not in the Root Container of the Target CDB
5. Run apxpatch.sql using catcon.pl like the following example:

host &OH_HOME/perl/bin/perl -I
&OH_HOME/rdbms/admin &OH_HOME/rdbms/admin/catcon.pl -b apxpatch -c '<PDB_name>'

apxpatch.sql
Where:
• &OH_HOME represents the full path to the Oracle home
• <PDB_name> is the name of the PDB you are patching
6. Follow the instructions outlined in the patch set notes for updating the images directory.
5.4.5.2.2 Upgrading Application Express in a PDB

Learn how to upgrade Application Express in a PDB.
To upgrade Application Express in a PDB:
• On Windows:

$ sqlplus /nolog
4. Run apexins_nocdb.sql or apxrtins_nocdb.sql using catcon.pl like the following
example:
host &OH_HOME/perl/bin/perl -I
&OH_HOME/rdbms/admin &OH_HOME/rdbms/admin/catcon.pl -b apexins -c '<PDB_name>'

apexins_nocdb.sql --pSYSAUX --pSYSAUX --pTEMP --p/i/ --p1,2,3
Where:
• &OH_HOME represents the full path to the Oracle home
• <PDB_name> is the name of the PDB you are patching
5. Follow the instructions outlined in the patch set notes for updating the images directory.
5.5 Plugging in a PDB When Application Express Is Not in the

Root Container of the Target CDB
The scenarios in this section describe when Application Express is not installed in the root
container, CDB$ROOT, by explicitly removing it as described in "Uninstalling Application
Express from a CDB".
5-17
Chapter 5
In such cases, you can optionally install a local Application Express into each PDB
independently. If Application Express is installed into a PDB it is considered to be
installed locally and has no metadata linked objects. There are multiple scenarios
related to where the database being plugged in originated from and how Application
Express was configured in the originating database.
• Scenario 1: Plug-in a Non-CDB with Application Express

• Scenario 2: Plug-in PDB with Common Application Express from Another CDB
• Scenario 3: Plug-in PDB with a Local Application Express from Another CDB
Plug-in a PDB with local Application Express from another CDB.
• Scenario 4: Plug-in a Non-CDB or PDB with No Application Express
Plug-in a Non-CDB or PDB if Application Express is not installed.
See Also:
"Uninstalling Application Express from a CDB."
5.5.1 Scenario 1: Plug-in a Non-CDB with Application Express

If you are upgrading from a previous Oracle Database release then you need to
upgrade to Oracle Database 12c or later non-CDB (or standalone database) and then
plug the database into your CDB. Alternatively you may have configured a non-CDB
Oracle Database 12c or later that you now want to plug into a CDB. In both cases, the
originating database had Application Express installed and was not formerly a PDB.
As described in the Oracle Database Installation Guide for your operating system,
when plugging in a standalone database you need to run the $ORACLE_HOME/rdbms/
admin/noncdb_to_pdb.sql script. This script creates the necessary metadata linked
objects (instead of local objects) and recompiles the database objects for all common
database options. However, because Application Express has been removed from the
root container, the script will not create any metadata links for any of the Application
Express objects. The script does not change the Application Express installation from
the originating database and no additional steps are needed other than configuring the
Web listener depending on the type of Web listener you are using.
See Also:
"Installing and Configuring Application Express and Oracle REST Data
Services"
5-18
Chapter 5
5.5.2 Scenario 2: Plug-in PDB with Common Application Express from

Another CDB
If you are copying or moving a PDB from an existing Oracle Database 12c where the
originating CDB had Application Express installed in the root container, then an error is raised
whenever you try to open the PDB. The error is due to the originating PDB included metadata
links to objects in the originating root container which cannot be recompiled because the
target root container does not include Application Express. You will not be able to open the
PDB unless you remove Application Express from the PDB or if Application Express is
already installed in the target root container. Oracle does not support installing Application
Express in the root container if it contains PDBs with locally installed Application Express.
5.5.3 Scenario 3: Plug-in PDB with a Local Application Express from

Another CDB
Plug-in a PDB with local Application Express from another CDB.
If you are copying or moving a PDB from an existing Oracle Database 12c or later where the
originating PDB had a local Application Express installed (not in the CDB) then you do not
need to perform any additional steps, other than configuring the Web listener in the PDB
depending on the type of Web listener you are using.
APEX_210100 schema within the PDB being plugged in, already has all of the Application
Express objects defined locally and no metadata links.
See Also:
5.5.4 Scenario 4: Plug-in a Non-CDB or PDB with No Application Express

Plug-in a Non-CDB or PDB if Application Express is not installed.
If you are plugging in a non-CDB, or copying or moving a PDB from another CDB, where
Application Express was not installed in the originating database or PDB then you do not
need to perform any additional steps. There will be no Application Express engine schema,
such as APEX_210100, within the PDB, and the PDB can be started without error.
5-19
6
Installing and Configuring Application Express
and Oracle REST Data Services
Install or upgrade Oracle Application Express by downloading a ZIP file from the Oracle
Application Express download page and then downloading and installing Oracle REST Data
Services (ORDS). These instructions apply to both new and upgrade installations.
• Performing Pre-installation Tasks for Oracle Application Express

Review and perform pre-installation tasks before installing Oracle Application Express.
• Downloading and Installing Oracle Application Express
Learn about downloading and installing Oracle Application Express.
• Downloading and Installing Oracle REST Data Services
Learn about downloading and installing Oracle REST Data Services.
• Configuring Oracle REST Data Services
Configuring Oracle REST Data Services requires that you copy the images directory, run
a configuration to configure RESTful Services, configure static files support, and secure
Oracle REST data service.
• Enabling Network Services in Oracle Database 11g or Later
You must enable network services in Oracle Database 11g or later versions to send
outbound mail, use Web services, or use PDF report printing in Oracle Application
Express.
• Performing Security Tasks
Oracle recommends configuring and using Secure Sockets Layer (SSL) to ensure that
passwords and other sensitive data are not transmitted in clear text in HTTP requests.
• Controlling the Number of Concurrent Jobs
Learn about specifying the number of concurrently running jobs.
• About Running Oracle Application Express in Other Languages
You can install a single instance of Oracle Application Express with one or more of
translated versions.
• Installing Translated Versions of Oracle Application Express
Learn about installing translated versions of Oracle Application Express.
• Creating a Workspace and Adding Oracle Application Express Users
Before you can develop or install applications, you must create a workspace, add Oracle
Application Express users, and sign in to your workspace.
• Performing Post Installation Tasks for Upgrade Installations
Once you have verified that your upgrade installation was successful and all upgraded
applications function properly, you should remove schemas from prior Oracle Application
Express installations.
• About Performance Optimization Tasks
Learn about performance optimization.
• Converting Between Runtime and Full Development Environments
Learn about converting between runtime and full development environments.
6-1
Chapter 6
Performing Pre-installation Tasks for Oracle Application Express
See Also:
"Web Listener Requirements"
6.1 Performing Pre-installation Tasks for Oracle Application

Express
Review and perform pre-installation tasks before installing Oracle Application Express.
Before installing Oracle Application Express, Oracle recommends that you complete
the following steps:
1. Review and satisfy all Oracle Application Express installation requirements.
2. If you are actively using Oracle Application Express and upgrading the current
installation, then shut down with normal or immediate priority the Oracle Database
instances where you plan to install Oracle Application Express. On Oracle Real
Application Clusters (Oracle RAC) systems, shut down all instances on each node.
An alternative to shutting down the database, you can prevent all users from
accessing Oracle Application Express when upgrading your installation from a
previous release of Oracle Application Express. Oracle only recommends this
option in high availability production environments where planned outages are not
available. For all other scenarios, the database should be shut down.
To disable access to Oracle Application Express when an existing installation is
using Oracle REST Data Services, shut down the appropriate application server
where Oracle REST Data Services is deployed.
Once you have prevented access from Oracle Application Express users, you
should log in to SQL*Plus as SYS, connecting to the database where Oracle
Application Express is installed, and query V$SESSION to ensure there are no long
running sessions which would interfere with the upgrade process.
3. Back up the Oracle Database installation.
Oracle recommends that you create a backup of the current Oracle Database
installation before you install Oracle Application Express. You can use Oracle
Database Recovery Manager, which is included in the Oracle Database
installation, to perform the backup.
4. Start the Oracle Database instance that contains the target database.
After backing up the system, you must start the Oracle instance that contains the
target Oracle Database. Do not start other processes such as a Web listener.
However, if you are performing a remote installation, make sure the Web listener
for the remote database has started.
Note:
If you are connecting to a remote database, then start the Web listener.
6-2
Chapter 6
Downloading and Installing Oracle Application Express
See Also:
• " Oracle Application Express Installation Requirements "

• "Oracle Database Backup and Recovery User’s Guide"
6.2 Downloading and Installing Oracle Application Express

Learn about downloading and installing Oracle Application Express.
How you install Oracle Application Express depends upon by the type of database you into
which you are installing. This section describes how to download and install Oracle
• Installing Application Express

Install Oracle Application Express by downloading a ZIP file from the Oracle Application
Express download page.
• Creating or Updating Your Instance Administration Account
Learn how to create or update Instance Administrator account.
• Restarting Processes
Restart the processes that you stopped before you began the installation.
• Configuring the APEX_PUBLIC_USER Account
It is important to correctly configure the APEX_PUBLIC_USER account to enable proper
operation of Oracle Application Express.
• Configuring RESTful Services
In a new installation of Oracle Application Express, you must run the configuration script
apex_rest_config.sql to configure RESTful Services.
See Also:
"Utilizing the Multitenant Architecture in Oracle Database 12c or Later."
6.2.1 Installing Application Express

Install Oracle Application Express by downloading a ZIP file from the Oracle Application
Express download page.
To install Oracle Application Express:
1. For installations where the development will be in English only, download the file
apex_21.1_en.zip from the Oracle Application Express download page. If the
development will include languages other than English, download apex_21.1.zip from
the Oracle Application Express download page. See:
https://www.oracle.com/tools/downloads/apex-downloads.html
Note that the actual file name may differ if a more recent release has shipped since this
document was published.
6-3
Chapter 6
2. Unzip downloaded zip file:

• If English only, unzip apex_21.1_en.zip as follows, preserving directory
names:
– UNIX and Linux: $ unzip apex_21.1_en.zip
– Windows: Double click the file apex_21.1_en.zip in Windows Explorer
• If multiple languages, unzip apex_21.1.zip as follows, preserving directory
names:
– UNIX and Linux: $ unzip apex_21.1.zip
– Windows: Double click the file apex_21.1.zip in Windows Explorer
Note:
You should keep the directory tree where you unzip the files short and
not under directories that contain spaces. For example, within Windows
unzip to C:\TEMP.
3. Change your working directory to apex.

4. Start SQL*Plus and connect to the database where Oracle Application Express is
• On Windows:
$ sqlplus /nolog
5. Disable any existing password complexity rules for the default profile.
• Full development environment. Run apexins.sql passing the following four
@apexins.sql tablespace_apex tablespace_files tablespace_temp images
Where:
– tablespace_files is the name of the tablespace for the Oracle
Application Express files user.
6-4
Chapter 6

– images is the virtual directory for Oracle Application Express images. For
installations using EPG, /i/ is the required value for the images argument. To
support future Oracle Application Express upgrades, define the virtual image
directory as /i/.
Example:
Note:
If you receive the following error, exit SQL*Plus and change your working
directory to where you unzipped the installation file, for example C:\TEMP in
Windows, before starting SQL*Plus:
SP2-0310: unable to open file "apexins.sql"
• Runtime environment. Run apxrtins.sql passing the following arguments in the

order shown:
Where:
– tablespace_files is the name of the tablespace for the Oracle Application
Express files user.
– images is the virtual directory for Oracle Application Express images. To support
future Oracle Application Express upgrades, define the virtual image directory
as /i/.
Example:
If you configured RESTful Web services, then these additional accounts will be created:
stored in Oracle Application Express.
Oracle Application Express.
If you are upgrading from a previous release, then FLOWS_FILES already exists and
APEX_PUBLIC_USER is created if it does not already exist.
6-5
Chapter 6
See Also:
• "Configuring Password Protection" in Oracle Database Security Guide

• "SQL*Plus User's Guide and Reference" for more information about
SQL*Plus
• Oracle Application Express must be installed from a writable directory on
the file system. See "Reviewing a Log of an Installation Session"
6.2.2 Creating or Updating Your Instance Administration Account

Learn how to create or update Instance Administrator account.
This section describes how to create or update your Instance Administrator account.
Tip:
Skip this section if you are upgrading from a previous release of Oracle
Application Express. In an upgrade scenario, the Instance Administrator
account and password is preserved and carried over from the prior release.
• What Is an Instance Administrator?

Instance administrators are superusers that are responsible for managing an
entire Oracle Application Express instance, including managing workspace
provisioning, configuring features and instance settings, and managing security.
• About apxchpwd.sql
Running the apxchpwd.sql script enables you to create or update your Instance
Administrator account.
• Running apxchpwd.sql
Run the apxchpwd.sql script to create and update your Instance Administrator
account.
6.2.2.1 What Is an Instance Administrator?

Instance administrators are superusers that are responsible for managing an entire
Oracle Application Express instance, including managing workspace provisioning,
configuring features and instance settings, and managing security.
To perform these tasks, an Instance administrator signs in to the Oracle Application
Express Administration Services application.
6-6
Chapter 6
See Also:
"Oracle Application Express Administration Services" in Oracle Application Express
Administration Guide
6.2.2.2 About apxchpwd.sql

Running the apxchpwd.sql script enables you to create or update your Instance Administrator
account.
You must run the apxchpwd.sql script in the following scenarios:
• New Oracle Application Express installations - Run apxchpwd.sql to create an

Instance Administrator account and password.
• Converting of a runtime environment to a development environment - Run
apxchpwd.sql to change the Instance Administrator account password.
• Changing Your Instance Administrator Password -Run apxchpwd.sql to change the
password for an existing Instance Administrator account.
• Unlocking Your Instance Administrator Account - Run apxchpwd.sql to unlock an
existing Instance Administrator account.
Tip:
You do not need to run apxchpwd.sql when upgrading from a previous release of
Oracle Application Express. In an upgrade scenario, the Instance Administrator
account password is preserved and carried over from the prior release.
6.2.2.3 Running apxchpwd.sql

Run the apxchpwd.sql script to create and update your Instance Administrator account.
To create or update your Instance Administrator account:

1. Change your working directory to the apex directory where you unzipped the installation
software.
• On Windows:
$ sqlplus /nolog
3. Run apxchpwd.sql. For example:
6-7
Chapter 6
@apxchpwd.sql
Follow the on-screen instructions. You will be prompted provide a username,

password, and email address. If the account username does not exist, it will be
created for you.
See Also:
SQL*Plus User's Guide and Reference for more information about SQL*Plus
6.2.3 Restarting Processes

Restart the processes that you stopped before you began the installation.
After you install Oracle Application Express, you must restart the processes that you
stopped before you began the installation.
6.2.4 Configuring the APEX_PUBLIC_USER Account

It is important to correctly configure the APEX_PUBLIC_USER account to enable proper
operation of Oracle Application Express.
• About the APEX_PUBLIC_USER Account
The APEX_PUBLIC_USER account is created with a random password in a new
installation of Oracle Application Express.
• Unlocking the APEX_PUBLIC_USER Account
Unlock the APEX_PUBLIC_USER account by running a SQL statement.
• Changing the Password for the APEX_PUBLIC_USER Account
Change the password for the APEX_PUBLIC_USER account by running a SQL
statement.
• About Password Expiration in Oracle Database 11g and Later
You can set PASSWORD_LIFE_TIME parameter to unlimited by altering
APEX_PUBLIC_USER to prevent password expiration. To do this create another
profile in which the PASSWORD_LIFE_TIME parameter is set to unlimited and alter the
APEX_PUBLIC_USER account and assign it to the new profile.
6.2.4.1 About the APEX_PUBLIC_USER Account

The APEX_PUBLIC_USER account is created with a random password in a new
You must change the password for this account before configuring the database
access descriptor (DAD) in a new installation.
6-8
Chapter 6
6.2.4.2 Unlocking the APEX_PUBLIC_USER Account

Unlock the APEX_PUBLIC_USER account by running a SQL statement.
Tip:
If you are upgrading from a prior release of Oracle Application Express, this step is
unnecessary.
To unlock the APEX_PUBLIC_USER account:
installed as SYS specifying the SYSDBA role. If Oracle Application Express is installed in
the CDB, ensure you connect to CDB$ROOT. For example:
• On Windows:
$ sqlplus /nolog
2. Run the following statement:
ALTER USER APEX_PUBLIC_USER ACCOUNT UNLOCK
6.2.4.3 Changing the Password for the APEX_PUBLIC_USER Account

Change the password for the APEX_PUBLIC_USER account by running a SQL statement.
Tip:
If you are upgrading from a prior release of Oracle Application Express, this step is
unnecessary.
To change the password for the APEX_PUBLIC_USER account:
installed as SYS specifying the SYSDBA role. If Oracle Application Express is installed in
the CDB, ensure you connect to CDB$ROOT. For example:
• On Windows:
6-9
Chapter 6
$ sqlplus /nolog
2. Run the following statement:
ALTER USER APEX_PUBLIC_USER IDENTIFIED BY new_password
Where new_password is the new password you are setting for APEX_PUBLIC_USER.
You will use this password when creating the DAD in the sections that follow.
6.2.4.4 About Password Expiration in Oracle Database 11g and Later

You can set PASSWORD_LIFE_TIME parameter to unlimited by altering
APEX_PUBLIC_USER to prevent password expiration. To do this create another profile in
which the PASSWORD_LIFE_TIME parameter is set to unlimited and alter the
APEX_PUBLIC_USER account and assign it to the new profile.
In the default profile in Oracle Database 11g or later, the parameter

PASSWORD_LIFE_TIME is set to 180. If you are using Oracle Database 11g or later with
Oracle Application Express, this causes the password for APEX_PUBLIC_USER to expire
in 180 days. As a result, your Oracle Application Express instance will become
unusable until you change the password.
See Also:
Oracle Database Security Guide for information on creating profiles and
assigning them to database users
6.2.5 Configuring RESTful Services

In a new installation of Oracle Application Express, you must run the configuration
script apex_rest_config.sql to configure RESTful Services.
Once configured, the instance administrator can control the availability of the feature. If
the instance administrator has disabled RESTful Services for this Application Express
instance, RESTful Services are not available for this instance and the RESTful
Services icon does not display.
To configure RESTful Services in Oracle Application Express:
1. Change your working directory to the apex directory where you unzipped the
installation software.
• On Windows:
6-10
Chapter 6
Downloading and Installing Oracle REST Data Services
$ sqlplus /nolog
3. Run apex_rest_config.sql. For example:
@apex_rest_config.sql
When Prompted, enter a password for the APEX_LISTENER and APEX_REST_PUBLIC_USER

accounts.
When configuring RESTful Services in Oracle Application Express, it creates two new
database accounts.
• APEX_REST_PUBLIC_USER - The account used when calling RESTful Services
definitions stored in Oracle Application Express.
See Also:
"Enabling RESTful Services for an Instance" in Oracle Application Express
6.3 Downloading and Installing Oracle REST Data Services

Learn about downloading and installing Oracle REST Data Services.
• Downloading Oracle REST Data Services

Learn how to download Oracle REST Data Services.
• About Configuring Oracle REST Data Services Behind a Reverse Proxy or Load
Balancer
When Oracle Application Express is running behind a reverse proxy or load balancer, it is
important to communicate the original HTTP hostname and protocol as seen by the
user's browser to the Application Express engine.
• Web Server HTTP POST Request Limits
Learn about Web Server HTTP POST request limits.
See Also:
Oracle REST Data Services Installation, Configuration, and Development Guide
6-11
Chapter 6
Downloading and Installing Oracle REST Data Services
6.3.1 Downloading Oracle REST Data Services

Learn how to download Oracle REST Data Services.
Tip:
By default, the context root for accessing Oracle Application Express through
Oracle REST Data Services is /ords. If you wish to have a context root of /
apex for accessing Oracle Application Express, rename the ords.war file to
apex.war before installing Oracle REST Data Services. See "Installing
Oracle REST Data Services" in Oracle REST Data Services Installation,
Configuration, and Development Guide.
To download Oracle REST Data Services:

1. Download the latest release of Oracle REST Data services.
2. Unzip the downloaded zip file into a directory (or folder) of your choice:
• UNIX and Linux: unzip ords.version.number.zip
• Windows: Double-click the file ords.version.number.zip in Windows
Explorer
3. Copy the images directory, apex/images, from the Oracle Application Express
software ZIP to a location on the file system where Oracle REST Data Services is
installed.
4. See Oracle REST Data Services Installation, Configuration, and Development
Guide and follow and complete all installation and configuration steps.
5. For Oracle Database 12c or later multitenant architecture, ensure that you
configure the connection using the service name of the specific pluggable
database (PDB) you want to access. Do not use the service name of the CDB$ROOT
unless you are configuring Oracle REST Data Services to address PDBs through
the URL. See Oracle REST Data Services Installation, Configuration, and
Development Guide for more information.
6.3.2 About Configuring Oracle REST Data Services Behind a

Reverse Proxy or Load Balancer
When Oracle Application Express is running behind a reverse proxy or load balancer,
it is important to communicate the original HTTP hostname and protocol as seen by
the user's browser to the Application Express engine.
The Application Express engine uses this information to generate valid URLs in HTML
responses and HTTP redirects that the user's browser can successfully follow. The
exact configuration steps depend on your Java EE application server. For example, for
Oracle WebLogic Server, this is accomplished using Oracle WebLogic Server Proxy
Plug-Ins. To learn more, see your Java EE application server documentation.
6-12
Chapter 6
Configuring Oracle REST Data Services
6.3.3 Web Server HTTP POST Request Limits

Learn about Web Server HTTP POST request limits.
When running Oracle REST Data Services (ORDS) in standalone mode or within a Tomcat
Java Container, size limits are being imposed on POST requests which are not file uploads.
Application Express users will encounter these limits when uploading data in SQL Workshop
using Copy and Paste or when using Copy and Paste while building an Application from
Spreadsheet.
• When running Oracle REST Data Services in Standalone Mode, the default limit is 200
KB for ORDS 19.4.6 and earlier. It is recommended to increase the limit as follows:
Set the Java System property
org.eclipse.jetty.server.Request.maxFormContentSize to a higher value in bytes.
You can set this property upon startup of Oracle REST Data Services. For example: java
-Dorg.eclipse.jetty.server.Request.maxFormContentSize=3000000 -jar ords.war
• When running on Apache Tomcat, the default limit is 2 megabytes. Adjust Apache
Tomcat's maxPostSize parameter to change that limit.
See Also:
"http://tomcat.apache.org/" for more information.
6.4 Configuring Oracle REST Data Services

Configuring Oracle REST Data Services requires that you copy the images directory, run a
configuration to configure RESTful Services, configure static files support, and secure Oracle
REST data service.
How to configure RESTful Services in a new installation is discussed in the following section.
• Copying the Images Directory
Whether you are loading a new installation or upgrading from a previous release, you
must copy the images directory from the top level of the apex\images directory, for
example C:\TEMP, to the location used by your Oracle REST Data Services installation.
• Validating the Oracle REST Data Services Installation
In a new installation or upgrade of Oracle Application Express, you must validate the
Oracle REST Data Services installation.
• Configuring Static File Support
For configuring static files, you must run apex_rest_config.sql after a new installation
of Oracle Application Express.
• Securing Oracle REST Data Service
In a configuration for Oracle Application Express, Oracle recommends setting the
parameter security.requestValidationFunction to
wwv_flow_epg_include_modules.authorize.
6-13
Chapter 6
Configuring Oracle REST Data Services
6.4.1 Copying the Images Directory

Whether you are loading a new installation or upgrading from a previous release, you
must copy the images directory from the top level of the apex\images directory, for
example C:\TEMP, to the location used by your Oracle REST Data Services
installation.
During an upgrade, you overwrite your existing images directory. Before you begin the
upgrade, to ensure that you can revert to the previous version, Oracle recommends
that you create a copy of your existing images directory for Oracle Application
Express, indicating the release number of the images (for example, images_5_1).
See Also:
Oracle REST Data Services Installation, Configuration, and Development
Guide
6.4.2 Validating the Oracle REST Data Services Installation

In a new installation or upgrade of Oracle Application Express, you must validate the
Oracle REST Data Services installation.
For validating the Oracle REST Data Services installation in a new installation or
upgrade of Oracle Application Express, run the following :
java -jar ords.war validate [--database <dbname>]
See Also:
Guide
6.4.3 Configuring Static File Support

For configuring static files, you must run apex_rest_config.sql after a new
Oracle Application Express enables application developers to include static files with
their applications. Static files can be associated with a workspace, an application, a
plug-in, or an application theme. When using Oracle REST Data Services as your web
listener, static files are served using RESTful service module built into Oracle
Application Express. Therefore, you must run apex_rest_config.sql after a new
6-14
Chapter 6
Enabling Network Services in Oracle Database 11g or Later
See Also:
"Configuring Oracle REST Data Services"
6.4.4 Securing Oracle REST Data Service

In a configuration for Oracle Application Express, Oracle recommends setting the parameter
security.requestValidationFunction to wwv_flow_epg_include_modules.authorize.
Set parameter security.requestValidationFunction to

wwv_flow_epg_include_modules.authorize activates the white list of callable procedures
which ships with Oracle Application Express and prohibits calls to other procedures.
See Also:
Oracle Application Express App Builder User’s Guide
6.5 Enabling Network Services in Oracle Database 11g or Later

You must enable network services in Oracle Database 11g or later versions to send outbound
mail, use Web services, or use PDF report printing in Oracle Application Express.
• When and Why Network Services Must be Enabled
Enabling network services enables support for sending outbound mail in Oracle
Application Express, use of Web services in Application Express, and PDF report printing
with BI Publisher.
• Granting Connect Privileges Prior to Oracle Database 12c
Demonstrates how to grant connect privileges to any host for the APEX_210100 database
user.
• Granting Connect Privileges in Oracle Database 12c or Later
Procedures CREATE_ACL, ASSIGN_ACL, ADD_PRIVILEGE and CHECK_PRIVILEGE in
DBMS_NETWORK_ACL_ADMIN are deprecated in Oracle Database 12c. Oracle recommends
to use APPEND_HOST_ACE.
• Troubleshooting an Invalid ACL Error
Learn how to identify any invalid ACL error by running the query.
6.5.1 When and Why Network Services Must be Enabled

Enabling network services enables support for sending outbound mail in Oracle Application
Express, use of Web services in Application Express, and PDF report printing with BI
Publisher.
By default, the ability to interact with network services is disabled in Oracle Database 11g
Release 2 or later. Therefore, if you are running Application Express with Oracle Database
11g Release 2 or later, you must use the new DBMS_NETWORK_ACL_ADMIN package to grant
connect privileges to any host for the APEX_210100 database user. Failing to grant these
privileges results in issues with:
6-15
Chapter 6
• Sending outbound mail in Application Express.

Users can call methods from the APEX_MAIL package, but issues arise when
sending outbound email.
• Consuming web services from Application Express.
• Making outbound LDAP calls from Application Express.
• PDF report printing with BI Publisher.
Note:
When upgrading Application Express on a database 12c or newer, based on
the configuration of the old Application Express version the upgrade
automatically configures Network Services.
Tip:
To run the examples described in this section, the compatible initialization
parameter of the database must be set to at least 11.1.0.0.0. By default an
11g or 12c database will already have the parameter set properly, but a
database upgraded to 11g or 12c from a prior version may not. For
information about changing database initialization parameters, see
Specifying the Database Compatibility Level in Oracle Multitenant
Administrator's Guide.
See Also:
About Report Printing in Oracle Application Express App Builder User’s
Guide.
6.5.2 Granting Connect Privileges Prior to Oracle Database 12c

Demonstrates how to grant connect privileges to any host for the APEX_210100
database user.
The following example demonstrates how to grant connect privileges to any host for
the APEX_210100 database user. This example assumes you connected to the
database where Oracle Application Express is installed as SYS specifying the SYSDBA
role.
DECLARE
ACL_PATH VARCHAR2(4000);
BEGIN
-- Look for the ACL currently assigned to '*' and give APEX_210100
-- the "connect" privilege if APEX_210100 does not have the privilege
yet.
6-16
Chapter 6
SELECT ACL INTO ACL_PATH FROM DBA_NETWORK_ACLS

WHERE HOST = '*' AND LOWER_PORT IS NULL AND UPPER_PORT IS NULL;
IF DBMS_NETWORK_ACL_ADMIN.CHECK_PRIVILEGE(ACL_PATH, 'APEX_210100',
'connect') IS NULL THEN
DBMS_NETWORK_ACL_ADMIN.ADD_PRIVILEGE(ACL_PATH,
'APEX_210100', TRUE, 'connect');
END IF;
EXCEPTION
-- When no ACL has been assigned to '*'.
WHEN NO_DATA_FOUND THEN
DBMS_NETWORK_ACL_ADMIN.CREATE_ACL('power_users.xml',
'ACL that lets power users to connect to everywhere',
DBMS_NETWORK_ACL_ADMIN.ASSIGN_ACL('power_users.xml','*');
END;
/
COMMIT;
The following example demonstrates how to provide less privileged access to local network
resources. This example enables access to servers on the local host only, such as email and
report servers.
DECLARE
ACL_PATH VARCHAR2(4000);
BEGIN
-- Look for the ACL currently assigned to 'localhost' and give APEX_210100
-- the "connect" privilege if APEX_210100 does not have the privilege yet.
SELECT ACL INTO ACL_PATH FROM DBA_NETWORK_ACLS
WHERE HOST = 'localhost' AND LOWER_PORT IS NULL AND UPPER_PORT IS NULL;
IF DBMS_NETWORK_ACL_ADMIN.CHECK_PRIVILEGE(ACL_PATH, 'APEX_210100',
'connect') IS NULL THEN
DBMS_NETWORK_ACL_ADMIN.ADD_PRIVILEGE(ACL_PATH,
END IF;
EXCEPTION
-- When no ACL has been assigned to 'localhost'.
WHEN NO_DATA_FOUND THEN
DBMS_NETWORK_ACL_ADMIN.CREATE_ACL('local-access-users.xml',
'ACL that lets users to connect to localhost',
DBMS_NETWORK_ACL_ADMIN.ASSIGN_ACL('local-access-users.xml','localhost');
END;
/
COMMIT;
6-17
Chapter 6
6.5.3 Granting Connect Privileges in Oracle Database 12c or Later

Procedures CREATE_ACL, ASSIGN_ACL, ADD_PRIVILEGE and CHECK_PRIVILEGE in
DBMS_NETWORK_ACL_ADMIN are deprecated in Oracle Database 12c. Oracle
recommends to use APPEND_HOST_ACE.
The following example demonstrates how to grant connect privileges to any host for
the APEX_210100 database user. This example assumes you connected to the
database where Oracle Application Express is installed as SYS specifying the SYSDBA
role.
BEGIN
DBMS_NETWORK_ACL_ADMIN.APPEND_HOST_ACE(
host => '*',
ace => xs$ace_type(privilege_list => xs$name_list('connect'),
principal_name => 'APEX_210100',
principal_type => xs_acl.ptype_db));
END;
/
The following example demonstrates how to provide less privileged access to local
network resources. This example enables access to servers on the local host only,
such as email and report servers.
BEGIN
DBMS_NETWORK_ACL_ADMIN.APPEND_HOST_ACE(
host => 'localhost',
ace => xs$ace_type(privilege_list => xs$name_list('connect'),
principal_name => 'APEX_210100',
principal_type => xs_acl.ptype_db));
END;
/
6.5.4 Troubleshooting an Invalid ACL Error

Learn how to identify any invalid ACL error by running the query.
If you receive an ORA-44416: Invalid ACL error after running the previous script, use
the following query to identify the invalid ACL:
REM Show the dangling references to dropped users in the ACL that is
assigned
REM to '*'.
SELECT ACL, PRINCIPAL

FROM DBA_NETWORK_ACLS NACL, XDS_ACE ACE
WHERE HOST = '*' AND LOWER_PORT IS NULL AND UPPER_PORT IS NULL AND
NACL.ACLID = ACE.ACLID AND
NOT EXISTS (SELECT NULL FROM ALL_USERS WHERE USERNAME =
PRINCIPAL);
6-18
Chapter 6
Performing Security Tasks
Next, run the following code to fix the ACL:
DECLARE
ACL_ID RAW(16);
CNT NUMBER;
BEGIN
-- Look for the object ID of the ACL currently assigned to '*'
SELECT ACLID INTO ACL_ID FROM DBA_NETWORK_ACLS
WHERE HOST = '*' AND LOWER_PORT IS NULL AND UPPER_PORT IS NULL;
-- If just some users referenced in the ACL are invalid, remove just those
-- users in the ACL. Otherwise, drop the ACL completely.
SELECT COUNT(PRINCIPAL) INTO CNT FROM XDS_ACE
WHERE ACLID = ACL_ID AND
EXISTS (SELECT NULL FROM ALL_USERS WHERE USERNAME = PRINCIPAL);
IF (CNT > 0) THEN
FOR R IN (SELECT PRINCIPAL FROM XDS_ACE

WHERE ACLID = ACL_ID AND
NOT EXISTS (SELECT NULL FROM ALL_USERS
WHERE USERNAME = PRINCIPAL)) LOOP
UPDATE XDB.XDB$ACL
SET OBJECT_VALUE =
DELETEXML(OBJECT_VALUE,
'/ACL/ACE[PRINCIPAL="'||R.PRINCIPAL||'"]')
WHERE OBJECT_ID = ACL_ID;
END LOOP;
ELSE
DELETE FROM XDB.XDB$ACL WHERE OBJECT_ID = ACL_ID;
END IF;
END;
/
REM commit the changes.
COMMIT;
Once the ACL has been fixed, you must run the first script in this section to apply the ACL to
the APEX_210100 user.
6.6 Performing Security Tasks

Oracle recommends configuring and using Secure Sockets Layer (SSL) to ensure that
passwords and other sensitive data are not transmitted in clear text in HTTP requests.
Without the use of SSL, passwords could potentially be exposed, compromising security.
SSL is an industry standard protocol that uses RSA public key cryptography in conjunction
with symmetric key cryptography to provide authentication, encryption, and data integrity.
6-19
Chapter 6
Controlling the Number of Concurrent Jobs
See Also:
"Configuring HTTP Protocol Attributes" in Oracle Application Express
6.7 Controlling the Number of Concurrent Jobs

Learn about specifying the number of concurrently running jobs.
• About Managing the Number of Concurrent Jobs
Learn about managing maximum number of concurrently running jobs.
• Viewing the Number of JOB_QUEUE_PROCESSES
You can view number of JOB_QUEUE_PROCESSES in three ways.
• Changing the Number of JOB_QUEUE_PROCESSES
You can change the number of JOB_QUEUE_PROCESSES by running a SQL statement
in SQL*Plus.
6.7.1 About Managing the Number of Concurrent Jobs

Learn about managing maximum number of concurrently running jobs.
JOB_QUEUE_PROCESSES determine the maximum number of concurrently running jobs.
In Oracle Application Express transactional support and SQL scripts require jobs. If
JOB_QUEUE_PROCESSES is not enabled and working properly, you cannot successfully
execute a script.
6.7.2 Viewing the Number of JOB_QUEUE_PROCESSES

You can view number of JOB_QUEUE_PROCESSES in three ways.
• Viewing JOB_QUEUE_PROCESSES in the Installation Log File

View JOB_QUEUE_PROCESSES in the installation log files.
• Viewing JOB_QUEUE_PROCESSES in Oracle Application Express
View the number of JOB_QUEUE_PROCESSES on the About Application Express page.
• Viewing JOB_QUEUE_PROCESSES from SQL*Plus
View the number of JOB_QUEUE_PROCESSES from SQL*Plus.
6.7.2.1 Viewing JOB_QUEUE_PROCESSES in the Installation Log File

View JOB_QUEUE_PROCESSES in the installation log files.
See Also:
"Reviewing a Log of an Installation Session"
6-20
Chapter 6
Controlling the Number of Concurrent Jobs
6.7.2.2 Viewing JOB_QUEUE_PROCESSES in Oracle Application Express

View the number of JOB_QUEUE_PROCESSES on the About Application Express page.
To view the About Application Express page:

1. Sign in to Oracle Application Express.
2. Locate the Help menu at the top of the page.
3. From the Help menu, select About.
The About Application Express page appears.
4. Scroll down and find JOB_QUEUE_PROCESSES at the bottom of the page.
See Also:
"Signing In to Your Workspace"
6.7.2.3 Viewing JOB_QUEUE_PROCESSES from SQL*Plus

View the number of JOB_QUEUE_PROCESSES from SQL*Plus.
1. To view the number of JOB_QUEUE_PROCESSES from SQL*Plus:

installed as SYS specifying the SYSDBA role:
• On Windows:

$ sqlplus /nolog
2. Run the appropriate SQL statement. For example:
SELECT VALUE FROM v$parameter WHERE NAME = 'job_queue_processes'
6.7.3 Changing the Number of JOB_QUEUE_PROCESSES

You can change the number of JOB_QUEUE_PROCESSES by running a SQL statement in
SQL*Plus.
To update the number of JOB_QUEUE_PROCESSES:
6-21
Chapter 6
About Running Oracle Application Express in Other Languages
• On Windows:

$ sqlplus /nolog
2. In SQL*Plus run the following SQL statement:
ALTER SYSTEM SET JOB_QUEUE_PROCESSES = <number>
For example, running the statement ALTER SYSTEM SET JOB_QUEUE_PROCESSES =

20 sets JOB_QUEUE_PROCESSES to 20.
6.8 About Running Oracle Application Express in Other

Languages
You can install a single instance of Oracle Application Express with one or more of
translated versions.
The Oracle Application Express interface is translated into German, Spanish, French,
Italian, Japanese, Korean, Brazilian Portuguese, Simplified Chinese, and Traditional
Chinese. A single instance of Oracle Application Express can be installed with one or
more of these translated versions. Developers can choose to run the Application
Express development environment in any of the installed languages by simply
selecting the language from the App Builder log in screen or home page.
In order to install other languages you must use the apex_21.1.zip file which contains
the extra files referenced below. If you previously downloaded apex_21.1_en.zip, then
you do not need to re-install Oracle Application Express. Simply download
apex_21.1.zip and unzip the file into the same directory where you unzipped
apex_21.1_en.zip.
The translated version of Oracle Application Express should be loaded into a database
that has a character set that supports the specific language. If you attempt to install a
translated version of Oracle Application Express into a database that does not support
the character encoding of the language, the installation may fail or the translated
Oracle Application Express instance may appear corrupt when run. The database
character set AL32UTF8 supports all the translated versions of Oracle Application
Express.
You can manually install translated versions of Oracle Application Express using
SQL*Plus. The installation files are encoded in AL32UTF8.
6-22
Chapter 6
Installing Translated Versions of Oracle Application Express
Note:
Regardless of the target database character set, to install a translated version of
Oracle Application Express, you must set the character set value of the NLS_LANG
environment variable to AL32UTF8 before starting SQL*Plus.
The following examples illustrate valid NLS_LANG settings for loading Oracle Application
Express translations:
American_America.AL32UTF8
Japanese_Japan.AL32UTF8
6.9 Installing Translated Versions of Oracle Application Express

Learn about installing translated versions of Oracle Application Express.
• About Installing Translated Versions of Oracle Application Express
You must run load_lang.sql script to run a translated version of Oracle Application
Express.
• Installing a Translated Version of Oracle Application Express
Learn how to install a translated version of Oracle Application Express.
6.9.1 About Installing Translated Versions of Oracle Application Express

You must run load_lang.sql script to run a translated version of Oracle Application Express.
Whether you are installing for the first time or upgrading from a previous release, you must
run the load_lang.sql script to run a translated version of Oracle Application Express.
The installation scripts are located in subdirectories identified by a language code in the
unzipped distribution apex/builder. For example, the German version is located in apex/
builder/de and the Japanese version is located in apex/builder/ja. Within each directory,
there is a language loading script identified by the language code (for example, load_de.sql
or load_ja.sql).
6.9.2 Installing a Translated Version of Oracle Application Express

Learn how to install a translated version of Oracle Application Express.
To install a translated version of Oracle Application Express:
1. Set the NLS_LANG environment variable, making sure that the character set is AL32UTF8.
For example:
• Bourne or Korn shell:
NLS_LANG=American_America.AL32UTF8
export NLS_LANG
6-23
Chapter 6
Creating a Workspace and Adding Oracle Application Express Users
• C shell:
setenv NLS_LANG American_America.AL32UTF8
• For Windows based systems:
set NLS_LANG=American_America.AL32UTF8
2. Navigate to the directory under apex/builder based on the language you need to
install. For example for German, navigate to apex/builder/de. Start SQL*Plus
and connect to the database where Oracle Application Express is installed as SYS
specifying the SYSDBA role. For example:
• On Windows:

$ sqlplus /nolog
3. Execute the following statement:
ALTER SESSION SET CURRENT_SCHEMA = APEX_210100;
4. Execute the appropriate language specific script. For example:
@load_lang.sql
Where lang is the specific language (for example, load_de.sql for German or
load_ja.sql for Japanese).
6.10 Creating a Workspace and Adding Oracle Application

Express Users
Before you can develop or install applications, you must create a workspace, add
Oracle Application Express users, and sign in to your workspace.
• About Workspaces and Users
A workspace enables multiple users to work within the same Oracle Application
Express installation while keeping their objects, data, and applications private.
• Signing In To Administration Services
Sign in to Oracle Application Express Administration Services using the Instance
administrator account and password created or reset during the installation
process.
6-24
Chapter 6
• Creating a Workspace Manually

Sign in to Oracle Application Express Administration Services to create workspace
manually.
• Creating Oracle Application Express Users
Create new users in Oracle Application Express Administration Services.
• Signing In to Your Workspace
Learn how to sign in to a workspace using the Oracle REST Data Services.
6.10.1 About Workspaces and Users

A workspace enables multiple users to work within the same Oracle Application Express
installation while keeping their objects, data, and applications private.
You access the Oracle Application Express home page by logging in to a workspace using a
JavaScript enabled Web browser.
Each workspace has a unique ID and name. An instance administrator can create a
workspace manually within Oracle Application Express Administration Services or have users
submit requests. Oracle Application Express Administration Services is a separate
application for managing an entire Oracle Application Express instance.
6.10.2 Signing In To Administration Services

Sign in to Oracle Application Express Administration Services using the Instance
administrator account and password created or reset during the installation process.
To manually create a workspace and user accounts, you sign in to a separate application for
managing an entire Oracle Application Express instance called Oracle Application Express
Administration Services.
To sign in to Oracle Application Express Administration Services:
1. In a Web browser, navigate to the Oracle Application Express Administration Services
application.
Tip:
By default, the context root for accessing Oracle Application Express through
Oracle REST Data Services is /ords. If you wish to have a context root of /
apex for accessing Oracle Application Express, rename the ords.war file to
apex.war before installing Oracle REST Data Services. See "Installing Oracle
REST Data Services" in Oracle REST Data Services Installation, Configuration,
and Development Guide.
By default, Oracle Application Express Administration Services installs to the following

location:
http://hostname:port/ords/apex_admin
Where:
• hostname is the name of the system where Oracle REST Data Services is installed.
6-25
Chapter 6
• port is the port number assigned when configuring Oracle REST Data
Services. In a default installation, this number is 8080. To learn more, see
Guide.
• ords is the service name defined when configuring Oracle REST Data
Services.
2. On the Sign In page:
a. Username - Enter the Instance administrator account username specified in
Creating or Updating Your Instance Administration Account.
b. Password - Enter your Instance administrator account password.
c. Click Sign In to Administration.
Oracle Application Express Administration Services appears.
• Username - Enter the Oracle Application Express administrator account
username you specified in Creating or Updating Your Instance Administration
Account.
• Password - Enter the Oracle Application Express administrator account
password.
• Click Sign In to Administration.
Note that, depending on your setup, you might be required to change your
password when you log in for the first time.
See Also:
• "Creating or Updating Your Instance Administration Account"

• "Oracle Application Express Administration Services" in Oracle
Application Express Administration Guide
6.10.3 Creating a Workspace Manually

Sign in to Oracle Application Express Administration Services to create workspace
manually.
To manually create a workspace you sign in to a separate application called Oracle
Application Express Administration Services. You sign in to Oracle Application Express
Administration Services using the ADMIN account and password created or reset during
the installation process.
To create an Oracle Application Express workspace manually:
1. Access Oracle Application Express Administration Services.
Oracle Application Express Administration Services appears. Next, create a
workspace.
2. Click Manage Workspaces.
3. Under Workspace Actions, click Create Workspace.
The Create Workspace Wizard appears.
6-26
Chapter 6
4. For Identify Workspace, enter the following:

a. Workspace Name - Enter a unique workspace name.
b. Workspace ID - Leave Workspace ID blank to have the new Workspace ID
automatically generated. A Workspace ID must be a positive integer greater than
100000.
c. Workspace Description - Enter a workspace description.
d. Click Next.
5. For Identify Schema, specify whether you are re-using an existing schema or creating a
new one.
If you are using an existing schema:
a. For Re-use existing schema, select Yes.
b. Select a schema from the list.
c. Click Next.
If you are creating a new schema:
a. For Re-use existing schema, select No.
b. Enter a schema name and password.
c. Specify a space quota.
d. Click Next.
6. For Identify Administrator, enter the Workspace administrator information and click Next.
7. Confirm your selections and click Create Workspace.
See Also:

• "Managing Existing Workspaces" in Oracle Application Express Administration
Guide
6.10.4 Creating Oracle Application Express Users

Create new users in Oracle Application Express Administration Services.
Create new users by signing into the Oracle Application Express Administration Services
application using your Instance administrator password.
To create an Oracle Application Express user account:
1. Sign into Oracle Application Express Administration Services.
2. Click Manage Workspaces.
3. Under Workspace Actions, click Manage Developers and Users.
The Manage Developers and Users page appears.
4. Click Create User.
6-27
Chapter 6
5. Under User Attributes, enter the appropriate information. Fields marked with an
asterisk are required.
Tip:
Most attributes in Oracle Application Express include field-level Help.
Attributes with field-level Help, have light gray icon that resembles a
question mark (?). To view field-level Help, click the Help icon.
6. Under Account Privileges:

a. Workspace - Select a workspace from the list.
b. Default Schema - Specify the default schema used for this user
When using workspaces that have more than one schema available, this
schema is the default. This setting does not control security, only the user's
preference.
c. User is an administrator - Specify if this user should have workspace
administrator privileges.
Administrators are given access to all components. Additionally, they can
manage user accounts, groups, and development services. Components may
not be available if they are switched off by Instance Administrators.
d. User is a developer - Specify if this user should have developer privileges.
Developers must have access to either App Builder, SQL Workshop, or both.
These components may not be available if they are switched off by the
Instance Administrator.
e. App Builder Access - Determines whether a developer has access to the
App Builder.
f. SQL Workshop Access - Determines whether a developer has access to the
SQL Workshop.
g. Team Development Access - Determines whether a developer has access to
the Team Development.
h. Set Account Availability - Select Locked to prevent the account from being
used. Select Unlocked to allow the account to be used.
If the user has exceeded the maximum log in failures allowed, specified in
Workspace Preferences, then their account will be locked automatically.
a. Workspace - Select a workspace in which to create the user.
b. Default Schema - Select the default schema for this user.
c. Accessible Schemas (null for all) - Enter a colon-delimited list of schemas
for which this developer has permissions when using the SQL Workshop.
The list of schemas you enter here restricts the user to a subset of the full set
of schemas provisioned for the workspace and determines what schema
names the user sees in SQL Workshop.
d. User is an administrator - Select Yes or No to specify if this user should
have workspace administrator privileges.
6-28
Chapter 6
Administrators are given access to all components. Additionally, they can manage
user accounts, groups, and development services. Components may not be available
if they are switched off by an Instance Administrator.
e. User is a developer - Select Yes or No to specify if this user should have developer
privileges.
Developers must have access to either the App Builder, SQL Workshop, or both.
Components may not be available if they are switched off by Instance Administrators.
f. App Builder Access - Determines whether a developer has access to App Builder
g. SQL Workshop Access - Determines whether a developer has access to the SQL
Workshop.
h. Team Development Access - Determines whether a user has access to the Team
Development.
i. Account Availability - Select Locked to prevent the account from being used.
Select Unlocked to allow the account to be used.
7. Under Password:
• Password - Enter a case sensitive password.
• Confirm Password - Enter the password again.
• Require Change of Password On First Use - Select No to allow the user to use the
same password until it expires. Select Yes to require the user to change the
password immediately when logging in the first time.
8. Click Create User or Create and Create Another.
See Also:
"Managing Users Across an Application Express Instance" in Oracle Application
6.10.5 Signing In to Your Workspace

Learn how to sign in to a workspace using the Oracle REST Data Services.
After you creaste a workspace and Application Express users, you can sign in to your
workspace using your credentials (that is, your workspace name, user name and password).
To sign in to your workspace:
1. In a Web browser, navigate to the Oracle Application Express Sign In page:
http://hostname:port/apex/
Where:
• hostname is the name of the system where Oracle REST Data Services is installed.
• port is the port number assigned when configuring Oracle REST Data Services. In a
default installation, this number is 8080. To learn more, see Oracle REST Data
Services Installation, Configuration, and Development Guide.
6-29
Chapter 6
Performing Post Installation Tasks for Upgrade Installations
• apex is the service name defined when configuring Oracle REST Data
Services.
The Sign In page appears.
2. On the Sign In page, enter:
• Workspace - Enter the name of your workspace.
• Username - Enter your user name.
• Password - Enter your case-sensitive password.
3. Click Sign In.
Note that, depending on your setup, you might be required to change your
password when you log in for the first time.
See Also:

• "Managing Requests" in Oracle Application Express Administration
Guide
6.11 Performing Post Installation Tasks for Upgrade

Installations
Once you have verified that your upgrade installation was successful and all upgraded
applications function properly, you should remove schemas from prior Oracle
Application Express installations.
• About Removing Prior Oracle Application Express Installations

Learn about removing schemas from a prior installation by verifying if a prior
installation exists.
• Verifying if a Prior Installation Exists
Run the SQL query to verify if a prior Oracle Application Express installation
exists.
• Removing Schemas and SYS Objects from Prior Installations
Start SQL*Plus and connect to database and execute a statement to remove
schemas and SYS objects.
• Removing Schemas from Prior Installations in a CDB
Use catcon.pl to remove schemas of prior installations in a CDB.
• Fixing Invalid ACL in Oracle Database 11g or Later
Learn how to fix an invalid ACL if you are running Oracle Database 11g or later.
6-30
Chapter 6
See Also:
6.11.1 About Removing Prior Oracle Application Express Installations

Learn about removing schemas from a prior installation by verifying if a prior installation
exists.
The database users associated with schemas from prior installations are privileged users and
should be removed when they are no longer necessary. Removing schemas from a prior
installation is a two step process. First you verify if a prior installation exists and then you
remove the schemas.
6.11.2 Verifying if a Prior Installation Exists

Run the SQL query to verify if a prior Oracle Application Express installation exists.
To verify if a prior installation exists:
installed as SYS. For example:
• On Windows:

$ sqlplus /nolog
2. Run the following query:
SELECT username
FROM dba_users
WHERE ( username LIKE 'FLOWS\_______' ESCAPE '\'
OR username LIKE 'APEX\_______' ESCAPE '\' )
AND username NOT IN ( SELECT schema
FROM dba_registry
WHERE comp_id = 'APEX' );
If the results contain entries in the form FLOWS_XXXXXX or APEX_XXXXXX where XXXXXX
represents six numbers, those entries are candidates for removal.
6-31
Chapter 6
6.11.3 Removing Schemas and SYS Objects from Prior Installations

Start SQL*Plus and connect to database and execute a statement to remove schemas
and SYS objects.
To remove schemas and SYS objects from prior installations:
• On Windows:

$ sqlplus /nolog
2. Execute statements similar to the following example:
DROP USER APEX_200200 CASCADE;

DROP PACKAGE SYS.WWV_DBMS_SQL_APEX_200200;
6.11.4 Removing Schemas from Prior Installations in a CDB

Use catcon.pl to remove schemas of prior installations in a CDB.
To remove schemas and SYS objects from prior installations, run commands using the
following example:
$ORACLE_HOME/perl/bin/perl -I $ORACLE_HOME/rdbms/admin $ORACLE_HOME/

rdbms/admin/catcon.pl -b drop_apex190100 -- --x'drop user APEX_190100
cascade'
$ORACLE_HOME/perl/bin/perl -I $ORACLE_HOME/rdbms/admin $ORACLE_HOME/
rdbms/admin/catcon.pl -b drop_wwv_dbms_sql -- --x'drop package
SYS.WWV_DBMS_SQL_APEX_190100'
6.11.5 Fixing Invalid ACL in Oracle Database 11g or Later

Learn how to fix an invalid ACL if you are running Oracle Database 11g or later.
After following the instructions in"About Removing Prior Oracle Application Express
Installations," you may need to fix an invalid ACL if you are running Oracle Database
11g or later and you enabled network services for the prior Oracle Application Express
schema.
To fix an invalid ACL:
6-32
Chapter 6
About Performance Optimization Tasks
software.
• On Windows:

$ sqlplus /nolog
3. Execute a statement similar to the following:
EXEC DBMS_NETWORK_ACL_ADMIN.DELETE_PRIVILEGE('power_users.xml',
'APEX_040200');
6.12 About Performance Optimization Tasks

Learn about performance optimization.
Performance of web applications heavily depends on their size and how often a browser has
to request static content like images, CSS and JavaScript files. To improve performance,
most web servers support on-the-fly HTTP response compression and provide settings that
enable you to configure on how long browsers can cache a file before requesting it again.
The HTTP response compression is usually implemented using gzip encoding, while browser
file caching is enabled by issuing Cache-Control HTTP response header.
Please see your web server documentation to learn how to enable response compression
and browser file caching. For optimal performance of the Oracle Application Express
development environment and Oracle Application Express applications, Oracle recommends
enabling gzip compression of files in the virtual images directory (for example, /i/) and
responses from the database access descriptor as well as allowing browsers to cache files
from the virtual images directory for at least 12 hours.
6.13 Converting Between Runtime and Full Development

Environments
Learn about converting between runtime and full development environments.
This section describes how to convert between runtime and full development environments.
• About Runtime and Full Development Environments
An Oracle Application Express runtime environment enables users to run a production
application without supporting the ability to change or edit the application.
6-33
Chapter 6
Converting Between Runtime and Full Development Environments
• Converting a Runtime Environment to a Full Development Environment

Start SQL*Plus and connect to the database where Oracle Application Express is
installed as SYS specifying the SYSDBA role and run the apxdvins.sql.
• Converting a Full Development Environment to a Runtime Environment
installed as SYS specifying the SYSDBA role and run the apxdevrm.sql.
6.13.1 About Runtime and Full Development Environments

An Oracle Application Express runtime environment enables users to run a production
application without supporting the ability to change or edit the application.
A runtime environment includes only the packages necessary to run your applications,
making it a more hardened environment. It does not provide a web interface for
administration.
You administer an Oracle Application Express runtime environment using SQL*Plus or
SQL Developer and the APEX_INSTANCE_ADMIN API.
See Also:

• "Installing Exported Applications into a Runtime Environment" in Oracle
Application Express Administration Guide
6.13.2 Converting a Runtime Environment to a Full Development

Environment
installed as SYS specifying the SYSDBA role and run the apxdvins.sql.
To convert an Oracle Application Express runtime environment to a full development

environment:
1. Change your working directory to the apex directory where you unzipped the
installation software.
• On Windows:

6-34
Chapter 6
$ sqlplus /nolog
3. Run apxdvins.sql. For example:
@apxdvins.sql
4. Follow the instructions in Creating or Updating Your Instance Administration Account.
See Also:
• "Creating or Updating Your Instance Administration Account"

• SQL*Plus User's Guide and Reference for more information about SQL*Plus
6.13.3 Converting a Full Development Environment to a Runtime

Environment
Start SQL*Plus and connect to the database where Oracle Application Express is installed as
SYS specifying the SYSDBA role and run the apxdevrm.sql.
To convert an Oracle Application Express full development environment to a runtime

environment:
software.
• On Windows:

$ sqlplus /nolog
3. Run apxdevrm.sql. For example:
@apxdevrm.sql
6-35
Chapter 6
See Also:
SQL*Plus User's Guide and Reference for more information about SQL*Plus
6-36
A
Automating the Oracle Application Express
Installation Process
Automate the process of installing and configuring an Oracle Application Express instance.
• About apxsilentins.sql
Run the apxsilentins.sql script to automate the installation and configuration of an
Oracle Application Expresss instance.
• Running apxsilentins.sql
Run the apxsilentins.sql script.
A.1 About apxsilentins.sql

Run the apxsilentins.sql script to automate the installation and configuration of an Oracle
Application Expresss instance.
Traditionally you run the run the apexins.sql script to install Oracle Application Express and
then perform a multiple other steps to configure the APEX_PUBLIC_USER account. The
apxsilentins.sql script simplifies the installation and configuation process.
apxsilentins.sql accepts additional parameters so that passwords can be passed for
following database users associated with the Oracle Application Express schema:
APEX_PUBLIC_USER, APEX_LISTENER, APEX_REST_PUBLIC_USER and the Oracle Application
Express Instance Administration user, ADMIN. You can also use these passwords for the
configuration of middle tiers and other processes. apxsilentins.sql also completes other
installation steps such as creating and setting the password for the Instance Administration
user, ADMIN, configuring a network ACL, and configuring Oracle REST Data Services.
Running the apxsilentins.sql script, removes the need for completing the following topics:
• Installing Application Express
• Creating or Updating Your Instance Administration Account
• Configuring the APEX_PUBLIC_USER Account
• Enabling Network Services in Oracle Database 11g or Later
• Configuring Static File Support (apex_rest_config.sql)
A.2 Running apxsilentins.sql

Run the apxsilentins.sql script.
1. To run apxsilentins.sql:
2. Start SQL*Plus and connect as user SYS to the database where Oracle Application
Express is installed. You will need to specify the SYSDBA role. For example:
• On Windows:
A-1
Appendix A
Running apxsilentins.sql

$ sqlplus /nolog
3. Disable any existing password complexity rules for the default profile.
4. Run apxsilentins.sql passing the following eight arguments in the order shown:
@apxsilentins.sql tablespace_apex tablespace_files tablespace_temp images
password_apex_pub_user password_apex_listener
password_apex_rest_pub_user
password_internal_admin
Where:
• tablespace_apex is the name of the tablespace for the Oracle Application
• tablespace_files is the name of the tablespace for the Oracle Application
Express files user.
• tablespace_temp is the name of the temporary tablespace or tablespace
group.
• images is the virtual directory for Oracle Application Express images. For
installations using EPG, /i/ is the required value for the images argument. To
directory as /i/.
• password_apex_pub_user is the password for the APEX_PUBLIC_USER database
account.
• password_apex_listener is the password for the APEX_LISTENER database
account.
• password_apex_rest_pub_user is the password for the
APEX_REST_PUBLIC_USER database account.
• password_internal_admin is the password for the Instance Administration
ADMIN Application Express account. This password must meet the following
requirements:
– Contain at least 6 characters.
– Contain at least one numeric character (0123456789).
– Contain at least one punctuation character (!"#$%&()``*+,-/:;?_).
– Contain at least one uppercase alphabetic character.
For example:
@apxsilentins.sql SYSAUX SYSAUX TEMP /i/ Passw0rd!1 Passw0rd!2 Passw0rd!3
Passw0rd!4
Once apxsilentins.sql completes, you complete the steps in "Downloading and

Installing Oracle REST Services" and "Configuring Oracle REST Data Services"
(except for "Configuring Static File Support.")
A-2
Appendix A
Running apxsilentins.sql
Use the passwords you supplied to apxsilentins.sql when completing these steps. Then,
move on to "Creating a Workspace and Adding Oracle Application Express Users."
See Also:
• "Downloading and Installing Oracle REST Data Services"

• "Configuring Oracle REST Data Services"
• "Creating a Workspace and Adding Oracle Application Express Users"
A-3
B
Maximizing Uptime During an Application
Express Upgrade
Learn how to maximize uptime during an Application Express upgrade.
Previously, Oracle Application Express could only be upgraded by completely disabling
application usage for an extended length of time. The following is an overview of the
additional steps you can take to keep your applications usable for end users during most
portions of an Oracle Application Express upgrade.
This advanced procedure is an alternative to the following the topics in "Downloading and
Installing Oracle Application Express."
To upgrade the instance, administrators typically run these phases in one step by executing
one of the following:
• For full development environment:
• For runtime-only environment:
Where:
• tablespace_apex is the name of the tablespace for the Oracle Application Express
application user.
• tablespace_files is the name of the tablespace for the Oracle Application Express files
user.
• tablespace_temp is the name of the temporary tablespace or tablespace group.
• images is the virtual directory for Oracle Application Express images.
The upgrade of an Application Express instance runs in four phases:
1. Create database schemas and database objects (tables, packages).
2. Migrate application metadata.
3. Migrate data that runtime applications modify and switch to the new version.
4. Migrate additional log and summary data.
Phases 1 and 4 do not disable end users using the instance. Phase 2 only affects developers
who modify applications. Phase 3 affects all access to Application Express.
Oracle now also provides alternative upgrade scripts to run the phases independently.
Administrators can use these scripts instead of apexins.sql and apxrtins.sql, to reduce
the effective downtime of an Application Express instance from potentially hours to just a few
minutes (depending on hardware performance).
B-1
Appendix B
Note:
This feature is not supported when Application Express is installed in
CDB$ROOT.
Administrators must sequentially execute the following scripts to start phases 1, 2 and
3, respectively. At the end of phase 3, a scheduler job automatically starts to execute
phase 4.
To reduce downtime during an Oracle Application Express upgrade:
1. Execute phase 1 script: Development and runtime usage is not affected.
@apexins1.sql tablespace_apex tablespace_files tablespace_temp
images
@apxrtins1.sql tablespace_apex tablespace_files tablespace_temp
images
Example: @apexins1.sql sysaux sysaux temp /i/
2. Execute phase 2 script: Development is disabled, but runtime usage is not
affected.
images
images
3. Disable web access for the web listener, Oracle REST Data Services.
4. Execute phase 3 script: Application Express can not be used.
images
images
5. Install images of the new Application Express version in your web listener.
Administrators can do this while phase 3 is running or even earlier, if the new
version's images directory is different to the previous Application Express version's
( for example: /i51/ for the new version vs. /i50/ for the old version).
For details refer to the installation instructions for Oracle REST Data Services.
B-2
Appendix B
6. Re-enable web access for the web listener and restart Oracle REST Data Services.
After web access is restarted, developers and users can access the instance again, while
phase 4 finishes in the background.
See Also:
B-3
C
Troubleshooting
Learn about troubleshooting Oracle Application Express Installation.
This section contains information on troubleshooting.
• Reviewing a Log of an Installation Session

The apexins.sql script creates a log file in the apex directory using the naming
convention installYYYY-MM-DD_HH24-MI-SS.log.
• Verifying the Validity of an Oracle Application Express Installation
Verify the validity of an Oracle Application Express installation by running a query.
• Removing the Oracle Application Express Release 21.1 Schema from a CDB
Create text files, start SQL*Plus and connect to the database execute
@remove_apx211_usr.sql.
• Cleaning Up After a Failed Installation
Learn about best practices for troubleshooting and cleaning up after a failed installation.
• About Images Displaying Incorrectly in Oracle Application Express
Learn about troubleshooting if images in Oracle Application Express do not display
correctly.
• About Page Protection Violation
A page protection violation may be caused by manual alteration of protected page items.
See Also:
C.1 Reviewing a Log of an Installation Session

The apexins.sql script creates a log file in the apex directory using the naming convention
installYYYY-MM-DD_HH24-MI-SS.log.
In a successful installation, the log file contains the following text:

Thank you for installing Oracle Application Express.
Oracle Application Express is installed in the APEX_210100 schema.
If the log file contains a few errors, it does not mean that your installation failed. Note that
acceptable errors are noted as such in the log file.
C-1
Appendix C
Verifying the Validity of an Oracle Application Express Installation
C.2 Verifying the Validity of an Oracle Application Express

Installation
Verify the validity of an Oracle Application Express installation by running a query.
You can verify the validity of an Oracle Application Express installation by running the
following query:
SELECT STATUS FROM DBA_REGISTRY
WHERE COMP_ID = 'APEX';
If the result is VALID, you can assume the installation was successful.
C.3 Removing the Oracle Application Express Release 21.1

Schema from a CDB
To remove the release 21.1 schema from a CDB:

1. Create a new text file named remove_apx211_usr1.sql with the following contents:
alter session set current_schema = SYS;
drop user APEX_210100 cascade;
2. Create a second new text file named remove_apx211_usr.sql with the following
contents:
set define '^'
whenever sqlerror exit
column :xe_home new_value OH_HOME NOPRINT
variable xe_home varchar2(255)
set serverout on
begin
-- get oracle_home
sys.dbms_system.get_env('ORACLE_HOME',:xe_home);
if length(:xe_home) = 0 then
sys.dbms_output.put_line(lpad('-',80,'-'));
raise_application_error (
-20001,
'Oracle Home environment variable not set' );
end if;
end;
/
whenever sqlerror continue
set termout off

select :xe_home from sys.dual;
set termout on
host ÔH_HOME/perl/bin/perl -I ÔH_HOME/rdbms/admin ÔH_HOME/rdbms/admin/

catcon.pl -b remove_apx211_usr remove_apx211_usr1.sql
C-2
Appendix C
Cleaning Up After a Failed Installation
• On Windows:
SQL> SQL> CONNECT SYS as SYSDBA
$ sqlplus /nolog
4. Execute the following command:
@remove_apx211_usr.sql
Once you have removed the Oracle Application Express 21.1 schema, you can now
attempt the upgrade again.
C.4 Cleaning Up After a Failed Installation

Learn about best practices for troubleshooting and cleaning up after a failed installation.
In a successful installation the following banner displays near the end of the installation:
Thank you for installing Oracle Application Express.
Oracle Application Express is installed in the APEX_210100 schema.
To reinstall, you must either drop the Oracle Application Express database schemas, or run a
script to completely remove Application Express from the database, depending upon the
installation type.
• Reverting to a Previous Release After a Failed Upgrade Installation
Learn about reverting to Oracle Application Express to a previous release in the case of a
failed upgrade installation.
• Removing Oracle Application Express from the Database
installed as SYS specifying the SYSDBA role and execute the SQL> @apxremov.sql
command.
C.4.1 Reverting to a Previous Release After a Failed Upgrade Installation

Learn about reverting to Oracle Application Express to a previous release in the case of a
failed upgrade installation.
In the case of a failed upgrade installation, you may want to revert Oracle Application
Express to a previous release and then remove the schemas associated with the current
release.
• Verifying If You Have a Previous Release of Oracle Application Express
Run a query to verify if you have previous release of Oracle Application Express.
• Reverting the Images Directory
If you altered your images directory, revert it back to the release you want to revert to.
You must point the text alias /i/ back to images directory for the release you want to
revert to.
C-3
Appendix C
• Reverting to a Previous Release

Learn how to revert to a previous release Oracle Application Express.
• Removing the Oracle Application Express Release Schema
After you revert to the prior release, remove the Oracle Application Express
schema.
C.4.1.1 Verifying If You Have a Previous Release of Oracle Application Express

Run a query to verify if you have previous release of Oracle Application Express.
To verify whether you have a previous release of Oracle Application Express:
• On Windows:
$ sqlplus /nolog
2. Execute the following command in SQL*Plus:
select username from dba_users
where regexp_like(username,'(FLOWS|APEX)_\d{6}')
and username <> (select table_owner from all_synonyms
where synonym_name = 'WWV_FLOW'
and owner = 'PUBLIC')
If the query above returns any rows, the database contains a previous release of
C.4.1.2 Reverting the Images Directory

If you altered your images directory, revert it back to the release you want to revert to.
You must point the text alias /i/ back to images directory for the release you want to
revert to.
See Also:
"Copying the Images Directory"
C.4.1.3 Reverting to a Previous Release

Learn how to revert to a previous release Oracle Application Express.
• Reverting to Release 1.5
C-4
Appendix C

• Reverting to Release 4.2 in a non-CDB
• Reverting to Release 4.2 in a CDB
• Re-enabling the REST Administration Interface After Downgrading
C.4.1.3.1 Reverting to Release 1.5

To revert to a previous Oracle Application Express release 1.5:
1. If you altered your images directory, revert it back to the release you want to revert to.
• On Windows:
C-5
Appendix C
$ sqlplus /nolog
3. Execute the following:
ALTER SESSION SET CURRENT_SCHEMA = FLOWS_010500;
exec
flows_010500.wwv_flow_upgrade.switch_schemas('APEX_210100','FLOWS_010500');
4. See "Removing the Oracle Application Express Release Schema."
See Also:
• "Reverting the Images Directory"

• "Removing the Oracle Application Express Release Schema"

To revert to a Oracle Application Express release 1.6:
1. If you altered your images directory, revert it back to the release you want to revert
to.
• On Windows:
$ sqlplus /nolog
exec
4. Depending upon the release you are reverting to, execute the appropriate
command in SQL*Plus.
See Also:

C-6
Appendix C

• On Windows:
$ sqlplus /nolog
exec flows_020000.wwv_flow_upgrade.switch_schemas('APEX_210100','FLOWS_020000');
See Also:


• On Windows:
$ sqlplus /nolog
C-7
Appendix C
See Also:


to.
2. Change your working directory to apex in the 3.0 source.
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
set define '^'
@apexvalidate x x FLOWS_030000
exec
ALTER SESSION SET CURRENT_SCHEMA = SYS;
declare
l_apex_version varchar2(30);
begin
l_apex_version := flows_030000.wwv_flows_release;
dbms_registry.downgrading('APEX','Oracle Application
Express','validate_apex','FLOWS_030000');
dbms_registry.downgraded('APEX',l_apex_version);
validate_apex;
end;
/
5. See "Removing the Oracle Application Express Release 19.1 Schema."
C-8
Appendix C
See Also:


2. Change your working directory to apex/core in the 3.1 source.
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
4. Execute the following commands:
@wwv_flow_val.plb
@wwv_dbms_sql.sql
@wwv_dbms_sql.plb
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
set define '^'
@apexvalidate x x FLOWS_030100
declare
C-9
Appendix C
begin
l_apex_version := flows_030100.wwv_flows_release;
Express','validate_apex','FLOWS_030100');
validate_apex;
end;
/
See Also:


to.
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
@wwv_flow_val.plb
@wwv_dbms_sql.sql
@wwv_dbms_sql.plb
On Windows:
On UNIX and Linux:
C-10
Appendix C
$ sqlplus /nolog
set define '^'
@apexvalidate x x APEX_030200
exec apex_030200.wwv_flow_upgrade.switch_schemas('APEX_210100','APEX_030200');
declare
begin
l_apex_version := apex_030200.wwv_flows_release;
Express','validate_apex','APEX_030200')
validate_apex;
end;
/
See Also:


On Windows:
On UNIX and Linux:

$ sqlplus /nolog
@wwv_flow_val.sql
@wwv_flow_val.plb
@wwv_dbms_sql.sql
@wwv_dbms_sql.plb
C-11
Appendix C
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
set define '^'
exec
apex_040000.wwv_flow_upgrade.switch_schemas('APEX_210100','APEX_040000');
declare
begin
Express','validate_apex','APEX_040000');
validate_apex;
end;
/
See Also:


to.
On Windows:
C-12
Appendix C

On UNIX and Linux:

$ sqlplus /nolog
@wwv_flow_val.sql
@wwv_flow_val.plb
@wwv_dbms_sql.sql
@wwv_dbms_sql.plb
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
set define '^'
declare
begin
validate_apex;
end;
/
See Also:

C-13
Appendix C
C.4.1.3.10 Reverting to Release 4.2 in a non-CDB

To revert to a previous Oracle Application Express release 4.2 in a non-CDB:
to.
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
@core_sys_views.sql
grant select on sys.wwv_flow_gv$session to APEX_040200;
@wwv_flow_val.sql
@wwv_flow_val.plb
@wwv_dbms_sql.sql
grant execute on wwv_dbms_sql to APEX_040200;
@wwv_dbms_sql.plb
begin
dbms_utility.compile_schema('APEX_040200');
end;
/
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
set define '^'
C-14
Appendix C
declare
begin
validate_apex;
end;
/
See Also:

C.4.1.3.11 Reverting to Release 4.2 in a CDB

To revert to a previous Oracle Application Express release 4.2 in a CDB:
3. Create a new text file in that directory named apx42dgrd1.sql consisting of the following:
@core_sys_views.sql
grant select on sys.wwv_flow_gv$session to APEX_040200;
@wwv_flow_val.sql
@wwv_flow_val.plb
@wwv_dbms_sql.sql
grant execute on wwv_dbms_sql to APEX_040200;
@wwv_dbms_sql.plb
begin
end;
/
4. Create a second new text file in that directory named apx42dgrd.sql consisting of the
following:
set define '^'

C-15
Appendix C
set serverout on
begin
-- get oracle_home
-20001,
end if;
end;
/
set termout off

set termout on

catcon.pl -b apx42dgrd apx42dgrd1.sql
5. Start SQL*Plus and connect to CDB$ROOT of the database where Oracle Application
Express is installed as SYS specifying the SYSDBA role:
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
@apx42dgrd.sql
8. Create a new text file in that directory name apx42dgrd1.sql with the following
contents:
set define '^'

exec
declare
begin
validate_apex;
C-16
Appendix C
end;
/
following:
set define '^'

set serverout on
begin
-- get oracle_home
-20001,
end if;
end;
/
set termout off

set termout on
host ÔH_HOME/perl/bin/perl -I ÔH_HOME/rdbms/admin ÔH_HOME/rdbms/admin/catcon.pl

-b apx42dgrd apx42dgrd1.sql
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
@apx42dgrd.sql
See Also:

C-17
Appendix C

to.
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
@wwv_flow_val.sql
@wwv_flow_val.plb
begin
end;
/
set define '^'

@validate_apex x x APEX_050000
begin
for i in ( select owner, trigger_name
from sys.dba_triggers
where owner = 'APEX_050000'
and trigger_name like 'WWV_FLOW_UPGRADE_%'
order by 1 )
loop
sys.dbms_output.put_line('Dropping trigger '||i.owner||'.'||
i.trigger_name);
execute immediate 'drop trigger '||i.owner||'.'||i.trigger_name;
end loop;
end;
/

exec
drop context APEX$SESSION;
create context APEX$SESSION using APEX_050000.WWV_FLOW_SESSION_CONTEXT;
declare
l_schemas sys.dbms_registry.schema_list_t;
C-18
Appendix C
begin
select username
bulk collect into l_schemas
from all_users
where username in
('FLOWS_FILES','APEX_PUBLIC_USER','APEX_LISTENER','APEX_REST_PUBLIC_USER','APEX_INS
TANCE_ADMIN_USER')
order by 1;
sys.dbms_registry.update_schema_list('APEX', l_schemas);
validate_apex;
end;
/
See Also:


3. Create a new text file in that directory named apx50dgrd1.sql consisting of the following:
@wwv_flow_val.sql
@wwv_flow_val.plb
begin
end;
/
set define '^'

begin
order by 1 )
loop
sys.dbms_output.put_line('Dropping trigger '||i.owner||'.'||i.trigger_name);
end loop;
C-19
Appendix C
end;
/

exec
declare
begin
select username
from all_users
where username in
('FLOWS_FILES','APEX_PUBLIC_USER','APEX_LISTENER','APEX_REST_PUBLIC_USER','AP
EX_INSTANCE_ADMIN_USER')
order by 1;
validate_apex;
end;
/
4. Create a second new text file in that directory named apx50dgrd.sql consisting of
the following:
set define '^'
set serverout on
begin
-- get oracle_home
raise_application_error (-20001,'Oracle Home environment variable not
set' );
end if;
end;
/
set termout off
set termout on
On Windows:
C-20
Appendix C
On UNIX and Linux:

$ sqlplus /nolog
@apx50dgrd.sql
See Also:


On Windows:
On UNIX and Linux:

$ sqlplus /nolog
@wwv_flow_val.sql
@wwv_flow_val.plb
begin
end;
/
set define '^'

begin
C-21
Appendix C

order by 1 )
loop
sys.dbms_output.put_line('Dropping trigger '||i.owner||'.'||
i.trigger_name);
end loop;
end;
/

exec
declare
begin
select username
from all_users
where username in
order by 1;
validate_apex;
end;
/
5. See the next section, "Removing the Oracle Application Express Release 19.1
Schema."
See Also:


to.
3. Create a new text file in that directory named apx51dgrd1.sql consisting of the
following:
C-22
Appendix C
@wwv_flow_val.sql
@wwv_flow_val.plb
begin
end;
/
set define '^'

begin
order by 1 )
loop
sys.dbms_output.put_line('Dropping trigger '||i.owner||'.'||i.trigger_name);
end loop;
end;
/

declare
begin
select username
from all_users
where username in
TANCE_ADMIN_USER')
order by 1;
validate_apex;
end;
/
following:
set define '^'
set serverout on
begin
-- get oracle_home
C-23
Appendix C
set' );
end if;
end;
/
set termout off
set termout on
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
@apx51dgrd.sql
See Also:


to.
3. Create a new text file in that directory named apxdwngrd.sql consisting of the
following:
set define '^'

set concat on
set concat .
set verify off
C-24
Appendix C
set termout off

column foo new_val LOG
select 'apxdwngrd_' ||to_char(sysdate, 'YYYY-MM-DD_HH24-MI-SS') || '.log'
as foo
from sys.dual;
set termout on
spool ^LOG
@@core/scripts/set_appun.sql

set serveroutput on size unlimited
declare
l_cnt number := 0;
begin
select count(*) into l_cnt from sys.dba_users where username =
'ÂPPUN';
if l_cnt = 0 then
dbms_output.put_line('ÂPPUN not found in this database.');
raise program_error;
end if;
end;
/
prompt ...Create validate procedure in SYS schema and start registration

@@core/validate_apex.sql x x ÂPPUN
grant inherit any privileges to ÂPPUN;
prompt Installing SYS views
@@core/sys_core_views.sql
@@core/wwv_flow_val.sql
grant execute on sys.wwv_flow_val to ÂPPUN.;
@@core/wwv_flow_val.plb
ALTER SESSION SET CURRENT_SCHEMA = ÂPPUN;
exec sys.dbms_session.modify_package_state(sys.dbms_session.reinitialize);
begin
ÂPPUN..wwv_flow_upgrade.remove_jobs();
ÂPPUN..wwv_flow_upgrade.create_jobs('ÂPPUN');
ÂPPUN..wwv_flow_upgrade.create_public_synonyms('ÂPPUN');
ÂPPUN..wwv_flow_upgrade.grant_public_synonyms('ÂPPUN');
ÂPPUN..wwv_flow_upgrade.flows_files_objects_remove('ÂPPUN');
ÂPPUN..wwv_flow_upgrade.flows_files_objects_create('ÂPPUN');
end;
/
C-25
Appendix C

create context APEX$SESSION using ÂPPUN..WWV_FLOW_SESSION_CONTEXT;
alter package sys.wwv_dbms_sql_ÂPPUN. compile;

alter package sys.wwv_dbms_sql_ÂPPUN. compile body;
exec
sys.dbms_session.modify_package_state(sys.dbms_session.reinitialize)
;
declare
begin
execute immediate 'drop package ÂPPUN..WWV_FLOW_DB_VERSION';
l_apex_version := ÂPPUN..wwv_flows_release;
sys.dbms_registry.loading('APEX','Oracle Application
Express','validate_apex', 'ÂPPUN');
select username
from sys.all_users
where username in
('FLOWS_FILES','APEX_PUBLIC_USER','APEX_LISTENER','APEX_REST_PUBLIC_
USER','APEX_INSTANCE_ADMIN_USER')
order by 1;
sys.dbms_registry.loaded('APEX',l_apex_version);
commit;
sys.validate_apex;
end;
/
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
5. Run the apxdwngrd.sql script:
SQL> @apxdwngrd.sql
C-26
Appendix C
See Also:


3. Create a new text file in that directory named apxdwngrd.sql consisting of the following:
set define '^'
set concat on
set concat .
set verify off
set termout off

select 'apxdwngrd_' ||to_char(sysdate, 'YYYY-MM-DD_HH24-MI-SS') || '.log' as foo
from sys.dual;
set termout on
spool ^LOG

declare
l_cnt number := 0;
begin
select count(*) into l_cnt from sys.dba_users where username = 'ÂPPUN';
if l_cnt = 0 then
end if;
end;
/

C-27
Appendix C
begin
end;
/


declare
begin
select username
from sys.all_users
where username in
order by 1;
commit;
sys.validate_apex;
end;
/
4. Create a second new text file in that directory named apxdwngrd_cdb.sql
consisting of the following:
set define '^'
set serverout on
begin
-- get oracle_home
C-28
Appendix C
raise_application_error (-20001,'Oracle Home environment variable not set' );

end if;
end;
/
set termout off
set termout on
host ÔH_HOME/perl/bin/perl -I ÔH_HOME/rdbms/admin ÔH_HOME/rdbms/admin/catcon.pl
-b apx181dgrd apxdwngrd.sql
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
6. Run the apxdwngrd_cdb.sql script:
SQL> @apxdwngrd_cdb.sql
See Also:


3. Create a new text file in that directory named apxdwngrd.sql consisting of the following:
set define '^'

set concat on
set concat .
set verify off
set termout off

select 'apxdwngrd_' ||to_char(sysdate, 'YYYY-MM-DD_HH24-MI-SS') || '.log'
as foo
from sys.dual;
C-29
Appendix C
set termout on
spool ^LOG

declare
l_cnt number := 0;
begin
select count(*) into l_cnt from sys.dba_users where username =
'ÂPPUN';
if l_cnt = 0 then
end if;
end;
/
prompt ...Create validate procedure in SYS schema and start

registration
exec
sys.dbms_session.modify_package_state(sys.dbms_session.reinitialize)
;
begin
end;
/
C-30
Appendix C


declare
begin
select username
from sys.all_users
where username in
('FLOWS_FILES','APEX_PUBLIC_USER','APEX_LISTENER','APEX_REST_PUBLIC_USER',
'APEX_INSTANCE_ADMIN_USER')
order by 1;
commit;
sys.validate_apex;
end;
/
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
SQL> @apxdwngrd.sql
C-31
Appendix C
See Also:


to.
3. Create a new text file in that directory named apxdwngrd.sql consisting of the
following:
set define '^'
set concat on
set concat .
set verify off
set termout off

select 'apxdwngrd_' ||to_char(sysdate, 'YYYY-MM-DD_HH24-MI-SS') || '.log' as
foo
from sys.dual;
set termout on
spool ^LOG

declare
l_cnt number := 0;
begin
select count(*) into l_cnt from sys.dba_users where username = 'ÂPPUN';
if l_cnt = 0 then
end if;
end;
/

C-32
Appendix C
begin
end;
/


declare
begin
sys.dbms_registry.loading('APEX','Oracle Application Express','validate_apex',
'ÂPPUN');
select username
from sys.all_users
where username in
TANCE_ADMIN_USER')
order by 1;
commit;
sys.validate_apex;
end;
/
4. Create a second new text file in that directory named apxdwngrd_cdb.sql consisting of
the following:
set define '^'
set serverout on
begin
C-33
Appendix C
-- get oracle_home
set' );
end if;
end;
/
set termout off
set termout on
catcon.pl -b apx182dgrd apxdwngrd.sql
On Windows:
On UNIX and Linux:

$ sqlplus /nolog
See Also:


To revert to Oracle Application Express release 19.1 in a non-CDB:
to.
C-34
Appendix C
• On Windows:

$ sqlplus /nolog
SQL> @apxdwngrd.sql

To revert to Oracle Application Express release 19.1 in a CDB:
3. Create a script in the apex directory called apxdwngrd_cdb.sql with the following
contents:
set define '^'

set serverout on
begin
-- get oracle_home
set' );
end if;
end;
/
set termout off
set termout on
C-35
Appendix C
• On Windows:

$ sqlplus /nolog

to.
• On Windows:

$ sqlplus /nolog
SQL> @apxdwngrd.sql

to.
C-36
Appendix C
contents:
set define '^'

set serverout on
begin
-- get oracle_home
set' );
end if;
end;
/
set termout off
set termout on
• On Windows:

$ sqlplus /nolog

C-37
Appendix C
• On Windows:

$ sqlplus /nolog
SQL> @apxdwngrd.sql

to.
contents:
set define '^'

set serverout on
begin
-- get oracle_home
raise_application_error (-20001,'Oracle Home environment
variable not set' );
end if;
end;
/
set termout off
set termout on
host ÔH_HOME/perl/bin/perl -I ÔH_HOME/rdbms/admin ÔH_HOME/rdbms/
admin/catcon.pl -b apx201dgrd apxdwngrd.sql
C-38
Appendix C
• On Windows:

$ sqlplus /nolog

• On Windows:

$ sqlplus /nolog
SQL> @apxdwngrd.sql

contents:
set define '^'

C-39
Appendix C

set serverout on
begin
-- get oracle_home
raise_application_error (-20001,'Oracle Home environment
variable not set' );
end if;
end;
/
set termout off
set termout on
host ÔH_HOME/perl/bin/perl -I ÔH_HOME/rdbms/admin ÔH_HOME/rdbms/
admin/catcon.pl -b apx202dgrd apxdwngrd.sql
• On Windows:

$ sqlplus /nolog
C.4.1.3.28 Re-enabling the REST Administration Interface After Downgrading

If the REST Administration Interface was used before the upgrade attempt, you must
re-create the APEX_INSTANCE_ADMIN_USER. If the REST Administration Interface was
not used, skip this step.
To re-create the APEX_INSTANCE_ADMIN_USER:
1. Change your working directory to apex in the, XX.X release source (where XX.X is
the release number you reverted to.
C-40
Appendix C
• On Windows:

$ sqlplus /nolog
3. If the no authentication was used, run the following:
create user apex_instance_admin_user no authentication
4. If the authentication was used, run the following:
create user apex_instance_admin_user identified by <random-password>

password expire
C.4.1.4 Removing the Oracle Application Express Release Schema

After you revert to the prior release, remove the Oracle Application Express schema.
• Removing the Oracle Application Express Release 21.1 Schema from a Non-CDB
Start SQL*Plus and connect to the database and execute DROP USER APEX_210100
CASCADE; .
• Removing the Oracle Application Express Release 21.1 Schema from a CDB
C.4.1.4.1 Removing the Oracle Application Express Release 21.1 Schema from a Non-CDB
Start SQL*Plus and connect to the database and execute DROP USER APEX_210100
CASCADE; .
To remove the release 21.1 schema from a non-CDB:

• On Windows:
$ sqlplus /nolog
DROP USER APEX_210100 CASCADE;
C-41
Appendix C
Once you have removed the Oracle Application Express 21.1 schema, you can
now attempt the upgrade again.
C.4.1.4.2 Removing the Oracle Application Express Release 21.1 Schema from a CDB
To remove the release 21.1 schema from a CDB:

1. Create a new text file named remove_apx211_usr1.sql with the following contents:
drop user APEX_210100 cascade;
2. Create a second new text file named remove_apx211_usr.sql with the following
contents:
set define '^'
set serverout on
begin
-- get oracle_home
-20001,
end if;
end;
/
set termout off

set termout on

catcon.pl -b remove_apx211_usr remove_apx211_usr1.sql
• On Windows:
$ sqlplus /nolog
@remove_apx211_usr.sql
C-42
Appendix C
About Images Displaying Incorrectly in Oracle Application Express
Once you have removed the Oracle Application Express 21.1 schema, you can now
attempt the upgrade again.
C.4.2 Removing Oracle Application Express from the Database

Start SQL*Plus and connect to the database where Oracle Application Express is installed as
SYS specifying the SYSDBA role and execute the SQL> @apxremov.sql command.
This section describes how to remove the Oracle Application Express schema, synonyms,
and users from the database without deleting the database.
Note:
Do NOT follow these steps if you have upgraded your database from a prior
release, and still want to use the prior release of Oracle Application Express. For
information about reverting to a prior release, see Reverting to a Previous Release.
If you are not sure whether you have completed a new installation or an upgrade
installation, review Cleaning Up After a Failed Installation to verify if a previous
release of Oracle Application Express exists in the database.
To remove Oracle Application Express from the database:

1. Change your working directory to the apex directory where you unzipped the Oracle
Application Express software.
• On Windows:
$ sqlplus /nolog
SQL> @apxremov.sql
4. After successfully removing Application Express using apxremov.sql, you must exit your
current SQL*Plus session and reconnect before attempting another install using
apexins.sql.
C.5 About Images Displaying Incorrectly in Oracle Application

Express
Learn about troubleshooting if images in Oracle Application Express do not display correctly.
If images in Oracle Application Express do not display correctly, you may have more than one
definition of the /i/ alias. To address this issue:
C-43
Appendix C
About Page Protection Violation
• If possible, rename the first instance of /i/ to a different alias name.

• Alternatively, copy the images from the directory where Oracle Application Express
was downloaded or the images copied for Oracle REST Data Services (ORDS) to
the directory defined by the first /i/ alias.
C.6 About Page Protection Violation

A page protection violation may be caused by manual alteration of protected page
items.
If this error occurs after installation when trying to log into Oracle Application Express,
then stop and start Oracle REST Data Services. If you are unsure of what caused this
error, contact the application administrator for assistance.
C-44
D
Upgrading Oracle Application Express within
Oracle Database Express Edition
Learn about upgrading Oracle Application Express included with Oracle Database 11g
Express Edition.
Oracle Database 11g Express Edition (Oracle Database XE) includes Oracle Application
Express release 4.0. Oracle strongly recommends that you upgrade to the latest Oracle
Application Express release to take advantage of the latest features. This section describes
how to upgrade Oracle Application Express included with Oracle Database XE.
Tip:
Upgrading Oracle Application Express does not change the Oracle Support policy
for Oracle Database XE. Oracle Database XE is only supported on the Oracle OTN
forums. Oracle Support will not answer questions about Oracle Application Express
on Oracle Database XE.
• Upgrading to the Latest Oracle Application Express Release

Learn how to upgrade to the latest Oracle Application Express release in Oracle
Database XE.
• Understanding the Differences Between Later Oracle Application Express Releases
Learn about Oracle Database 11g Express Edition that includes Oracle Application
Express 4.0 and the difference between 4.0 and later releases.
See Also:
Oracle Database 11g Express Edition OTN site at:
http://www.oracle.com/technetwork/database/database-technologies/
express-edition/overview/index.html
D.1 Upgrading to the Latest Oracle Application Express Release

Learn how to upgrade to the latest Oracle Application Express release in Oracle Database
XE.
To upgrade to the latest Oracle Application Express release:
1. Download the latest version of Oracle Application Express from the download page. See:
http://www.oracle.com/technetwork/developer-tools/apex/downloads/index.html
2. Unzip downloaded zip file:
D-1
Appendix D
Upgrading to the Latest Oracle Application Express Release
• UNIX and Linux: $ unzip filename.zip

• Windows: Double click filename.zip in Windows Explorer
Tip:
Keep the directory tree where you unzip the files short and not under
directories that contain spaces. For example, within Windows unzip
to C:\.

4. Start SQL*Plus and connect to the Oracle Database XE where Oracle Application
Express is installed as SYS specifying the SYSDBA role. For example:
• On Windows:
$ sqlplus /nolog
Tip:
Keep the directory tree where you unzip the files short and not under
directories that contain spaces. For example, within Windows unzip
to C:\.
5. Install Oracle Application Express:

Where:
• tablespace_apex is the name of the tablespace for the Oracle Application
• tablespace_files is the name of the tablespace for the Oracle Application
Express files user.
• tablespace_temp is the name of the temporary tablespace or tablespace
group.
• images is the virtual directory for Oracle Application Express images. To
directory as /i/.
Example
6. Configure ORDS for HTTP(s) access. See "Installing and Configuring Application
Express and Oracle REST Data Services."
7. Upgrade the Oracle Application Express password by running apxchpwd.sql:
D-2
Appendix D
Understanding the Differences Between Later Oracle Application Express Releases
@apxchpwd.sql
When prompted, enter a password for the ADMIN account.

8. Navigate to the Oracle Application Express Administration Services application:
a. In a Web browser, navigate to:
http://hostname:port/apex/apex_admin
Where:
hostname is the name of the system where Oracle XML DB Protocol server is
installed.
port is the port number assigned to HTTP on the Oracle XML DB Protocol server. In
a default installation, this number is 8080. If you are using the Oracle Database 12c
or later multitenant architecture, then each pluggable database (PDB) will have a
distinct port number.
apex is the database access descriptor (DAD) defined in the configuration file.
b. On the Sign In page:
• Username - Enter admin.
• Password - Enter the Oracle Application Express administrator account
password you specified in step 4.
• Click Sign In to Administration.
Note that, depending on your setup, you might be required to change your password
when you log in for the first time.
D.2 Understanding the Differences Between Later Oracle

Application Express Releases
Learn about Oracle Database 11g Express Edition that includes Oracle Application Express
4.0 and the difference between 4.0 and later releases.
Oracle Database 11g Express Edition includes Oracle Application Express 4.0. This section
describes the differences between Oracle Application Express release 4.0 and later releases.
• User Interface Differences
Learn about the differences between Oracle Application Express release 4.0 and later
releases.
D.2.1 User Interface Differences

Learn about the differences between Oracle Application Express release 4.0 and later
releases.
This section describes the differences between Oracle Application Express release 4.0 and
later releases:
• Workspace Home Page - The Workspace home page displays differently in newer
versions of Oracle Application Express. In the newer versions of Application Express, the
components displayed on the Workspace home page are App Builder, SQL Workshop,
Team Development, and App Gallery .
D-3
Appendix D
Understanding the Differences Between Later Oracle Application Express Releases
• Administration - In the newer versions of Oracle Application Express,

Administration appears as a menu on the Workspace home page.
• Account - In the newer versions of Oracle Application Express, the Account
Menu appears at the top of the Application Express home page and allows you to
set the following preferences:
– Default Schema
– Default Date Format
– Enable Legacy Component View
– Run application in new window - Specify how Application Express manages
windows or tabs when running applications from Application Builder
– Use single window to run all applications - Specify whether different
applications reuse the same application runtime window or tab
• Accessibility Mode - In the newer versions of Oracle Application Express, the
Workspace home page includes Accessibility Mode list that allows you to select
either Standard or Screen Reader mode.
D-4
Index
A apxchpwd.sql (continued)
running, 6-7
ACL unlockin Instance Administrator account, 6-7
fixing invalid, 6-32 updating Instance Administrator account, 6-7
Administration Services apxdevrm.sql, 6-35
signing in, 6-25 apxdvins.sql, 6-35
APEX_PUBLIC_USER account apxrtins.sql, 6-5
about, 6-8
changing password, 6-9
configuring, 6-8
B
expiration in Oracle Database 11g, 6-10 browser
unlocking, 6-9 requirement, 2-3
apexins.sql, 6-4
application container
about, 5-3 C
Application Express CDB
about users, 6-25 application container, 5-3
about workspaces, 6-25 CDBs
accessing in Oracle Cloud, 3-3 patching Application Express, 5-15
Administration Services, 6-25 uninstalling Application Express, 5-7
browser requirement, 2-3 CDBs reinstalling Application Express, 5-10
creating workspace manually, 6-26 common Application Express from another CDB,
database requirement, 2-1 5-19
disk space requirements, 2-3 configure
download and install in non-CDB, 6-3 HTTP access, 5-6
download and install locally in PDB, 6-3 creating
getting started, 6-24 application PDB, application root seed, 5-6
incompatible versions, 5-15 application seed, 5-5
installing translated versions, 6-23
patching in CDBs, 5-15
patching in PDBs, 5-16, 5-17 D
pre-installation tasks, 6-2
database requirement
reinstalling in CDBs, 5-10
Application Express, 2-1
release number, 4-2
development environment
signing in to workspace, 6-29
changing to runtime, 6-35
uninstalling in CDBs, 5-7
disk space
XML DB requirement, 2-3
requirements, 2-3
Application Express Administration Services,
6-26
applications E
upgrading, 4-4
apxchpwd.sql, 6-7, D-2 environment, configuring, 3-5
changing Instance Administrator account
password, 6-7
creating Instance Administrator account, 6-7
Index-1
Index
F J
full development environment JOB_QUEUE_PROCESSES, 6-20
about, 6-34 changing number of, 6-21
converting to runtime, 6-35 viewing from SQL*Plus, 6-21
installing, 6-4 viewing in installation log, 6-20
viewing number of, 6-20
viewing on About page, 6-21
G
getting started L
Application Express, 6-24
log file, C-1
login credentials
I recovering workspace name, 3-9
installation
downloading Oracle REST Data Services, M
6-11, 6-12
enabling network services, 6-15 MEMORY_TARGET
installing in other languages, 6-22 checking, 2-2
managing JOB_QUEUE_PROCESSES, 6-20 Multitenant Architecture, 5-1
overview, 3-5
patch sets, 3-5
performing security tasks, 6-19
N
planning, 3-4 network services
point releases, 3-5 enabling, 6-15
process, 3-5 granting connect privileges, 6-16
requirements, 2-1, 3-4 granting connect privileges, Oracle Database
restart processes, 6-8 12c, 6-18
signing in, 6-24 invalid ACL error, 6-18
understanding, 3-3 non-CDB
verifying validity, C-2 installing in, 6-3
installation option
full development environment, 6-4
runtime environment, 6-4 O
installing Oracle APEX Application Development
Application Express in application container, accessing Application Express, 3-3
5-3 Oracle Application Express
failures, C-3 accessing in Oracle Cloud, 3-3
Oracle REST Data Services, 6-11, 6-12 configuring your environment, 3-5
other languages, 6-22 creating users, 6-27
Instance administrator account installing, 4-3
about, 6-6 Oracle Database, 4-3
creating, 6-6 Oracle Autonomous Data Warehouse
running apxchpwd.sql, 6-7 accessing Application Express, 3-3
updating, 6-6 Oracle Autonomous Transaction Processing
Instance Administrator account accessing Application Express, 3-3
changing password, 6-7 Oracle Cloud
creating, 6-7 accessing Application Express, 3-3
creating password, 6-7 Oracle Real Application Clusters (Oracle RAC)
unlocking, 6-7 shutting down instances, 6-2
Oracle REST Data Services
about, 3-1
configuring, 6-1
configuring behind load balancer, 6-12
Index-2
Index
Oracle REST Data Services (continued) R

configuring behind reverse proxy, 6-12
configuring RESTful Services, 6-10, 6-13 release number
Copying the Images Directory, 6-14 Oracle REST Data Services, 4-3
downloading, 6-11, 6-12 viewing, 4-2
installing, 6-1, 6-11, 6-12 release numbering
release number, 4-3 convention, 4-2
Validating the Oracle REST Data Services removing schemas from prior installation, 6-32
Installation, 6-14 requirements, 2-1
Web Server HTTP POST Request Limits, browser, 2-3
6-13 database, 2-1
ords.version.number.zip, 6-12 disk space, 2-3
overview, 3-5 MEMORY_TARGET, 2-2
Oracle XML DB, 2-3
RESTful Services
P configuring, 6-10
password reverting to previous release, 4-5
resetting from Sign In page, 3-8 running
patch sets, 3-5 apexins.sql, 6-4
PDB apxchpwd.sql, 6-7, D-2
application container, 5-3 apxdevrm.sql, 6-35
installing in, 6-3 apxdvins.sql, 6-35
PDBs apxrtins.sql, 6-5
patching Application Express, 5-16, 5-17 runtime environment
performance about, 3-9, 6-34
optimizing, 6-33 converting to development environment, 6-34
performance optimization installing, 6-5
about, 6-33
expired header attribute, 6-33 S
gzip compression, 6-33
Plug-in non-CDB, 5-14 Secure Sockets Layer (SSL), 6-19
Plug-in PDB, 5-14 Sign In dialog
plugging in PDBs requesting a workspace, 3-7
Application Express from another CDB, 5-13 SSL, 6-19
Application Express in root, 5-12
Application Express is not contained in the
root container
T
local Application Express from another translated version
CDB, 5-19 installing, 6-22
Application Express is not in the root translated versions
container of the target CDB about installing, 6-23
non-CDB or PDB with no Application troubleshooting, C-1
Express, 5-19 cleaning up after failed installation, C-3
non-CDB with Application Express, 5-18 images, C-43
Application Express not contained root, 5-19 reviewing log file, C-1
Application Express not in the root of CDB,
5-17
Application Express root another CDB, 5-13 U
non-CDB with Application Express, 5-12 upgrade post installation tasks, 6-30
point releases, 3-5 fixing invalid ACL, 6-32
post-installation tasks removing prior installation, 6-31
installing other languages, 6-22 removing schemas from prior installation,
pre-installation tasks, 6-2 6-32
prior installations verifying prior installation, 6-31
removing when upgrading, 6-31
Index-3
Index
upgrading web listener

about, 4-1 Oracle REST Data Services, 3-1
Application Express in application container, Web listener
5-3 Oracle REST Data Services, 6-1
environment clean-up, 4-5 Web Listener
existing applications, 4-4 Oracle REST Data Services, 2-3
reverting, 4-5 requirements, 2-3
sample scenarios, 4-2 workspace
testing, 4-4 creating, 6-26
user accounts recovering workspace name, 3-9
creating, 6-27 requesting from Sign In dialog, 3-7
signing in, 6-29
workspace name
V recovering, 3-9
verifying
application container installation, 5-4 X
version, 4-3
XML DB
requirement, 2-3
W
Web browser
requirements, 2-3
Index-4

Oracle Application Express Installation Guide

Uploaded by

Copyright:

Available Formats

Oracle Application Express Installation Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Oracle Application Express Installation Guide

Uploaded by

Copyright:

Available Formats

Oracle® Application Express

Copyright © 2003, 2021, Oracle and/or its affiliates.

Primary Author: Terri Jennings

1 Changes in Release 21.1 for Oracle Application Express Installation

2 Oracle Application Express Installation Requirements

3 Oracle Application Express Installation Overview

4 Upgrading from a Previous Oracle Application Express Release

5 Utilizing the Multitenant Architecture in Oracle Database 12c or Later

6 Installing and Configuring Application Express and Oracle REST Data

A Automating the Oracle Application Express Installation Process

B Maximizing Uptime During an Application Express Upgrade

C Oracle Application Express Installation Troubleshooting

D Upgrading Oracle Application Express within Oracle Database Express

Access to Oracle Support

• Oracle Application Express API Reference

Third-Party License Information

Deprecated and Desupported Features

• Oracle Database Requirements

2.1 Oracle Database Requirements

2.2 Checking the MEMORY_TARGET of the Target

To check the MEMORY_TARGET of the target database:

1. Start the database:

2.3 Browser Requirements

2.4 Web Listener Requirements

2.5 Disk Space Requirement

2.6 Oracle XML DB Requirement

• About Oracle Application Express Architecture

3.1 About Oracle Application Express Architecture

About the Oracle Application Express Architecture

Oracle Database with

About Oracle REST Data Services

• "Web Listener Requirements"

3.2 About Accessing Oracle Application Express in Oracle

3.3 Understanding the Installation Process

• About Planning Your Installation

• About the Installation Scripts

3.3.1 About Planning Your Installation

3.3.2 About Patch Sets

3.3.3 About the Installation Scripts

3.3.4 About Accessing Oracle Application Express

• Workspace administrators can perform administrator tasks specific to a

About Specifying a Provisioning Mode

About Creating Workspaces and Users

• "Creating Workspaces in Administration Services" in Oracle Application

3.3.5 Requesting a Workspace from the Sign In Dialog

1. You will receive an email containing a verification link.

3.3.6 Resetting Your Password from the Sign In Page

1. To reset your password from the Sign In Page:

b. Confirm Password - Enter your new password again.

3.3.7 Recovering Your Workspace Name

3.4 About the Oracle Application Express Runtime Environment

• About Release Numbering Conventions

• Understanding the Installation Process

4.1 About Release Numbering Conventions

4.2 Sample Upgrade Scenarios

Table 4-1 Sample Upgrade Scenarios

Upgrade Scenarios Action

4.3 Viewing the Oracle Application Express Release

4.4 Viewing the Oracle REST Data Services Release Number

4.5 About Installing the Oracle Application Express Release

• "Using SQLPlus" in SQLPlus User's Guide and Reference