SAP Analytics Cloud Scripting
Comprehensive skill for scripting in SAP Analytics Cloud (SAC) Analytics Designer and Optimized Story Experience.
Getting Started
When the user invokes this skill with no specific task (e.g. "help with SAC scripting", "use SAC scripting skill", or no follow-up question), respond with this structured orientation:
Welcome! I can help you with SAP Analytics Cloud scripting.
First, which environment are you working in?
- Analytics Designer — application-based scripting, full API
- Optimized Story Experience — story-based scripting, OSE API (v2025.14)
Then, what do you need help with?
- Write a new script (filter, planning, navigation, export...)
- Debug an existing script
- Optimize performance
- Find the right API method
- Planning operations (version management, data locking...)
Plugin Components
This plugin provides specialized tools for SAC development:
Agents (use via Task tool):
sac-script-debugger - Debug script errors, trace issues
sac-performance-optimizer - Analyze and fix performance bottlenecks
sac-planning-assistant - Guide planning operations and version management
sac-api-helper - Find correct APIs and provide code examples
Commands (use via /command):
/sac-script-template - Generate script templates (filter, planning, export, etc.)
/sac-debug - Interactive debugging guidance
/sac-optimize - Performance analysis and recommendations
/sac-planning - Planning operation templates
Hooks:
- Automatic validation on SAC script writes for common issues
MCP Setup
This plugin ships with a .mcp.json that connects to the community sap_analytics_cloud_mcp
server, exposing 90 SAC REST API tools across 11 service areas (Content, Data Export, Data Import,
Multi Actions, Calendar, Content Transport, User Management, Monitoring, Schedule & Publication,
Translation, Smart Query).
Before using MCP tools, check if the server is already installed:
- Look for
.claude/sac-mcp.local.md in the project
- Or check if
SAC_MCP_PATH is set in the environment
If not installed, ask the user once: "Would you like help setting up the SAC MCP server?"
If yes, guide them through:
Clone and build:
git clone https://github.com/secondsky/sap_analytics_cloud_mcp
cd sap_analytics_cloud_mcp && npm install && npm run build
Configure environment variables:
SAC_MCP_PATH — absolute path to the cloned repo (e.g. /home/user/sap_analytics_cloud_mcp)
SAC_BASE_URL — SAC tenant root URL (e.g. https://mytenant.eu10.hanacloudservices.cloud.sap)
SAC_TOKEN_URL — OAuth token endpoint
SAC_CLIENT_ID / SAC_CLIENT_SECRET — from SAC OAuth client configuration
After successful install, write .claude/sac-mcp.local.md (gitignored) with:
# SAC MCP Installation Record
- Installed: [date]
- Path: [absolute path to build/index.js]
- Env vars configured: SAC_MCP_PATH, SAC_BASE_URL, SAC_TOKEN_URL, SAC_CLIENT_ID, SAC_CLIENT_SECRET
This prevents re-prompting in future sessions.
What's New in Q1 2026 (2026.2)
Key scripting enhancements in the latest SAC release:
- Chart Variance APIs - Script control over chart variance display
- Compass for Seamless Planning - Enhanced planning integration
- Data Actions Enhancements - Automatic dimension mapping, input control binding
- Time Series Forecast API - Programmatic forecasting control
- Comments APIs - Widget and cell comment management
See references/whats-new-q1-2026.md for complete details.
Environment Detection
Before writing or analyzing any script, identify which SAC environment the user is working in.
Detection signals:
| Signal |
Environment |
Mentions .story, "Optimized Story", OSE, Story., Application.getActivePage() |
OSE |
Mentions Analytics Designer, AnalyticApplication, Designer, .application |
Analytics Designer |
| Says "SAC script" / "my script" without further context |
Unclear |
When environment is unclear, ask ONE concise question before proceeding:
"Are you scripting in Analytics Designer or Optimized Story Experience? This determines which API reference I use."
Do not ask again after the user answers.
After confirmation, use the correct references:
- OSE →
references/ose-api-*.md (8 files, Q1 2026, v2025.14)
- Analytics Designer →
references/api-*.md (existing files)
Quick Start
Script Editor Access
- Analytics Designer: Edit mode → Select widget → Scripts tab
- Optimized Story Experience: Advanced Mode → Select widget → Add script
Basic Script Structure
// Event handler example (onSelect on Chart_1)
var selections = Chart_1.getSelections();
if (selections.length > 0) {
var selectedValue = selections[0]["Location"];
Table_1.getDataSource().setDimensionFilter("Location", selectedValue);
}
Core APIs
DataSource API
Access via Widget.getDataSource(). Key methods:
getMembers(dim, {accessMode: MemberAccessMode.BookedValues}) - Get dimension members efficiently
getResultSet() - Cached data access (preferred over getData())
setDimensionFilter(dim, value) - Apply filters
setRefreshPaused(true/false) - Batch multiple operations
Planning API
Access via Table.getPlanning(). Key operations:
getPublicVersion() / getPrivateVersion() - Version access
publish() - Submit private to public
copyFromPublicVersion() / copyToPublicVersion() - Data copy
setLock(true/false) - Data locking
Widget APIs
- Charts:
addMeasure(), addDimension(), getSelections()
- Tables:
addDimensionToRows(), setZeroSuppressionEnabled()
- Containers: Panel, TabStrip, PageBook for layout
Application Object
Global utilities:
Application.showBusyIndicator() / hideBusyIndicator()
Application.showMessage(type, text)
Application.getUserInfo() / getInfo()
Performance Best Practices
Minimize Backend Calls
// Use getResultSet() (cached) instead of getMembers() (backend)
var data = ds.getResultSet();
Batch Filter Operations
ds.setRefreshPaused(true);
ds.setDimensionFilter("Dim1", value1);
ds.setDimensionFilter("Dim2", value2);
ds.setRefreshPaused(false); // Single refresh
Keep onInitialization Empty
Defer heavy operations to lazy loading or first interaction.
Use BookedValues for Members
var members = ds.getMembers("Dim", {accessMode: MemberAccessMode.BookedValues});
Debugging
Console Logging
console.log("Debug:", myVariable);
console.log("Selections:", JSON.stringify(Chart_1.getSelections()));
Browser DevTools
- Press F12 → Console tab
- Filter by "Info" type
- Add
?APP_PERFORMANCE_LOGGING=true to URL for timing
Bundled Resources
Reference Files (63 files):
- Core APIs:
references/api-datasource.md, references/api-widgets.md, references/api-planning.md
- Advanced:
references/api-calendar-bookmarks.md, references/api-advanced-widgets.md
- Best Practices:
references/best-practices-developer.md, references/best-practices-planning-stories.md
- Language:
references/scripting-language-fundamentals.md
- Q1 2026:
references/whats-new-q1-2026.md, references/chart-variance-apis.md
- OSE API (Q1 2026, v2025.14) — complete method/parameter/return documentation:
references/ose-api-application-core.md — Application, PageBook, Panel, Popup, Widget (15 classes)
references/ose-api-widgets.md — Button, Dropdown, InputField, Slider, Switch, Text, TextArea (15 classes)
references/ose-api-datasource.md — DataSource, DataAction, DataBinding, DataLocking, DataChangeInsights (39 classes)
references/ose-api-chart-viz.md — Chart, Table, GeoMap, RVisualization, ValueDriverTree (20 classes)
references/ose-api-planning-calendar.md — Planning, PlanningModel, all Calendar classes (54 classes)
references/ose-api-filtering-selection.md — FilterLine, FilterValue, Selection (11 classes)
references/ose-api-utilities.md — BookmarkSet, MemberInfo, DimensionInfo, Timer, NavigationUtils (37 classes)
references/ose-api-types-enums.md — All enum types: Feed, Layout, NumberFormat, VariableValue (70 classes)
Templates (56 patterns):
templates/common-patterns.js - 40 general scripting patterns
templates/planning-operations.js - 16 planning-specific patterns
Official Documentation
Version: 3.0.1 | Last Verified: 2026-03-07 | SAC Version: Q1 2026 (2026.2) | API Version: 2025.14
1---2name: sap-sac-scripting3description: Comprehensive SAC scripting skill for SAP Analytics Cloud Analytics Designer and Optimized Story Experience. This skill should be used when the user asks to "create SAC script", "debug Analytics Designer", "optimize SAC performance", "planning operations in SAC", "filter data in SAC", "use DataSource API", "chart scripting", "table manipulation", "SAC event handlers", "version management", "data locking", "Optimized Story Experience API", "OSE scripting", "OSE widget API", "OSE DataSource", "story scripting API", "OSE planning API", "OSE method", "optimized story", "SAC story scripting", "story script", "SAC scripting", or works with SAC widgets, planning models, or analytics applications.4license: GPL-3.05---67# SAP Analytics Cloud Scripting89Comprehensive skill for scripting in SAP Analytics Cloud (SAC) Analytics Designer and Optimized Story Experience.1011## Getting Started1213When the user invokes this skill with no specific task (e.g. "help with SAC scripting", "use SAC scripting skill", or no follow-up question), respond with this structured orientation:1415> Welcome! I can help you with SAP Analytics Cloud scripting.16>17> First, which environment are you working in?18> 1. **Analytics Designer** — application-based scripting, full API19> 2. **Optimized Story Experience** — story-based scripting, OSE API (v2025.14)20>21> Then, what do you need help with?22> - Write a new script (filter, planning, navigation, export...)23> - Debug an existing script24> - Optimize performance25> - Find the right API method26> - Planning operations (version management, data locking...)2728## Plugin Components2930This plugin provides specialized tools for SAC development:3132**Agents** (use via Task tool):33- `sac-script-debugger` - Debug script errors, trace issues34- `sac-performance-optimizer` - Analyze and fix performance bottlenecks35- `sac-planning-assistant` - Guide planning operations and version management36- `sac-api-helper` - Find correct APIs and provide code examples3738**Commands** (use via /command):39- `/sac-script-template` - Generate script templates (filter, planning, export, etc.)40- `/sac-debug` - Interactive debugging guidance41- `/sac-optimize` - Performance analysis and recommendations42- `/sac-planning` - Planning operation templates4344**Hooks**:45- Automatic validation on SAC script writes for common issues4647## MCP Setup4849This plugin ships with a `.mcp.json` that connects to the community `sap_analytics_cloud_mcp`50server, exposing 90 SAC REST API tools across 11 service areas (Content, Data Export, Data Import,51Multi Actions, Calendar, Content Transport, User Management, Monitoring, Schedule & Publication,52Translation, Smart Query).5354**Before using MCP tools**, check if the server is already installed:55- Look for `.claude/sac-mcp.local.md` in the project56- Or check if `SAC_MCP_PATH` is set in the environment5758If not installed, ask the user once: **"Would you like help setting up the SAC MCP server?"**5960**If yes**, guide them through:61621. Clone and build:63 ```bash64 git clone https://github.com/secondsky/sap_analytics_cloud_mcp65 cd sap_analytics_cloud_mcp && npm install && npm run build66 ```67682. Configure environment variables:69 - `SAC_MCP_PATH` — absolute path to the cloned repo (e.g. `/home/user/sap_analytics_cloud_mcp`)70 - `SAC_BASE_URL` — SAC tenant root URL (e.g. `https://mytenant.eu10.hanacloudservices.cloud.sap`)71 - `SAC_TOKEN_URL` — OAuth token endpoint72 - `SAC_CLIENT_ID` / `SAC_CLIENT_SECRET` — from SAC OAuth client configuration73743. After successful install, write `.claude/sac-mcp.local.md` (gitignored) with:75 ```markdown76 # SAC MCP Installation Record77 - Installed: [date]78 - Path: [absolute path to build/index.js]79 - Env vars configured: SAC_MCP_PATH, SAC_BASE_URL, SAC_TOKEN_URL, SAC_CLIENT_ID, SAC_CLIENT_SECRET80 ```8182This prevents re-prompting in future sessions.8384## What's New in Q1 2026 (2026.2)8586Key scripting enhancements in the latest SAC release:87- **Chart Variance APIs** - Script control over chart variance display88- **Compass for Seamless Planning** - Enhanced planning integration89- **Data Actions Enhancements** - Automatic dimension mapping, input control binding90- **Time Series Forecast API** - Programmatic forecasting control91- **Comments APIs** - Widget and cell comment management9293See `references/whats-new-q1-2026.md` for complete details.9495## Environment Detection9697Before writing or analyzing any script, identify which SAC environment the user is working in.9899**Detection signals:**100101| Signal | Environment |102|--------|-------------|103| Mentions `.story`, "Optimized Story", OSE, `Story.`, `Application.getActivePage()` | **OSE** |104| Mentions Analytics Designer, `AnalyticApplication`, `Designer`, `.application` | **Analytics Designer** |105| Says "SAC script" / "my script" without further context | **Unclear** |106107**When environment is unclear**, ask ONE concise question before proceeding:108109> "Are you scripting in **Analytics Designer** or **Optimized Story Experience**? This determines which API reference I use."110111Do not ask again after the user answers.112113**After confirmation**, use the correct references:114- **OSE** → `references/ose-api-*.md` (8 files, Q1 2026, v2025.14)115- **Analytics Designer** → `references/api-*.md` (existing files)116117## Quick Start118119### Script Editor Access120- **Analytics Designer**: Edit mode → Select widget → Scripts tab121- **Optimized Story Experience**: Advanced Mode → Select widget → Add script122123### Basic Script Structure124```javascript125// Event handler example (onSelect on Chart_1)126var selections = Chart_1.getSelections();127if (selections.length > 0) {128 var selectedValue = selections[0]["Location"];129 Table_1.getDataSource().setDimensionFilter("Location", selectedValue);130}131```132133## Core APIs134135### DataSource API136Access via `Widget.getDataSource()`. Key methods:137- `getMembers(dim, {accessMode: MemberAccessMode.BookedValues})` - Get dimension members efficiently138- `getResultSet()` - Cached data access (preferred over getData())139- `setDimensionFilter(dim, value)` - Apply filters140- `setRefreshPaused(true/false)` - Batch multiple operations141142### Planning API143Access via `Table.getPlanning()`. Key operations:144- `getPublicVersion()` / `getPrivateVersion()` - Version access145- `publish()` - Submit private to public146- `copyFromPublicVersion()` / `copyToPublicVersion()` - Data copy147- `setLock(true/false)` - Data locking148149### Widget APIs150- **Charts**: `addMeasure()`, `addDimension()`, `getSelections()`151- **Tables**: `addDimensionToRows()`, `setZeroSuppressionEnabled()`152- **Containers**: Panel, TabStrip, PageBook for layout153154### Application Object155Global utilities:156- `Application.showBusyIndicator()` / `hideBusyIndicator()`157- `Application.showMessage(type, text)`158- `Application.getUserInfo()` / `getInfo()`159160## Performance Best Practices1611621. **Minimize Backend Calls**163 ```javascript164 // Use getResultSet() (cached) instead of getMembers() (backend)165 var data = ds.getResultSet();166 ```1671682. **Batch Filter Operations**169 ```javascript170 ds.setRefreshPaused(true);171 ds.setDimensionFilter("Dim1", value1);172 ds.setDimensionFilter("Dim2", value2);173 ds.setRefreshPaused(false); // Single refresh174 ```1751763. **Keep onInitialization Empty**177 Defer heavy operations to lazy loading or first interaction.1781794. **Use BookedValues for Members**180 ```javascript181 var members = ds.getMembers("Dim", {accessMode: MemberAccessMode.BookedValues});182 ```183184## Debugging185186### Console Logging187```javascript188console.log("Debug:", myVariable);189console.log("Selections:", JSON.stringify(Chart_1.getSelections()));190```191192### Browser DevTools1931. Press F12 → Console tab1942. Filter by "Info" type1953. Add `?APP_PERFORMANCE_LOGGING=true` to URL for timing196197## Bundled Resources198199**Reference Files** (63 files):200- Core APIs: `references/api-datasource.md`, `references/api-widgets.md`, `references/api-planning.md`201- Advanced: `references/api-calendar-bookmarks.md`, `references/api-advanced-widgets.md`202- Best Practices: `references/best-practices-developer.md`, `references/best-practices-planning-stories.md`203- Language: `references/scripting-language-fundamentals.md`204- Q1 2026: `references/whats-new-q1-2026.md`, `references/chart-variance-apis.md`205- **OSE API (Q1 2026, v2025.14)** — complete method/parameter/return documentation:206 - `references/ose-api-application-core.md` — Application, PageBook, Panel, Popup, Widget (15 classes)207 - `references/ose-api-widgets.md` — Button, Dropdown, InputField, Slider, Switch, Text, TextArea (15 classes)208 - `references/ose-api-datasource.md` — DataSource, DataAction, DataBinding, DataLocking, DataChangeInsights (39 classes)209 - `references/ose-api-chart-viz.md` — Chart, Table, GeoMap, RVisualization, ValueDriverTree (20 classes)210 - `references/ose-api-planning-calendar.md` — Planning, PlanningModel, all Calendar classes (54 classes)211 - `references/ose-api-filtering-selection.md` — FilterLine, FilterValue, Selection (11 classes)212 - `references/ose-api-utilities.md` — BookmarkSet, MemberInfo, DimensionInfo, Timer, NavigationUtils (37 classes)213 - `references/ose-api-types-enums.md` — All enum types: Feed, Layout, NumberFormat, VariableValue (70 classes)214215**Templates** (56 patterns):216- `templates/common-patterns.js` - 40 general scripting patterns217- `templates/planning-operations.js` - 16 planning-specific patterns218219## Official Documentation220221- **Analytics Designer API**: https://help.sap.com/doc/958d4c11261f42e992e8d01a4c0dde25/release/en-US/222- **Optimized Story Experience API**: https://help.sap.com/doc/1639cb9ccaa54b2592224df577abe822/release/en-US/223- **SAC Documentation**: https://help.sap.com/docs/SAP_ANALYTICS_CLOUD224- **What's New Q4 2025**: https://help.sap.com/docs/SAP_ANALYTICS_CLOUD/00f68c2e08b941f081002fd3691d86a7/c96a267c5da04fff90bb55313ee9f77c.html225226---227228**Version**: 3.0.1 | **Last Verified**: 2026-03-07 | **SAC Version**: Q1 2026 (2026.2) | **API Version**: 2025.14