Install Admin Tool
Note:
All the tasks below need to be followed in sequential order.Prerequisites
Before installing the OUAW Admin Tool component, verify the following:
-
Ensure that the Admin Tool installation is performed both on the database and the application servers.
-
Ensure Oracle Database Server Enterprise is installed on the database server.
-
Ensure Java is installed both on the database and the application servers.
-
Ensure Oracle Fusion Middleware Infrastructure is installed on the application server.
-
Ensure Oracle APEX is installed on the application server.
-
Ensure Oracle REST Data source (ORDS) is installed on the application server.
See Perform Pre-Installation Steps for OUAW for more information.
Install APEX on the Database Server
Note:
Make sure the same OS user installs all software, and replace all parameters enclosed in <> with actual values.-
Navigate to the Apex extracted directory. Example: </u01/ouaw/apex>
-
Connect to the Oracle Utilities Analytics Warehouse Database with sys user and execute the following commands in order:
-
sqlplus sys/<SYS USER PASSWORD>@<DATABASE SERVICE NAME> as sysdba
-
@apxrtins.sql <Tablespace name> <Tablespace name> <Temp Tablespace name> /i/
-
@apxrtins.sql <CISTS_01> <CISTS_01> <TEMP> /i/
-
@apxchpwd.sql
A sample output for @apxchpwd.sql is shown below. Provide the inputs and store it for future reference.SQL> @apxchpwd.sql ...set_appun.sql ================================================================================ This script can be used to change the password of an Application Express instance administrator. If the user does not yet exist, a user record will be created. ================================================================================ Enter the administrator's username [ADMIN] User "ADMIN" does not yet exist and will be created. Enter ADMIN's email [ADMIN] <admin email id> Enter ADMIN's password [] Created instance administrator ADMIN.
-
ALTER USER APEX_PUBLIC_USER ACCOUNT UNLOCK;
-
ALTER USER APEX_PUBLIC_USER IDENTIFIED BY APEX_PUBLIC_USER;
-
@apex_rest_config.sql
A sample output for @apex_rest_config.sql is shown below. Provide the inputs and store it for future reference.SQL> @apex_rest_config.sql Enter a password for the APEX_LISTENER user [] Enter a password for the APEX_REST_PUBLIC_USER user [] ...set_appun.sql ...setting session environment ...create APEX_LISTENER and APEX_REST_PUBLIC_USER users SQL>
-
Note:
Make sure that you save the passwords forAPEX_Listener
user and APEX_REST_PUBLIC_USER
Configure APEX Workspace for OUAW
-
To connect to the database with the sys user:
sqlplus sys/<SYS USER PASSWORD>@<DATABASE SERVICE NAME> as sysdba
-
To create a workspace and configure the users:
@CreateAppWorkspace.sql
-
To import the OUAW application run:
@DeployAdminApp.sql
Install ORDS on the Application Server
This section provides the steps to install ORDS 21.4.3 or ORDS 25.1.1.
Installing ORDS 21.4.3
-
Navigate to the ORDS extracted directory on the application server and make sure that the Apex extracted directory is available in the location where the Admin Tool is set up.
Example: </u01/ouaw/ords>
-
Create a directory on the application server to configure Apex.
Example: mkdir -p </u01/ouaw/apex_configuration>
-
Navigate back to the ords directory where Oracle REST Data source (ORDS) was extracted.
Example: cd </u01/ouaw/ords>
-
To perform an advanced installation, execute the following commands:
export JAVA_HOME=</u01/ouaw/java> export PATH=$JAVA_HOME/bin:$PATH java -jar ords.war install advanced
Note:
See below an example of the command prompt, in which default options will appear enclosed in square brackets [ ]. Use these options or provide the necessary inputs for your requirement.Specify the database connection type to use. Enter number for [1] Basic [2] TNS [3] Custom URL [1]: Enter the name of the database server [localhost]:<target.dbserver.host> Enter the database listen port [1521]: <target database port> Enter 1 to specify the database service name, or 2 to specify the database SID [1]: Enter the database service name:<target database service name> Enter 1 if you want to verify/install Oracle REST Data Services schema or 2 to skip this step [1]: Enter the database password for ORDS_PUBLIC_USER: <ORDS_PUBLIC_USER user password> Confirm password: <ORDS_PUBLIC_USER user password> Requires to login with administrator privileges to verify Oracle REST Data Services schema. Enter the administrator username:sys Enter the database password for SYS AS SYSDBA: Confirm password: Connecting to database user: SYS AS SYSDBA url: jdbc:oracle:thin:@//<targetdatabase.host>:<target database port>/<target database service name> Retrieving information. Enter the default tablespace for ORDS_METADATA [SYSAUX]: Enter the temporary tablespace for ORDS_METADATA [TEMP]: Enter the default tablespace for ORDS_PUBLIC_USER [SYSAUX]: Enter the temporary tablespace for ORDS_PUBLIC_USER [TEMP]: Enter 1 if you want to use PL/SQL Gateway or 2 to skip this step. If using Oracle Application Express or migrating from mod_plsql then you must enter 1 [1]: Enter the PL/SQL Gateway database user name [APEX_PUBLIC_USER]: Enter the database password for APEX_PUBLIC_USER: Confirm password: Enter 1 to specify passwords for Application Express RESTful Services database users (APEX_LISTENER, APEX_REST_PUBLIC_USER) or 2 to skip this step [1]: Enter the database password for APEX_LISTENER: Confirm password: Enter the database password for APEX_REST_PUBLIC_USER: Confirm password: Enter a number to select a feature to enable: [1] SQL Developer Web (Enables all features) [2] REST Enabled SQL [3] Database API [4] REST Enabled SQL and Database API [5] None Choose [1]: 2024-03-12T15:03:44.227Z INFO reloaded pools: [] Installing Oracle REST Data Services version 21.4.3.r1170405 ... Log file written to /scratch/gbuora/ords_install_core_2024-03-12_150344_00313.log ... Verified database prerequisites ... Created Oracle REST Data Services proxy user ... Created Oracle REST Data Services schema ... Granted privileges to Oracle REST Data Services ... Created Oracle REST Data Services database objects ... Log file written to /scratch/gbuora/ords_install_datamodel_2024-03-12_150354_00176.log ... Log file written to /scratch/gbuora/ords_install_scheduler_2024-03-12_150354_00969.log ... Log file written to /scratch/gbuora/ords_install_apex_2024-03-12_150356_00802.log Completed installation for Oracle REST Data Services version 21.4.3.r1170405. Enter 1 if you wish to start in standalone mode or 2 to exit [1]:2
-
Navigate to the ORDS directory.
Example: cd </u01/ouaw/ords>
-
Run the following command after setting JAVA HOME and add the following PATH:
java -jar ords.war static </u01/ouaw/apex>/apex/images>
Note:
The command will create an i.war file in the ords folder.
Installing ORDS 25.1.1
-
Create the configuration and installation log directories on the application server to confgure ORDS.
Example:
mkdir -p </u01/ouaw/ords_configuration>
mkdir -p </u01/ouaw/ords_install_log>
-
Navigate to the ORDS extracted directory on the application server and make sure that the Apex extracted directory is available in the location.
Example: </u01/ouaw/ords>
-
To install ords, execute the following commands:
export JAVA_HOME=</u01/ouaw/java17> export PATH=$JAVA_HOME/bin:$PATH /u01/ouaw/ords/bin/ords --config /u01/ouaw/ords_configuration install --interactive --log-folder /u01/ouaw/ords_install_log
Note:
See below an example of the command prompt, in which default options will appear enclosed in square brackets [ ]. Use these options or provide the necessary inputs for your requirement.ORDS: Release 25.1 Production on Fri Jun 06 14:16:28 2025 Copyright (c) 2010, 2025, Oracle. Configuration: /u01/ouaw/ords_configuration The configuration folder /u01/ouaw/ords_configuration does not contain any configuration files. Oracle REST Data Services - Interactive Install Enter a number to select the TNS net service name to use from /scratch/ouawcicd/Database_base/Ora_home/network/admin/tnsnames.ora or specify the database connection [1] OUACICDB SERVICE_NAME=OUACICDB [2] OUAW906DB SERVICE_NAME=OUAW906DB [S] Specify the database connection Choose [1]: <target pdb service name> Provide database username with administrator privileges. Enter the administrator username: sys Enter the database password for SYS AS SYSDBA: Retrieving information. ORDS is not installed in the database. ORDS installation is required. Enter a number to update the value or select option A to Accept and Continue [1] Connection Type: TNS [2] TNS Connection: TNS_NAME=OUAW906DB TNS_FOLDER=/scratch/ouawcicd/Database_base/Ora_home/network/admin Administrator User: SYS AS SYSDBA [3] Database password for ORDS runtime user (ORDS_PUBLIC_USER): <generate> [4] ORDS runtime user and schema tablespaces: Default: SYSAUX Temporary TEMP [5] Additional Feature: Database Actions [6] Configure and start ORDS in Standalone Mode: Yes [7] Protocol: HTTP [8] HTTP Port: 8080 [9] APEX static resources location: [A] Accept and Continue - Create configuration and Install ORDS in the database [Q] Quit - Do not proceed. No changes Choose [A]: 3 Enter your choice for the runtime user password (ORDS_PUBLIC_USER) [S] Specify your own password [G] Generate password [C] Cancel - No Changes Choose [G]: S Enter the database password for ORDS_PUBLIC_USER: Confirm password: Enter a number to update the value or select option A to Accept and Continue [1] Connection Type: TNS [2] TNS Connection: TNS_NAME=OUAW906DB TNS_FOLDER=/scratch/ouawcicd/Database_base/Ora_home/network/admin Administrator User: SYS AS SYSDBA [3] Database password for ORDS runtime user (ORDS_PUBLIC_USER): <specified password> [4] ORDS runtime user and schema tablespaces: Default: SYSAUX Temporary TEMP [5] Additional Feature: Database Actions [6] Configure and start ORDS in Standalone Mode: Yes [7] Protocol: HTTP [8] HTTP Port: 8080 [9] APEX static resources location: [A] Accept and Continue - Create configuration and Install ORDS in the database [Q] Quit - Do not proceed. No changes Choose [A]: 6 Enter a number to update the value or select option A to Accept and Continue [1] Connection Type: TNS [2] TNS Connection: TNS_NAME=OUAW906DB TNS_FOLDER=/scratch/ouawcicd/Database_base/Ora_home/network/admin Administrator User: SYS AS SYSDBA [3] Database password for ORDS runtime user (ORDS_PUBLIC_USER): <specified password> [4] ORDS runtime user and schema tablespaces: Default: SYSAUX Temporary TEMP [5] Additional Feature: Database Actions [6] Configure and start ORDS in Standalone Mode: No [A] Accept and Continue - Create configuration and Install ORDS in the database [Q] Quit - Do not proceed. No changes Choose [A]: The setting named: db.connectionType was set to: tns in configuration: default The setting named: db.tnsAliasName was set to: OUAW906DB in configuration: default The setting named: db.tnsDirectory was set to: /scratch/ouawcicd/Database_base/Ora_home/network/admin in configuration: default The setting named: plsql.gateway.mode was set to: proxied in configuration: default The setting named: db.username was set to: ORDS_PUBLIC_USER in configuration: default The setting named: db.password was set to: ****** in configuration: default The setting named: feature.sdw was set to: true in configuration: default The global setting named: database.api.enabled was set to: true The setting named: restEnabledSql.active was set to: true in configuration: default The setting named: security.requestValidationFunction was set to: ords_util.authorize_plsql_gateway in configuration: default 2025-06-06T14:19:34.025Z INFO Installing Oracle REST Data Services version 25.1.1.r1411642 in OUAW906DB 2025-06-06T14:19:35.449Z INFO ... Verified database prerequisites 2025-06-06T14:19:35.777Z INFO ... Created Oracle REST Data Services proxy user 2025-06-06T14:19:36.214Z INFO ... Created Oracle REST Data Services schema 2025-06-06T14:19:36.741Z INFO ... Granted privileges to Oracle REST Data Services 2025-06-06T14:19:39.255Z INFO ... Created Oracle REST Data Services database objects 2025-06-06T14:19:50.792Z INFO Completed installation for Oracle REST Data Services version 25.1.1.r1411642. Elapsed time: 00:00:16.744 2025-06-06T14:19:50.860Z INFO Completed configuring PL/SQL gateway user for Oracle REST Data Services version 25.1.1.r1411642. Elapsed time: 00:00:00.67 2025-06-06T14:19:50.862Z INFO Log file written to /u01/ouaw/ords_install_log/ords_install_2025-06-06_141933_94132.log
-
Navigate to the ORDS directory. You will find the ords.war
Example: cd </u01/ouaw/ords>
-
To create i.war, complete these steps.
- Create a directory which is the source for your web archive. In that directory, create a WEB-INF directory with the following web.xml and weblogic.xml.
mkdir -p /u01/ouaw/temp/WEB-INF
-
Create web.xml and weblogic.xml inside WEB-INF folder.
cd /u01/ouaw/temp/WEB-INF
web.xml<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" "http://java.sun.com/j2ee/dtds/web-app_2_3.dtd"> <web-app> <!-- This Web-App leverages the alternate doc-root functionality in WebLogic to serve static content For WebLogic refer to the weblogic.xml file in this folder --> </web-app>
weblogic.xml<weblogic-web-app xmlns="http://www.bea.com/ns/weblogic/weblogic-web-app"> <!-- This element specifies the context path the static resources are served from --> <context-root>/i</context-root> <virtual-directory-mapping> <!-- This element specifies the location on disk where the static resources are located --> <local-path></scratch/apex/apex_21.2_en/images></local-path> <url-pattern>/*</url-pattern> </virtual-directory-mapping> </weblogic-web-app>
Note:
<local-path> is the path of apex image folder. - To create i.war with the web.xml and weblogic.xml files, execute the following command:
export JAVA_HOME=</u01/ouaw/java17> export PATH=$JAVA_HOME/bin:$PATH jar cMf i.war WEB-INF/web.xml WEB-INF/weblogic.xml
Note:
For more information, refer to Deploying Oracle REST Data Services. - Create a directory which is the source for your web archive. In that directory, create a WEB-INF directory with the following web.xml and weblogic.xml.
Create the Apex Domain
This section describes how to create the apex domain. The apex domain is configured on the application server using the ords.war and i.war files generated in the previous procedure.
-
Navigate to the following directory: <FMW HOME>/oracle_common/common/bin.
-
Add JAVA_HOME/bin to the PATH variable.
export JAVA_HOME=<JAVA HOME PATH> export PATH=$JAVA_HOME/bin:$PATH
-
Execute the following command to launch the Oracle Fusion Middleware Configuration Wizard for <apex_domain> configuration:
./config.sh
-
On the Create Domain screen, select Create a new domain, and click Next.
Field Name and Description Value Domain Location: Enter the location where the apex_domain can be created. Example: </u01/ouaw/domains/apex_domain> -
On the Templates page, below the Available Templates list, select Basic WebLogic Server Domain and click Next.
-
On the Administrator Account page, enter the following values and click Next.
Field Name and Description Value Name: Enter the user name. weblogic Password: Enter the WebLogic user password. <weblogic user password> Confirm Password: Enter the same WebLogic user password as above. <weblogic user password> -
On the Domain Mode and JDK page, select the options as shown below, and click Next.
Field Name and Description Value Domain Mode: Select the appropriate domain mode. Production mode JDK: Select the JDK location using a browser. Example: <JAVA HOME> -
On the Advanced Configuration page, select Administration Server and Topology.
-
On the Administration Server page, enter the values as in the table below, and click Next.
Field Name and Description Value Server Name: Enter the Admin server name. AdminServer Listen Address: Enter the listen address. All local addresses Listen Port: Enter the listen port number. Example: <12000> -
On the Managed Servers page, enter the following values to add a managed server. Click Next.
Field Name and Description Value Server Name: Enter the managed server name. Example: <apex_server1> Listen Address: Enter the listen address. All local addresses. Listen Port: Enter the listen port number. Example: <12001> -
Click Next on the Clusters, Server Templates, Machines, Virtual Targets and Partitions pages respectively. There is nothing to add or change to these pages.
-
On the Configuration Summary page, click Create .
-
On the Configuration Progress page, wait until the progress bar is 100% complete and then click Next.
-
On the End Of Configuration page, you will find the domain path and the administration server URL that will be used in the following steps. Click Finish.
Start the Apex Domain
-
Navigate to the appropriate <apex_domain>.
Example: cd <apex_domain>
-
Create the boot.properties file under the AdminServer and Managedserver '<APEX DOMAIN>/servers' location.
mkdir -p AdminServer/security mkdir -p apex_server1/security
-
Enter the following lines to
boot.properties
:username=weblogic password=weblogic123
-
Start the administration server and managed server apex_server1.
cd <APEX DOMAIN>/bin nohup ./startWebLogic.sh > adminserver.log 2>&1 & nohup ./startManagedWebLogic.sh apex_server1 > apex_server1.log 2>&1 &
Install the ords.war and i.war Files
Installing ords.war and i.war in WebLogic 12c
-
Log in to the <apex domain> WebLogic administration console and click the Lock & Edit button located in the Change Center.
-
On the Domain Structure panel, select Deployments and then click Install.
-
Enter the appropriate path and then select the ords.war file. Click Next.
Example: </u01/ouaw/ords>
-
Select the deployment target as <apex_server1>.
-
Enter the following information on the application assistant:
Field Name and Description Value Name: Enter the deployment name. ords Security: Select the security model to be used. Select the Custom Roles option. Source accessibility: Select the source accessibility option. Select theUse the defaults defined by the deployment's targetsoption. -
The location of ords.war file and target will appear on the Summary section. Click Finish.
-
After saving the ords.war deployment, click on the Activate Changes button located in the Change Center.
-
Repeat the above steps to deploy the i.war file.
-
On the WebLogic administration console, navigate to Deployment > Control .
-
Select i and ords, and then click Start > Servicing All Requests.
-
Restart the administration and managed servers.
Installing ords.war and i.war in WebLogic 14c
Note:
To access the WebLogic 14c admin console, you need to install the WebLogic Remote Console in your system. Refer to WebLogic Remote Console for more information.-
Log in to the <apex domain> WebLogic administration console.
-
Navigate to Edit Tree > Deployments > App Deployments > New.
-
Enter the appropriate values for Name (Example: i), Targets (Example: Apex Managed Server apex_server1), and Source Path (Example: full path of the i.war file location).
-
Click Create and Save then the Commit Changes (
) button.
-
Repeat steps 2 to 4 to deploy the ords.war file.
-
Navigate to Monitoring Tree > Deployments > Application Management.
-
Select the i and ords checkboxes then click Start > Servicing All Requests.
-
Stop the Apex administration and managed servers.
-
Add this parameter to the end of setDomainEnv.sh, which is in the Apex Domain/bin folder.
JAVA_OPTIONS="${JAVA_OPTIONS} -Dconfig.url=/u01/ouaw/ords_configuration"
Note:
Dconfig.url is the path of ords configuration folder. -
Restart the Apex administration and managed servers.
Access the AdminTool
-
Access the AdminTool from the following URL: http://<hostname>:<apex_server1_port>/ords/f?p=104
-
Provide the following credentials to access the Admin Tool.
Username: Admin
Password: Admin_123
Note:
After logging in to the application for the first time, you will be asked to change your password. -
After logging in, you can get the following Admin Tool access to ETL Configuration and ETL Job Execution.
Change Default Password of the Admin User
begin
wwv_flow_api.set_security_group_id(p_security_group_id=>nvl(wwv_flow_application_install.get_workspace_id,2090606133849294));end;
/
begin
apex_util.edit_user(
p_user_id => '1467765078687596',
p_user_name => 'ADMIN',
p_web_password => 'New password',
p_new_password => 'New password'
);
end;
/
commit;
/
Note:
It is strongly recommended that you change the default password after logging in.Upgrade Apex and ORDS
Apex Domain In-Place Upgrade
-
Log in to the Apex Domain admin console.
-
Remove ords.war and i.war applications from the Apex WebLogic console.
- Log in to APEX WebLogic console.
-
Navigate to Deployments > Control.
-
Click Stop and select Force Stop Now.
-
Click Yes.
-
On the Configuration tab, click Lock and Edit.
-
Under Deployments, select i and ords.
-
Click Delete.
-
Confirm the deletion and click Activate Changes.
-
Upgrade the Apex Domain to use WebLogic 14c. Refer to Apex Domain In-Place Upgradefor more information.
Upgrading Apex to 24.2
-
Log in to the target database server and navigate to the Apex 24.2 extracted directory.
Example: cd </u01/ouaw/apex>
-
Connect to the Oracle Utilities Analytics Warehouse Database with sys user and execute the following commands in order:
export ORACLE_HOME=<ORACLE_HOME> export ORACLE_SID=<DATABASE SERVICE NAME> export PATH=$ORACLE_HOME/bin:$PATH sqlplus sys/<sys user password>@<database service name> as sysdba @apxrtins.sql <Tablespace name> <Tablespace name> <Temp Tablespace name> /i/
Example:
@apxrtins.sql <CISTS_01> <CISTS_01> <TEMP> /i/
-
Set Apex Admin account and password. Execute the following:
@apxchpwd.sql
-
Run the following SQL:
ALTER USER APEX_PUBLIC_USER ACCOUNT UNLOCK; ALTER USER APEX_PUBLIC_USER IDENTIFIED BY APEX_PUBLIC_USER; @apex_rest_config.sql
Note:
Make sure to note the password for these two users: APEX_LISTENER user and APEX_REST_PUBLIC_USER.
Upgrading ORDS to 25.1.1
-
Uninstall the existing ords.war from the database by navigating to the old ords unzip location on the application server and executing these commands:
cd </u01>/<ords> export JAVA_HOME=<JAVA HOME> export PATH=$JAVA_HOME/bin:$PATH java -jar ords.war uninstall
- Install ORDS 25.1.1. Refer to Installing ORDS 25.1.1for more information.
-
Deploy i.war and ords.war. Refer to Installing ords.war and i.war in WebLogic 14c for more information.