SAP Build Work Zone, Advanced Edition
Related Skills
- sap-btp-business-application-studio: Use for dev space setup and UI Integration Card development workflows
- sap-btp-cloud-platform: Use for BTP subscriptions, destinations, role collections, and runtime setup
- sapui5: Use for UI5 card/component development details
- sap-btp-connectivity: Use for destinations, Cloud Connector, and OData business-record connectivity
This skill provides comprehensive guidance for implementing SAP Build Work Zone, advanced edition - a digital workplace platform for unified access to business applications, processes, and collaboration.
When to Use This Skill
Use this skill when:
- Creating workspaces, workpages, and collaborative sites
- Developing UI Integration Cards in SAP Business Application Studio
- Building and deploying content packages
- Creating workspace templates
- Integrating with Microsoft 365, Teams, SharePoint, or Google Drive
- Configuring chatbots using SAP Conversational AI
- Implementing webhooks for event notifications
- Setting up SCIM API for user provisioning
- Configuring OData-based business records
- Managing themes and branding
- Configuring role-based access and SSO
- Working with the Administration Console
Quick Start
- Confirm the subaccount has SAP Build Work Zone, advanced edition entitlement and subscription.
- Assign the required administrator role collections.
- Create or verify SAP Business Application Studio dev space support for UI Integration Cards.
- Configure destinations for content, cards, OData business records, or external systems.
- Use the content package and card templates in
templates/ for implementation.
Table of Contents
Platform Overview
SAP Build Work Zone, advanced edition is a digital workplace platform that:
- Provides unified access to SAP and third-party business applications
- Enables collaborative workspaces with feeds, blogs, wikis, and forums
- Supports role-based navigation with Single Sign-On (SSO)
- Works across web browsers, mobile apps, and responsive web UI
- Integrates with cloud, hybrid, and on-premise applications
Core Concepts
Workspaces
Separate sections with dedicated pages and feeds for team communication and collaboration within specific user groups.
Workpages
Customizable pages that can be configured with widgets, cards, and applications.
UI Integration Cards
Design patterns displaying concise information in limited-space containers. Follow SAPUI5 card specifications (minimum version 1.87.0; newer versions supported and recommended for latest features).
Content Packages
Collections of artifacts (cards, workflows, workspace templates) bundled in ZIP files for distribution.
Workspace Templates
Pre-built frameworks enabling workspace creation with minimum modification.
Development Environment Setup
Prerequisites
- SAP BTP subscription to SAP Build Work Zone, advanced edition
- SAP Business Application Studio subscription
- Workzone_Admin role collection assignment
- Destination to content repository configured
Dev Space Setup
1. Open SAP Business Application Studio
2. Create new dev space
3. Select "Development Tools for SAP Build Work Zone, Advanced Edition" extension
4. Start the dev space
UI Integration Cards Development
Creating a UI Card
- Open SAP Business Application Studio
- Select "New Project From Template"
- Choose "UI Integration Card"
- Configure:
- Project Name: Your identifier
- Card Sample: Template selection
- NameSpace: Used for Card ID (namespace.projectname)
- Card Title/Subtitle: Display text
- Mobile Compatibility: Enable for mobile support
Card Types
- List Cards
- Object Cards
- Table Cards
- Timeline Cards
- Analytical Cards
- Calendar Cards
- Component Cards
For complete card development, see references/ui-integration-cards.md.
Content Packages
Supported Artifacts
- UI Integration Cards
- Workflows
- Workspace templates
- Exported workspace configurations
- Homepage configurations
Package Types
- Centrally-provided: Auto-available to all customers, non-customizable
- Local packages: Custom packages uploaded by administrators
Development Flow
Create in BAS → Build package → Deploy → Install in Admin Console
For complete content package guide, see references/content-packages.md.
Workspace Templates
Templates enable users to create workspaces with predefined layouts and widgets.
Creating Templates
- Design workspace structure
- Define widget layouts
- Configure default settings
- Package and deploy
For template development, see references/workspace-templates.md.
Chatbot Integration
Important Notice
SAP Conversational AI is in maintenance mode since January 2023. While existing chatbots may continue to function, SAP does not recommend creating new implementations. Consider alternative solutions for chatbot functionality.
Options
- Custom chatbots: Build using SAP Conversational AI (https://cai.tools.sap/) - ⚠️ Maintenance Mode
- Pre-built chatbot: Fork and configure the SAP Build Work Zone chatbot - ⚠️ Not recommended for new projects
Configuration Steps (for existing implementations)
- Fork chatbot in SAP Conversational AI
- Connect using SAP Jam Collaboration connector
- Register OAuth client in Admin Console
- Configure alias account for bot posting
- Set up push notifications and webhooks
For chatbot configuration, see references/chatbots.md.
API Reference
SCIM API
Endpoint: /api/v1/scim
Authentication: 2-legged OAuth using "Workzone API Client"
Rate Limits:
| Limit Type |
Value |
| Hourly limit |
10,000 requests/tenant |
| Burst limit |
200 requests/minute |
Headers:
X-RateLimit-Limit: Maximum hourly requests
X-RateLimit-Remaining: Available requests
X-RateLimit-Reset: Seconds until reset
Content-Type: application/json (required for POST/PUT)
OData API
SAP Build Work Zone uses OData v2 with v4 extensions.
Format: XML (AtomPub) or JSON
For complete API reference, see references/api-reference.md.
Administration Console
Access via: User Actions menu → Administration
Key Sections
- Users: Manage internal/external users, user lists
- Authentication: SAML IdP, OAuth clients, SSO
- Theming: Assign themes, customize email templates
- Areas & Workspaces: Home pages, workspace settings
- Integrations: Microsoft Teams, mobile apps, chatbots
- Features: Enable/disable site features
- Compliance: Content administration, monitoring
- Analytics: Usage reports, adoption metrics
Feature Management
Compliance Features
- Compliance Monitor: Flags content with compliance dictionary terms
- Profanity Monitor: Marks items with profanity violations
- Unscannable Filter: Flags non-scannable files
Content Features
- File sharing, feed sharing
- Content rating
- Wikis, blogs, knowledge bases
- Video/audio uploads
- PDF viewing
Integration Features
- API access
- Microsoft Teams integration
- Office 365 SharePoint integration
- Google Drive integration
External Integrations
| Integration |
Purpose |
| Microsoft Teams |
Collaboration, notifications |
| Office 365 SharePoint |
Document sharing, sites |
| Google Drive |
Cloud storage |
| SAP SuccessFactors |
HR integration |
| SAP Cloud for Customer |
CRM integration |
| SAP Task Center |
Unified task management |
| SAP Build Process Automation |
Workflow automation |
Security
Authentication
- SAML Identity Providers
- OAuth 2.0 clients
- Single Sign-On (SSO)
- Trusted Certificate Authorities
Key Considerations
- Role-based access control
- HTTP security headers (clickjacking, XSS protection)
- Content provider security guidelines
- Audit logging for security events
For security configuration, see references/security.md.
Webhooks
Track platform events and send notifications to third-party applications.
Configuration
- Define events to monitor
- Configure callback URLs
- Set up authentication tokens
- Handle push notifications
Theming and Branding
Options
- Assign themes to site
- Customize email templates
- Local themes (partial UI coverage)
- Theme Manager for custom branding
Reports and Analytics
Available Reports
- Activity Summary (week/month)
- User Contribution
- Workspace Activity
- Content Views
- Compliance Report
- Kudo Details
- Search Summary
- Expertise Report
Third-Party Analytics
Integration with external analytics platforms supported.
Troubleshooting
Common Issues
| Issue |
Solution |
| HTTP 503 |
Service maintenance, retry later |
| Rate limit exceeded |
Check X-RateLimit headers, wait for reset |
| OAuth authentication failure |
Verify Workzone API Client credentials |
| Card not displaying |
Check SAPUI5 version compatibility |
For troubleshooting guide, see references/troubleshooting.md.
Bundled Resources
Reference Documentation
references/ui-integration-cards.md (331 lines) - Complete UI Integration Cards development guide
references/content-packages.md (266 lines) - Content package creation and deployment
references/workspace-templates.md (159 lines) - Workspace template development
references/chatbots.md (297 lines) - Chatbot configuration (maintenance mode notice included)
references/api-reference.md (306 lines) - SCIM and OData API documentation
references/security.md (128 lines) - Security configuration best practices
references/administration.md (299 lines) - Administration Console guide
references/auditing.md (176 lines) - Audit and compliance features
references/mobile-app.md (124 lines) - Mobile app configuration
references/notifications.md (147 lines) - Notification system setup
references/troubleshooting.md (124 lines) - Common error resolution
references/widgets.md (213 lines) - Widget development guide
references/workspaces.md (295 lines) - Workspace management
Templates
templates/card-manifest.json - UI Integration Card manifest template
templates/content-package-manifest.json - Content package manifest template
templates/dt-configuration.js - Deployment configuration template
templates/workspace-template-config.json - Workspace template configuration
Documentation Links
Last Updated: 2025-11-27
Documentation Version: Based on SAP documentation as of November 2025
1---
2name: sap-btp-build-work-zone-advanced
3description: |
4 Develops and administers SAP Build Work Zone, advanced edition digital workplace solutions. Use when creating workspaces, workpages, and collaborative sites, developing UI Integration Cards in SAP Business Application Studio, building content packages and workspace templates, integrating with Microsoft 365/Teams/SharePoint/Google Drive, configuring chatbots and webhooks, implementing SCIM API user provisioning, setting up OData business records, managing themes and branding, configuring role-based access and SSO, troubleshooting deployment issues, or working with the Administration Console.
5
6 Keywords: SAP Build Work Zone advanced edition, digital workplace, UI Integration Cards, content packages, workspace templates, SAP Business Application Studio, SAP Conversational AI, SCIM API, OData, Microsoft Teams integration, SSO, theming, Administration Console
7license: GPL-3.0
8metadata:
9 source: https://skillmd.com/skills/secondsky/sap-btp-build-work-zone-advanced
10 maintainer: "Eduard Jiglau"
11 maintainer_email: "hello@sap-ai-skills.com"
12 website: "https://sap-ai-skills.com"
13 version: "2.4.1"
14 last_verified: "2025-11-27"
15---
16
17# SAP Build Work Zone, Advanced Edition
18
19## Related Skills
20
21- **sap-btp-business-application-studio**: Use for dev space setup and UI Integration Card development workflows
22- **sap-btp-cloud-platform**: Use for BTP subscriptions, destinations, role collections, and runtime setup
23- **sapui5**: Use for UI5 card/component development details
24- **sap-btp-connectivity**: Use for destinations, Cloud Connector, and OData business-record connectivity
25
26This skill provides comprehensive guidance for implementing SAP Build Work Zone, advanced edition - a digital workplace platform for unified access to business applications, processes, and collaboration.
27
28## When to Use This Skill
29
30Use this skill when:
31- Creating workspaces, workpages, and collaborative sites
32- Developing UI Integration Cards in SAP Business Application Studio
33- Building and deploying content packages
34- Creating workspace templates
35- Integrating with Microsoft 365, Teams, SharePoint, or Google Drive
36- Configuring chatbots using SAP Conversational AI
37- Implementing webhooks for event notifications
38- Setting up SCIM API for user provisioning
39- Configuring OData-based business records
40- Managing themes and branding
41- Configuring role-based access and SSO
42- Working with the Administration Console
43
44## Quick Start
45
461. Confirm the subaccount has SAP Build Work Zone, advanced edition entitlement and subscription.
472. Assign the required administrator role collections.
483. Create or verify SAP Business Application Studio dev space support for UI Integration Cards.
494. Configure destinations for content, cards, OData business records, or external systems.
505. Use the content package and card templates in `templates/` for implementation.
51
52## Table of Contents
53- [Platform Overview](#platform-overview)
54- [Core Concepts](#core-concepts)
55- [Development Environment Setup](#development-environment-setup)
56- [UI Integration Cards Development](#ui-integration-cards-development)
57- [Content Packages](#content-packages)
58- [Workspace Templates](#workspace-templates)
59- [Chatbot Integration](#chatbot-integration)
60- [API Reference](#api-reference)
61- [Administration Console](#administration-console)
62- [Feature Management](#feature-management)
63- [External Integrations](#external-integrations)
64- [Security](#security)
65- [Webhooks](#webhooks)
66- [Theming and Branding](#theming-and-branding)
67- [Reports and Analytics](#reports-and-analytics)
68- [Troubleshooting](#troubleshooting)
69- [Bundled Resources](#bundled-resources)
70- [Documentation Links](#documentation-links)
71
72## Platform Overview
73
74SAP Build Work Zone, advanced edition is a digital workplace platform that:
75- Provides unified access to SAP and third-party business applications
76- Enables collaborative workspaces with feeds, blogs, wikis, and forums
77- Supports role-based navigation with Single Sign-On (SSO)
78- Works across web browsers, mobile apps, and responsive web UI
79- Integrates with cloud, hybrid, and on-premise applications
80
81## Core Concepts
82
83### Workspaces
84Separate sections with dedicated pages and feeds for team communication and collaboration within specific user groups.
85
86### Workpages
87Customizable pages that can be configured with widgets, cards, and applications.
88
89### UI Integration Cards
90Design patterns displaying concise information in limited-space containers. Follow SAPUI5 card specifications (minimum version 1.87.0; newer versions supported and recommended for latest features).
91
92### Content Packages
93Collections of artifacts (cards, workflows, workspace templates) bundled in ZIP files for distribution.
94
95### Workspace Templates
96Pre-built frameworks enabling workspace creation with minimum modification.
97
98## Development Environment Setup
99
100### Prerequisites
1011. SAP BTP subscription to SAP Build Work Zone, advanced edition
1022. SAP Business Application Studio subscription
1033. Workzone_Admin role collection assignment
1044. Destination to content repository configured
105
106### Dev Space Setup
107```
1081. Open SAP Business Application Studio
1092. Create new dev space
1103. Select "Development Tools for SAP Build Work Zone, Advanced Edition" extension
1114. Start the dev space
112```
113
114## UI Integration Cards Development
115
116### Creating a UI Card
117
1181. Open SAP Business Application Studio
1192. Select "New Project From Template"
1203. Choose "UI Integration Card"
1214. Configure:
122 - **Project Name**: Your identifier
123 - **Card Sample**: Template selection
124 - **NameSpace**: Used for Card ID (namespace.projectname)
125 - **Card Title/Subtitle**: Display text
126 - **Mobile Compatibility**: Enable for mobile support
127
128### Card Types
129- List Cards
130- Object Cards
131- Table Cards
132- Timeline Cards
133- Analytical Cards
134- Calendar Cards
135- Component Cards
136
137For complete card development, see `references/ui-integration-cards.md`.
138
139## Content Packages
140
141### Supported Artifacts
142- UI Integration Cards
143- Workflows
144- Workspace templates
145- Exported workspace configurations
146- Homepage configurations
147
148### Package Types
149- **Centrally-provided**: Auto-available to all customers, non-customizable
150- **Local packages**: Custom packages uploaded by administrators
151
152### Development Flow
153```
154Create in BAS → Build package → Deploy → Install in Admin Console
155```
156
157For complete content package guide, see `references/content-packages.md`.
158
159## Workspace Templates
160
161Templates enable users to create workspaces with predefined layouts and widgets.
162
163### Creating Templates
1641. Design workspace structure
1652. Define widget layouts
1663. Configure default settings
1674. Package and deploy
168
169For template development, see `references/workspace-templates.md`.
170
171## Chatbot Integration
172
173### Important Notice
174**SAP Conversational AI is in maintenance mode since January 2023**. While existing chatbots may continue to function, SAP does not recommend creating new implementations. Consider alternative solutions for chatbot functionality.
175
176### Options
1771. **Custom chatbots**: Build using SAP Conversational AI ([https://cai.tools.sap/](https://cai.tools.sap/)) - ⚠️ Maintenance Mode
1782. **Pre-built chatbot**: Fork and configure the SAP Build Work Zone chatbot - ⚠️ Not recommended for new projects
179
180### Configuration Steps (for existing implementations)
1811. Fork chatbot in SAP Conversational AI
1822. Connect using SAP Jam Collaboration connector
1833. Register OAuth client in Admin Console
1844. Configure alias account for bot posting
1855. Set up push notifications and webhooks
186
187For chatbot configuration, see `references/chatbots.md`.
188
189## API Reference
190
191### SCIM API
192
193**Endpoint**: `/api/v1/scim`
194
195**Authentication**: 2-legged OAuth using "Workzone API Client"
196
197**Rate Limits**:
198| Limit Type | Value |
199|------------|-------|
200| Hourly limit | 10,000 requests/tenant |
201| Burst limit | 200 requests/minute |
202
203**Headers**:
204- `X-RateLimit-Limit`: Maximum hourly requests
205- `X-RateLimit-Remaining`: Available requests
206- `X-RateLimit-Reset`: Seconds until reset
207
208**Content-Type**: `application/json` (required for POST/PUT)
209
210### OData API
211
212SAP Build Work Zone uses OData v2 with v4 extensions.
213
214**Format**: XML (AtomPub) or JSON
215
216For complete API reference, see `references/api-reference.md`.
217
218## Administration Console
219
220Access via: User Actions menu → Administration
221
222### Key Sections
223- **Users**: Manage internal/external users, user lists
224- **Authentication**: SAML IdP, OAuth clients, SSO
225- **Theming**: Assign themes, customize email templates
226- **Areas & Workspaces**: Home pages, workspace settings
227- **Integrations**: Microsoft Teams, mobile apps, chatbots
228- **Features**: Enable/disable site features
229- **Compliance**: Content administration, monitoring
230- **Analytics**: Usage reports, adoption metrics
231
232## Feature Management
233
234### Compliance Features
235- **Compliance Monitor**: Flags content with compliance dictionary terms
236- **Profanity Monitor**: Marks items with profanity violations
237- **Unscannable Filter**: Flags non-scannable files
238
239### Content Features
240- File sharing, feed sharing
241- Content rating
242- Wikis, blogs, knowledge bases
243- Video/audio uploads
244- PDF viewing
245
246### Integration Features
247- API access
248- Microsoft Teams integration
249- Office 365 SharePoint integration
250- Google Drive integration
251
252## External Integrations
253
254| Integration | Purpose |
255|-------------|---------|
256| Microsoft Teams | Collaboration, notifications |
257| Office 365 SharePoint | Document sharing, sites |
258| Google Drive | Cloud storage |
259| SAP SuccessFactors | HR integration |
260| SAP Cloud for Customer | CRM integration |
261| SAP Task Center | Unified task management |
262| SAP Build Process Automation | Workflow automation |
263
264## Security
265
266### Authentication
267- SAML Identity Providers
268- OAuth 2.0 clients
269- Single Sign-On (SSO)
270- Trusted Certificate Authorities
271
272### Key Considerations
273- Role-based access control
274- HTTP security headers (clickjacking, XSS protection)
275- Content provider security guidelines
276- Audit logging for security events
277
278For security configuration, see `references/security.md`.
279
280## Webhooks
281
282Track platform events and send notifications to third-party applications.
283
284### Configuration
2851. Define events to monitor
2862. Configure callback URLs
2873. Set up authentication tokens
2884. Handle push notifications
289
290## Theming and Branding
291
292### Options
293- Assign themes to site
294- Customize email templates
295- Local themes (partial UI coverage)
296- Theme Manager for custom branding
297
298## Reports and Analytics
299
300### Available Reports
301- Activity Summary (week/month)
302- User Contribution
303- Workspace Activity
304- Content Views
305- Compliance Report
306- Kudo Details
307- Search Summary
308- Expertise Report
309
310### Third-Party Analytics
311Integration with external analytics platforms supported.
312
313## Troubleshooting
314
315### Common Issues
316| Issue | Solution |
317|-------|----------|
318| HTTP 503 | Service maintenance, retry later |
319| Rate limit exceeded | Check X-RateLimit headers, wait for reset |
320| OAuth authentication failure | Verify Workzone API Client credentials |
321| Card not displaying | Check SAPUI5 version compatibility |
322
323For troubleshooting guide, see `references/troubleshooting.md`.
324
325## Bundled Resources
326
327### Reference Documentation
328- `references/ui-integration-cards.md` (331 lines) - Complete UI Integration Cards development guide
329- `references/content-packages.md` (266 lines) - Content package creation and deployment
330- `references/workspace-templates.md` (159 lines) - Workspace template development
331- `references/chatbots.md` (297 lines) - Chatbot configuration (maintenance mode notice included)
332- `references/api-reference.md` (306 lines) - SCIM and OData API documentation
333- `references/security.md` (128 lines) - Security configuration best practices
334- `references/administration.md` (299 lines) - Administration Console guide
335- `references/auditing.md` (176 lines) - Audit and compliance features
336- `references/mobile-app.md` (124 lines) - Mobile app configuration
337- `references/notifications.md` (147 lines) - Notification system setup
338- `references/troubleshooting.md` (124 lines) - Common error resolution
339- `references/widgets.md` (213 lines) - Widget development guide
340- `references/workspaces.md` (295 lines) - Workspace management
341
342### Templates
343- `templates/card-manifest.json` - UI Integration Card manifest template
344- `templates/content-package-manifest.json` - Content package manifest template
345- `templates/dt-configuration.js` - Deployment configuration template
346- `templates/workspace-template-config.json` - Workspace template configuration
347
348## Documentation Links
349
350- **SAP Help Portal**: [https://help.sap.com/docs/build-work-zone-advanced-edition](https://help.sap.com/docs/build-work-zone-advanced-edition)
351- **GitHub Docs**: [https://github.com/SAP-docs/sap-btp-build-work-zone-advanced](https://github.com/SAP-docs/sap-btp-build-work-zone-advanced)
352- **SAP API Hub**: [https://api.sap.com/](https://api.sap.com/) (search "SAP Cloud Portal Service")
353- **OData API Docs**: [https://jam2.sapjam.com](https://jam2.sapjam.com)
354- **SAPUI5 Card Explorer**: [https://ui5.sap.com/test-resources/sap/ui/integration/demokit/cardExplorer/](https://ui5.sap.com/test-resources/sap/ui/integration/demokit/cardExplorer/)
355
356---
357
358**Last Updated**: 2025-11-27
359**Documentation Version**: Based on SAP documentation as of November 2025