| Oracle® Retail Omnichannel Cloud Data Service Implementation Guide Release 19.0.000 F25864-02 |
|
 Previous |
 Next |
| Oracle® Retail Omnichannel Cloud Data Service Implementation Guide Release 19.0.000 F25864-02 |
|
Previous |
Next |
The RESTful API enabling Omnichannel applications to access the Merchandising and Pricing data from OCDS runs on Oracle REST Data Services (ORDS).
As the number of Omnichannel clients of OCDS increases, it is possible to experience performance degradation due to there being too few database connections to service the load. ORDS uses the Oracle Universal Connection Pool (UCP), a cache of reusable database connection objects. The out-of-the-box ORDS defaults for initial number of connections created and the maximum number of connections allowed is 3 and 10 respectively, which may be low for very active environments.
These properties, and others, are stored in the Oracle REST Data Services <config-folder>/ords/defaults.xml file that is created at the install time.
Increase these connection limits by setting the jdbc.InitialLimit and jdbc.MaxLimit configuration file parameters to higher values.
The ORDS jdbc.statementTimeout property and the Weblogic Stuck Thread Max Time setting can be increased if the amount of time needed to generate an OCDS REST response exceeds default limits.
Additionally, GZIP compression can be enabled through the Weblogic console if all OCDS clients support GZIP compressed REST responses.
To enable GZIP:
Log into the Weblogic console for OCDS.
Select a domain (example home > ocds_domain), then click Web Application tab.
Check GZip Compression Enabled.
Set the desired GZIP Compression Min. Content Length (example: 2048).
Add application/json to GZIP Compression Content Type.
See section B.4 Understanding the Configuration File Format of the Oracle REST Data Services Documentation Release 18.1 (Oracle REST Data Services Installation, Configuration, and Development Guide) for details on all ORDS configurations.
This chapter deals with the REST Services.
REST Services are secured with SSL and basic authentication. Successful authentication of a REST request requires the caller provide the username and password of a User in the OcdsMonitorGroup.
The root URL pattern for the OCDS (ORDS) Web Services is shown below, where {system} is defined during the ORDS install/configuration procedure by using the map-url command. The {system} is also known as the "path prefix" and "URL prefix" in ORDS documentation.
http[s]://{host}[:{port}]/ords/{system}/omnichannel/
For individual URL endpoint patterns, see Appendix A: REST Web Service API.
WebLogic security realms provide a mechanism for protecting WebLogic resources. Users are entities that can be authenticated in a security realm. Users are organized into Groups that can have different levels of access to WebLogic resources.
This section lists the default security realm's Groups and Users used by the ORDS web service component.
The credentials of Users in the OcdsMonitorGroup are used for REST web service authentication. It is recommended that one user be created for each Omnichannel application that is integrated with OCDS.
A production OCDS should be integrated with IDCS or OIM. See the documentation for the integrated identity management solution for details on password management.
A non-production OCDS can simply use the WebLogic DefaultAuthenticator. The OCDS ORDS Web Service user password is authenticated by the default Authentication Provider configured for the security realm of the WebLogic domain. When using the DefaultAuthenticator, a user password can be reset directly by accessing the Users and Groups tab of the security realm's settings in the WebLogic Admin Console.
