7 OCDS (ORDS) Web Services

This chapter describes the process to deploy the configured ords.war file onto the OCDS domain.

Prerequisites

The prerequisites and steps outlined in the OCDS Schemas chapter have been completed.

The target WebLogic Admin Server and Managed Server should be running.

The JAVA_HOME environment variable must be set.

Preparation

The OCDS Web Services leverage Oracle REST Data Services (ORDS). Perform the following procedure to prepare for the installation of ORDS.

1. Unzip ocds-ords-deployment.zip.

2. Copy the configured ords.war file into the /dist folder.

Deploy ORDS

Perform the following procedure to deploy the ORDS web application onto a WebLogic Domain:

1. Configure conf/ords-deployment-env-info.json file with the database and WebLogic domain details. This file is used by the deployment script.

   1. Edit the Middleware Server definitions for OrdsAppServer.

      • webLogicDomainName: WebLogic domain name.

      • webLogicDomainHome: WebLogic domain home directory.

      • webLogicDomainAdminServerUrl: Server URL information.

      • webLogicDomainAdminServerHost: Server host.

      • webLogicDomainAdminServerPort: Admin Server port.

      • webLogicDomainTargetManagedServerName: Managed Server name.

        Figure 7-1 Middleware Server Definitions for OrdsAppServer

        
        

2. Stop and restart the Managed Server and the Admin Server.

3. With the WebLogic Admin Server and the Managed Server running, change to the ocds-ords-deployment/bin folder and execute the version ords-deployer script for the o/s using the switches:

   -setup-credentials -deploy-ords-app

   On Linux:

   ./ords-deployer.sh -setup-credentials -deploy-ords-app

   On Windows:

   ords-deployer.cmd -setup-credentials -deploy-ords-app

   1. There will be one prompt for WebLogic user credentials:

      • Enter username for alias (OcdsAppServerAdminServerUserAlias):

        Enter the WebLogic Admin Server credentials.

        Figure 7-2 WebLogic User Credentials

        
        

   2. There will be one prompt to create the OCDS Integration User:

      Enter the credentials for the OCDS Integration user. These credentials will enable an Omnichannel application, such as the Xstore Suite, to communicate with OCDS.

      
      

      Note: Password must not start with a number.

      
      

      Figure 7-3 OCDS Integration User

      
      

Verify Installation

If the OCDS web services have been successfully installed then you should be able to request a JSON response from one of the OCDS REST resources.

1. Test by invoking a REST endpoint using a tool like curl (or SOAPUI, and so on). Curl is used for demonstration purposes.

   URL http[s]://host[:port]/ords/<path-prefix>/omnichannel/metadata-catalog/

   where

   • <path-prefix> is the prefix (defined in a previous step) that must occur at the start of the request path

     curl -i -k --user ocdsXstoreUser:ocdsXstoreUser1 https://example:8443/ords/ocds/omnichannel/metadata-catalog/

     Figure 7-4 Request Path