@sap/cds-analytics
CDS plugin that adds embedded analytics to a CAP project, so a service view can be annotated as an analytical cube for SAP Analytics CloudSAP Analytics CloudSAP's SaaS front end for analytics: business intelligence, planning and predictive in one product, and the place a Datasphere analytic model is meant to end up being read.sap official, btp.
A CAP service view is a list of rows, and an analytical front end wants a cube with measures and dimensions it can name. This plugin is what SAP publishes for that: npm add @sap/cds-analytics puts what its README calls built-in support for embedded analytics in the project, and the one example it gives annotates a service @protocol: 'ina' and its view @ObjectModel.modelingPattern: #ANALYTICAL_CUBE and @ObjectModel.supportedCapabilities: [#ANALYTICAL_PROVIDER]. The README names the integration with SAP Analytics CloudSAP Analytics CloudSAP's SaaS front end for analytics: business intelligence, planning and predictive in one product, and the place a Datasphere analytic model is meant to end up being read.sap official, btp and stops at those annotations; for a multi-tenant scenario with extensibility it adds that the package is listed again in the package.json inside the mtx/sidecar directory. The package ships no repository and its licence is the LICENSE file inside it, so the npm entry is the whole of the documentation, down to CDS_ANALYTICS_DEBUG set to TRUE as the way to produce a log for SAP support.
Facts
Where it sits
Who is behind it
Before choosing this
Conditions
LicenceSAP Developer License Agreement 3.2 CAP§ 1, 2, 3A cds-plugin is used with SAP CAP materials, or an artifact is explicitly identified as a CAP plugin or application.
- § 1 License. Productive customer applications are limited to SAP BTP or another SAP-licensed platform, and mass extraction to a non-SAP product is restricted except where solely required for SAP interoperability.
- § 2 Intellectual Property. The agreement retains SAP's rights in the covered materials and limits making APIs, tools or software available to third parties, while preserving ownership of customer applications subject to SAP's underlying rights.
- § 3 Artificial Intelligence Training. The agreement prohibits use of the covered materials and customer applications for training artificial-intelligence models or systems.
PracticalFunctional boundary
Not in a project on CAP 7 or earlier: the package declares @sap/cds >=8 and @sap/cds-compiler >=5 as peer dependencies.
What it declares
Every artifact
- Type
- CDS plugin
- Origin
- By SAP
- Runtime
- Node.js
As a CDS plugin
- Declared for
- >=8
- Distributed through
- npm
Connections
Marking up a CDS model so an analytical front end reads it as a cube
SaaS for business intelligence, planning and predictive analytics
Download
Install
npm add @sap/cds-analyticsDerived from the package name. No recipe recorded; the README has the configuration.
Where it sits in your app
Download
README
quoted from @sap/cds-analytics@1.0.1 under SEE LICENSE IN LICENSE, readCDS 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
Install the plugin in your project:
npm add @sap/cds-analytics
Dependency added to package.json
{
// ...
"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.
History
v1.0.1
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
Flavors
“Install the plugin in your project: ```sh npm add @sap/cds-analytics ```” — @sap/cds-analytics — npm registry document, Setup
History in the atlas
- First seen.
For your agent
- Ref
artifact:sap-cds-analytics- JSON
- /artifacts/sap-cds-analytics.json
- MCP
- Connecting an agent