[1

]
Oracle®
REST Data Services

Installation and Configuration Guide
Release 2.0
E25066-12

October 2014

Oracle REST Data Services Installation and Configuration Guide, Release 2.0
E25066-12
Copyright © 2011, 2014, Oracle and/or its affiliates. All rights reserved.
Primary Author: Chuck Murray
Contributors: Colm Divilly, Hilary Farrell, Terri Jennings, Sharon Kennedy, Ganesh Pitchaiah, Kris Rice,
Elizabeth Saunders, Drue Swadener, Jason Straub, Vladislav Uvarov, Rodney Ward
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.

Contents
Preface ................................................................................................................................................................. v
Topic Overview ...........................................................................................................................................
Audience.......................................................................................................................................................
Documentation Accessibility .....................................................................................................................
Related Documents .....................................................................................................................................
Conventions .................................................................................................................................................
Third-Party License Information...............................................................................................................

v
v
vi
vi
vi
vi

1 Installing Oracle REST Data Services
1.1
1.2
1.2.1
1.2.2
1.2.3
1.3
1.4
1.4.1
1.4.2
1.4.3
1.4.4
1.4.4.1
1.4.4.2
1.4.5
1.5
1.5.1
1.5.2
1.5.3
1.6
1.6.1
1.6.2
1.6.3
1.6.4
1.6.5
1.6.6
1.6.7

About Oracle REST Data Services ............................................................................................ 1-1
Understanding the Installation Process................................................................................... 1-2
Supported Java EE Application Servers ........................................................................... 1-2
System Requirements.......................................................................................................... 1-2
About Installing Oracle REST Data Services ................................................................... 1-2
Installing Oracle REST Data Services....................................................................................... 1-3
Configuring Oracle REST Data Services.................................................................................. 1-3
About Using the Command-Line Interface ..................................................................... 1-4
About the Database Users Used by Oracle REST Data Services................................... 1-4
Downloading and Configuring Oracle REST Data Services ......................................... 1-4
Using SQL Developer Oracle REST Data Services Administration (Optional) .......... 1-5
About SQL Developer Oracle REST Data Services Administration ..................... 1-5
Configuring an Administrator User .......................................................................... 1-6
Using OAuth2 in Non HTTPS Environments ................................................................. 1-6
Running in Standalone Mode ................................................................................................... 1-7
Starting in Standalone Mode.............................................................................................. 1-7
Stopping the Server in Standalone Mode......................................................................... 1-7
About JServ Protocol (AJP) Support ................................................................................. 1-8
Deploying to Oracle WebLogic Server .................................................................................... 1-8
About Oracle WebLogic Server ......................................................................................... 1-8
Downloading and Unzipping Oracle REST Data Services............................................ 1-8
Configuring Oracle REST Data Services .......................................................................... 1-8
Configuring Oracle Application Express Images ........................................................... 1-9
Launching the Administration Server Console............................................................... 1-9
Installing the Oracle WebLogic Server Deployment ..................................................... 1-9
Configuring WebLogic to Handle HTTP Basic Challenges Correctly ...................... 1-11

iii

......... 1-11 1-11 1-12 1-12 1-12 1-12 1-12 1-13 1-13 1-14 1-14 1-14 1-14 1-14 1-15 2 Configuring Oracle REST Data Services 2...........................1..................8........................... Understanding the url-mapping...............3.............................9 Verifying the State and Health of apex and i......... Configuring Oracle Application Express Images .........................2 Configuring Additional Databases ...................................................................................1 1.......................... Caching................1 A.........................4 1............. 2-2 2.........1........7.......................................................................2 Configuring Security................ 2-3 2....................1 Configuring Multiple Databases .......... Launching the Administration Server Console....5 1...........3 Developing RESTful Services for Use with Oracle REST Data Services.............. Installing the GlassFish Server Deployment................. and Excel Settings 2-4 2........7 1............................. A-1 A-1 A-1 A-2 A-2 A-3 B Troubleshooting B.....................................6................................................................ Setting the Location of the Configuration Files ..... About Apache Tomcat ................. 2-1 2......................... 2-3 2...........4 A.....................1 B........... B-1 Configuring Application Express Static Resources with Oracle REST Data Services ....................... Deploying to GlassFish Server ............................ 2-3 2....8.................... Downloading and Unzipping Oracle REST Data Services........ Configuring Oracle REST Data Services .........................................................................................................................................................................1 Example of Routing Based on Request Path Prefix ............2 1.........xml File Format ......................................................................................... Upgrading Oracle REST Data Services ......6 1.................................................................................7.................................................................................................1...........................................1 1.7..................................... B-1 .....3 1....... Installing the Apache Tomcat Deployment .......................................7...........4... Configuring Oracle REST Data Services ........8 1........................................5 1....... Environment.........................1 A......................................2 1...8 1.... 2-4 A About the Configuration File A..2 B............8........................................................8....1 Example of Routing Based on Request URL Prefix....1 About the Request URL .... B-1 Enabling Detailed Request Error Messages . Understanding the Configuration File Format........ About GlassFish Server......................................................................1...1......8.......4......................and Post Processing............7............... 2-1 2.7.................................... Downloading and Unzipping Oracle REST Data Services.......................3 1........................3 A..... 2-2 2................................................................... Pre..... Understanding Configurable Parameters ..............5 Locating Configuration Files........................................1........................................................................ Configuring Oracle Application Express Images .........1...............2 A... Deploying to Apache Tomcat .................................................................................4 Routing Based on Request URL Prefix ..............3 Routing Based on the Request Path Prefix............................................................................ Understanding the Configuration Folder Structure ..........................3 Index iv Enabling Debug Tracing .........4 1........

0. especially REST (Representational State Transfer). Name Change: Topics: Topic Overview ■ ■ Audience ■ Documentation Accessibility ■ Related Documents ■ Conventions ■ Third-Party License Information Topic Overview Title Description Installing Oracle REST Data Services Describes how to download. and deploy Oracle REST Data Services in various environments. Configuring Oracle REST Data Services Explains how to configure Oracle REST Data Services for connecting to multiple databases for routing requests. This guide assumes you are familiar with web technologies.Preface Oracle REST Data Services Installation and Configuration Guide explains how to install and configure Oracle REST Data Services. About the Configuration File Describes the Oracle REST Data Services configuration file. Oracle REST Data Services was called Oracle Application Express Listener before Release 2. and have a general understanding of Windows and UNIX platforms. install. Audience This document is intended for system administrators or application developers who are installing and configuring Oracle REST Data Services. Troubleshooting Describes how to enable debug tracing and detailed request error messages using the Oracle REST Data Services configuration file. configure.6. v . run.

Documentation Accessibility For information about Oracle's commitment to accessibility.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired. however. see the following the Oracle Technology Network (OTN) site: http://www.oracle. code in examples. Note. and the terms contained in the following notices do not change those rights. text that is displayed on the screen. Third-Party License Information Oracle REST Data Services contains third-party code. or placeholder variables for which you supply particular values. that the Oracle program license that accompanied this product determines your right to use the Oracle program. or terms defined in text or the glossary. visit http://www. visit the Oracle Accessibility Program website at http://www.com/technetwork/developer-tools/rest-data-services/ Conventions The following text conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements associated with an action. Access to Oracle Support Oracle customers have access to electronic support through My Oracle Support.oracle. vi .com/pls/topic/lookup?ctx=acc&id=docacc. including the third-party software. See the Oracle Database Licensing Information book for notices Oracle is required to provide. monospace Monospace type indicates commands within a paragraph.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle. emphasis. Related Documents For more information and resources relating to Oracle REST Data Services. italic Italic type indicates book titles. or text that you enter. For information. URLs.

Apache Tomcat. file caching. The Oracle Application Express architecture requires some form of web server to proxy requests between a web browser and the Oracle Application Express engine. Oracle REST Data Services satisfies this need but its use goes beyond that of Oracle Application Express configurations.1 About Oracle REST Data Services Oracle REST Data Services is a Java EE-based alternative for Oracle HTTP Server and mod_plsql. Installing Oracle REST Data Services 1-1 .0. GlassFish Server. The Java EE implementation offers increased functionality including a command line based configuration. Name Change: Topics: ■ About Oracle REST Data Services ■ Understanding the Installation Process ■ Installing Oracle REST Data Services ■ Configuring Oracle REST Data Services ■ Running in Standalone Mode ■ Deploying to Oracle WebLogic Server ■ Deploying to GlassFish Server ■ Deploying to Apache Tomcat ■ Upgrading Oracle REST Data Services 1. and a standalone mode.6. enhanced security. as connectivity is provided using an embedded JDBC driver. Oracle REST Data Services simplifies the deployment process because there is no Oracle home required.) Oracle REST Data Services was called Oracle Application Express Listener before Release 2. and RESTful web services.1 Installing Oracle REST Data Services 1 This section describes how to install and deploy Oracle REST Data Services. (REST stands for Representational State Transfer. Oracle REST Data Services also provides increased flexibility by supporting deployments using Oracle WebLogic Server.

Standard Edition or Standard Edition One) release 10.2 Understanding the Installation Process This section offers an overview of Oracle REST Data Services and provides information about supported Java Platform. or Oracle Database 10g Release 2 Express Edition or later.3.3 About Installing Oracle REST Data Services To install Oracle REST Data Services: 1.2.0 or later.1 Supported Java EE Application Servers Oracle REST Data Services supports the following Java EE application servers: Application Server Supported Release Oracle WebLogic Server 11g Release 1 (10. – If you want to use RESTful Services.2. – Ensure that all steps of the Oracle Application Express installation process have been completed. Oracle Application Express: – Oracle REST Data Services depends on Oracle Application Express for storing and creating RESTful Services. ■ Java Servlet Specification 2. See Section 1. Download and unzip Oracle REST Data Services. – Mozilla Firefox 3.2.3.0 or later. Topics: ■ Supported Java EE Application Servers ■ System Requirements 1. including the step "Configure RESTful Services" in Oracle Application Express Installation Guide.Understanding the Installation Process 1. then Oracle Application Express 4. ■ Java 6 Update 20 JDK or later. – If you do not want to use RESTful Services. "Installing Oracle REST Data Services".3) or later GlassFish Server Release 3 or later Apache Tomcat Release 6 or later 1.0 or later.0. then the use of any Oracle Application Express version is supported.2 or later is required. Enterprise Edition (Java EE) application servers and system requirements.3 or later. – Google Chrome 2. ■ Web browser requirements: – Microsoft Internet Explorer 8.2 System Requirements Oracle REST Data Services system requirements are as follows: ■ ■ Oracle Database (Enterprise Edition. 1-2 Oracle REST Data Services Installation and Configuration Guide .3 or later.2. 1.

See Section 1. Deploy Oracle REST Data Services. 2. "Deploying to GlassFish Server".html Note that the version.number. See Section 1. See Section 1. you must configure it using a command-line interface. ■ Apache Tomcat. Deployment options include: ■ ■ Standalone Mode.number in the file name reflects the current release number.zip Windows: Double-click the file ords. "Deploying to Oracle WebLogic Server".version. "Running in Standalone Mode".8. See Section 1.7. "Troubleshooting" See Also: 1. Download the file ords.oracle. ■ GlassFish Server. This section describes the various ways you can configure Oracle REST Data Services.number. Section 1. Tip: To quickly get started with Oracle REST Data Services execute the following command: java -jar ords. Unzip the downloaded zip file into a directory (or folder) of your choice: ■ ■ UNIX and Linux: unzip ords.version. 3. Oracle WebLogic Server.zip in Windows Explorer 1.war You are prompted to enter some information.5. and it then starts in Standalone Mode. Configure Oracle REST Data Services. See Section 1.4. "Upgrading Oracle REST Data Services" and Appendix B.number.3 Installing Oracle REST Data Services To install Oracle REST Data Services: 1.zip from the Oracle REST Data Services download page. "Deploying to Apache Tomcat". See: http://www. "Configuring Oracle REST Data Services".version.Configuring Oracle REST Data Services 2.9. Topics: About Using the Command-Line Interface ■ ■ About the Database Users Used by Oracle REST Data Services ■ Downloading and Configuring Oracle REST Data Services ■ Using SQL Developer Oracle REST Data Services Administration (Optional) ■ Using OAuth2 in Non HTTPS Environments Installing Oracle REST Data Services 1-3 .6.4 Configuring Oracle REST Data Services Before you deploy Oracle REST Data Services.com/technetwork/developer-tools/rest-data-services/do wnloads/index.

4. 3.4. all Oracle Application Express operations.war 1-4 Oracle REST Data Services Installation and Configuration Guide . To configure Oracle REST Data Services: 1. Download and unzip Oracle REST Data Services. Change your active directory to the directory where you unzipped Oracle REST Data Services. for example.2 About the Database Users Used by Oracle REST Data Services Oracle REST Data Services uses the following database users: User Name Required Description APEX_PUBLIC_USER Yes If you use Oracle REST Data Services with Oracle Application Express. For information on unlocking the APEX_ PUBLIC_USER.3. 1. enter help followed by the command name. "Installing Oracle REST Data Services". Execute the following command: java -jar ords. execute the following command: java –jar ords. for example: java -jar ords. See Section 1. configure the database Oracle REST Data Services uses. To display a full list of available commands. see "Configure APEX_ PUBLIC_USER Account" in Oracle Application Express Installation Guide.4.3 Downloading and Configuring Oracle REST Data Services Note: You must complete the configuration steps in this section before deploying to an application server. To see instructions on how to use each of these commands. this is the database user used when invoking PL/SQL Gateway operations.war help A list of the available commands is displayed.war help configdir 1. and start Oracle REST Data Services in standalone mode. For example. 2. you can configure the location where Oracle REST Data Services stores configuration files. APEX_REST_PUBLIC_USER Only if using RESTful Services The database user used when invoking RESTful services APEX_LISTENER Only if using RESTful Services The database user used to query RESTful Services definitions stored in Oracle Application Express Each of these database users is created during the Oracle Application Express installation process.1 About Using the Command-Line Interface Oracle REST Data Services provides several command line commands.Configuring Oracle REST Data Services 1.

4. press Enter without entering anything. There is no default value.Enter the location where you want to store Oracle REST Data Services configuration data. – Database SID .Options include: – Choose passwords . Database user name .2 and later) enables you to administer Oracle REST Data Services using a graphical user interface. Passwords for RESTful Services Database Accounts .Enter 2 to use the same password for APEX_LISTENER and APEX_REST_PUBLIC_USER as used for APEX_PUBLIC_ USER. You are prompted to enter the following data: ■ ■ ■ ■ ■ ■ ■ Location to store configuration data . When prompted.1 About SQL Developer Oracle REST Data Services Administration Oracle SQL Developer (release 3.4.Enter the port number that database is listening on. enter the information required to complete the configuration process. The default value is APEX_PUBLIC_USER. The default value is localhost. "About the Database Users Used by Oracle REST Data Services" See Also: 1. The default value is 1521. Each prompt may have a default response enclosed in brackets []. Database service name or database SID . "Oracle REST Data Services Administration" in Oracle SQL Developer User's Guide See Also: Topics: About SQL Developer Oracle REST Data Services Administration ■ ■ Configuring an Administrator User 1. Note that entering 3 disables RESTful Services.4. Using SQL Developer for Oracle REST Data Services administration is optional.Enter 2 to specify the database SID. Database listener port . – Skip passwords .Configuring Oracle REST Data Services 4.4 Using SQL Developer Oracle REST Data Services Administration (Optional) This section describes how to use Oracle SQL Developer to administer Oracle REST Data Services. Installing Oracle REST Data Services 1-5 .Options include: – Database service name .Enter the name of the database server. There is no default value.4.Enter 1 to specify passwords for APEX_LISTENER and APEX_REST_PUBLIC_USER accounts (the default value). Name of the database server . – Re-use APEX_PUBLIC_USER password .Enter 3 to skip configuring RESTful Services.Enter the database user name to use for all PL/SQL Gateway operations. To choose the default response.Enter the database password for the user specified in the previous step.Enter 1 to specify the database service name (the default value).2. Database user password . Section 1.

Oracle SQL Developer also provides statistical reporting. This default behavior can be disabled in environments where HTTPS is not available as follows: 1. Add the following setting to the end of this file just before the </properties> tag. Note: Oracle REST Data Services must be restarted after making configuration changes. ■ If you are using Oracle REST Data Services without HTTPS.4. and logging.5 Using OAuth2 in Non HTTPS Environments RESTful Services can be protected with the OAuth2 protocol to control access to nonpublic data. It will refuse to service any such requests received over HTTP. blocked procedures. ■ Confirm the password for the adminlistener user. security (allowed procedures. 5.4. then you must configure an administrator user as follows: ■ Execute the following command: java -jar ords. error reporting. It is never appropriate to use this setting in production environments because it will result in user credentials being passed in clear text. <entry key="security. when prompted.war user adminlistener "Listener Administrator" ■ Enter a password for the adminlistener user.4. Edit the file named defaults. enter the credentials provided in the preceding list.xml. The default behavior of Oracle REST Data Services is to verify that all OAuth2 related requests have been received using HTTPS. See your application server documentation for information on how to restart applications. follow the steps in Section 1. and Excel Settings.2 Configuring an Administrator User If you want to be able to administer Oracle REST Data Services using SQL Developer. To prevent data snooping.Configuring Oracle REST Data Services Using this graphical user interface. 1-6 Oracle REST Data Services Installation and Configuration Guide . "Oracle REST Data Services Administration" in Oracle SQL Developer User's Guide See Also: 1. returning an HTTP status code of 403 Forbidden.4. Locate the folder where the Oracle REST Data Services configuration is stored. 2. Save the file. When using SQL Developer to retrieve and/or upload an Oracle REST Data Services configuration. Restart Oracle REST Data Services if it is running. 1. OAuth2 requires all requests involved in the OAuth2 authentication process to be transported using HTTPS.5. Caching. you can update the database connections. Note that it is only appropriate to use this setting in development or test environments. JDBC settings. URL mappings.verifySSL">false</entry> 4. "Using OAuth2 in Non HTTPS Environments". 3. validation function and virus scanning). Environment. Pre/Post Processing Procedures. RESTful connections.

you also have the option of running in standalone mode. enter the value of the HTTP port you want the standalone Oracle REST Data Services to listen on. You are only prompted for these values the first time you launch standalone mode.5 Running in Standalone Mode Although Oracle REST Data Services supports the Java EE application servers described in Section 1. and is not supported for use in production deployments. "Supported Java EE Application Servers". "Using OAuth2 in Non HTTPS Environments" must be followed if you want to use RESTful Services that require secure access (including the SQL Developer Administration View).Running in Standalone Mode 1. To start Standalone mode. at a command prompt press Ctrl+C. Use a supported Java EE application server for production deployments. Standalone mode is suitable for development use only. When prompted. Topics: ■ Starting in Standalone Mode ■ Stopping the Server in Standalone Mode ■ About JServ Protocol (AJP) Support 1. so the steps in Section 1.war help standalone Note: Standalone mode does not support HTTPS. The default port 8080 is commonly used by HTTP or application servers including the embedded PL/SQL gateway.1. The default port is 8080. specify the location of the folder containing the Oracle Application Express static resources used by Oracle REST Data Services. 1.2.war If you have not yet completed configuration.1 Starting in Standalone Mode To launch Oracle REST Data Services in standalone mode: 1. Installing Oracle REST Data Services 1-7 . When prompted. you are prompted to do so. or press Enter if you do not want to specify this location.5.4. execute the following command: java -jar ords. execute the following command: java –jar ords. Tip: To see help on standalone mode options. Note: Ensure that no other servers are listening on the port you choose. 3.2 Stopping the Server in Standalone Mode To stop the Oracle REST Data Services server in standalone mode. This section describes how to run Oracle REST Data Services in standalone mode.5. 2.5.

5.6.6. 1. 1-8 Oracle REST Data Services Installation and Configuration Guide .3 Configuring Oracle REST Data Services You must complete this step before deploying Oracle REST Data Services on WebLogic.war standalone --ajp-port 8009 --apex-images /usr/local/ords/images Note: Enabling AJP implicitly disables HTTP.oracle.4. users and roles. "Configuring Oracle REST Data Services". "Installing Oracle REST Data Services". 1. security. See: http://www. Topics: ■ About Oracle WebLogic Server ■ Downloading and Unzipping Oracle REST Data Services ■ Configuring Oracle REST Data Services ■ Configuring Oracle Application Express Images ■ Launching the Administration Server Console ■ Installing the Oracle WebLogic Server Deployment ■ Configuring WebLogic to Handle HTTP Basic Challenges Correctly ■ Verifying the State and Health of apex and i 1.html To learn more about installing Oracle WebLogic Server. It assumes that you have completed the installation process and are familiar with Oracle WebLogic Server. see Oracle Fusion Middleware Getting Started With Installation for Oracle WebLogic Server and Oracle Fusion Middleware Installation Guide for Oracle WebLogic Server. use the --ajp-port command line option with the standalone command to indicate the port to listen on (usually 8009). To enable the AJP.2 Downloading and Unzipping Oracle REST Data Services For information. 1.com/technetwork/middleware/weblogic/downloads/index.1 About Oracle WebLogic Server You can download Oracle WebLogic Server from Oracle Technology Network.6 Deploying to Oracle WebLogic Server This section describes how to deploy Oracle REST Data Services on Oracle WebLogic Server. managed servers. For example: java -jar ords. refer to your Oracle WebLogic Server documentation.2 and mod_jk).3 About JServ Protocol (AJP) Support Standalone mode supports the Apache JServ Protocol (AJP).6. deployment. see Section 1.3. It is not possible to listen for both protocols simultaneously. For more information. If you are unfamiliar with domains. enabling it to be integrated with web servers that support AJP (for example. Apache 2. see Section 1.Deploying to Oracle WebLogic Server 1.

click the Lock & Edit button on the left-pane below the submenu Change Center. Installing the Oracle WebLogic Server Deployment 3. 4. If your domain is in Development mode.4. you must create a web archive (WAR) file to reference the Oracle Application Express image files.war. 2.6.war file. Start an Administration Server.war help static to see the full range of options for the static command.5 Launching the Administration Server Console To launch the Administration Server console: 1. This command runs the static command contained in the ords.war file to deploy to WebLogic in the following steps: 1. Configuring WebLogic to Handle HTTP Basic Challenges Correctly 1.war and i. See Section 1.war: java -jar ords. it references the location where the static resources are stored. <port> is the port on which the Administration Server is listening for requests (port 7001 by default).3. ords.6. Use the static command to create a web archive file named i. Enter your WebLogic Administrator username and password. must be available before you start this task.war static <apex directory>\images Where: ■ <apex directory> is the directory location of Oracle Application Express. 3. It packages the Application Express static images into an archive file named i. Tip: Use java -jar ords.war. Therefore the static resources must be available at the specified path on the server where the WAR is deployed. 1. "Configuring Oracle Application Express Images" To install the deployment: Installing Oracle REST Data Services 1-9 . Launch the WebLogic Administration Console by typing the following URL in your web browser: http://<host>:<port>/console Where: ■ ■ <host> is the DNS name or IP address of the Administration Server. "Installing Oracle REST Data Services" and Section 1.Deploying to Oracle WebLogic Server 1.6.6 Installing the Oracle WebLogic Server Deployment Tip: The Oracle REST Data Services files.4 Configuring Oracle Application Express Images Before you begin. instead. this button does not appear. If your domain is in Production mode. The created images WAR does not contain the static resources.6. Use the i. Launching the Administration Server Console 2.

Returns you to the Summary of Deployments page. Specify the location of the ords. 5. 10. use policies that are defined in the deployment descriptor c. 11. 8. then you must rename ords.. Select the servers and/or clusters to which you want to deploy the application or module and click Next. Go to the WebLogic Server Home Page. Security . Repeat the previous steps to deploy the i. Below Domain Configuration.war file and click Next.Displays the Configuration page.Enter: i 1-10 Oracle REST Data Services Installation and Configuration Guide . you do not see this assistant page. so that URLs are of the form http://server/apex/. Click Finish. specify the following: a.. The Summary of Deployments is displayed.3. The ords. Click Install. "Installing Oracle REST Data Services". In the Optional Settings. 4. The Install Application assistant is displayed.Deploying to Oracle WebLogic Server 1. 3. If you need to keep backward compatibility. specify the following: a. Under Additional configuration.Select the following: Custom Roles: Use roles that are defined in the Administration Console. 2.Select: Use the defaults defined by the deployment’s targets 7.war to apex. select one of the following: ■ ■ 9. Name .war file..Enter: ords b. Name .. Review the summary of configuration settings that you have specified. Click Next. take me to the deployment’s configuration . Select Install this deployment as an application and click Next. In the optional settings.. Tip: If you have not created additional Managed Servers or clusters. A summary page is displayed. No I will review the configuration later . 6. Tip: WebLogic Server determines the context root from the file name of a WAR archive.war file is located in the folder where you unzipped the Oracle REST Data Services ZIP file. Yes. See Section 1. select Deployments. Source accessibility . rather than http://server/ords/.war before the deployment.

xml Add the <enforce-valid-basic-auth-credentials> element to config. Save the updated config. 1. Topics: ■ About GlassFish Server ■ Downloading and Unzipping Oracle REST Data Services ■ Configuring Oracle REST Data Services ■ Configuring Oracle Application Express Images ■ Launching the Administration Server Console ■ Installing the GlassFish Server Deployment Tip: This section assumes that you have completed the installation process and are familiar with GlassFish Server. If you are unfamiliar with domains.6. 1. Source Accessibility .7 Configuring WebLogic to Handle HTTP Basic Challenges Correctly By default WebLogic attempts to intercept all HTTP Basic Authentication challenges. see your GlassFish Server documentation. <enforce-valid-basic-auth-credentials>false</enforce-valid-basic-auth-credentials> </security-configuration> . applications. Click Start and select Servicing all requests to make them active.6. and restart WebLogic if it is running.Deploying to GlassFish Server b. servers. then on the Change Center click Activate Changes.8 Verifying the State and Health of apex and i In the Summary of Deployments. The edited file should look like the following: ..xml within the<security-configuration> element. See your WebLogic documentation for the location of the WebLogic configuration file named: config.xml file. If apex or i are not Active.Select: Custom Roles: Use roles that are defined in the Administration Console.. If your domain is in Production Mode. 1. users and roles. select the check box adjacent to apex and/or i. This default behavior needs to be disabled for Oracle REST Data Services to function correctly...7 Deploying to GlassFish Server This section describes how to deploy Oracle REST Data Services on GlassFish Server. In the Deployments table. select the Control tab and verify that both the apex and i State are Active and the Health status is OK. use policies that are defined in the deployment descriptor c. then enable them. Installing Oracle REST Data Services 1-11 . Security . security.Select: Use the defaults defined by the deployment’s targets 12.

see Section 1. Therefore the static resources must be available at the specified path on the server where the WAR is deployed.4.Deploying to GlassFish Server 1. it references the location where the static resources are stored.4 Configuring Oracle Application Express Images Before you begin. you must create a web archive (WAR) file to reference the Oracle Application Express image files.7.war help static to see the full range of options for the static command. Use the static command to create a web archive file named i. see Section 1.7.7.oracle.5 Launching the Administration Server Console At least one GlassFish server domain must be started before you start the Administration Console. To launch the Administration Console: 1. Use the i. Launching the Administration Server Console 2.3 Configuring Oracle REST Data Services You must complete this step before deploying Oracle REST Data Services on GlassFish.com/us/products/middleware/application-server/oracle-gla ssfish-server/index.7.1 About GlassFish Server You can install Oracle REST Data Services with GlassFish Server.7. See: http://www. Tip: Use java -jar ords.war file to deploy to GlassFish in the following steps: 1.war static <apex directory>\images Where: ■ <apex directory> is the directory location of Oracle Application Express. instead.2 Downloading and Unzipping Oracle REST Data Services For information. If prompted. For more information. Tip: You are prompted to log in if you chose to require an administration password at the time GlassFish server was installed. log in to the Administration Console. GlassFish Server is available for download from the Oracle Technology Network.html 1.war: java -jar ords. 1. "Installing Oracle REST Data Services". 1-12 Oracle REST Data Services Installation and Configuration Guide . Installing the GlassFish Server Deployment 1. "Configuring Oracle REST Data Services". Launch the Administration Console by typing the following URL in your web browser: http://localhost:4848 2. The created images WAR does not contain the static resources. 1.3.

Clear the Context Root field so that the context root set in the sun-web. Application Name: ords d. Navigate to the location of the ords. and click Open. specify the following: a...war file. Accept all other default settings and click OK. Type: Web Application b. so that URLs are of the form http://server/apex/. 5.. Status: Enabled e.3. "Configuring Oracle Application Express Images".4. A check mark should appear in the Enabled field for ords Tip: If a check mark does not appear in the Enabled column for ords. then select the check box next to ords and click Enable.7.. 3. c. The Deploy Applications or Modules page is displayed.war and i. Tip: 6. Select Packaged File to be Uploaded to the Server and click Browse. See Section 1. select the file.war must be available before you start this task. However you can change it to apex if you need to keep backward compatibility. Click the Deploy button. On the navigation tree..6 Installing the GlassFish Server Deployment Tip: The Oracle REST Data Services files. 1. "Installing Oracle REST Data Services" and Section 1.7. ords. The Deploy Applications or Modules page is displayed. On the Deploy Applications or Modules page.war file. Context Root: ords The Context Root value defaults to ords. Description: Oracle REST Data Services f.Deploying to Apache Tomcat 1. The Applications page is displayed. click the Application node. The Applications page is displayed. Repeat the previous steps to deploy the i.8 Deploying to Apache Tomcat This section describes how to deploy Oracle REST Data Services on Apache Tomcat. Topics: ■ About Apache Tomcat ■ Downloading and Unzipping Oracle REST Data Services ■ Configuring Oracle REST Data Services ■ Configuring Oracle Application Express Images Installing Oracle REST Data Services 1-13 . 4. rather than http://server/ords/. 2.xml is used. To install the deployment: 1.

2 Downloading and Unzipping Oracle REST Data Services For information.8.3 Configuring Oracle REST Data Services You must complete this step before deploying Oracle REST Data Services on Apache Tomcat. See Section 1.Deploying to Apache Tomcat ■ Installing the Apache Tomcat Deployment 1.4 Configuring Oracle Application Express Images To configure Oracle Application Express Images on Apache Tomcat: ■ Copy the contents of the <apex directory>/images folder to <Tomcat directory>/webapps/i/.apache. 2.8.8.war before moving it into to the webapps folder. Tip: Apache Tomcat determines the context root from the file name of a WAR archive. 1. "Configuring Oracle Application Express Images". 1. For more information. Move the ords. To install the Apache Tomcat deployment: 1. security. "Installing Oracle REST Data Services" and Section 1. servers.8. rather than http://server/ords/.3...1 About Apache Tomcat You can download Apache Tomcat from: http://tomcat.3. "Installing Oracle REST Data Services". If you need to keep backward compatibility. then you must rename ords. Where: – <apex directory> is the directory location of the Oracle Application Express distribution.5 Installing the Apache Tomcat Deployment Tip: The Oracle REST Data Services file ords.4. see Section 1.war file into the webapps folder where Apache Tomcat is installed. If you are unfamiliar with domains.org/download-70.cgi Tip: This section assumes that you have completed the installation process and are familiar with Apache Tomcat. "Configuring Oracle REST Data Services". 1.8. see Section 1.4. Access Oracle REST Data Services typing the following URL in your web browser: http://<hostname>:<port>/ords Where: 1-14 Oracle REST Data Services Installation and Configuration Guide .. so that URLs are of the form http://server/apex/.. applications.war to apex. see your Apache Tomcat documentation. users and roles.. 1. – <Tomcat directory> is the folder where Apache Tomcat is installed.8.war must be available before you start this task.

If the configuration folder specified during Section 1.9 Upgrading Oracle REST Data Services In Oracle REST Data Services 2.4.1 configuration. Installing Oracle REST Data Services 1-15 .Upgrading Oracle REST Data Services ■ <hostname> is the name of the server where Apache Tomcat is running.0. the format of configuration files has changed and RESTful Services (also known as Resource Templates) are now stored in the Oracle Application Express schema.0 format. "Configuring Oracle REST Data Services" contains an existing Oracle REST Data Services 1. the configuration and any RESTful Services are migrated to 2. ■ <port> is the port number configured for Apache Tomcat application server. 1.

Upgrading Oracle REST Data Services 1-16 Oracle REST Data Services Installation and Configuration Guide .

Caching. Consider the following URL: https://www.1 Configuring Multiple Databases Oracle REST Data Services supports the ability to connect to more than one database.com/ords/sales/f?p=1:1 This URL consists of the following sections: ■ Protocol: https Configuring Oracle REST Data Services 2-1 . Environment. Topics: ■ Configuring Multiple Databases ■ ■ Configuring Security. It is useful to recap the pertinent portions of a request URL. Topics: ■ About the Request URL ■ Configuring Additional Databases ■ Routing Based on the Request Path Prefix ■ Routing Based on Request URL Prefix 2.and Post Processing. All of these strategies rely on examining the request URL and choosing the database based on some kind of match against the URL.2 Configuring Oracle REST Data Services 2 This section explains how to configure Oracle REST Data Services for connecting to multiple databases for routing requests. See your application server documentation for information on how to restart applications. and Excel Settings Developing RESTful Services for Use with Oracle REST Data Services 2. Note: Oracle REST Data Services must be restarted after making configuration changes. This section describes different strategies for routing requests to the appropriate database.example.1. and it refers to other documentation sources for other configuration information.1 About the Request URL Oracle REST Data Services supports a number of different strategies for routing requests to the appropriate database. Pre.

war setup --database <database name> Where: ■ <database name> is the name you want to give the database connection.example. ■ Request Path: /sales/f?p=1. it may be important to route requests based on certain prefixes in the request path or certain prefixes in the full request URL. Configuring which requests are routed to which database 2.4. You can create additional database connections using the setup command. You are prompted to enter the information required to configure the database.1. "Routing Based on the Request Path Prefix". There are two steps to configuring multiple databases: 1.3. See Section 1.2 Configuring Additional Databases When you first configure Oracle REST Data Services. you configure a default database connection named: apex.war help setup To create a database connection type the following: java -jar ords. "Configuring Oracle REST Data Services" for more information on the data that must be entered. Tip: To see full help for the map-url command type: java -jar ords. After you have configured the additional databases.1.Configuring Multiple Databases ■ Host Name: www.war help map-url If you want to route requests based just on matching a prefix in the request path portion of the URL.3 Routing Based on the Request Path Prefix You create request routing rules using the map-url command. "Routing Based on the Request Path Prefix" and Section 2. use the map-url command as follows: java -jar ords.com ■ Context Root: /ords The context root is the location at which Oracle REST Data Services is deployed on the application server. define the rules for how requests are route to the appropriate database: see Section 2.1. Tip: To see full help for the setup command type: java -jar ords.1 This is the portion of the request URL relative to the context root.war map-url --type base-path --workspace-id <workspace name> <path prefix> <database name> Where: 2-2 Oracle REST Data Services Installation and Configuration Guide .1. For different applications. 2.3. Configuring the database connection information 2.

This may be omitted if RESTful Services are not being used.. then create the following rule: java -jar ords.4.com:8080/ords/sales/f?p=1:1 (The port is wrong: 443 is default for https. <database name> is the name of the database connection configured in the previous step.3. are routed to the sales_db database connection.com resolves to the same system as example.example.example.) (If The previous rule does not match of any of the following requests: http://example. then create the following rule: java -jar ords.1 Example of Routing Based on Request URL Prefix Assuming Oracle REST Data Services is deployed on a system named example. ■ <url prefix> is the prefix with which the request URL must start.) https://example.com/ords/sales/f?p=1:1 https://example.1 Example of Routing Based on Request Path Prefix Assuming Oracle REST Data Services is deployed on a system named example.) 2. This may be omitted if RESTful Services are not being used.1. ■ <database name> is the name of the database connection.com at the context path /ords.2.com/ords/sales/leads/ https://www. Section 2.war map-url --type base-url --workspace-id sales_rest https://example.com/ords/sales/forecasting.) https://example. The sales_rest workspace defined within the sales_db database is searched for RESTful Services definitions. The previous rule matches all of the following requests: https://example.1.com/ords/sales/f?p=1:1 (The protocol is wrong.) https://example. 2.com/ords/f?p=1:1 (Missing the /sales prefix.com/pls/sales/leads/ (The context path is wrong.Configuring Multiple Databases ■ ■ ■ <workspace name> is the name of the Oracle Application Express workspace where RESTful services for this connection are defined..com/ords/sales/.com. 2.com/ords/sales sales_db Configuring Oracle REST Data Services 2-3 . "Configuring Additional Databases".report?month=jan www. use the map-url command as follows: java -jar ords.1. but don’t specify if using default.war map-url --type base-url --workspace-id <workspace name> <url prefix> <database name> Where: ■ <workspace name> is the name of the Oracle Application Express workspace where RESTful services for this connection are defined.4 Routing Based on Request URL Prefix If you want to route requests based on a match of the request URL prefix.war map-url --type base-path --workspace-id sales_rest /sales sales_db This rule means that any requests matching https://example.com at the context path /ords.1. <path prefix> is the prefix that must occur at the start of the request path.

2 Configuring Security.3 Developing RESTful Services for Use with Oracle REST Data Services For more information on how to develop RESTful Services for use with Oracle REST Data Services. pre.and Post Processing.and post. are routed to the sales_db database connection. Pre.) https://example. and Excel Settings This rule means that any requests matching https://example.com/ords/sales/f?p=1:1 https://example.4.. environment.4. and Excel Settings To configure security. The sales_rest workspace defined within the sales_db database is searched for RESTful Services definitions. and Excel settings. caching.example. but don’t specify if using default.com/ords/sales/f?p=1:1 (The protocol is wrong. see Section 1.com/ords/sales/forecasting. Caching. Pre.com:8080/ords/sales/f?p=1:1 (The port is wrong: 443 is default for https. The previous rule matches all of the following requests: https://example.) 2.) https://www.Configuring Security. 2.) https://example. Caching.com/ords/sales/forecasting. Environment. Environment.report?month=jan The previous rule does not match of any of the following requests: http://example. "Using SQL Developer Oracle REST Data Services Administration (Optional)".com/ords/sales/leads/ https://example. 2-4 Oracle REST Data Services Installation and Configuration Guide .) https://example.com/ords/sales/.processing.com/ords/f?p=1:1 (Missing the /sales segment of the base URL.report?month=jan (The host name is wrong.com/pls/sales/leads/ (The context path is wrong.. see "Using RESTful Services" in Oracle Application Express SQL Workshop Guide.and Post Processing.

is displayed.dir setting is not set.xml +-apex. Topics: ■ Locating Configuration Files ■ Setting the Location of the Configuration Files ■ Understanding the Configuration Folder Structure ■ Understanding the Configuration File Format ■ Understanding Configurable Parameters A./ | +-defaults. the message: The config. A.1 Locating Configuration Files Use the configdir command to display the current location of the configuration files: java -jar ords.war configdir If the configuration folder has not yet been configured.3 Understanding the Configuration Folder Structure The configuration folder has the following structure: . If it has been configured.war configdir </path/to/config> Where: ■ </path/to/config> is the location where the configuration files are stored. the current value of the setting is displayed.2 Setting the Location of the Configuration Files To change the location of the configuration folder use the configdir command: java -jar ords. A.xml | +conf/ | About the Configuration File A-1 .properties* +-url-mapping.A About the Configuration File A The section describes the Oracle REST Data Services configuration file.

xml.com/dtd/properties.1 Understanding the url-mapping.xml file: <pool-config xmlns="http://xmlns.sid">orcl</entry> <entry <entry <entry <entry <entry <entry <entry <entry key="jdbc.sun.xml and <db-name>_rt.xml +-(db-name)_rt. The following is an example of a defaults. where each configuration setting contains a key and a corresponding value.oracle. where <db-name> is the name of the database connection.4.xml file stores the rules that route requests to the appropriate database when more than one database is configured.xml.MinLimit">1</entry> key="jdbc.xml file: <?xml version="1. +-(db-name). If the database connection uses RESTful services.MaxLimit">10</entry> key="jdbc.xml +-apex_al.DriverType">thin</entry> key="jdbc.xml File Format The url-mapping. A.statementTimeout">900</entry> key="jdbc.xml | .4 Understanding the Configuration File Format Configuration files use the standard Java XML properties file format.xml +-apex_rt.connectionType">basic</entry> key="db.InitialLimit">3</entry> key="jdbc. Settings specific to a particular database connection (for example.xml Global settings that apply to all database connections are stored in defaults.hostname">localhost</entry> key="db.xml +-(db-name)_al.Understanding the Configuration File Format +-apex. then two additional files: <db-name>_ al.0" encoding="UTF-8"?> <!DOCTYPE properties SYSTEM "http://java.port">1521</entry> key="db.com/apex/pool-config"> <pool name="sales_db" uri-pattern="/sales" type="base-path" workspace-id="sales_rest"/> </pool-config> A-2 Oracle REST Data Services Installation and Configuration Guide . the default apex connection) are stored in conf/<db-name>.MaxConnectionReuseCount">1000</entry> </properties> A. The following is an example of a url-mapping..MaxStatementsLimit">10</entry> key="jdbc.xml store the configuration for the APEX_LISTENER and APEX_REST_PUBLIC_USER database users respectively.InactivityTimeout">1800</entry> key="jdbc.dtd"> <properties> <entry <entry <entry <entry key="db..

4.excel2collection.onecollectio n or apex. Supported values: cache.excel2collection.excel2collection boolean Indicate whether to place your Excel files into an Oracle Application Express collection. Tip: Oracle recommends users to use the Oracle REST Data Services command-line interface and Oracle SQL Developer Oracle REST Data Services Administration to edit the configuration files. see Section 1. false Supported values: apex.excel2collection. About the Configuration File A-3 .xml and (db-name).xml configuration files.name string apex. false Supported values: ■ true ■ false (default) If value is true. "Configuring Oracle REST Data Services" and "Oracle REST Data Services Administration" in Oracle SQL Developer User's Guide.WWV_FLOW_ FILE_OBJECTS$.onecollectio n is true. Table A–1 Oracle REST Data Services Configuration Files Parameters Key Type Description Example apex.caching boolean ■ true ■ false (default) Supported values: ■ true ■ false (default) true For caching to be enabled.5 Understanding Configurable Parameters Table A–1 lists editable parameters for the defaults.excel2collection. apex. this must be set to true and the procedureNameList must have a procedure. and uses each worksheet name for the corresponding collection name. Indicate whether to put all Excel worksheets into a single collection. MYDOCTABLE Defaults to FLOWS_FILES. then either apex.Understanding Configurable Parameters A.excel2collection.useSheetName should be set to true. apex. The mycollection name is required if apex.useSheetNam boolean e ■ true ■ false (default) Indicate whether to create a collection false for each Excel worksheet. For more information.docTable string Name of the document table used by Application Express.excel2collection.onecollecti boolean on The name of the apex collection.

Defaults to 60. cache. Oracle REST Data Services. 60 If the cache type is expire.Understanding Configurable Parameters Table A–1 (Cont.ex ample.us. checks the cache every NN minutes for files that have expired. 500 Defaults to 500. For example. cache. cache. then it checks the cache every 60 minutes. cache. @(DESCRIPTION=(AD DRESS= (PROTOCOL=TCP) (HOST=myhost)(POR T=1521)) (CONNECT_ DATA=(SERVICE_ NAME=ora111.expiration numeric Required for expire cache type. Use an asterisk (*) to substitute zero or more characters and a question mark (?) to substitute for any one character.maxEntries numeric Required for lru cache type.type db. C:\data\cachefile s cache.monitorInterval numeric Interval time is specified in minutes.com))) db. if the monitorInterval is 60.customURL string string string Supported values: ■ expire ■ lru (default) The type of connection. myhostname A-4 Oracle REST Data Services Installation and Configuration Guide .duration string Supported values: days ■ days (default) ■ minutes ■ hours Required for expire cache type. 7 Defaults to 7. download_file Procedure names can contain the wildcard characters asterisk (*) or question mark (?).) Oracle REST Data Services Configuration Files Parameters Key Type Description Example cache.connectionType db. Supported values: ■ basic ■ tns ■ customurl lru basic The JDBC URL connection to connect to jdbc:oracle:thin: the database. Each procedure name must be separated by a comma. p.directory string The directory location for the cache files. cache.procedureNameList string Specify the procedure names to allow for caching of their files.hostname string The host system for the Oracle database.

Supported values: ■ thin ■ oci8 thin About the Configuration File A-5 .server is required to have a value. MY_TNSALIAS db.server string Specify the Internet Content Adaptation servername Protocol (ICAP) Server name to virus scan files.) Oracle REST Data Services Configuration Files Parameters Key Type Description Example db. jdbc.example. The icap.servicename string The network service name of the database.debugger boolean Indicate whether to display debugging messages on the application server console.printDebugToScreen boolean ■ true ■ false (default) Indicate whether to display error messages on the browser. APEX_PUBLIC_USER debug.tnsAliasName string The TNS alias name that matches the name in the tnsnames. 50 Defaults to 50.sid string The name of the database. icap. ora111.DriverType string The JDBC driver type. false Supported values: error.password string The password of the specified database !password4user user.co m db.ora file.maxEntries numeric ■ true ■ false (default) Specify the total number of error messages to retain.tnsDirectory string The directory location of your tnsnames. ora111 db.username string The name of the database user for the connection.ora file. Include an exclamation at the beginning of the password so that it can be stored encrypted. false Supported values: debug. C:\ORACLE\NETWORK \ADMIN db. 1521 db.port numeric The database listener port.keepErrorMessages boolean ■ true ■ false (default) Indicate whether to retain the error messages.port is required to have a value. db.Understanding Configurable Parameters Table A–1 (Cont. icap.port numeric Specify the Internet Content Adaptation 5555 Protocol (ICAP) Port to virus scan files. true Supported values: error. The icap.

1000 Defaults to 1000.MaxLimit numeric Specify the maximum number of connections. Defaults to 3. Defaults to 10.InactivityTimeout numeric Specify how long an available connection can remain idle before it is closed. 1800 Defaults to 1800. Defaults to 500. regardless of whether the resource is paginated.statementTimeout numeric Specify how long a borrowed (in use) connection can remain unused before it is considered as abandoned and reclaimed.logging boolean Indicate whether to retain the log messages. jdbc. Affects all RESTful services generated through a SQL query.MaxRows numeric Specify the maximum number of rows 300 that will be returned from a query when processing a RESTful service and that will be returned from a nested cursor in a result set. A-6 Oracle REST Data Services Installation and Configuration Guide 50 . 10 Defaults to 10. jdbc.Understanding Configurable Parameters Table A–1 (Cont. true Supported values: log. 1 Defaults to 1.MaxStatementsLimit numeric Specify the maximum number of 10 statements to cache for each connection. Defaults to 50. jdbc. The abandoned connection timeout is in seconds.MaxConnectionReuseCount numeric Specify the maximum number of times to reuse a connection before it is discarded and replaced with a new connection. jdbc. log.InitialLimit numeric Specify the initial size for the number of 3 connections that will be created.maxEntries numeric ■ true ■ false (default) Specify the total number of log messages to retain. jdbc. 900 Defaults to 900. The inactivity connection timeout is in seconds.) Oracle REST Data Services Configuration Files Parameters Key Type Description Example jdbc.MinLimit numeric Specify the minimum number of connections. jdbc. jdbc.

Use an asterisk (*) to substitute zero or more characters and a question mark (?) to substitute for any one character.bank*.Understanding Configurable Parameters Table A–1 (Cont. Multiple procedure names must be separated by commas. c* Procedure names can contain the wildcard characters asterisk (*) or question mark (?).postProcess string Specify the procedure name(s) to execute after executing the procedure specified on the URL.defaultPage string The default page to display.PROC Supported values: false security.procedure boolean Indicate whether procedures are to be logged. security. or schema names which are account. Procedure names can contain the wildcard characters asterisk (*) or question mark (?).RE QUEST. is commonly used. About the Configuration File A-7 . procedure. wwv_*. y*.disableDefaultExclusionL boolean ist security. Multiple procedure names must be separated by commas. or schema names which are allowed to be directly executed from a browser. forbidden to be directly executed from a employe? browser. The Oracle apex REST Data Services home page. SCHEMA1. customer_ packages. SCOTT. Note: Separate multiple patterns using commas.PREPROC1. packages.inclusionList string Specify a pattern for procedures. Note: Separate multiple patterns using commas. INITIALIZE. PKG1. f.exclusionList string ■ true ■ false (default) Specify a pattern for procedures. apex. v.SUBMIT.) Oracle REST Data Services Configuration Files Parameters Key Type Description Example log.FINISHTASK procedure. apex. p. false Supported values: ■ true ■ false (default) misc. Use an asterisk (*) to substitute zero or more characters and a question mark (?) to substitute for any one character.preProcess string Specify the procedure name(s) to execute prior to executing the procedure specified on the URL.

4. A-8 Oracle REST Data Services Installation and Configuration Guide . CHECK_VALID_ PROCEDURE Indicate whether HTTPS is available in your environment.Understanding Configurable Parameters Table A–1 (Cont.) Oracle REST Data Services Configuration Files Parameters Key Type Description Example security.maxEntries numeric Specify the maximum cache size. 2000 Defaults to 2000.verifySSL boolean Specify a validation function to determine if the requested procedure in the URL should be allowed or disallowed for processing. "Using OAuth2 in Non HTTPS Environments". The function should return true if the procedure is allowed. true Supported values: ■ true ■ false (default) If you change the value to false.5. return false. see Section 1.requestValidationFunctio string n security. security. otherwise.

a blank page might be displayed when attempting to access an Oracle Application Express page. detailed logging information that may help with problem diagnosis is appended to the Oracle REST Data Services log output. for example.2 Enabling Detailed Request Error Messages To enable detailed request error messages. Troubleshooting B-1 . any request that produces an error response includes a detailed message.xml: <entry key="debug. This problem is caused by an improper configuration of Application Express static resources. add the following setting to the Oracle REST Data Services configuration file named: defaults. add the following setting to the Oracle REST Data Services configuration file named: defaults. B. B.xml. This setting must not be enabled on productions systems due to the risk of sensitive information being revealed to an attacker. including a stack trace. which causes the JavaScript and CSS resources required by Application Express not to be found and the Application Express page not to render correctly.printDebugToScreen">true</entry> When this setting is present in defaults. This setting should not be enabled on production systems due to the performance impact of outputting large amounts of data to the log.B Troubleshooting B This appendix contains information on troubleshooting. when attempting to display https://example/ords/.xml: <entry key="debug.1 Enabling Debug Tracing To enable debug tracing.3 Configuring Application Express Static Resources with Oracle REST Data Services When using Oracle REST Data Services.debugger">true</entry> When this setting is present in defaults.xml. Topics: ■ Enabling Debug Tracing ■ Enabling Detailed Request Error Messages ■ Configuring Application Express Static Resources with Oracle REST Data Services B.

com/i/apex_version. check if you have made an error mentioned in the last item in the preceding list of possible specific causes. use a browser to access the following URL: https://example. then check the preceding list of possible specific causes. For example. check the information in this book about creating and deploying i. because Oracle REST Data Services is not configured to use the correct version of the Application Express static resources to match the Application Express version in the database. If a plain text file is displayed. entering an incorrect path (or not specifying a path) when prompted on the first run of Standalone mode When running in Standalone mode.war for your environment.Configuring Application Express Static Resources with Oracle REST Data Services The specific cause can be any of the following: ■ ■ ■ ■ ■ ■ ■ ■ Forgetting to ensure that the Application Express static images are located on the same server as the Oracle REST Data Services instance Forgetting to deploy i. such as WebLogic Server or Glassfish.war after deploying i.com/ords/ and your static resources have been deployed at https://example. if your Application Express deployment is located at https://example.war When running in Standalone mode. you can try to access the apex_version.war static Moving. You can also get detailed help on the static listener command by entering the following at a command prompt: java -jar ords. entering an incorrect path with the --static-images option Upgrading to a new version of Application Express and forgetting to reconfigure and redeploy i.2.com/i/.txt If you get a 404 Not Found error.war Configuring Application Express to use a nondefault context path for static resources (/i) and not specifying the same context path (using the --context-path option) when using java -jar ords. If you need help in solving the problem.1 Check that the version number matches the version of Application Express that is deployed on the database. If the numbers do not match.war not being deployed or not pointing to a folder containing Application Express static resources. renaming. or deleting the folder pointed to by i.war on WebLogic Server or GlassFish Specifying an incorrect path when using the java -jar ords.war to point to the static resources for the new Application Express version. including i.war static command to generate i.txt file.war help static B-2 Oracle REST Data Services Installation and Configuration Guide . or in Standalone mode forgetting to update the location by using the --apex-images option To help in diagnosing the problem. it should contain text like the following: Application Express Version: 4.

useSheetName. A-5 icap. A-1 D database users. A-1 format of.requestValidationFunction. A-4 db. B-1 defaults. A-7 procedure. A-7 procedure. A-5 jdbc. A-5 db. 1-11 Oracle WebLogic Server.password. A-3 cache. 1-13 downloading. 1-12 Oracle WebLogic Server. A-7 security.connectionType. A-6 log. 1-4 configdir command. A-4 cache.inclusionList.verifySSL. A-5 db. A-6 configuration files. A-5 error.maxEntries.expiration. A-1 locating configuration folder. B-1 enabling detailed request error messages.duration. A-7 security. A-1 configuration folder setting location.docTable.xmll. A-4 cache.excel2collection. A-5 db. A-4 cache. A-1 structure of.Index A Apache Tomcat. A-3 apex.excel2collection.port. A-3 apex.preProcess. A-7 security. 1-14 GlassFish Server.caching. 1-14 configuring Oracle REST Data Services images.InitialLimit. A-4 db. A-4 cache. A-5 db.tnsDirectory.MinLimit. 1-14 C command-line interface. 1-8 downloading Apache Tomcat. A-3 apex. A-7 misc. 1-4 defaults. A-4 db.procedure.logging. A-6 jdbc. A-6 log. A-3 apex.MaxStatementsLimit.excel2collection.maxEntries.exclusionList.postProcess. A-4 cache.onecollection.MaxConnectionReuseCount. B-1 enabling debug tracing.servicename.DriverType. A-4 db. A-2 locating using configdir command. A-6 jdbc.MaxRows. file format. 1-8 Index-1 .type.debugger.port. A-5 error.name. A-6 jdbc.tnsAliasName. 1-13 deployment options GlassFish Server. A-5 debug.excel2collection. A-5 debug.directory. A-5 db. A-4 cache.disableDefaultExclusionList.defaultPage. A-5 db.MaxLimit. A-3 cache.sid.server.monitorInterval. 1-14 deploying to.procedureNameList. A-6 log. A-5 jdbc.printDebugToScreen. A-6 jdbc. A-1 configuration file editable parameters apex. A-7 security.xml configuration file Oracle REST Data Services. A-6 jdbc. A-1 locating configuration files. A-6 jdbc. A-8 statementTimeout.hostname. A-8 security. A-8 security.keepErrorMessages.maxEntries.InactivityTimeout. A-2 deploy options Apache Tomcat.customURL.username. A-5 icap.maxEntries. 1-2 about.

1-8 deploy to. B-1 O OAuth2. 1-12 creating a WAR file for images. 1-13. 1-14 graphical user interface administration. 2-4 I installation options standalone mode. 1-7 standalone mode. 1-3 pre. 1-4 developing RESTful services. 1-7 security. running in. 1-8 downloading. 1-8 starting. A-1 supported Java EE application servers. 1-4 database users. 1-9 R RESTful services developing. 2-4 installation overview. 1-5 about. 2-4 configuration file defaults. default behavior. 1-2 M multiple database configuration.xml file format.processing.xml. 2-2 routing request rules. 1-3 environment. 1-8 installing. 1-3 about upgrading. 1-5 caching. 1-6 Oracle GlassFish Server launching Administration Console. 2-2 routing requests based on URL prefix. A-2 . 1-2 system requirements. 1-2 T troubleshooting.G GlassFish Server. 1-2 installing. B-1 enabling detailed request error messages. 1-12 installing the deployment.and post. 2-1 configuring multiple databases. 2-4 running in standalone mode. 1-5 standalone mode about JServ Protocol (AJP) support. A-1 configuring. 2-4 Excel settings. 1-12 Oracle REST Data Services about. 1-4. B-1 enabling detailed request error messages. 1-2 about. 1-15 administering with graphical user interface. A-2 request rules routing. 1-7 structure of configuration folder. 1-2 Index-2 U url-mapping. 1-2 J Java EE application servers about supported. 2-1 configuring additional databases. 1-7 stopping the server. 2-1 about the request URL. 1-8 installing the deployment. 1-1 about configuring. B-1 configuration files. 1-12 deploy to. 1-11 downloading. B-1 Oracle WebLogic Server. 2-3 S SQL Developer Oracle REST Data Services Administration. 1-7 installation overview. 1-2 Oracle REST Data Services configuration file enabling debug tracing. 2-4 system requirements. 2-1 configuring with command-line interface. B-1 enabling debug tracing. 2-4 downloading.