CDS Enterprise Analytics Plugin

The @sap/cds-analytics package is a CDS plugin that enhances the SAP Cloud Application Programming Model (CAP) with built-in support for embedded analytics, enabling seamless integration with SAP Analytics Cloud.

Table of Contents

• Setup
• Usage
• Support
• Licensing

Setup

Install the plugin in your project:

npm add @sap/cds-analytics

{
  // ...
  "dependencies": {
    // ...
    "@sap/cds-analytics": "^X.X.X"
  }
}

For multi-tenant scenarios with extensibility, ensure that @sap/cds-analytics is also listed as a dependency in the package.json within your mtx/sidecar directory.

Usage

To leverage the analytics features, annotate your CDS service views with the required properties. Example:

@protocol: 'ina'
@restrict: [{ grant: '*', to: 'authenticated-user' } ]
service FlightService {
  @ObjectModel.modelingPattern: #ANALYTICAL_CUBE
  @ObjectModel.supportedCapabilities: [#ANALYTICAL_PROVIDER]
  view FlightByAirport as select from my.Flight {
    // ...
  }
}

Support

If you experience issues with @sap/cds-analytics plugin, enable debug logging by setting the environment variable CDS_ANALYTICS_DEBUG to TRUE. Redirect the build output to a file and provide it to SAP support for troubleshooting and resolution.

Licensing

Copyright 2024 SAP SE or an SAP affiliate company and contributors. See LICENSE for details.