Oracle® Application Express

Installation Guide

Release 4.2 for Oracle Database 12c

E17958-12

May 2014

Oracle Application Express Installation Guide, Release 4.2 for Oracle Database 12c

E17958-12

Copyright © 2003, 2014, Oracle and/or its affiliates. All rights reserved.

Primary Author:   Drue Swadener

Contributors:  Terri Jennings, Christina Cho, Joel Kallman, David Peake, Jason Straub

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, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. 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 Xeon 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, Opteron, the AMD logo, and the AMD Opteron 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 on 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. 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.

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 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.

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Related Documents

For more information, see these Oracle resources:

Oracle Application Express Release Notes

Oracle Database 2 Day + Oracle Application Express Developer's Guide

Oracle Application Express Application Builder User's Guide

Oracle Application Express Administration Guide

Oracle Application Express SQL Workshop and Utilities Guide

Oracle Application Express API Reference

Oracle Application Migration Guide

Oracle Application Express End User's Guide

Oracle Database Concepts

Oracle HTTP Server Administrator's Guide

Oracle Database Advanced Application Developer's Guide

Oracle Database Administrator's Guide

Oracle Database SQL Language Reference

SQL*Plus User's Guide and Reference

Oracle Database Licensing Information

Oracle REST Data Services Installation and Developer Guide

For information about Oracle error messages, see Oracle Database Error Messages. Oracle error message documentation is available only in HTML. If you have access to the Oracle Database Documentation Library, you can browse the error messages by range. Once you find the specific range, use your browser's "find in page" feature to locate the specific message. When connected to the Internet, you can search for a specific error message using the error message search feature of the Oracle online documentation.

Many books in the documentation set use the sample schemas of the seed database, which is installed by default when you install Oracle. Refer to Oracle Database Sample Schemas for information on how these schemas were created and how you can use them yourself.

For additional application examples, go to the Learning Library. Search for free online training content, including Oracle by Example (OBE), demos, and tutorials. To access the Oracle Learning Library, go to:

http://www.oracle.com/technetwork/tutorials/index.html

Printed documentation is available for sale in the Oracle Store at

http://shop.oracle.com/

If you already have a user name and password for OTN, then you can go directly to the documentation section of the OTN Web site at

http://www.oracle.com/technology/documentation/

Conventions

The following text conventions are used in this document:

Convention
Meaning

Third-Party License Information

Oracle Application Express contains third-party code. Please see the Oracle Database Licensing Information book 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.

Changes in This Release

This preface contains:

Changes in Oracle Application Express Release 4.2 for Oracle Database 12c

Changes in Oracle Application Express Release 4.2 for Oracle Database 12c

The following are changes in Oracle Application Express Installation Guide for Oracle Application Express release 4.2 for Oracle Database 12c.

New Features

The following features are new in this release:

Oracle Database 12c introduces the multitenant architecture

See "Utilizing the Multitenant Architecture".

Increased Size Limit for VARCHAR2, NVARCHAR2, and RAW Data Types

The maximum size of the VARCHAR2, NVARCHAR2, and RAW data types has been increased from 4,000 to 32K characters. Increasing the allotted size for these data types allows users to store more information in character data types before switching to large objects (LOBs). This is especially useful for brief textual data types and the capabilities to build indexes on these types of columns.

In order for Application Express collections to be able to utilize the increased size limit you must run /core/collection_member_resize.sql to change collection VARCHAR2 columns from 4000 characters to 32767 characters.

RESTful Web Services

In SQL Workshop you can now define RESTful Web Service calls from the database. These definitions combined with Oracle REST Data Services 2.0 enables the database to emit RESTful Web Services rather than just being able to consume Web Services. See "Using RESTful Services" in Oracle Application Express SQL Workshop and Utilities Guide

RESTful Services require the installation of Oracle REST Data Services release 2.0. See "Configure RESTful Services".

The instance administrator enables RESTful Services for this Application Express instance. See "Configuring SQL Workshop" in Oracle Application Express Administration Guide.

Other Changes

The following are additional changes in the release:

All content has been updated to reflect new functionality.

Screen captures and graphics have been added and updated to reflect Oracle Application Express release 4.2 user interface enhancements.

1 Oracle Application Express Installation Overview

This chapter provides an overview of installing Oracle Application Express and describes issues to consider before installing.

Overview of the Installation Process

Upgrading from a Previous Release of Oracle Application Express

About the Oracle Application Express Runtime Environment

About Choosing a Web Listener

Available Installation Scenarios

1.1 Overview of the Installation Process

The installation process involves the following:

Plan your installation: This chapter offers an overview of the steps required to install Oracle Application Express. During the planning phase, you should also determine whether to install a full development environment or runtime environment.

A full development environment provides complete access to the Application Builder environment to develop applications. A runtime environment is an appropriate choice for production implementations in which you want to run applications that cannot be modified. To learn more, see "About the Oracle Application Express Runtime Environment".

Verify installation requirements: "Oracle Application Express Installation Requirements" describes the minimum requirements that your system must meet before you install the software.

Install the software: The required installation steps depend upon which Web listener you decide to use. Available options include the Oracle REST Data Services, the embedded PL/SQL gateway, or Oracle HTTP Server and mod_plsql.

How you install Oracle Application Express. Available options include using the release of Oracle Application Express that installs with Oracle Database 12c and later.

Which Web Listener you decide to use. Available options include the Oracle REST Data Services, the embedded PL/SQL gateway, or Oracle HTTP Server and mod_plsql.

1.2 Upgrading from a Previous Release of Oracle Application Express

If you have release 1.5.x, 1.6.x, 2.0.x, 2.2.x, 3.0.x, 3.1.x, 3.2.x, 4.0x or 4.1x of Oracle Application Express, following any of the installation scenarios in this guide upgrades your Oracle Application Express instance to release 4.2 and creates Oracle Application Express release 4.2 database objects in a new schema and migrates the application metadata to the new release.

1.3 Upgrading to Application Express Release 4.2.1 or Later

Oracle Database 12c Release 1 (12.1) includes Oracle Application Express Release 4.2.0.00.08. However, the latest version available for download from the Oracle Technology Network is Oracle Application Express Release 4.2.2.00.11. If deploying a non-container database, it is recommended that you upgrade to the latest available release. A future patch or major release of Application Express will contain the appropriate scripts to upgrade or patch a container database.

1.4 About the Oracle Application Express Runtime Environment

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. To learn more see, "Managing a Runtime Environment" in Oracle Application Express Application Builder User's Guide.

Scripts are provided to remove or add the developer interface from an existing instance. To learn more, see "Configuration Tasks When Installing from the Database".

1.5 About Choosing a Web Listener

In order to run, Oracle Application Express must have access to Oracle REST Data Services, Oracle HTTP Server and mod_plsql, or the embedded PL/SQL gateway.

For further information on selecting the best Web listener, please the review the Oracle Application Express Deployment page on Oracle Technology Network (OTN):

http://www.oracle.com/technetwork/developer-tools/apex/application-express/apex-deploy-installation-1878444.html#listener

About Oracle REST Data Services and Oracle HTTP Server with mod_plsql

About the Embedded PL/SQL Gateway

Selecting a Web Listener in an Oracle RAC Environment

1.5.1 About Oracle REST Data Services and Oracle HTTP Server with mod_plsql

Oracle REST Data Services communicates directly with the Oracle Application Express engine. Oracle HTTP Server uses the mod_plsql plug-in to communicate with the Oracle Application Express engine within the Oracle database. Oracle REST Data Services and the Oracle HTTP Server function as communication brokers between the Web server and the Oracle Application Express objects in the Oracle database. More specifically, they map browser requests into database stored procedure calls over a SQL*Net connection. The following graphic illustrates the Oracle Application Express architecture using the Oracle REST Data Services.

See Also:

"Web Listener Requirements"

Note this three tier architecture consists of the following components:

Web browser

Oracle REST Data Services or Oracle HTTP Server with mod_plsql

Oracle database containing Oracle Application Express

The major advantage of Oracle REST Data Services or Oracle HTTP Server (Apache) with mod_plsql is the separation of the mid-tier and the database tier. Note that this architecture is appropriate for Oracle Real Application Clusters (Oracle RAC) environments.

1.5.1.1 Where Images Are Stored When Using Oracle HTTP Server

In an Oracle HTTP Server or Oracle Application Server configuration, images are stored on the file system in the location referenced by the alias /i/. If you are upgrading Oracle Application Express from a prior release, you can locate the images directory on the file system, by reviewing the following files and searching for the text alias /i/:

Oracle HTTP Server distributed with Oracle Database 11g Release 1 (11.1) and later — see the dads.conf file.

Oracle Application Server 10g—see the marvel.conf file.

Specific examples for locating the text alias /i/ can be found in "Configuration Tasks When Installing from the Database".

1.5.2 About the Embedded PL/SQL Gateway

Oracle XML DB Protocol Server with the embedded PL/SQL gateway installs with Oracle Database. It provides the Oracle database with a Web server and also the necessary infrastructure to create dynamic applications. The embedded PL/SQL gateway runs in the Oracle XML DB Protocol Server in the Oracle database and includes the core features of mod_plsql. The following graphic illustrates the Oracle Application Express architecture using the embedded PL/SQL gateway.

As shown in the previous graphic, the embedded PL/SQL gateway consists of a simple two tier architecture: a Web browser and an Oracle database containing the embedded PL/SQL gateway and Oracle Application Express.

Advantages of the embedded PL/SQL gateway include:

Ease of configuration

Included in the database

No separate server installation

1.5.2.1 Security Considerations When Using the Embedded PL/SQL Gateway

The embedded PL/SQL gateway runs in the database as part of the XML DB HTTP Protocol Listener. Because the HTTP listener runs in the same database where Oracle Application Express is installed, it is not possible to separate the HTTP listener from the database. For this reason, Oracle does not recommend the use of the embedded PL/SQL gateway for applications that run on the Internet.

1.5.2.2 Where Images Are Stored When Using the Embedded PL/SQL Gateway

When running Oracle Application Express with the embedded PL/SQL gateway, images are stored directly in the database within the Oracle XML DB repository. You can access images by using the WebDAV feature of Oracle XML DB or by using FTP. To learn more, see "Accessing the Repository Using Protocols" in Oracle XML DB Developer's Guide.

1.5.3 Selecting a Web Listener in an Oracle RAC Environment

When running Oracle Application Express in an Oracle Real Application Clusters (Oracle RAC) environment, Oracle recommends that you use Oracle REST Data Services or Oracle HTTP Server with mod_plsql. Oracle REST Data Services or Oracle HTTP Server with mod_plsql permit you to specify a connection in the service name format, so that one HTTP Server can access all nodes.

Oracle recommends that you do not select the embedded PL/SQL gateway option for Oracle RAC installations. The embedded PL/SQL gateway uses an HTTP Server built into the database instance, and because of this, it does not take advantage of the Oracle RAC shared architecture.

1.6 Available Installation Scenarios

How you install Oracle Application Express depends upon which Web listener you decide to use. This section provides an overview of each installation scenario.

See Also:

"About Choosing a Web Listener" and "About the Oracle Application Express Runtime Environment"

Installing from the Database and Configuring Oracle REST Data Services

Installing from the Database and Configuring the Embedded PL/SQL Gateway

Installing from the Database and Configuring the Oracle HTTP Server

1.6.1 Installing from the Database and Configuring Oracle REST Data Services

Follow the steps in this scenario if you are using a release of Oracle Application Express that installs with Oracle Database 12c and later and configuring the Oracle REST Data Services. Required steps in this scenario include:

Step 1: Install the Oracle Database and Complete Preinstallation Tasks

Step 2: Download and Install Oracle REST Data Services

Step 3: Enable Network Services in Oracle Database 12c

Step 4: Security Considerations

Step 5: About Running Oracle Application Express in Other Languages

Step 6: About Managing JOB_QUEUE_PROCESSES

Step 7: Create a Workspace and Add Oracle Application Express Users

1.6.2 Installing from the Database and Configuring the Embedded PL/SQL Gateway

Follow the steps in this scenario if you are using a release of Oracle Application Express that installs with Oracle Database 12c or later and configuring the embedded PL/SQL gateway. Required steps in this scenario include:

Step 1: Install the Oracle Database and Complete Pre-installation Tasks

Step 2: Configure the Embedded PL/SQL Gateway

Step 3: Enable Network Services in Oracle Database 12c

Step 4: Security Considerations

Step 5: About Running Oracle Application Express in Other Languages

Step 6: About Managing JOB_QUEUE_PROCESSES

Step 7: Configuring the SHARED_SERVERS Parameter

Step 8: Create a Workspace and Add Oracle Application Express Users

1.6.3 Installing from the Database and Configuring the Oracle HTTP Server

Follow the steps in this scenario if you are using a release of Oracle Application Express that installs with Oracle Database 12c or later and configuring Oracle HTTP Server with mod_plsql distributed with Oracle Database 12c and later. Required steps in this scenario include:

Step 1: Install the Oracle Database and Complete Pre-installation Tasks

Step 2: Configure Oracle HTTP Server Distributed with Oracle Database 12c

Step 3: Enable Network Services in Oracle Database 12c

Step 4: Security Considerations

Step 5: About Running Oracle Application Express in Other Languages

Step 6: About Managing JOB_QUEUE_PROCESSES

Step 7: About Obfuscating PlsqlDatabasePassword Parameter

Step 8: Create a Workspace and Add Oracle Application Express Users

2 Oracle Application Express Installation Requirements

This chapter describes the requirements for installing Oracle Application Express.

Oracle Database Requirements

Browser Requirements

Web Listener Requirements

Disk Space Requirement

Oracle XML DB Requirement

PL/SQL Web Toolkit

2.1 Oracle Database Requirements

Oracle Application Express release 4.2 requires an Oracle database (Enterprise Edition, Standard Edition or Standard Edition One) that is Release 10.2.0.4 and later. Oracle Application Express release 4.2 can also be used with Oracle Database Express Edition 10g Release 2 (10.2) and later. The Oracle HTTP Server is not included with the distribution of Oracle Database Express Edition.

Note:

You can upgrade the version of Oracle Application Express in Oracle Database Express Edition 10g Release 2 (10.2) and later, by installing Oracle Application Express release 4.2. For more information, see the Oracle Application Express Learn More page on the Oracle Technology Network (OTN).

2.1.1 Checking the shared_pool_size of the Target Database

Note:

Ignore this requirement if your configuration defines specific memory target values for the database initialization parameters SGA_TARGET (in Oracle Database 10g and 11g or later) MEMORY_TARGET (in Oracle Database 11g or later).

Oracle Application Express requires the shared_pool_size of the target database to be at least 100 MB.

To check the shared_pool_size of the target database:

Start the database:

SQL> STARTUP

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.

Determine the current values of the shared_pool_size parameter:

SQL> SHOW PARAMETER SHARED_POOL_SIZE

If the system is using a server parameter file, set the value of the SHARED_POOL_SIZE initialization parameter to at least 100 MB:

SQL> ALTER SYSTEM SET SHARED_POOL_SIZE='100M' SCOPE=spfile;

If the system uses an initialization parameter file, change the value of the SHARED_POOL_SIZE parameter to at least 100 MB in the initialization parameter file (initsid.ora).

Shut down the database:

SQL> SHUTDOWN

Restart the database:

SQL> STARTUP

2.2 Browser Requirements

To run or develop Oracle Application Express applications, Web browsers must have JavaScript enabled. The following browsers are required to develop applications in Oracle Application Express:

Microsoft Internet Explorer 7.0 or later

Mozilla Firefox 14 or later

Google Chrome 21 or later

Apple Safari 5.0 or later

Oracle Application Express applications can be developed that support earlier Web browser releases, including Microsoft Explorer 6.0. Application Express has a number of advanced widgets, such as date pickers, which may not work correctly on earlier browsers.

2.3 Web Listener Requirements

In order to run Oracle Application Express you must have access to one of the following:

Oracle REST Data Services

Oracle REST Data Services is a Java-based Web server. It features file system caching, offers improved file upload capability, and is certified with Oracle WebLogic Server, and Oracle Glassfish Server.

Embedded PL/SQL gateway

Oracle XML DB Protocol Server with the embedded PL/SQL gateway installs with Oracle Database 11g Release 1 (11.1). It provides the database with a Web server and the necessary infrastructure to create dynamic applications.

Oracle HTTP Server and mod_plsql

Oracle HTTP Server uses the mod_plsql plug-in to communicate with the Oracle Application Express engine within the Oracle database.

The following products include appropriate versions of HTTP Server and mod_plsql:

Oracle Database 10g Companion CD Release 2

Oracle Database 11g Release 1 (11.1) and Oracle Database 11g Release 1 (11.2)

Oracle Database 12c Release 1 (12.1)

See Also:

"About Choosing a Web Listener"

2.4 Disk Space Requirement

Oracle Application Express disk space requirements are as follows:

Free space for Oracle Application Express software files on the file system: 278 MB if using English only download (apex_4.2_en.zip) and 935 MB if using full download (apex_4.2.zip).

Free space in Oracle Application Express tablespace: 275 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.5 Oracle XML DB Requirement

Oracle XML DB must be installed in the Oracle database that you want to use. 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.

See Also:

Oracle XML DB Developer's Guide for more information about manually adding Oracle XML DB to an existing database

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.6 PL/SQL Web Toolkit

Oracle Application Express requires the PL/SQL Web Toolkit release 10.1.2.0.6 or later. For instructions on determining the current release of the PL/SQL Web Toolkit, and for instructions on installing release 10.1.2.0.6, please review the README.txt file contained in the directory apex/owa.

3 Utilizing the Multitenant Architecture

This chapter outlines the installation choices and different scenarios associated with copying and moving pluggable databases introduced by the Oracle Database 12c multitenant architecture with respect to Oracle Application Express (Application Express).

Understanding Installation Choices in Oracle Database 12c

Plugging in a PDB When Application Express is Installed in the Root Container

Plugging in a PDB When Application Express Is Not in the Root Container of the Target CDB

3.1 Understanding Installation Choices in Oracle Database 12c

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 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.

Oracle Application Express Release 4.2 is the earliest release that can be configured with Oracle Database 12c. When choosing to install Oracle Database 12c using the Oracle Database 12c multitenant architecture, Oracle Application Express 4.2.4 is installed as a common database option by default. You may also choose to uninstall Application Express from the root container and then install a local Application Express Release 4.2.4 or later individually into one or more PDBs. Oracle does not support uninstalling Application Express from the root container, or reinstalling Application Express into the root container, once any PDBs have been configured. This may invalidate or completely remove the meta data associated with the existing Application Express installation.

When configuring multitenant architecture, Oracle Application Express is installed in the root container database by default. In such an 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_040200 schema with the Application Express tables, and creating metadata links back to the common database objects held in the APEX_040200 schema within the CDB$ROOT. As such there are multiple 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_040200 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.

As a best practice, Oracle recommends having a common Oracle Application Express installation in the root container, which ensures every PDB is running the same version of Oracle Application Express. This offers ease of administration by enabling centralized management of Oracle Application Express infrastructure tasks, such as upgrading and patching. The other alternative is to uninstall Application Express from CDB$ROOT, PDB$SEED, and all other PDBs, and then install Application Express locally into each PDB. The advantage of a local Oracle Application Express is that you can run different versions of Application Express in each PDB. However, the disadvantage of choosing this option is that each local Oracle Application Express installation must be managed separately in respect of upgrades and patches for Application Express, which is a greater maintenance effort.

3.1.1 Uninstalling Application Express from a CDB

To have the flexibility of installing different versions of Oracle Application Express into different PDBs, you need to uninstall Oracle Application Express release 4.2.4 which was installed into the container database. Once you have removed Oracle Application Express from the container database, then you can install a local Application Express within each PDB as required. When Oracle Application Express is installed locally there are no Application Express metadata linked objects and all packages, views, and tables are created within the APEX_0402000 schema, within each PDB where Application Express is installed.

To uninstall Oracle Application Express from the CDB:

Change your working directory to $ORACLE_HOME/apex.

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Run apxremov_con.sql.

For example:

@apxremov_con.sql

Note:

If you run apexremov_con.sql after PDBs have been added to the CDB then Application Express uninstalls from all of the PDBs. Therefore, any applications defined in any of the PDBs will be removed. If you run apxremov.sql then Application Express is only removed from the root container. However, every PDB is left in an invalid state and will cause errors when trying to open the PDB.

3.1.2 Installing Application Express Locally in a PDB

Once you have removed Oracle 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 Oracle Application Express locally in a PDB:

Change your working directory to $ORACLE_HOME/apex.

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Set the container to the PDB you wish to install Application Express locally:

ALTER SESSION SET CONTAINER = <PDB_name>;

Select the appropriate installation option.

Full development environment provides complete access to the Application Builder environment to develop applications. A Runtime environment enables users to run applications that cannot be modified. To learn more, see "About the Oracle Application Express Runtime Environment".

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 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. To support future Oracle 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:

o @apxrtins.sql tablespace_apex tablespace_files tablespace_temp images

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. To support future Oracle Application Express upgrades, define the virtual image directory as /i/.

For example:

@apxrtins.sql SYSAUX SYSAUX TEMP /i/

Note:

If you did not apply the database patch prior to executing apxremov_con.sql in the previous step, then attempting to install Oracle Application Express into a PDB will fail as the installation script will exit immediately without installing Oracle Application Express. In this scenario please contact Oracle Support for further assistance.

If you are using Oracle REST Data Services, complete the appropriate steps in "Download and Install Oracle REST Data Services" through "Create a Workspace and Add Oracle Application Express Users".

If you are using Oracle HTTP Server, complete the appropriate steps in "Configure Oracle HTTP Server Distributed with Oracle Database 12c" through "Create a Workspace and Add Oracle Application Express Users".

If you are using embedded PL/SQL gateway, run apex_epg_config.sql passing the path to the Oracle Home and then complete the appropriate steps in "Configure the Embedded PL/SQL Gateway".

See Also:

Oracle Database SQL Language Reference for more information about SQL*Plus

When Oracle Application Express installs, it creates three new database accounts:

APEX_040200 - The account that owns the Oracle Application Express schema and metadata.

FLOWS_FILES - The account that owns the Oracle Application Express uploaded files.

APEX_PUBLIC_USER - The minimally privileged account is used for Oracle 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 Oracle Application Express.

APEX_LISTENER - The account used to query RESTful Services definitions stored in Oracle Application Express.

3.1.3 Reinstalling Application Express into a CDB

If you previously uninstalled Oracle Application Express 4.2.4 and want to reinstall Application Express into a CDB you need to install Oracle Application Express 4.2.4 using the Oracle Database 12c distribution. Following the reinstallation you can apply Application Express patches if required as outlined in "Patching Application Express in the CDB".

To reinstall Application Express into a CDB:

Change your working directory to $ORACLE_HOME/apex.

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Select the appropriate installation option.

Full development environment provides complete access to the Application Builder environment to develop applications. A Runtime environment enables users to run applications that cannot be modified. To learn more, see "About the Oracle Application Express Runtime Environment".

Available installation options include:

Full development environment. Run apexins_con.sql passing the following four arguments in the order shown:

@apexins_con.sql tablespace_apex tablespace_files tablespace_temp images

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. To support future Oracle Application Express upgrades, define the virtual image directory as /i/.

Example:

@apexins_con.sql SYSAUX SYSAUX TEMP /i/

Runtime environment. Run apxrtins_con.sql passing the following arguments in the order shown:

@apxrtins_con.sql tablespace_apex tablespace_files tablespace_temp images

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. To support future Oracle Application Express upgrades, define the virtual image directory as /i/.

Example:

@apxrtins_con.sql SYSAUX SYSAUX TEMP /i/

If using Oracle REST Data Services, complete appropriate steps in sections "Download and Install Oracle REST Data Services" through "Create a Workspace and Add Oracle Application Express Users".

If using the Oracle HTTP Server, complete appropriate steps in sections "Configure Oracle HTTP Server Distributed with Oracle Database 12c" through "Create a Workspace and Add Oracle Application Express Users".

If using the embedded PL/SQL gateway, run apex_epg_config_con.sql passing the path to the Oracle Home and then complete appropriate steps in "Configure the Embedded PL/SQL Gateway".

See Also:

Oracle Database SQL Language Reference for more information about SQL*Plus

When Oracle Application Express installs, it creates three new database accounts:

APEX_040200 - The account that owns the Oracle Application Express schema and metadata.

FLOWS_FILES - The account that owns the Oracle Application Express uploaded files.

APEX_PUBLIC_USER - The minimally privileged account is used for Oracle 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 Oracle Application Express.

APEX_LISTENER - The account used to query RESTful Services definitions stored in Oracle Application Express.

3.2 Plugging in a PDB When Application Express is Installed in the Root Container

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 Oracle Application Express

Scenario 2: Plug-in PDB with a Common Application Express from Another CDB

Scenario 3: Plug-in PDB with a Local Application Express from Another CDB

Scenario 4: Plug-in Non-CDB or PDB with No Application Express

About Incompatible Application Express Versions

3.2.1 Scenario 1: Plug-in Non-CDB with Oracle 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) and then plug the database into your CDB. Alternatively, if you have configured a non-CDB Oracle Database 12c, 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 Oracle Application Express. After installing Oracle Application Express, you need to configure the Web listener for the PDB as described in "Configuration Tasks When Installing from the Database".

If the version of Application Express installed in the originating database (which is now a PDB) is not the same as that installed into the root container of the target, an error will be raised when trying to open the PDB. For information on how to make the versions of Application Express compatible, see "About Incompatible Application Express Versions".

3.2.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 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 as described in "Configuration Tasks When Installing from the Database".

Assuming Oracle Application Express release 4.2 is installed, the APEX_040200 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 not the same as that installed in the root container of the target an error is raised when trying to open the PDB. For information on how to make the versions of Application Express compatible, see "About Incompatible Application Express Versions".

3.2.3 Scenario 3: Plug-in PDB with a Local Application Express from Another CDB

If you are copying or moving a PDB from an existing Oracle Database 12c 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. Assuming Oracle Application Express release 4.2 is installed, the APEX_040200 schema within the PDB being plugged in contains all of the Application Express 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:

Change your working directory to $ORACLE_HOME/rdbms/admin.

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Set the container to the PDB to be configured:

ALTER SESSION SET CONTAINER = <PDB_name>;

Run apex_to_common.sql. For example:

@apex_to_common.sql

If the version of Application Express installed in the originating database is not the same as that installed in the root container of the target an error is raised when trying to open the PDB. For information on how to make the versions of Application Express compatible, see "About Incompatible Application Express Versions".

3.2.4 Scenario 4: Plug-in Non-CDB or PDB with No Application Express

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_040200 for Oracle Application Express release 4.2, will not be present in the originating database or 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.

3.2.5 About Incompatible Application Express Versions

If the version of Oracle Application Express in the root container, CDB$ROOT, is not the same as the Oracle 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 Application Express in the CDB

Patching Application Express in a PDB

3.2.5.1 Patching Application Express in the CDB

If the version of Application Express in the PDB is higher than the version of Application Express in the root container, then you must patch the version of Application Express in the root container to be able to open the PDB without error.

To patch Application Express in the root container:

Download the appropriate patch from My Oracle Support.

Unzip and extract the installation files.

Change your working directory to where the installation files were extracted

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Run apxpatch_con.sql for example:

@apxpatch_con.sql

Follow the instructions outlined in the Patch Set Notes for updating the images directory based on the Web Server you are using. If you are using the embedded PL/SQL gateway, run apxldimg_con.sql for example:

@apxldimg_con.sql

3.2.5.2 Patching Application Express in a PDB

If the version of Application Express in the PDB is lower than the version of Application Express in the root container, CDB$ROOT, then it will be necessary to patch the version of Application Express in the PDB.

To patch Application Express in the PDB:

Download the appropriate patch from My Oracle Support.

Unzip and extract the installation files.

Change your working directory to where the installation files were extracted

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

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

Follow the instructions outlined in the patch set notes for updating the images directory based on the Web Server you are using. If you are using the embedded PL/SQL gateway, run apxldimg.sql for example:

ALTER SESSION SET CONTAINER = <PDB_name>;
@apxldimg.sql

3.3 Plugging in a PDB When Application Express Is Not in the Root Container of the Target CDB

The scenarios in this section describe when Oracle Application Express is not installed in the root container, CDB$ROOT, by explicitly removing it as described in "Uninstalling Application Express from a CDB". In such cases, you can optionally install a local Application Express into each PDB independently. If Oracle 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

Scenario 4: Plug-in a Non-CDB or PDB with No Application Express

3.3.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 non-CDB (or standalone database) and then plug the database into your CDB. Alternatively you may have configured a non-CDB Oracle Database 12c that you now wish 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 Oracle 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 Server as outlined in "Configuration Tasks When Installing from the Database".

3.3.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 and open the PDB. The error is due to the fact that 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 unless no PDBs are installed. For further assistance, contact Oracle Support.

3.3.3 Scenario 3: Plug-in PDB with a Local Application Express from Another CDB

If you are copying or moving a PDB from an existing Oracle Database 12c 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 Server in the PDB as described in "Configuration Tasks When Installing from the Database". Assuming Oracle Application Express release 4.2 is installed, the APEX_040200 schema within the PDB being plugged in already has all of the Application Express objects defined locally and no metadata links.

3.3.4 Scenario 4: Plug-in a Non-CDB or PDB with No Application Express

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_040200, within the PDB, and the PDB can be started without error.

4 Configuration Tasks When Installing from the Database

Oracle Application Express is installed by default with Oracle Database 11g Release 1 (11.1) and later. This chapter describes required postinstallation configuration tasks for Oracle Application Express when installed with Oracle Database 12c or later in the standalone and multitenant architecture.

The instructions in this chapter apply to both new and upgrade installations. To learn more, see "Upgrading from a Previous Release of Oracle Application Express".

Note:

This chapter applies to installations in Oracle Database 12c in the multitenant architecture and non-CDB (or standalone) architecture. For more information on multitenant architecture, see "Part VI" in Oracle Database Concepts 12c Release 1 (12.1). For more information on different installation scenarios relating to Application Express in an Oracle Database 12c Release 1 (12.1) multitenant architecture, see Chapter 3, "Utilizing the Multitenant Architecture".

About Patching Oracle Application Express

Recommended Pre-installation Tasks

Choosing a Web Listener

Installing from the Database and Configuring Oracle REST Data Services

Installing from the Database and Configuring the Embedded PL/SQL Gateway

Installing from the Database and Configuring the Oracle HTTP Server

Post Installation Tasks for Upgrade Installations

About the Oracle Application Express Runtime Environment

4.1 About Patching Oracle Application Express

If you are already running Oracle Application Express, then check the Oracle Application Express page on the Oracle Technology Network (OTN) at the following URL for information about patch set releases or later releases of Oracle Application Express:

http://www.oracle.com/technology/products/database/application_express/index.html

Upgrading to Oracle Database 12c Release 1 (12.1) will not patch Oracle Application Express. To learn more about downloading and installing Oracle Application Express from Oracle Technology Network (OTN) see "Downloading from Oracle Technology Network" in Oracle Application Express Installation Guide for Oracle Application Express release 4.2.

4.2 Recommended Pre-installation Tasks

Before installing Oracle Application Express, Oracle recommends that you complete the following steps:

Review and satisfy all Oracle Application Express installation requirements. See "Oracle Application Express Installation Requirements".

Shut down any existing Oracle Database instances as well as Oracle-related processes.

Shut down any existing Oracle Database instances with normal or immediate priority, except for the database where you plan to install the Oracle Application Express schemas. On Oracle Real Application Clusters (Oracle RAC) systems, shut down all instances on each node.

If Oracle Automatic Storage Management (ASM) is running, shut down all databases that use ASM except for the database where you will install Oracle Application Express, and then shut down the ASM instance.

You can use the Windows Services utility, located either in the Windows Control Panel or from the Administrative Tools menu (under Start and then Programs), to shut down Oracle Database and ASM instances. Names of Oracle Databases are preceded with OracleService. The Oracle ASM service is named OracleASMService+ASM. In addition, shut down the OracleCSService service, which ASM uses. Right-click the name of the service and from the menu, choose Stop.

Back up the Oracle Database installation.

Oracle recommends that you create a backup of the current installation of Oracle Database installation before you install Oracle Application Express. You can use Oracle Database Recovery Manager, which is included the Oracle Database installation, to perform the backup.

See Also:

Oracle Database Backup and Recovery User's Guide

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.

4.3 Choosing a Web Listener

In order to run, Oracle Application Express must have access to Oracle REST Data Services, Oracle HTTP Server and mod_plsql, or the embedded PL/SQL gateway. To learn more, see "About Choosing a Web Listener".

4.4 Installing from the Database and Configuring Oracle REST Data Services

This section describes required postinstallation configuration tasks when running Oracle Application Express with Oracle REST Data Services.

Install the Oracle Database and Complete Preinstallation Tasks

Download and Install Oracle REST Data Services

Configure RESTful Services

Enable Network Services in Oracle Database 12c

Security Considerations

About Running Oracle Application Express in Other Languages

About Managing JOB_QUEUE_PROCESSES

Create a Workspace and Add Oracle Application Express Users

4.4.1 Install the Oracle Database and Complete Preinstallation Tasks

Oracle Application Express automatically installs with Oracle Database 11g and later. To learn more about installing the Oracle Database, see the Oracle Database Installation Guide for your platform and "Recommended Pre-installation Tasks".

4.4.2 Download and Install Oracle REST Data Services

To download Oracle REST Data Services:

Download the latest release of Oracle REST Data Services from the following site:

http://www.oracle.com/technetwork/developer-tools/rest-data-services/downloads/index.html

Note that the version.number in the file name reflects the current release number.

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

Copy the images directory, apex/images, from the Application Express software ZIP to a location on the file system where Oracle REST Data Services is installed.

Locate the installation guide for Oracle REST Data Services and follow instructions to complete installation and configuration steps.

For Oracle Database 12c 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 and Developer Guide for more information.

4.4.3 Configure RESTful Services

In a new installation of Oracle Application Express, you configure RESTful Services by running the configuration script apex_rest_config.sql. This step is optional and only needs to be completed if you wish to use RESTful Services with Oracle REST Data Services on the instance. 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. See "Configuring SQL Workshop" in Oracle Application Express Administration Guide.

Note:

RESTful Services requires Oracle REST Data Services release 2.0 or later.

To configure RESTful Services in Oracle Application Express:

Change your working directory to $ORACLE_HOME/apex.

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the pluggable database (PDB) to be configured:

ALTER SESSION SET CONTAINER = <PDB_name>;

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_LISTENER - The account used to query RESTful Services definitions stored in Oracle Application Express.

APEX_REST_PUBLIC_USER - The account used when calling RESTful Services definitions stored in Oracle Application Express.

4.4.4 Enable Network Services in Oracle Database 12c

By default, the ability to interact with network services is disabled in Oracle Database 12c. Therefore, if you are running Oracle Application Express with Oracle Database 12c, you must use the new DBMS_NETWORK_ACL_ADMIN package to grant connect privileges to any host for the APEX_040200 database user. Failing to grant these privileges results in issues with:

Sending outbound mail in Oracle Application Express.

Users can call methods from the APEX_MAIL package, but issues arise when sending outbound email.

Using Web services in Oracle Application Express.

PDF report printing.

Granting Connect Privileges

Troubleshooting an Invalid ACL Error

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 Oracle Database 12c already has the parameter set properly, but a database upgraded to Oracle Database 12c from a prior version may not. See "Creating and Configuring an Oracle Database" in Oracle Database Administrator's Guide for information about changing database initialization parameters.

The examples below should be modified according to your environment and in a Oracle Database 12c multitenant architecture, should be run on each pluggable database (PDB).

4.4.4.1 Granting Connect Privileges

The following example demonstrates how to grant connect privileges to any host for the APEX_040200 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_040200
  -- the "connect" privilege if APEX_040200 does not have the privilege yet.

  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_040200',
     'connect') IS NULL THEN
      DBMS_NETWORK_ACL_ADMIN.ADD_PRIVILEGE(ACL_PATH,
     'APEX_040200', 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',
    'APEX_040200', TRUE, 'connect');
  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 is used to enable 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_040200
  -- the "connect" privilege if APEX_040200 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_040200',
     'connect') IS NULL THEN
      DBMS_NETWORK_ACL_ADMIN.ADD_PRIVILEGE(ACL_PATH,
     'APEX_040200', TRUE, 'connect');
  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',
    'APEX_040200', TRUE, 'connect');
  DBMS_NETWORK_ACL_ADMIN.ASSIGN_ACL('local-access-users.xml','localhost');
END;
/
COMMIT;

4.4.4.2 Troubleshooting an Invalid ACL Error

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);

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_040200 user. See "Granting Connect Privileges".

4.4.5 Security Considerations

Oracle highly recommends you configure and use a 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.

See Also:

"Requiring HTTPS" in Oracle Application Express Administration Guide

4.4.6 About Running Oracle Application Express in Other Languages

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. At runtime, each user's Web browser language settings determine the specific language version.

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.

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

In a multitenant architecture, the scripts below should be run in each pluggable database (PDB).

4.4.6.1 Installing 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 $ORACLE_HOME/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).

To install a translated version of Oracle Application Express:

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

C shell:

setenv NLS_LANG American_America.AL32UTF8

For Windows based systems:

set NLS_LANG=American_America.AL32UTF8

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the PDB to be configured:

ALTER SESSION SET CONTAINER = <PDB_name>;

Execute the following statement:

ALTER SESSION SET CURRENT_SCHEMA = APEX_040200;

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).

4.4.7 About Managing JOB_QUEUE_PROCESSES

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

Viewing the Number of JOB_QUEUE_PROCESSES

Changing the Number of JOB_QUEUE_PROCESSES

4.4.7.1 Viewing the Number of JOB_QUEUE_PROCESSES

There are currently three ways to view the number of JOB_QUEUE_PROCESSES:

In the installation log file

On the About Application Express page in Oracle Application Express

From SQL*Plus

4.4.7.1.1 Viewing JOB_QUEUE_PROCESSES in the Installation Log File

After installing or upgrading Oracle Application Express to release 4.2, you can view the number of JOB_QUEUE_PROCESSES in the installation log files. See "Reviewing a Log of an Installation Session".

4.4.7.1.2 Viewing JOB_QUEUE_PROCESSES in Oracle Application Express

You can also view the number of JOB_QUEUE_PROCESSES on the About Application Express page.

To view the About Application Express page:

Log in to Oracle Application Express. See "Logging in to Your Oracle Application Express Workspace".

On the Administration list, click About Application Express.

The current number JOB_QUEUE_PROCESSES displays at the bottom of the page.

4.4.7.1.3 Viewing JOB_QUEUE_PROCESSES from SQL*Plus

You can also view the number of JOB_QUEUE_PROCESSES from SQL*Plus by running the following SQL statement:

SELECT VALUE FROM v$parameter WHERE NAME = 'job_queue_processes'

4.4.7.2 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:

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS specifying the SYSDBA role:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

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.

4.4.8 Create a Workspace and Add Oracle Application Express Users

You access the Oracle Application Express home page by logging in to workspace using a Web browser. Your Web browser must support JavaScript and the HTML 4.0 and CSS 1.0 standards. See "Browser Requirements".

A workspace is a virtual private database allowing 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 Oracle Application Express 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. See "Creating Workspaces" and "Managing Workspace Change Requests" in Oracle Application Express Administration Guide.

See Also:

Oracle Database 2 Day + Oracle Application Express Developer's Guide if you are new to Oracle Application Express

Creating a Workspace Manually

Creating Oracle Application Express Users

Logging in to Your Oracle Application Express Workspace

4.4.8.1 Creating a Workspace Manually

To create an Oracle Application Express workspace manually:

Log in to Oracle Application Express Administration Services. Oracle Application Express Administration Services is a separate application for managing an entire Oracle Application Express instance. You log in using the ADMIN account and password created or reset during the installation process.

In a Web browser, navigate to the Oracle Application Express Administration Services application.

If your setup uses the Oracle REST Data Services, go to:

http://hostname:port/apex/apex_admin

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 and Developer Guide.

apex is the service name defined when configuring Oracle REST Data Services.

On the Login page:

In Username, enter admin.

In Password, enter the Oracle Application Express administrator account password you specified when you installed Oracle Application Express.

Click Login.

See Also:

See "Logging in to Oracle Application Express Administration Services" in Oracle Application Express Administration Guide.

Next, create a workspace.

Click Manage Workspaces.

Under Manage Workspaces, click Create Workspace.

The Create Workspace Wizard appears.

For Identify Workspace, enter a workspace name and description and click Next.

For Identify Schema, select the Oracle Forms application schema.

For Re-use existing schema, select Yes.

Select a schema from the list.

Click Next.

For Identify Administrator, enter the Workspace administrator information and click Next.

Confirm your selections and click Create.

4.4.8.2 Creating Oracle Application Express Users

To create an Oracle Application Express user account:

Log in to Oracle Application Express Administration Services as described in the previous section. See "Logging in to Oracle Application Express Administration Services" in Oracle Application Express Administration Guide.

Click Manage Workspaces.

Under Manage Workspaces, click Manage Developers and Users.

The Manage Developers and Users page appears.

Click Create.

The Create/Edit User page appears.

Under User Attributes, enter the appropriate information. Fields marked with an asterisk are required.

Tip:

To learn more about a specific attribute, click the item label. When Help is available, the item label changes to red when you pass your cursor over it and the cursor changes to an arrow and question mark.

Under Password, type a case-sensitive password for this account.

If your organization has set up a password policy, be sure the password meets the requirements.

Under Developer Privileges, select the appropriate privileges:

User is a developer - To add this user as a developer or Workspace administrator, select Yes. For end users, select No.

Developers can create and modify applications and database objects as well as view developer activity, session state, workspace activity, application, and schema reports.

User is a workspace administrator - To add this user as a Workspace administrator, select Yes. For developers or end users, select No.

In addition to having developer privileges, workspace administrators can create and edit user accounts, manage groups, alter passwords of users within the same workspace, and manage development services.

Under Account Control, specify the following:

Account Availability - Select Unlocked to enable a user to log in to this account.

Require Change of Password on First Use - Select Yes to require the user to change the password immediately after logging in with the current, temporary password. Otherwise, select No.

Click Create User or Create and Create Another.

4.4.8.3 Logging in to Your Oracle Application Express Workspace

Once you create a workspace, you must log in to it using your login credentials (that is, the workspace name, user name, and password).

See Also:

See "Creating Workspaces" and "Managing Workspace and Change Requests" in Oracle Application Express Administration Guide

To log in to a workspace:

In a Web browser, navigate to the Oracle Application Express Login page.

If your setup uses Oracle REST Data Services, go to:

http://hostname:port/apex/apex_admin

Where:

hostname is the name of the system where Oracle REST Data Services is installed.

port is the port number assigned when configuring the Oracle REST Data Services. In a default installation, this number is 8080. To learn more, see Oracle REST Data Services Installation and Developer Guide.

apex is the service name defined when configuring Oracle REST Data Services.

The Login page appears.

Under Login, enter the following:

Workspace field - Enter the name of your workspace.

Username field - Enter your user name.

Password field - Enter your case-sensitive password.

Click Login.

Note that, depending on your setup, you might be required to change your password when you log in for the first time.

4.5 Installing from the Database and Configuring the Embedded PL/SQL Gateway

This section describes required post installation configuration tasks when running Oracle Application Express with the embedded PL/SQL gateway.

Install the Oracle Database and Complete Pre-installation Tasks

Load Resources in the XDB Repository

Configure the Embedded PL/SQL Gateway

Enable Network Services in Oracle Database 12c

Security Considerations

About Running Oracle Application Express in Other Languages

About Managing JOB_QUEUE_PROCESSES

Configuring the SHARED_SERVERS Parameter

Create a Workspace and Add Oracle Application Express Users

See Also:

"About the Oracle Application Express Runtime Environment"

4.5.1 Install the Oracle Database and Complete Pre-installation Tasks

Oracle Application Express automatically installs with Oracle Database 11g and later. To learn more about installing the Oracle Database, see the Oracle Database Installation Guide for your operating environment and "Recommended Pre-installation Tasks".

4.5.2 Load Resources in the XDB Repository

In a new or upgrade installation, you load image and static resources into the XDB repository and make them available by running the configuration script apex_epg_config.sql.

To run apex_epg_config.sql configuration script:

Change your working directory to ORACLE_BASE\ORACLE_HOME\apex or whatever convention used to indicate the Oracle home.

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS. For example:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On Unix and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the pluggable database (PDB) to be configured as shown in the following example:

ALTER SESSION SET CONTAINER = <PDB_name>;

Run apex_epg_config.sql passing the file system path to the Oracle home as shown in the following example:

@apex_epg_config /u01/app/product/12.1.0/dbhome_1

4.5.3 Configure the Embedded PL/SQL Gateway

Although the embedded PL/SQL gateway installs with the Oracle Database 12c, you must configure it before you can use it with Oracle Application Express. To accomplish this, you run a configuration script and unlock the ANONYMOUS account.

Note:

The Oracle XML DB Protocol Server with the embedded PL/SQL gateway is not supported before Oracle Database 11g.

Running the apxconf.sql Configuration Script

Verifying the Oracle XML DB Protocol Server Port

Enabling Oracle XML DB Protocol Server

Disabling Oracle XML DB Protocol Server

4.5.3.1 Running the apxconf.sql Configuration Script

In a new installation, you configure the embedded PL/SQL gateway by running the configuration script apxconf.sql. Then, you unlock the ANONYMOUS account.

Note:

If you are upgrading and have previously configured the embedded PL/SQL gateway, skip this section and go to "Enable Network Services in Oracle Database 12c".

To run the apxconf.sql configuration script:

Change your working directory to ORACLE_BASE\ORACLE_HOME\apex or whatever convention used to indicate the Oracle home.

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS. For example:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the pluggable database (PDB) to be configured as shown in the following example:

ALTER SESSION SET CONTAINER = <PDB_name>;

Run apxconf.sql as shown in the following example:

@apxconf

If running in the Oracle Database 12c multitenant architecture, set the container to CDB$ROOT:

ALTER SESSION SET CONTAINER = CDB$ROOT;

Enter the following statement to unlock the ANONYMOUS account:

ALTER USER ANONYMOUS ACCOUNT UNLOCK;

Tip:

If running in the Oracle Database 12c multitenant architecture, you only need to execute steps 5 and 6 once when configuring the first PDB, as you only need to unlock the ANONYMOUS account once in the root container.

Complete appropriate steps in sections "Enable Network Services in Oracle Database 12c" through "Create a Workspace and Add Oracle Application Express Users".

4.5.3.2 Verifying the Oracle XML DB Protocol Server Port

The embedded PL/SQL gateway runs in the Oracle XML DB Protocol Server in the Oracle Database. You can determine if the Oracle XML DB Protocol Server has HTTP enabled by verifying the associated port number.

To verify the HTTP port number where the Oracle XML DB Protocol Server is running:

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS specifying the SYSDBA role:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the pluggable database (PDB) to be verified:

ALTER SESSION SET CONTAINER = <PDB_name>;

Enter the following statement to verify the port number:

SELECT DBMS_XDB.GETHTTPPORT FROM DUAL;

If the port number returns 0, the Oracle XML DB Protocol Server is disabled.

To enable it, follow the instructions in "Enabling Oracle XML DB Protocol Server".

4.5.3.3 Enabling Oracle XML DB Protocol Server

The embedded PL/SQL gateway runs in the Oracle XML DB Protocol Server in the Oracle Database.

To enable Oracle XML DB Protocol Server:

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS. For example:

Windows:

DRIVE_LETTER:\> sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the PDB to enable:

ALTER SESSION SET CONTAINER = <PDB_name>;

Run the following statements:

EXEC DBMS_XDB.SETHTTPPORT(port);
COMMIT;

For example:

EXEC DBMS_XDB.SETHTTPPORT(8080);
COMMIT;

Note:

Port numbers less than 1024 are reserved for use by privileged processes on many operating systems. To enable the XML DB Protocol Server on a port less than 1024, such as 80, review the following documentation:

"Accessing the Repository Using Protocols" and "Oracle XML DB Protocol Server Configuration Management" in Oracle XML DB Developer's Guide.

"Protocol Address Configuration" and "Port Number Limitations" in Oracle Database Net Services Reference.

4.5.3.4 Disabling Oracle XML DB Protocol Server

The embedded PL/SQL gateway runs in the Oracle XML DB Protocol Server in the Oracle Database.

To disable Oracle XML DB Protocol Server:

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS. For example:

Windows:

DRIVE_LETTER:\> sqlplus /nolog
SQL> SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

UNIX and Linux:

$ sqlplus /nolog
SQL> SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the pluggable database (PDB) to disable:

ALTER SESSION SET CONTAINER = <PDB_name>;

Run the following statements:

EXEC DBMS_XDB.SETHTTPPORT(0);
COMMIT;

4.5.4 Enable Network Services in Oracle Database 12c

By default, the ability to interact with network services is disabled in Oracle Database 12c. Therefore, if you are running Oracle Application Express with Oracle Database 12c, you must use the new DBMS_NETWORK_ACL_ADMIN package to grant connect privileges to any host for the APEX_040200 database user. Failing to grant these privileges results in issues with:

Sending outbound mail in Oracle Application Express.

Users can call methods from the APEX_MAIL package, but issues arise when sending outbound email.

Using Web services in Oracle Application Express.

PDF report printing.

Granting Connect Privileges

Troubleshooting an Invalid ACL Error

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 Oracle Database 12c already has the parameter set properly, but a database upgraded to Oracle Database 12c from a prior version may not. See "Creating and Configuring an Oracle Database" in Oracle Database Administrator's Guide for information about changing database initialization parameters.

The examples below should be modified according to your environment and in a 12c multitenant architecture, should be run on each pluggable database (PDB).

4.5.4.1 Granting Connect Privileges

The following example demonstrates how to grant connect privileges to any host for the APEX_040200 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_040200
  -- the "connect" privilege if APEX_040200 does not have the privilege yet.

  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_040200',
     'connect') IS NULL THEN
      DBMS_NETWORK_ACL_ADMIN.ADD_PRIVILEGE(ACL_PATH,
     'APEX_040200', 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',
    'APEX_040200', TRUE, 'connect');
  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 is used to enable 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_040200
  -- the "connect" privilege if APEX_040200 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_040200',
     'connect') IS NULL THEN
      DBMS_NETWORK_ACL_ADMIN.ADD_PRIVILEGE(ACL_PATH,
     'APEX_040200', TRUE, 'connect');
  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',
    'APEX_040200', TRUE, 'connect');
  DBMS_NETWORK_ACL_ADMIN.ASSIGN_ACL('local-access-users.xml','localhost');
END;
/
COMMIT;

4.5.4.2 Troubleshooting an Invalid ACL Error

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);

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_040200 user. See "Granting Connect Privileges".

4.5.5 Security Considerations

Oracle highly recommends you configure and use a 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.

See Also:

"Requiring HTTPS" in Oracle Application Express Administration Guide

4.5.6 About Running Oracle Application Express in Other Languages

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. At runtime, each user's Web browser language settings determine the specific language version.

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.

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

4.5.6.1 Installing 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 of directory, there is a language loading script identified by the language code (for example, load_de.sql or load_ja.sql).

To install a translated version of Oracle Application Express:

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

C shell:

setenv NLS_LANG American_America.AL32UTF8

For Windows based systems:

set NLS_LANG=American_America.AL32UTF8

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the pluggable database (PDB) to be configured:

ALTER SESSION SET CONTAINER = <PDB_name>;

Execute the following statement:

ALTER SESSION SET CURRENT_SCHEMA = APEX_040200;

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).

4.5.7 About Managing JOB_QUEUE_PROCESSES

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

Viewing the Number of JOB_QUEUE_PROCESSES

Changing the Number of JOB_QUEUE_PROCESSES

4.5.7.1 Viewing the Number of JOB_QUEUE_PROCESSES

There are currently three ways to view the number of JOB_QUEUE_PROCESSES:

In the installation log file

On the About Application Express page in Oracle Application Express

From SQL*Plus

4.5.7.1.1 Viewing JOB_QUEUE_PROCESSES in the Installation Log File

After installing or upgrading Oracle Application Express to release 4.2, you can view the number of JOB_QUEUE_PROCESSES in the installation log files. See "Reviewing a Log of an Installation Session".

4.5.7.1.2 Viewing JOB_QUEUE_PROCESSES in Oracle Application Express

You can also view the number of JOB_QUEUE_PROCESSES on the About Application Express page.

To view the About Application Express page:

Log in to Oracle Application Express. See "Logging in to Your Oracle Application Express Workspace".

On the Administration list, click About Application Express.

The current number JOB_QUEUE_PROCESSES displays at the bottom of the page.

4.5.7.1.3 Viewing JOB_QUEUE_PROCESSES from SQL*Plus

You can also view the number of JOB_QUEUE_PROCESSES from SQL*Plus by running the following SQL statement:

SELECT VALUE FROM v$parameter WHERE NAME = 'job_queue_processes'

4.5.7.2 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:

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS specifying the SYSDBA role:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

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.

4.5.8 Configuring the SHARED_SERVERS Parameter

The embedded PL/SQL gateway uses the shared server architecture of the Oracle Database. To achieve acceptable performance when using the embedded PL/SQL gateway, ensure the SHARED_SERVERS database initialization parameter is set to a reasonable value (that is, not 0 or 1). For a small group of concurrent users, Oracle recommends a value of 5 for SHARED_SERVERS.

Consider the following example:

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Run the following statement:

ALTER SYSTEM SET SHARED_SERVERS = 5 SCOPE=BOTH;

4.5.9 Create a Workspace and Add Oracle Application Express Users

You access the Oracle Application Express home page by logging in to workspace using a Web browser. Your Web browser must support JavaScript and the HTML 4.0 and CSS 1.0 standards. See "Browser Requirements".

A workspace is a virtual private database allowing 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 Oracle Application Express 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. See "Creating Workspaces" and "Managing Workspace Requests" in Oracle Application Express Administration Guide.

See Also:

Oracle Database 2 Day + Oracle Application Express Developer's Guide if you are new to Oracle Application Express

Creating a Workspace Manually

Creating Oracle Application Express Users

Logging in to Your Oracle Application Express Workspace

4.5.9.1 Creating a Workspace Manually

To create an Oracle Application Express workspace manually:

Log in to Oracle Application Express Administration Services. Oracle Application Express Administration Services is a separate application for managing an entire Oracle Application Express instance. You log in using the ADMIN account and password created or reset during the installation process.

In a Web browser, navigate to the Oracle Application Express Administration Services application.

Because your setup uses the embedded PL/SQL gateway, go 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 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.

On the Login page:

In Username, enter admin.

In Password, enter the Oracle Application Express administrator account password you specified when you installed Oracle Application Express.

Click Login.

See Also:

See "Logging in to Oracle Application Express Administration Services" in Oracle Application Express Administration Guide.

Next, create a workspace.

Click Manage Workspaces.

Under Manage Workspaces, click Create Workspace.

The Create Workspace Wizard appears.

For Identify Workspace, enter a workspace name and description and click Next.

For Identify Schema, select the Oracle Forms application schema.

For Re-use existing schema, select Yes.

Select a schema from the list.

Click Next.

For Identify Administrator, enter the Workspace administrator information and click Next.

Confirm your selections and click Create.

4.5.9.2 Creating Oracle Application Express Users

To create an Oracle Application Express user account:

Log in to Oracle Application Express Administration Services as described in the previous section. See "Logging in to Oracle Application Express Administration Services" in Oracle Application Express Administration Guide.

Click Manage Workspaces.

Under Manage Workspaces, click Manage Developers and Users.

The Manage Developers and Users page appears.

Click Create.

The Create/Edit User page appears.

Under User Attributes, enter the appropriate information. Fields marked with an asterisk are required.

Tip:

To learn more about a specific attribute, click the item label. When Help is available, the item label changes to red when you pass your cursor over it and the cursor changes to an arrow and question mark.

Under Password, type a case-sensitive password for this account.

If your organization has set up a password policy, be sure the password meets the requirements.

Under Developer Privileges, select the appropriate privileges:

User is a developer - To add this user as a developer or Workspace administrator, select Yes. For end users, select No.

Developers can create and modify applications and database objects as well as view developer activity, session state, workspace activity, application, and schema reports.

User is a workspace administrator - To add this user as a Workspace administrator, select Yes. For developers or end users, select No.

In addition to having developer privileges, workspace administrators can create and edit user accounts, manage groups, alter passwords of users within the same workspace, and manage development services.

Under Account Control, specify the following:

Account Availability - Select Unlocked to enable a user to log in to this account.

Require Change of Password on First Use - Select Yes to require the user to change the password immediately after logging in with the current, temporary password. Otherwise, select No.

Click Create User or Create and Create Another.

4.5.9.3 Logging in to Your Oracle Application Express Workspace

Once you create a workspace, you must log in to it using your login credentials (that is, the workspace name, user name, and password).

See Also:

See "Creating Workspaces" and "Managing Workspace Requests" in Oracle Application Express Administration Guide

To log in to a workspace:

In a Web browser, navigate to the Oracle Application Express Login page.

If your setup uses the embedded PL/SQL gateway, go to:

http://hostname:port/apex

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 multitenant architecture then each PDB will have a distinct port number.

apex is the database access descriptor (DAD) defined in the configuration file.

For users who have upgraded from earlier releases, or who have a custom configuration, this value may be htmldb or something else. Verify your DAD with your Oracle Application Express administrator.

The Login page appears.

Under Login, enter the following:

Workspace field - Enter the name of your workspace.

Username field - Enter your user name.

Password field - Enter your case-sensitive password.

Click Login.

Note that, depending on your setup, you might be required to change your password when you log in for the first time.

4.6 Installing from the Database and Configuring the Oracle HTTP Server

This section describes how to configure Oracle HTTP Server with mod_plsql distributed with Oracle Database 12c.

Install the Oracle Database and Complete Pre-installation Tasks

Configure Oracle HTTP Server Distributed with Oracle Database 12c

Enable Network Services in Oracle Database 12c

Security Considerations

About Running Oracle Application Express in Other Languages

About Managing JOB_QUEUE_PROCESSES

About Obfuscating PlsqlDatabasePassword Parameter

Create a Workspace and Add Oracle Application Express Users

Note:

Within the context of this section, the Oracle home directory (ORACLE_HTTPSERVER_HOME) is the location where Oracle HTTP Server is installed.

4.6.1 Install the Oracle Database and Complete Pre-installation Tasks

Oracle Application Express automatically installs with Oracle Database 11g and later. To learn more about installing the Oracle Database, see the Oracle Database Installation Guide for your operating environment and "Recommended Pre-installation Tasks".

4.6.2 Configure Oracle HTTP Server Distributed with Oracle Database 12c

Perform these post installation steps if all of the following statements are true:

You are using a version of Oracle Application Express that installs with Oracle Database 12c or later.

You are not upgrading from a previous release. This is a new installation of Oracle Application Express.

You are running Oracle HTTP Server distributed with Oracle Database 12c.

This section contains the following topics:

Change the Password for the ADMIN Account

Unlock the APEX_PUBLIC_USER Database User

Change the Password for the APEX_PUBLIC_USER Database User

Copy the Images Directory

Configure Oracle HTTP Server 12c

Note:

Within the context of this section, the Oracle home directory (ORACLE_HTTPSERVER_HOME) is the location where Oracle HTTP Server is installed.

4.6.2.1 Change the Password for the ADMIN Account

First, change the password for the Oracle Application Express ADMIN account. In the multitenant architecture, this should only be done in the pluggable database (PDB) to be configured and never in the CDB$ROOT container.

Tip:

If you are upgrading from a prior release of Oracle Application Express, this step is unnecessary.

To change the password for the ADMIN account:

Change your working directory to ORACLE_BASE\ORACLE_HOME\apex or whatever convention used to indicate the Oracle home.

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS. For example:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the PDB to be configured:

ALTER SESSION SET CONTAINER = <PDB_name>;

Run apxchpwd.sql. For example:

@apxchpwd.sql

When prompted enter a password for the ADMIN account.

4.6.2.2 Unlock the APEX_PUBLIC_USER Database User

When configuring Oracle HTTP Server for Oracle Application Express in a new installation, the database user APEX_PUBLIC_USER must be an unlocked account. To unlock the account for database user APEX_PUBLIC_USER, execute the following steps:

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS. For example:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Run the following statement:

ALTER USER APEX_PUBLIC_USER ACCOUNT UNLOCK

4.6.2.3 Change the Password for the APEX_PUBLIC_USER Database User

In order to specify the password in the DAD file, you have to change the password for the database user APEX_PUBLIC_USER. Please use the following steps to change the password for the APEX_PUBLIC_USER database user:

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS. For example:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Run the following statement:

SQL> PASSWORD APEX_PUBLIC_USER
Changing password for APEX_PUBLIC_USER
New password: password
Retype new password: password

4.6.2.3.1 About Password Expiration in Oracle Database 12c

In the default profile in Oracle Database 12c, the parameter PASSWORD_LIFE_TIME is set to 180. If you are using Oracle Database 12c 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.

To prevent this behavior, create another profile in which the PASSWORD_LIFE_TIME parameter is set to unlimited and alter the APEX_PUBLIC_USER account and assign it the new profile.

To create a profile where the password does not expire in a non-CDB, follow these steps:

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS. For example:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Run the following statement:

SQL> create profile c##apex_pub_profile LIMIT PASSWORD_LIFE_TIME UNLIMITED;
alter user APEX_PUBLIC_USER profile c##apex_pub_profile;

See Also:

Oracle Database Security Guide for information on creating profiles and assigning them to database users.

To create a profile where the password does not expire in a CDB, follow these steps:

Start SQL*Plus and connect to CDB$ROOT of the database where Oracle Application Express is installed as SYS. For example:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Run the following statement:

SQL> create profile c##apex_pub_profile LIMIT
    PASSWORD_LIFE_TIME UNLIMITED;
    alter user APEX_PUBLIC_USER profile c##apex_pub_profile;

See Also:

Oracle Database Security Guide for information on creating profiles and assigning them to database users.

4.6.2.4 Copy 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 to the location on the file system containing the Oracle home for Oracle HTTP Server.

During an upgrade, to ensure that you can revert to the previous version, rename your existing images directory for Oracle Application Express, indicating the release number of the images.

To locate the images directory on the file system, review the following files for the text alias /i/:

Oracle HTTP Server distributed Oracle9i Release 2—see the httpd.conf file.

Oracle Application Server 10g—see the marvel.conf or dads.conf files.

Oracle HTTP Server distributed with Oracle Database 11g or 12c —see the marvel.conf or dads.conf files.

When you locate the images directory path, rename the existing images directory to a backup location. Doing so enables you to revert to the previous release, if that becomes necessary.

Use the following command syntax to copy the apex\images directory from the Oracle Database home to a path in the Oracle HTTP Server home:

Oracle HTTP Server distributed with Oracle Database 12c:

On Windows:

xcopy /E /I ORACLE_HOME\apex\images ORACLE_HTTPSERVER_HOME\user_projects\domains\base_domain\images

On UNIX and Linux:

cp -rf $ORACLE_HOME/apex/images ORACLE_HTTPSERVER_HOME/user_projects/domains/base_domain

In the preceding syntax examples:

ORACLE_HOME is the Oracle Database 12c Oracle home

ORACLE_HTTPSERVER_HOME is the existing Oracle Application Server or Oracle HTTP Server Oracle home

4.6.2.5 Configure Oracle HTTP Server 12c

Perform the following post installation steps if:

You are running Oracle HTTP Server 12c.

Oracle HTTP Server is installed in an Oracle home.

Note:

Within the context of this document, ORACLE_HTTPSERVER_HOME is the location where Oracle HTTP Server is installed.

Editing the dads.conf File

Stopping and Restarting Oracle HTTP Server 12c

4.6.2.5.1 Editing the dads.conf File

If this is a new installation of Oracle Application Express, you must edit the dads.conf file. The dads.conf file contains the information about the DAD to access Oracle Application Express.

To edit the dads.conf file:

Use a text editor and open the dads.conf.

Oracle HTTP Server distributed with Oracle Database 12c:

On Windows see:

ORACLE_HTTPSERVER_HOME\user_projects\domains\base_domain\config\fmwconfig\components\OHS\instances\ohs1\mod_plsql\dads.conf

On UNIX and Linux see:

ORACLE_HTTPSERVER_HOME/user_projects/domains/base_domain/config/fmwconfig/components/OHS/instances/ohs1/mod_plsql/dads.conf

Note:

In the examples above, ohs1 refers to the name of the Oracle HTTP Server instance. When running the Oracle HTTP Server Configuration Wizard, the default name is ohs1. It may have been changed to a name other than ohs1.

In the dads.conf file, replace ORACLE_HTTPSERVER_HOME, host, port, service_name, and apex_public_user_password with values appropriate for your environment. Note that the apex_public_user_password is the password you changed in "Change the Password for the APEX_PUBLIC_USER Database User". Also note that the service_name should be the service name of the PDB if configuring a multitenant architecture. It should never be the service_name of the CDB$ROOT container.

Note that the path listed is only an example. The path in the dads.conf file should reference the file system path described in "Copy the Images Directory". Also, if your are configuring an Oracle Application Express instance in a multitenant architecture, be sure to use the service name of the pluggable database (PDB) to be enabled. Never use the service name of the CDB$ROOT container.

Alias /i/ "ORACLE_HTTPSERVER_HOME/user_projects/domains/base_domain/images/"

<Location /pls/apex>
 Order deny,allow
 PlsqlDocumentPath docs
 AllowOverride None
 PlsqlDocumentProcedure         wwv_flow_file_mgr.process_download
 PlsqlDatabaseConnectString     host:port:service_name ServiceNameFormat
 PlsqlNLSLanguage               AMERICAN_AMERICA.AL32UTF8
 PlsqlAuthenticationMode        Basic
 SetHandler                     pls_handler
 PlsqlDocumentTablename         wwv_flow_file_objects$
 PlsqlDatabaseUsername          APEX_PUBLIC_USER
 PlsqlDefaultPage               apex
 PlsqlDatabasePassword          apex_public_user_password
 PlsqlRequestValidationFunction wwv_flow_epg_include_modules.authorize
 Allow from all
</Location>

Locate the line containing PlsqlNLSLanguage.

The PlsqlNLSLanguage setting determines the language setting of the DAD. The character set portion of the PlsqlNLSLanguage value must be set to AL32UTF8, regardless of whether or not the database character set is AL32UTF8. For example:

...
PlsqlNLSLanguage            AMERICAN_AMERICA.AL32UTF8
...

Save and exit the dads.conf file.

4.6.2.5.2 Stopping and Restarting Oracle HTTP Server 12c

To stop and restart the Oracle HTTP Server, enter commands using the following syntax, where DOMAIN_HOME is the path to the Oracle HTTP Server domain:

Linux:

$DOMAIN_HOME/bin/stopComponent.sh componentName

Windows:

%DOMAIN_HOME%\bin\stopComponent.cmd componentName

In a default installation, componentName is ohs1 but may have been changed when running the Oracle HTTP Server Configuration Wizard.

4.6.3 Enable Network Services in Oracle Database 12c

By default, the ability to interact with network services is disabled in Oracle Database 12c Release 1 (12.1). Therefore, if you are running Oracle Application Express with Oracle Database 12c Release 1 (12.1), you must use the new DBMS_NETWORK_ACL_ADMIN package to grant connect privileges to any host for the APEX_040200 database user. Failing to grant these privileges results in issues with:

Sending outbound mail in Oracle Application Express.

Users can call methods from the APEX_MAIL package, but issues arise when sending outbound email.

Using Web services in Oracle Application Express.

PDF report printing.

Granting Connect Privileges

Troubleshooting an Invalid ACL Error

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, Oracle Database 12c already has the parameter set properly, but a database upgraded to Oracle Database 12c from a prior version may not. See "Creating and Configuring an Oracle Database" in Oracle Database Administrator's Guide for information about changing database initialization parameters.

The examples below should be modified according to your environment and in an Oracle Database 12c multitenant architecture, should be run on each PDB.

4.6.3.1 Granting Connect Privileges

The following example demonstrates how to grant connect privileges to any host for the APEX_040200 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_040200
  -- the "connect" privilege if APEX_040200 does not have the privilege yet.

  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_040200',
     'connect') IS NULL THEN
      DBMS_NETWORK_ACL_ADMIN.ADD_PRIVILEGE(ACL_PATH,
     'APEX_040200', 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',
    'APEX_040200', TRUE, 'connect');
  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 is used to enable 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_040200
  -- the "connect" privilege if APEX_040200 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_040200',
     'connect') IS NULL THEN
      DBMS_NETWORK_ACL_ADMIN.ADD_PRIVILEGE(ACL_PATH,
     'APEX_040200', TRUE, 'connect');
  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',
    'APEX_040200', TRUE, 'connect');
  DBMS_NETWORK_ACL_ADMIN.ASSIGN_ACL('local-access-users.xml','localhost');
END;
/
COMMIT;

4.6.3.2 Troubleshooting an Invalid ACL Error

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);

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_040200 user. See "Granting Connect Privileges".

4.6.4 Security Considerations

Oracle highly recommends you configure and use 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.

See Also:

"Requiring HTTPS" in Oracle Application Express Administration Guide

4.6.5 About Running Oracle Application Express in Other Languages

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. At runtime, each user's Web browser language settings determine the specific language version.

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.

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

4.6.5.1 Installing 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 of directory, there is a language loading script identified by the language code (for example, load_de.sql or load_ja.sql).

To install a translated version of Oracle Application Express:

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

C shell:

setenv NLS_LANG American_America.AL32UTF8

For Windows based systems:

set NLS_LANG=American_America.AL32UTF8

If running in the Oracle Database 12c multitenant architecture, set the container to the pluggable database (PDB) to be configured:

ALTER SESSION SET CONTAINER = <PDB_name>;

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Execute the following statement:

ALTER SESSION SET CURRENT_SCHEMA = APEX_040200;

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).

4.6.6 About Managing JOB_QUEUE_PROCESSES

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

Viewing the Number of JOB_QUEUE_PROCESSES

Changing the Number of JOB_QUEUE_PROCESSES

4.6.6.1 Viewing the Number of JOB_QUEUE_PROCESSES

There are currently three ways to view the number of JOB_QUEUE_PROCESSES:

In the installation log file

On the About Application Express page in Oracle Application Express

From SQL*Plus

4.6.6.1.1 Viewing JOB_QUEUE_PROCESSES in the Installation Log File

After installing or upgrading Oracle Application Express to release 4.2, you can view the number of JOB_QUEUE_PROCESSES in the installation log files. See "Reviewing a Log of an Installation Session".

4.6.6.1.2 Viewing JOB_QUEUE_PROCESSES in Oracle Application Express

You can also view the number of JOB_QUEUE_PROCESSES on the About Application Express page.

To view the About Application Express page:

Log in to Oracle Application Express. See "Logging in to Your Oracle Application Express Workspace".

On the Administration list, click About Application Express.

The current number JOB_QUEUE_PROCESSES displays at the bottom of the page.

4.6.6.1.3 Viewing JOB_QUEUE_PROCESSES from SQL*Plus

You can also view the number of JOB_QUEUE_PROCESSES from SQL*Plus by running the following SQL statement:

SELECT VALUE FROM v$parameter WHERE NAME = 'job_queue_processes'

4.6.6.2 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:

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS specifying the SYSDBA role:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

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.

4.6.7 About Obfuscating PlsqlDatabasePassword Parameter

The PlsqlDatabasePassword parameter specifies the password for logging in to the database. You can use the dadTool.pl utility to obfuscate passwords in the dads.conf file.

You can find the dadTool.pl utility in the following directory:

For UNIX and Linux based systems:

ORACLE_BASE/ORACLE_HTTPSERVER_HOME/Apache/modplsql/conf

For Windows based systems:

ORACLE_BASE\ORACLE_HTTPSERVER_HOME\Apache\modplsql\conf

4.6.7.1 Obfuscating Passwords

To obfuscate passwords, run dadTool.pl by following the instructions in the dadTool.README file.

4.6.8 Create a Workspace and Add Oracle Application Express Users

You access the Oracle Application Express home page by logging in to workspace using a Web browser. Your Web browser must support JavaScript and the HTML 4.0 and CSS 1.0 standards. See "Browser Requirements".

A workspace is a virtual private database allowing 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 Oracle Application Express 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. See "Creating Workspaces" and "Managing Workspace Requests" in Oracle Application Express Administration Guide.

See Also:

Oracle Database 2 Day + Oracle Application Express Developer's Guide if you are new to Oracle Application Express

Creating a Workspace Manually

Creating Oracle Application Express Users

Logging in to Your Oracle Application Express Workspace

4.6.8.1 Creating a Workspace Manually

To create an Oracle Application Express workspace manually:

Log in to Oracle Application Express Administration Services. Oracle Application Express Administration Services is a separate application for managing an entire Oracle Application Express instance. You log in using the ADMIN account and password created or reset during the installation process.

If your setup uses Apache and mod_plsql, go to:

http://hostname:port/pls/apex/apex_admin

Where:

hostname is the name of the system where Oracle HTTP Server is installed.

port is the port number assigned to HTTP on the Oracle HTTP Server. In a default installation, this number is 7777.

pls is the indicator to use the mod_plsql cartridge.

apex is the database access descriptor (DAD) defined in the mod_plsql configuration file.

See Also:

See "Logging in to Oracle Application Express Administration Services" in Oracle Application Express Administration Guide.

Next, create a workspace.

Click Manage Workspaces.

Under Manage Workspaces, click Create Workspace.

The Create Workspace Wizard appears.

For Identify Workspace, enter a workspace name and description and click Next.

For Identify Schema, select the Oracle Forms application schema.

For Re-use existing schema, select Yes.

Select a schema from the list.

Click Next.

For Identify Administrator, enter the Workspace administrator information and click Next.

Confirm your selections and click Create.

4.6.8.2 Creating Oracle Application Express Users

To create an Oracle Application Express user account:

Log in to Oracle Application Express Administration Services as described in the previous section. See "Logging in to Oracle Application Express Administration Services" in Oracle Application Express Administration Guide.

Click Manage Workspaces.

Under Manage Workspaces, click Manage Developers and Users.

The Manage Developers and Users page appears.

Click Create.

The Create/Edit User page appears.

Under User Attributes, enter the appropriate information. Fields marked with an asterisk are required.

Tip:

To learn more about a specific attribute, click the item label. When Help is available, the item label changes to red when you pass your cursor over it and the cursor changes to an arrow and question mark.

Under Password, type a case-sensitive password for this account.

If your organization has set up a password policy, be sure the password meets the requirements.

Under Developer Privileges, select the appropriate privileges:

User is a developer - To add this user as a developer or Workspace administrator, select Yes. For end users, select No.

Developers can create and modify applications and database objects as well as view developer activity, session state, workspace activity, application, and schema reports.

User is a workspace administrator - To add this user as a Workspace administrator, select Yes. For developers or end users, select No.

In addition to having developer privileges, workspace administrators can create and edit user accounts, manage groups, alter passwords of users within the same workspace, and manage development services.

Under Account Control, specify the following:

Account Availability - Select Unlocked to enable a user to log in to this account.

Require Change of Password on First Use - Select Yes to require the user to change the password immediately after logging in with the current, temporary password. Otherwise, select No.

Click Create User or Create and Create Another.

4.6.8.3 Logging in to Your Oracle Application Express Workspace

Once you create a workspace, you must log in to it using your login credentials (that is, the workspace name, user name, and password).

See Also:

See "Creating Workspaces" and "Managing Workspace Requests" in Oracle Application Express Administration Guide

To log in to a workspace:

In a Web browser, navigate to the Oracle Application Express Login page. By default, Oracle Application Express installs to the following location:

If your setup uses Oracle HTTP Server (Apache) and mod_plsql, go to:

http://hostname:port/pls/apex

Where:

hostname is the name of the system where Oracle HTTP Server is installed.

port is the port number assigned to HTTP on the Oracle HTTP Server. In a default installation, this number is 7777. You can find information about your Oracle HTTP Server installation's port number from either of the following files:

ORACLE_BASE\ORACLE_HOME\install\portlist.ini
ORACLE_BASE\ORACLE_HTTPSERVER_HOME\Apache\Apache\conf\httpd.conf

Be aware that if you change a port number, it is not updated in the portlist.ini file. You can only rely on this file immediately after installation.

pls is the indicator to use the mod_plsql cartridge.

apex is the database access descriptor (DAD) defined in the mod_plsql configuration file.

For users who have upgraded from earlier releases, or who have a custom configuration, this value may be htmldb or something else. Verify your DAD with your Oracle Application Express administrator.

The Login page appears.

Under Login, enter the following:

Workspace field - Enter the name of your workspace.

Username field - Enter your user name.

Password field - Enter your case-sensitive password.

Click Login.

Note that, depending on your setup, you might be required to change your password when you log in for the first time.

4.7 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.

Remove Prior Oracle Application Express Installations

Fix Invalid ACL in Oracle Database 11g Release 1 (11.1) and Later

4.7.1 Remove Prior Oracle Application Express Installations

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.

4.7.1.1 Verify if Prior Installation Exist

To verify if prior installations exist:

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS. For example:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the PDB to be configured:

ALTER SESSION SET CONTAINER = <PDB_name>;

Run the following query:

SELECT username
   FROM dba_users
 WHERE (username LIKE 'FLOWS_%' OR USERNAME LIKE 'APEX_%')
   AND USERNAME NOT IN (
        SELECT 'FLOWS_FILES'
          FROM DUAL
         UNION
        SELECT 'APEX_PUBLIC_USER' FROM DUAL
         UNION
        SELECT SCHEMA s
           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.

4.7.1.2 Remove Schemas from Prior Installations

To remove schemas from prior installations:

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the PDB to be configured:

ALTER SESSION SET CONTAINER = <PDB_name>;

Execute a statement connected similar to the following example:

DROP USER FLOWS_030000 CASCADE;

4.7.2 Fix Invalid ACL in Oracle Database 11g Release 1 (11.1) and Later

After following the instructions in"Remove Prior Oracle Application Express Installations", you may need to fix an invalid ACL if you are running Oracle Database 12c and you enabled network services for the prior Oracle Application Express schema.

To fix an invalid ACL:

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

If running in the Oracle Database 12c multitenant architecture, set the container to the pluggable database (PDB) to be configured:

ALTER SESSION SET CONTAINER = <PDB_name>;

Execute a statement similar to following:

EXEC DBMS_NETWORK_ACL_ADMIN.DELETE_PRIVILEGE('power_users.xml', 'FLOWS_030000');

4.8 About the Oracle Application Express Runtime Environment

The Oracle Application Express runtime environment enables you to run production applications. It 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 the Oracle Application Express runtime environment using SQL*Plus or SQL Developer and the APEX_INSTANCE_ADMIN API. To learn more see, "Managing a Runtime Environment" and in Oracle Application Express Application Builder User's Guide.

Convert a Runtime Environment to a Full Development Environment - Oracle Database 12c Non-CDB

Convert a Runtime Environment to a Full Development Environment - Oracle Database 12c Multitenant Architecture

Convert a Full Development Environment to a Runtime Environment - Oracle Database 12c Non-CDB

Convert a Full Development Environment to a Runtime Environment - Oracle Database 12c Multitenant Architecture

4.8.1 Convert a Runtime Environment to a Full Development Environment - Oracle Database 12c Non-CDB

To convert an Oracle Application Express runtime environment to a full development environment:

Change your working directory to $ORACLE_HOME/apex.

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Run apxdvins.sql. For example:

@apxdvins

See Also:

Oracle Database PL/SQL Language Reference for more information about SQL*Plus

4.8.2 Convert a Runtime Environment to a Full Development Environment - Oracle Database 12c Multitenant Architecture

To convert an Oracle Application Express runtime environment to a full development environment in an Oracle Databases 12c multitenant architecture where Oracle Application Express is installed in the CDB$ROOT:

Change your working directory to $ORACLE_HOME/apex.

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Run apxdvins_con.sql. For example:

@apxdvins_con.sql

4.8.3 Convert a Full Development Environment to a Runtime Environment - Oracle Database 12c Non-CDB

To convert an Oracle Application Express full development environment to a runtime environment in an Oracle Database 12c non-CDB (standalone):

Change your working directory to $ORACLE_HOME/apex.

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Run apxdevrm.sql. For example:

@apxdevrm

Follow the instructions in "Change the Password for the ADMIN Account".

See Also:

Oracle Database PL/SQL Language Reference for more information about SQL*Plus

4.8.4 Convert a Full Development Environment to a Runtime Environment - Oracle Database 12c Multitenant Architecture

To convert an Oracle Application Express full development environment to a runtime environment in Oracle Database 12c multitenant architecture with Oracle Application Express installed in CDB$ROOT:

Change your working directory to $ORACLE_HOME/apex.

Start SQL*Plus and connect to the database where Oracle 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
SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Run apxdevrm_con.sql. For example:

@apxdevrm_con.sql

Follow the instructions in "Change the Password for the ADMIN Account".

A Oracle Application Express Troubleshooting

This appendix contains information on troubleshooting.

Reviewing a Log of an Installation Session

Verifying the Validity of an Oracle Application Express Installation

Cleaning Up After a Failed Installation

Images Displaying Incorrectly in Oracle Application Express

Page Protection Violation

A.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_040200 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.

A.2 Verifying the Validity of an Oracle Application Express Installation

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.

A.3 Cleaning Up After a Failed Installation

In a successful installation the following banner displays at the end of the installation:

Thank you for installing Oracle Application Express.
Oracle Application Express is installed in the APEX_040200 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.

Removing Oracle Application Express from the Database

A.3.1 Removing Oracle Application Express from the Database

This section describes how to remove the Oracle Application Express schema, synonyms, and users from the database without deleting the database. If you are going to delete the database, then you must complete these steps.

To remove Oracle Application Express from the Oracle Database 12c non-CDB where Oracle Application Express is not installed in the CDB$ROOT:

Change your working directory to $ORACLE_HOME/apex.

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS specifying the SYSDBA role:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Execute the following command:

SQL> @apxremov.sql

After successfully removing Application Express using apxremov.sql, you must exit your current SQL*Plus session and reconnect prior to attempting another install using apexins.sql.

To remove Oracle Application Express from the database in 12c multitenant architecture where Oracle Application Express is installed in the CDB$ROOT:

Change your working directory to $ORACLE_HOME/apex.

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS specifying the SYSDBA role:

On Windows:

SYSTEM_DRIVE:\ sqlplus /nolog
SQL> SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

On UNIX and Linux:

$ sqlplus /nolog
SQL> SQL> CONNECT SYS as SYSDBA
Enter password: SYS_password

Execute the following command:

SQL> @apxremov_con.sql

After successfully removing Application Express using apxremov_con.sql, you must exit your current SQL*Plus session and reconnect prior to attempting another install using apexins_con.sql.

A.4 Images Displaying Incorrectly in Oracle Application Express

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:

If possible, rename the first instance of /i/ to a different alias name.

Alternatively, copy the images from the ORACLE_HOME\apex\images directory to the directory defined by the first /i/ alias.

A.5 Page Protection Violation

This may be caused by manual alteration of protected page items. If this error occurs after installation when trying to log into Application Express, then stop and start Oracle REST Data Services. If you are unsure of what caused this error, please contact the application administrator for assistance.

To learn more about stopping and starting Oracle REST Data Services, see Oracle REST Data Services Installation and Developer Guide.

Index

A  B  C  D  E  G  I  J  L  N  O  P  R  S  T  U  W  X 

A

ACL

fixing invalid, 4.7.2

Application Express

browser requirement, 2.2

database requirement, 2.1

disk space requirements, 2.4

getting started, 4.5.9, 4.6.8

logging in to, 4.4.8, 4.5.9, 4.6.8

patching, 4.1

PL/SQL Web Toolkit requirement, 2.6

pre-installation tasks, 4.2

Web Listener requirement, 2.3

XML DB requirement, 2.5

Application Express Administration Services, 4.4.8.1, 4.5.9.1, 4.6.8.1

Application Express users

controlling account availability, 4.4.8.2, 4.5.9.2, 4.6.8.2

requiring password change, 4.4.8.2, 4.5.9.2, 4.6.8.2

apxconf.sql, 4.5.3.1

apxdevrm_con.sql, 4.8.4

apxdevrm.sql, 4.8.3

apxdvins_con.sql, 4.8.2

apxdvins.sql, 4.8.1

Automatic Storage Management (ASM)

shutting down, 4.2

B

browser

requirement, 2.2

C

CDBs

patching Application Express, 3.2.5.1

reinstalling Application Express, 3.1.3

uninstalling Application Express, 3.1.1

configuring

Oracle Application Server 11g, 4.6.2.5

Oracle Application Server 11g (new), 4.6.2

Oracle HTTP Server 11g, 4.6.2.5

Oracle HTTP Server 11g (new), 4.6.2

D

dadTool.pl utility, 4.6.7

database installation

backing up Oracle database, 4.2

configuring embedded PL/SQL gateway, 4.5.3

configuring Oracle Application Server 11g, 4.6.2.5

copying images (when upgrading), 4.6.2.4

downloading from and configuring embedded PL/SQL gateway, 4, 4.5

fixing invalid ACL, 4.7.2

installing in other languages, 4.6.5

installing other languages, 4.5.6

logging in to Application Express, 4.5.9, 4.6.8

managing JOB_QUEUE_PROCESSES, 4.5.7, 4.6.6

obfuscating passwords, 4.6.7

post installation tasks, 4.7

pre-installation tasks, 4.5.1

removing prior installation, 4.7.1

running apxconf.sql, 4.5.3.1

SHARED_SERVERS parameter, 4.5.8

stopping processes, 4.2

database requirement

Application Express, 2.1

development environment

changing to runtime for Oracle Database 12c Multitenant Architecture, 4.8.4

changing to runtime for Oracle Database 12c Non-CDB, 4.8.3

disk space

requirements, 2.4

documentation

on administration and tuning, Preface

on error messages, Preface

related, Preface

E

embedded PL/SQL gateway

about, 1.5.2

location of images, 1.5.2.2

security, 1.5.2.1

SHARED_SERVERS parameter, 4.5.8

G

getting started

Application Express, 4.5.9, 4.6.8

granting connect privileges, 4.4.4.1

I

images

copying when upgrading, 4.6.2.4

incompatible Application Express version

about, 3.2.5

installation

overview, 1, 1.1

planning, 1, 1.1

process, 1.6

requirements, 1, 1.1, 2

scenarios, 1.6

understanding installation choices in Oracle Database 12c, 3.1

verifying validity, A.2

installing

failures, A.3

other languages, 4.5.6, 4.6.5

J

JOB_QUEUE_PROCESSES, 4.5.7, 4.6.6

about managing, 4.4.7

changing number of, 4.4.7.2, 4.5.7.2, 4.6.6.2

viewing number of, 4.4.7.1, 4.5.7.1, 4.6.6.1

L

listener

stopping, 4.2

log file, A.1

N

new installation

configuring Oracle Application Server 10g, 4.6.2, 4.6.2

modifying marvel.conf, 4.6.2

O

obfuscate

password, 4.6.7

Oracle Application Express

creating and adding users, 4.4.8

creating users, 4.4.8.2, 4.5.9.2, 4.6.8.2

creating workspace manually, 4.4.8.1, 4.5.9.1, 4.6.8.1

installing a translated version, 4.4.6.1

logging in to a workspace, 4.4.8.3, 4.5.9.3, 4.6.8.3

Oracle Application Express Listener

about, 1.5.1

configuring, 4.4

enabling network services, 4.4.4

installing, 4.4

Oracle Database 12c

enabling network services, 4.4.4

Oracle HTTP Server

about, 1.5.1

location of images, 1.5.1.1

with Oracle Real Application Clusters (Oracle RAC), 1.5.3

Oracle HTTP Server 11g

configuring, 4.6.2, 4.6.2.5

Oracle Real Application Clusters (Oracle RAC)

selecting a Web Listener, 1.5.3

shutting down instances, 4.2

Oracle XML DB HTTP server

about, 1.5.2

verifying HTTP server port, 4.5.3.2

overview, 1, 1.1

P

password

obfuscating, 4.6.7

patching Application Express

CDBs, 3.2.5.1

PDBs, 3.2.5.2

PDBs

patching Application Express, 3.2.5.2

PL/SQL Web Toolkit

requirement, 2.6

plugging in PDBs

Application Express is contained in the root container

non-CDB or PDB with no Application Express, 3.2.4

with a local Application Express from another CDB, 3.2.3

Application Express is installed in the root container, 3.2

Application Express is not contained in the root container

common Application Express from another CDB, 3.3.2

local Application Express from another CDB, 3.3.3

Application Express is not in the root container of the target CDB, 3.3

non-CDB or PDB with no Application Express, 3.3.4

non-CDB with Application Express, 3.3.1

non-CDB with Application Express, 3.2.1

with a common Application Express from another CDB, 3.2.2

post-installation tasks

configuring Oracle Application Server 11g, 4.6.2

pre-installation tasks

shutting down database, 4.2

prior installations

removing, 4.7.1

R

reinstalling Application Express

CDBs, 3.1.3

related documentation, Preface

requirements, 2

browser, 2.2

database, 2.1

disk space, 2.4

Oracle XML DB, 2.5

PL/SQL Web Toolkit, 2.6

shared_pool_size, 2.1.1

Web Listener, 2.3

RESTful Services

configuring, 4.4.3

running

apxdevrm.sql, 4.8.3, 4.8.4

apxdvins_con.sql, 4.8.2

apxdvins.sql, 4.8.1

running Oracle Application Express

in other languages, 4.4.6

runtime environment

about, 1.4

changing to development environment for Oracle Database 12c Multitenant Architecture, 4.8.2

changing to development environment for Oracle Database 12c non-CDB, 4.8.1

S

security considerations, 4.4.5

shared_pool_size

changing, 2.1.1

T

translated version

installing, 4.5.6, 4.6.5

troubleshooting, A

cleaning up after failed installation, A.3

images, A.4

reviewing log file, A.1

troubleshooting an invalid ACL error, 4.4.4.2

U

uninstalling Application Express

CDBs, 3.1.1

upgrade installation

post installation tasks, 4.7

upgrading

about, 1.2

copying images, 4.6.2.4

obfuscating password, 4.6.7.1

user accounts

controlling account availability, 4.4.8.2, 4.5.9.2, 4.6.8.2

creating, 4.4.8.2, 4.5.9.2, 4.6.8.2

requiring password change, 4.4.8.2, 4.5.9.2, 4.6.8.2

W

Web browser

requirements, 2.2

Web Listener

choosing, 1.5, 4.3

pre-installation tasks, 4.2, 4.2

requirement, 2.3

selecting with Oracle Real Application Clusters (Oracle RAC), 1.5.3

workspace

creating, 4.4.8.1, 4.5.9.1, 4.6.8.1

logging in to, 4.4.8.3, 4.5.9.3, 4.6.8.3

X

XML DB

requirement, 2.5

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2015, Oracle and/or its affiliates. All rights reserved.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon 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, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

License Restrictions Warranty/Consequential Damages Disclaimer

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.

Warranty Disclaimer

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.

Restricted Rights Notice

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, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

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.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information on 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. 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.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.