5.5 Configuring the Embedded PL/SQL Gateway

Run the apex_epg_config.sql script. Then, unlock the ANONYMOUS account.

1. Change your working directory to the apex directory where you unzipped the Oracle Application Express software.
2. 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
     

3. If you are configuring a PDB, enter the following statement:

   ALTER SESSION SET CONTAINER = <PDB_NAME>;
   

4. Run apex_epg_config.sql passing the file system path to the base directory where the Oracle Application Express software was unzipped as shown in the following example:

   • On Windows:

     @apex_epg_config.sql SYSTEM_DRIVE:\TEMP
     

   • On UNIX and Linux:

     @apex_epg_config.sql /tmp
     

5. Enter the following statement to unlock the ANONYMOUS account:

   ALTER USER ANONYMOUS ACCOUNT UNLOCK;
   

Run the apex_epg_config.sql script to update the images directory.

1. Change your working directory to the apex directory where you unzipped the Oracle Application Express software.
2. 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
     

3. Run apex_epg_config.sql passing the file system path to the base directory where the Oracle Application Express software was unzipped as shown in the following example:

   • On Windows:

     @apex_epg_config.sql SYSTEM_DRIVE:\TEMP
     

   • On UNIX and Linux:

     @apex_epg_config.sql /tmp
     

   Tip:

   The above examples assume that you unzipped Oracle Application Express in a directory called TEMP on Windows and tmp on UNIX or Linux.

Start SQL* Plus and connect to the database and enter the statement to verify the port number assigned to HTTP on the Oracle XML DB HTTP Server.

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

2. 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 HTTP Server is disabled.

Start SQL* Plus and connect to the database and enter the statement to verify the port number where the Oracle XML DB Protocol Server is running.

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

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

3. To enable the Oracle XML DB Protocol Server.

Start SQL* Plus and connect to the database and run a SQL statement to enable Oracle XML DB Protocol Server.

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

2. Enter a statement similar to the following:

   EXEC DBMS_XDB.SETHTTPPORT(port);
   

   For example:

   EXEC DBMS_XDB.SETHTTPPORT(8080);
   

For configuring static files, you must run apex_rest_config.sql after a new installation or upgrade of Oracle Application Express.

Oracle Application Express enables application developers to include static files with their applications. Static files can be associated with a workspace, an application, a plug-in, or an application theme. When using the embedded PL/SQL gateway as your web listener, the necessary configuration to support static files is performed as part of the embedded PL/SQL gateway configuration.

Start SQL*Plus and connect to the database where Oracle Application Express is installed as SYS specifying the SYSDBA role. Execute the PL/SQL block.

If Oracle Application Express is running behind a reverse proxy or load balancer, you set the CGI environment variables PROTOCOL and HTTP_HOST. For embedded PL/SQL gateway, you must call the following PL/SQL block:

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

3. Execute the following PL/SQL block:

   BEGIN
    DBMS_EPG.set_dad_attribute (
    dad_name => 'APEX',
    attr_name => 'cgi-environment-list',
    attr_value => 'REQUEST_PROTOCOL=https');
    DBMS_EPG.set_dad_attribute (
    dad_name => 'APEX',
    attr_name => 'cgi-environment-list',
    attr_value => 'HTTP_HOST=external-name:external-port');
    commit;
   END;
   /
   

To learn more, see your Java EE application servers documentation.