This chapter describes tasks that you need to complete after you install the software.
This chapter contains these topics:
Note:
Within the context of this document, the Oracle home directory (ORACLE_HOME
) is the location where Oracle HTTP Server is installed.After you install Oracle Application Express, you need to complete the following steps:
Connect to the database where you installed Oracle Application Express as the SYS
user.
Run the utlrp.sql
script from the Oracle Database home to recompile all invalid PL/SQL packages now instead of when the packages are accessed for the first time. This step is optional but recommended.
SQL> @?/rdbms/admin/utlrp.sql
Restart the processes that you stopped before you began the installation, such as listener and other processes. In addition, restart Oracle HTTP Server.
See Also:
"Recommended Pre-installation Tasks"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 unzipped apex_2.2.zip
file to the location on the file system containing the Oracle home for Oracle HTTP Server.
Topics in this section include:
If you are upgrading from a previous version of Oracle Application Express, you should rename the existing images
directory for Oracle Application Express to reflect the release number (for example, images_2_0
). By renaming the images directory, you have the option of reverting to it later on.
To locate the images
directory on the file system, review the following files for the text alias /i/
:
Oracle9i HTTP Server Release 2, see the httpd.conf file
Oracle HTTP Server 10g, see the marvel.conf
file
Oracle Application Server 10g, see the marvel.conf
file
On a Windows system, you can copy the appropriate directory using Windows Explorer, or execute a command from a command prompt as shown in the following example:
xcopy /E /I apex\images ORACLE_BASE\ORACLE_HOME\Apache\Apache\images
On UNIX or Linux based systems, you can copy the appropriate directory by executing a command similar to the one shown in the following example:
cp -rf apex/images ORACLE_BASE/ORACLE_HOME/Apache/Apache
For both Windows and UNIX systems, the target of the copy should match the location of the images directory you located in the previous step.
On a Windows system, you can copy the apex\images
directory using Windows Explorer or execute a command from a command prompt as shown in the following example:
xcopy /E /I apex\images ORACLE_BASE\ORACLE_HOME\Apache\Apache\images
On UNIX or Linux based systems, you can copy the apex/images
directory by executing a command similar to the one shown in the following example:
cp -rf apex/images ORACLE_BASE/ORACLE_HOME/Apache/Apache
If you are upgrading Oracle Application Express from release 1.5.0.00.33. 1.5.1.00.12, 1.6.0.00.87, 1.6.1.00.03, or 2.0.0.00.49 and the password you provided during your initial installation differs from the one you specified while executing the apexins.sql
script, you need to modify the file that contains the Database Access Descriptors (DADs). A DAD is a set of values that specify how the Oracle HTTP Server component modplsql
connects to the database server to fulfill an HTTP request. The following sections describe the parameter you need to modify, depending upon the type of Oracle HTTP Server in your environment.
Topics in this section include:
If you are upgrading Oracle Application Express and are running Oracle HTTP Server release 9.0.3 or higher, you must modify the password
parameter in the wdbsvr.app
file. You may also need to modify the httpd.conf
file to add two new MIME types to support SQL Workshop.
In Oracle HTTP Server Release 9.0.3, the wdbsvr.app
file contains information about the DAD to access Oracle Application Express.
Perform the following tasks if the password you provided during your initial installation differs from the one you specified while executing the apexins.sql
script.
To modify the parameter password in the wdbsvr.app
file:
Use a text editor and open the wdbsvr.app
file.
For UNIX and Linux based systems, the file is located at:
ORACLE_BASE/ORACLE_HOME/Apache/modplsql/cfg/wdbsvr.app
For Windows based systems, the file is located at:
ORACLE_BASE\ORACLE_HOME\Apache\modplsql\cfg\wdbsvr.app
Find the DAD settings for Oracle Application Express by searching for the following:
DAD_htmldb
Locate the line containing nls_lang
.
The nls_lang
setting determines the language setting of the DAD. Note that the character set portion of the nls_lang
value must always be set to AL32UTF8
, regardless of whether or not the database character set is AL32UTF8
. For example:
nls_lang = American_America.AL32UTF8
Save and exit the wdbsvr.app file.
Stop and restart the Oracle HTTP Server.
For UNIX and Linux based systems, execute the following commands:
ORACLE_BASE/ORACLE_HOME/Apache/Apache/bin/apachectl stop ORACLE_BASE/ORACLE_HOME/Apache/Apache/bin/apachectl start
Note that if Oracle HTTP Server is listening on a port less than 1024, then these commands must be executed as a privileged user (such as root
).
For Windows based systems:
Stop Oracle HTTP Server - From the Start menu, select Programs, Oracle - OraHome, Oracle HTTP Server, and Stop HTTP Server.
Restart Oracle HTTP Server - From the Start menu, select Oracle - OraHome, Oracle HTTP Server, and Start HTTP Server.
See Also:
Oracle HTTP Server Administration GuideYou may also need to modify the httpd.conf
file to add two new MIME types to support SQL Workshop. If you are upgrading from Oracle HTML DB 2.0, these MIME types should already exist.
To modify httpd.conf
file:
Use a text editor and open the httpd.conf
file
For UNIX and Linux based systems, the file is located at:
ORACLE_BASE/ORACLE_HOME/Apache/Apache/conf/httpd.conf
For Windows based systems:
ORACLE_BASE\ORACLE_HOME\Apache\Apache\conf\httpd.conf
Add the following line if it does not currently exist:
AddType text/xml xbl
Add the following line if it does not currently exist:
AddType text/x-component htc
Save and exit the httpd.conf
file.
Stop and restart Oracle HTTP Server.
For UNIX and Linux based systems, execute the following commands:
ORACLE_BASE/ORACLE_HOME/Apache/Apache/bin/apachectl stop ORACLE_BASE/ORACLE_HOME/Apache/Apache/bin/apachectl start
Note that if the Oracle HTTP Server is listening on a port less than 1024, then these commands must be executed as a privileged user (such as root
).
For Windows based systems:
Stop Oracle HTTP Server - From the Start menu, select Programs, Oracle - OraHome, Oracle HTTP Server, and Stop HTTP Server.
Restart Oracle HTTP Server - From the Start menu, select Programs, Oracle - OraHome, Oracle HTTP Server, and Start HTTP Server.
See Also:
Oracle HTTP Server Administration GuideThe marvel.conf
file contains information about the DAD to access Oracle Application Express. If you are upgrading Oracle Application Express and are running Oracle HTTP Server 10g or Oracle Application Server 10g, you must modify the marvel.conf
file.
To modify the marvel.conf
file:
Use a text editor and open the marvel.conf
file:
For UNIX and Linux based systems, the file is located at:
ORACLE_BASE/ORACLE_HOME/Apache/modplsql/conf/marvel.conf
For Windows based systems, the file is located at:
ORACLE_BASE\ORACLE_HOME\Apache\modplsql\conf\marvel.conf
Find the DAD settings for Oracle Application Express by searching for the following:
/pls/htmldb
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 marvel.conf
file.
For Oracle Application Server 10g, execute the following commands:
For UNIX and Linux based systems:
ORACLE_BASE/ORACLE_HOME/dcm/bin/dcmctl updateConfig -ct ohs
For Windows based systems:
ORACLE_BASE\ORACLE_HOME\dcm\bin\dcmctl updateConfig -ct ohs
Stop and restart Oracle HTTP Server.
For UNIX and Linux based systems, execute the following commands:
ORACLE_BASE/ORACLE_HOME/opmn/bin/opmnctl stopproc ias-component=HTTP_Server ORACLE_BASE/ORACLE_HOME/opmn/bin/opmnctl startproc ias-component=HTTP_Server
For Windows based systems:
ORACLE_BASE\ORACLE_HOME\opmn\bin\opmnctl stopproc ias-component=HTTP_Server ORACLE_BASE\ORACLE_HOME\opmn\bin\opmnctl startproc ias-component=HTTP_Server
Oracle Application Express must have access to Oracle HTTP Server with mod_plsql
. The instructions that follow explain how to configure different versions of Oracle HTTP Server with mod_plsql
.
Topics in this section include:
Configuring Oracle HTTP Server Release 9.0.3 in a New Installation
Configuring Oracle HTTP Server 10g or Oracle Application Server 10g in a New Installation
In Oracle HTTP Server Release 9.0.3, the wdbsvr.app
file contains information about the DAD to access Oracle Application Express. A DAD is a set of values that specify how the Oracle HTTP Server component modplsql
connects to the database server to fulfill an HTTP request.
To create the DAD, you modify the file wdbsvr.app
and add an entry for Oracle Application Express.
To modify the wdbsvr.app
file:
Use a text editor and open the wdbsvr.app
file:
For UNIX and Linux based systems, the file is located at:
ORACLE_BASE/ORACLE_HOME/Apache/modplsql/cfg/wdbsvr.app
For Windows based systems:
ORACLE_BASE\ORACLE_HOME\Apache\modplsql\cfg\wdbsvr.app
Add an entry for Oracle Application Express using the following syntax. Only change the settings indicated in italics.
[DAD_apex] connect_string = localhost:1521:orcl password = apex username = apex_public_user default_page = apex document_table = wwv_flow_file_objects$ document_path = docs document_proc = wwv_flow_file_mgr.process_download reuse = Yes enablesso = No stateful = STATELESS_RESET nls_lang = American_America.AL32UTF8
Where:
connect_string
refers to the host ID, port number, and Oracle9i database where Oracle Application Express was installed. Use the format host:port:sid
.
If the Oracle9i version of Oracle HTTP Server you want to use is installed in the same Oracle home as the database you specified for use with Oracle Application Express, leave this parameter blank.
password
is the Application Express password you passed as the first argument to the apexins.sql
script.
nls_lang
determines the language setting of the DAD. The character set portion of the nls_lang
value must always be set to AL32UTF8
, regardless of whether or not the database character set is AL32UTF8
.
If either the territory portion or the language portion of the NLS settings contains a space, you must wrap the value in double quotes as shown in the following example:
nls_lang = "ENGLISH_UNITED KINGDOM.AL32UTF8"
You can find information about your database's NLS settings by querying the view NLS_DATABASE_PARAMETERS
as shown in the following example:
SELECT parameter,value FROM nls_database_parameters WHERE PARAMETER IN ('NLS_CHARACTERSET','NLS_LANGUAGE','NLS_TERRITORY');
Leave the remaining settings, including the username setting, as they appear in the previous example.
Save and exit the wdbsvr.app
file.
You need to modify the httpd.conf
file to include an alias that points to the file system path where you copied the images directory. You may also need to modify the httpd.conf
file to add two new MIME types to support SQL Workshop. If you are upgrading from Oracle HTML DB 2.0, these MIME types should already exist.
See Also:
"Copying the Images Directory When Upgrading" and "Installing the Oracle Application Express Software"To modify httpd.conf
file:
Use a text editor and open the httpd.conf
file
For UNIX and Linux based systems, the file is located at:
ORACLE_BASE/ORACLE_HOME/Apache/Apache/conf/httpd.conf
For Windows based systems:
ORACLE_BASE\ORACLE_HOME\Apache\Apache\conf\httpd.conf
Add an alias entry that points to the file system path where you copied the images directory. The following examples assume you specified the image directory alias as /i/
when you ran the apexins.sql
script.
Windows based system example:
Alias /i/ "C:\oracle\ora92\Apache\Apache\images/"
Note you must include the forward slash (/) at the end of the path.
UNIX and Linux based system example:
Alias /i/ "/home/oracle/OraHome1/Apache/Apache/images/"
Next, add two new MIME types to support SQL Workshop:
Add the following line if it does not currently exist:
AddType text/xml xbl
Add the following line if it does not currently exist:
AddType text/x-component htc
If you are upgrading from Oracle HTML DB 2.0, these MIME types should already exist.
Save and exit the httpd.conf
file.
Stop and restart Oracle HTTP Server.
For UNIX and Linux based systems, execute the following commands:
ORACLE_BASE/ORACLE_HOME/Apache/Apache/bin/apachectl stop ORACLE_BASE/ORACLE_HOME/Apache/Apache/bin/apachectl start
Note that if the Oracle HTTP Server is listening on a port less than 1024, then these commands must be executed as a privileged user (such as root
).
For Windows based systems:
Stop Oracle HTTP Server - From the Start menu, select Programs, Oracle - OraHome, Oracle HTTP Server, and Stop HTTP Server.
Restart Oracle HTTP Server - From the Start menu, select Programs, Oracle - OraHome, Oracle HTTP Server, and Start HTTP Server.
See Also:
Oracle HTTP Server Administrator's GuideOracle Application Express must have access to Oracle HTTP Server with mod_plsql. Perform the following post-installation steps if:
You are running Oracle HTTP Server 10g or Oracle Application Server 10g.
Oracle HTTP Server is installed in an Oracle home.
You have not previously configured Oracle HTTP Server to work with Oracle Application Express.
These instructions do not apply if you are running Oracle HTTP Server release 9.0.3. For more information on configuring Oracle HTTP Server release 9.0.3, see "Configuring Oracle HTTP Server Release 9.0.3 in a New Installation".
If you have not previously configured Oracle HTTP Server to work with Oracle Application Express, you need to create a marvel.conf
file. The marvel.conf
file contains the information about the DAD to access Oracle Application Express.
To create the marvel.conf
file:
Use a text editor and create a file named marvel.conf.
For UNIX and Linux based systems, save to:
ORACLE_BASE/ORACLE_HOME/Apache/modplsql/conf
For Windows based systems, save to:
ORACLE_BASE\ORACLE_HOME\Apache\modplsql\conf\
Copy the following into the marvel.conf
file. Replace ORACLE_HOME
, host
, port
, service_name
, and apex_public_user_password
with values appropriate for your environment. Note that apex_public_user_password
should be the same as the first parameter you supplied to apexins.sql
.
The following example assumes you specified the image directory alias as /i/
when you installed Application Express. Note that the path listed is only an example. The path in your marvel.conf
file should reference the images directory alias for your environment.
Alias /i/ "ORACLE_BASE/ORACLE_HOME/apex/images/" AddType text/xml xbl AddType text/x-component htc <Location /pls/apex> Order deny,allow PlsqlDocumentPath docs AllowOverride None PlsqlDocumentProcedure wwv_flow_file_manager.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 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 marvel.conf
file.
Next, you need to edit the httpd.conf
file to reference the marvel.conf
configuration file.
To edit the httpd.conf
file:
Use a text editor and open the httpd.conf
file.
For UNIX and Linux based systems:
ORACLE_BASE/ORACLE_HOME/Apache/Apache/conf/httpd.conf
For Windows based systems:
ORACLE_BASE\ORACLE_HOME\Apache\Apache\conf\httpd.conf
Add an entry to reference the marvel.conf
configuration file.
include "ORACLE_BASE/ORACLE_HOME/Apache/modplsql/conf/marvel.conf"
Save and exit the httpd.conf
file.
To stop and restart Oracle HTTP Server:
For UNIX and Linux based systems, execute the following commands:
ORACLE_BASE/ORACLE_HOME/opmn/bin/opmnctl stopproc ias-component=HTTP_Server ORACLE_BASE/ORACLE_HOME/opmn/bin/opmnctl startproc ias-component=HTTP_Server
For Windows based system, execute the following commands:
ORACLE_BASE\ORACLE_HOME\opmn\bin\opmnctl stopproc ias-component=HTTP_Server ORACLE_BASE\ORACLE_HOME\opmn\bin\opmnctl startproc ias-component=HTTP_Server
You must apply the PL/SQL Web Toolkit patch to every database where you wish to run Oracle Application Express 2.2. For instructions about applying this patch, please review the README.txt
file contained in the directory apex/patch/bug4554072
.
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 can support the specific language. If you attempt to install a translated version of Oracle Application Express into a database that does 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 UTF8
.
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 theNLS_LANG
environment variable to AL32UTF8
prior to starting SQL*Plus.The following examples illustrate valid NLS_LANG
settings for loading Oracle Application Express translations:
American_America.AL32UTF8 Japanese_Japan.AL32UTF8
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 target database as SYS.
Execute the following statement:
ALTER SESSION SET CURRENT_SCHEMA = FLOWS_020200;
Execute the appropriate language specific script. For example:
@load_de.sql
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 these directories, there is a language loading script identified by the language code (for example, load_de.sql
or load_ja.sql
).
JOB_QUEUE_PROCESSES
determine the maximum number of concurrently running jobs. In Oracle Application Express release 2.2, transactional support and SQL scripts require jobs. If JOB_QUEUE_PROCESSES
is not enabled and working properly, you cannot successfully execute a script.
Topics in this section include:
There are currently three ways to view the number of number of JOB_QUEUE_PROCESSES
:
In the installation log file
On the About Application Express page in Oracle Application Express
From SQL*Plus
After installing or upgrading Oracle Application Express to release 2.2, you can view the number of JOB_QUEUE_PROCESSES
in the installation log files. See "Reviewing a Log of an Installation Session".
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 Oracle Application Express".
On the Administration list, click About Application Express.
The current number JOB_QUEUE_PROCESSES
displays at the bottom of the page.
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
:
Log in to the database as SYSDBA
using SQL*Plus.
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.
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_HOME/Apache/modplsql/conf
For Windows based systems:
ORACLE_BASE\ORACLE_HOME\Apache\modplsql\conf
To obfuscate passwords:
Use a text editor and copy the entry for /pls/htmldb
or /pls/apex
from the marvel.conf
file into the dads.conf
file.
For UNIX and Linux based systems, these files are located in:
ORACLE_BASE/ORACLE_HOME/Apache/modplsql/conf/dads.conf
For Windows based systems, these files are located in:
ORACLE_BASE\ORACLE_HOME\Apache\modplsql\conf\dads.conf
Run dadTool.pl
by following the instructions in the dadTool.README
file.
Copy the entry for /pls/htmldb
or /pls/apex
from the dads.conf
file back into marvel.conf
.
Remove the entry for /pls/htmldb
or /pls/apex
from the dads.conf
file.
You open the Oracle Application Express home page in a Web browser. To view or develop Oracle Application Express applications, the Web browser must support JavaScript and the HTML 4.0 and CSS 1.0 standards. The following browsers meet this requirement:
Microsoft Internet Explorer 6.0 or higher (Windows only)
Netscape Communicator 7.2 or higher
Mozilla 1.2 or higher
Firefox 1.0 or higher
To log in to Oracle Application Express, open the following URL in a Web browser:
http://hostname:port/pls/database_access_descriptor/
Where:
hostname
is the name of the system where Oracle HTTP Server is installed.
port
is the port number assigned to 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 the httpd.conf
file, located in ORACLE_BASE\ORACLE_HOME\Apache\Apache\conf
, by searching for Port.
You can also find the port number in the portlist.ini
file, located in ORACLE_BASE\ORACLE_HOME\install
. However, be aware that if you change a port number, it is not updated in the portlist.ini
file, so you can only rely on this file immediately after installation.
database_access_descriptor
describes how Oracle HTTP Server connects to the database server so that it can fulfill an HTTP request. The default value is apex
.
See Also:
ORACLE_BASE\ORACLE_HOME\Apache\modplsql\conf\dads.readme
for more information on database access descriptorsThe Oracle Application Express Login page appears.
In the Oracle Application Express development environment, users log in to a shared work area called a workspace. Users are divided into three primary roles:
Developers create and edit applications.
Workspace administrators perform administrator tasks specific to a workspace such as managing user accounts, monitoring workspace activity, and viewing log files.
Oracle Application Express administrator are superusers that manage an entire hosted instance using the Oracle Application Express Administration Services application.
If you are a developer, an administrator must grant you access to a workspace. If you are an Oracle Application Express administrator, you need to:
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.
Specify a provisioning mode. In Oracle Application Express Administration Services, you need to determine how the process of creating (or provisioning) a workspace will work in your development environment.
Create a Workspace. A workspace is a shared work area within the Oracle Application Express development environment that has a unique ID and name. An Oracle Application Express administrator can create a workspace manually or have users submit requests.
Log in to a Workspace. Once you create a workspace in Oracle Application Express Administration Services, return to the Oracle Application Express Login page and log in to that workspace.
See Also:
"Quick Start" in Oracle Database Application Express User's Guide