6.3 Downloading and Installing Oracle APEX

Learn about downloading and installing Oracle APEX.

How you install Oracle APEX depends upon by the type of database into which you are installing. This topic describes how to download and install Oracle APEX in self-managed databases, such as your laptop or your data center, or co-managed Cloud databases such as Database Cloud Service (DBaaS) and Exadata Cloud Service. In fully managed Cloud databases, such as an Autonomous Database or Oracle APEX Application Development (APEX Service), Oracle APEX is pre-installed and pre-configured. To learn more, refer to the documentation for your service.

• Installing Oracle APEX
  Install Oracle APEX by downloading a ZIP file from the Oracle APEX download page.
• Creating or Updating Your Instance Administration Account
  Learn how to create or update Instance Administrator account.
• Restarting Processes
  Restart the processes that you stopped before you began the installation.
• Configuring the APEX_PUBLIC_USER Account
  It is important to correctly configure the APEX_PUBLIC_USER account to enable proper operation of Oracle APEX.
• Configuring RESTful Services
  In a new installation of Oracle APEX, you must run the configuration script apex_rest_config.sql to configure RESTful Services.

See Also:

• Welcome to Oracle APEX Application Development Service in Getting Started with Oracle APEX Application Development
• Creating Applications with Oracle Application Express on Autonomous Database in Using Oracle Autonomous Database on Shared Exadata Infrastructure
• Utilizing the Multitenant Architecture in Oracle Database 12c or Later

6.3.1 Installing Oracle APEX

Install Oracle APEX by downloading a ZIP file from the Oracle APEX download page.

Tip:

Oracle APEX must be installed from a writable directory on the file system. See Reviewing a Log of an Installation Session.

To install Oracle APEX:

1. For installations where the development will be in English only, download the file apex_22.1_en.zip from the Oracle APEX download page. If the development will include languages other than English, download apex_22.1.zip from the Oracle APEX download page. See:

   https://www.oracle.com/tools/downloads/apex-downloads.html

   Note that the actual file name may differ if a more recent release has shipped since this document was published.

2. Unzip downloaded zip file:

   • If English only, unzip apex_22.1_en.zip as follows, preserving directory names:

     • UNIX and Linux: $ unzip apex_22.1_en.zip

     • Windows: Double click the file apex_22.1_en.zip in Windows Explorer

   • If multiple languages, unzip apex_22.1.zip as follows, preserving directory names:

     • UNIX and Linux: $ unzip apex_22.1.zip

     • Windows: Double click the file apex_22.1.zip in Windows Explorer

   Note:

   You should keep the directory tree where you unzip the files short and not under directories that contain spaces. For example, within Windows unzip to C:\TEMP.

3. Change your working directory to apex.
4. Start SQL*Plus and connect to the database where Oracle APEX 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
     

5. Disable any existing password complexity rules for the default profile.
6. Select the appropriate installation option.

   Full development environment provides complete access to the App Builder environment to develop applications. A Runtime environment enables users to run applications that cannot be modified.

   Available installation options include:

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

     @apexins.sql tablespace_apex tablespace_files tablespace_temp images
     

     Where:

     • tablespace_apex is the name of the tablespace for the Oracle APEX application user.

     • tablespace_files is the name of the tablespace for the Oracle APEX files user.

     • tablespace_temp is the name of the temporary tablespace or tablespace group.

     • images is the virtual directory for Oracle APEX images. For installations using EPG, /i/ is the required value for the images argument. To support future Oracle APEX upgrades, define the virtual image directory as /i/.

     Example:

     @apexins.sql SYSAUX SYSAUX TEMP /i/

     Note:

     If you receive the following error, exit SQL*Plus and change your working directory to where you unzipped the installation file, for example C:\TEMP in Windows, before starting SQL*Plus:

     SP2-0310: unable to open file "apexins.sql"

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

     @apxrtins.sql tablespace_apex tablespace_files tablespace_temp images
     

     Where:

     • tablespace_apex is the name of the tablespace for the Oracle APEX application user.

     • tablespace_files is the name of the tablespace for the Oracle APEX files user.

     • tablespace_temp is the name of the temporary tablespace or tablespace group.

     • images is the virtual directory for Oracle APEX images. To support future Oracle APEX upgrades, define the virtual image directory as /i/.

     Example:

     @apxrtins.sql SYSAUX SYSAUX TEMP /i/

When Oracle APEX installs, it creates the following database accounts:

• APEX_220100 - This account owns the Oracle APEX schema and metadata.

• FLOWS_FILES - This account owns the Oracle APEX uploaded files.

• APEX_PUBLIC_USER - This minimally privileged account is used for Oracle APEX configuration with Oracle REST Data Services or Oracle HTTP Server and mod_plsql.

If you configured RESTful Web services, then these additional accounts will be created:

• APEX_REST_PUBLIC_USER - The account used when invoking RESTful Services definitions stored in Oracle APEX.

• APEX_LISTENER - The account used to query RESTful Services definitions stored in Oracle APEXs.

If you are upgrading from a previous release, then FLOWS_FILES already exists and APEX_PUBLIC_USER is created if it does not already exist.

See Also:

• About the Oracle APEX Runtime Environment

• Configuring Password Protection in Oracle Database Security Guide

• SQL*Plus User's Guide and Reference for more information about SQL*Plus

6.3.2 Creating or Updating Your Instance Administration Account

Learn how to create or update Instance Administrator account.

This section describes how to create or update your Instance Administrator account.

Tip:

Skip this section if you are upgrading from a previous release of Oracle APEX. In an upgrade scenario, the Instance Administrator account and password is preserved and carried over from the prior release.

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

6.3.2.1 What Is an Instance Administrator?

Instance administrators are superusers that are responsible for managing an entire Oracle APEX instance, including managing workspace provisioning, configuring features and instance settings, and managing security.

To perform these tasks, an Instance administrator signs in to the Oracle APEX Administration Services application.

See Also:

Oracle APEX Administration Services in Oracle APEX Administration Guide

6.3.2.2 About apxchpwd.sql

Running the apxchpwd.sql script enables you to create or update your Instance Administrator account.

Note:

The apxchpwd.sql script is not supported on Oracle Autonomous Database on Shared Exadata Infrastructure and Oracle APEX Application Development (APEX Service).

You must run the apxchpwd.sql script in the following scenarios:

• New Oracle APEX installations - Run apxchpwd.sql to create an Instance Administrator account and password.

• Converting of a runtime environment to a development environment - Run apxchpwd.sql to change the Instance Administrator account password.

• Changing Your Instance Administrator Password -Run apxchpwd.sql to change the password for an existing Instance Administrator account.

• Unlocking Your Instance Administrator Account - Run apxchpwd.sql to unlock an existing Instance Administrator account.

Tip:

You do not need to run apxchpwd.sql when upgrading from a previous release of Oracle APEX. In an upgrade scenario, the Instance Administrator account password is preserved and carried over from the prior release.

6.3.2.3 Running apxchpwd.sql

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

To create or update your Instance Administrator account:

1. Change your working directory to the apex directory where you unzipped the installation software.
2. Start SQL*Plus and connect to the database where Oracle APEX 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
     

3. Run apxchpwd.sql. For example:

   @apxchpwd.sql
   

   Follow the on-screen instructions. You will be prompted provide a username, password, and email address. If the account username does not exist, it will be created for you.

See Also:

SQL*Plus User's Guide and Reference for more information about SQL*Plus

6.3.3 Restarting Processes

Restart the processes that you stopped before you began the installation.

After you install Oracle APEX, you must restart the processes that you stopped before you began the installation.

6.3.4 Configuring the APEX_PUBLIC_USER Account

It is important to correctly configure the APEX_PUBLIC_USER account to enable proper operation of Oracle APEX.

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

6.3.4.1 About the APEX_PUBLIC_USER Account

The APEX_PUBLIC_USER account is created with a random password in a new installation of Oracle APEX.

You must change the password for this account before configuring the database access descriptor (DAD) in a new installation.

6.3.4.2 Unlocking the APEX_PUBLIC_USER Account

Unlock the APEX_PUBLIC_USER account by running a SQL statement.

Tip:

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

To unlock the APEX_PUBLIC_USER account:

1. Start SQL*Plus and connect to the database where Oracle APEX is installed as SYS specifying the SYSDBA role. If Oracle APEX is installed in the CDB, ensure you connect to CDB$ROOT. 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
     

2. Run the following statement:

   ALTER USER APEX_PUBLIC_USER ACCOUNT UNLOCK
   

6.3.4.3 Changing the Password for the APEX_PUBLIC_USER Account

Change the password for the APEX_PUBLIC_USER account by running a SQL statement.

Tip:

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

To change the password for the APEX_PUBLIC_USER account:

1. Start SQL*Plus and connect to the database where Oracle APEX is installed as SYS specifying the SYSDBA role. If Oracle APEX is installed in the CDB, ensure you connect to CDB$ROOT. 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
     

2. Run the following statement:

   ALTER USER APEX_PUBLIC_USER IDENTIFIED BY new_password
   

   Where new_password is the new password you are setting for APEX_PUBLIC_USER. You will use this password when creating the DAD in the sections that follow.

6.3.4.4 About Password Expiration in Oracle Database 11g and Later

You can set PASSWORD_LIFE_TIME parameter to unlimited by altering APEX_PUBLIC_USER to prevent password expiration. To do this create another profile in which the PASSWORD_LIFE_TIME parameter is set to unlimited and alter the APEX_PUBLIC_USER account and assign it to the new profile.

In the default profile in Oracle Database 11g or later, the parameter PASSWORD_LIFE_TIME is set to 180. If you are using Oracle Database 11g or later with Oracle APEX, this causes the password for APEX_PUBLIC_USER to expire in 180 days. As a result, your Oracle APEX instance will become unusable until you change the password.

See Also:

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

6.3.5 Configuring RESTful Services

In a new installation of Oracle APEX, you must run the configuration script apex_rest_config.sql to configure RESTful Services.

Once configured, the instance administrator can control the availability of the feature. If the instance administrator has disabled RESTful Services for this Oracle APEX instance, RESTful Services are not available for this instance and the RESTful Services icon does not display.

To configure RESTful Services in Oracle APEX:

1. Change your working directory to the apex directory where you unzipped the installation software.
2. Start SQL*Plus and connect to the database where Oracle APEX 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
     

3. Run apex_rest_config.sql. For example:

   @apex_rest_config.sql
   

   When Prompted, enter a password for the APEX_LISTENER and APEX_REST_PUBLIC_USER accounts.

   When configuring RESTful Services in Oracle APEX, it creates two new database accounts.

   • APEX_LISTENER - The account used to query RESTful Services definitions stored in Oracle APEX.

   • APEX_REST_PUBLIC_USER - The account used when calling RESTful Services definitions stored in Oracle APEX.

See Also:

Enabling RESTful Services for an Instance in Oracle APEX Administration Guide