Accessing OData (REST) Endpoints in SaaS Environment

book

Article ID: 185945

calendar_today

Updated On:

Products

Clarity PPM SaaS

Issue/Introduction

This article shows how to set up and use a Clarity user to connect to the REST (OData) endpoints to access the DWH database in the SaaS environment

Environment

Release : All Supported

Component : CA PPM SAAS APPLICATION

Resolution

  1. Go to Administration > General Settings > Data Warehouse OData Service
  2. Obtain the V4 Endpoint URL. The URL format is https://cppmbixxxx.ondemand.ca.com/api/odata4/SCHEMAxDataSourceV4
    • Here is a break down of the two Endpoint URLs you see:
      1. Data Warehouse OData v2 EndPoint URL - Defines the OData URL for the Clarity PPM 15.4 or newer instance which exposes the data warehouse to the customer. Use this URL for external authentication with OData v2.
        Example: http://<host:port>/api/odata/ppm_hdp_datasource_v2
      2. Data Warehouse OData v4 EndPoint URL - Defines the OData URL for the Clarity PPM 15.4 or newer instance which exposes the data warehouse to the customer.  Use this URL for external authentication with OData v4.
        Example: http://<host:port>/api/odata4/ppm_hdp_datasource_v4
  3. Obtain the OData Authenticator. The format is in SCHEMAxDWHHDP
  4. Go to Administration > Resources
  5. Filter for a resource that does not have 'External Authentication' checkmarked.
  6. Obtain the resource username.
  7. Open a browser and enter in the following fields:
    • Endpoint URL
    • Username
    • Password

Here is an example of how to enter the user name:

Additional Information

Verify the OData Connection