sap-btp-build-work-zone-advanced
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseSAP Build Work Zone, Advanced Edition
SAP Build Work Zone(高级版)
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.
本技能为实施SAP Build Work Zone(高级版)提供全面指导——这是一款用于统一访问业务应用、流程和协作功能的数字工作区平台。
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
在以下场景中使用本技能:
- 创建工作区、工作页面和协作站点
- 在SAP Business Application Studio中开发UI Integration Cards
- 构建并部署内容包
- 创建工作区模板
- 集成Microsoft 365、Teams、SharePoint或Google Drive
- 使用SAP Conversational AI配置聊天机器人
- 实现用于事件通知的webhooks
- 设置SCIM API进行用户配置
- 配置基于OData的业务记录
- 管理主题与品牌
- 配置基于角色的访问权限和SSO
- 使用Administration Console
Table of Contents
目录
- Platform Overview
- Core Concepts
- Development Environment Setup
- UI Integration Cards Development
- Content Packages
- Workspace Templates
- Chatbot Integration
- API Reference
- Administration Console
- Feature Management
- External Integrations
- Security
- Webhooks
- Theming and Branding
- Reports and Analytics
- Troubleshooting
- Bundled Resources
- Documentation Links
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
SAP Build Work Zone(高级版)是一款数字工作区平台,具备以下能力:
- 提供对SAP及第三方业务应用的统一访问
- 支持包含动态信息流、博客、维基和论坛的协作工作区
- 支持带Single Sign-On(SSO)的基于角色的导航
- 可在网页浏览器、移动应用和响应式Web UI中使用
- 支持与云、混合和本地部署的应用集成
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
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).
在有限空间容器中展示简洁信息的设计模式。遵循SAPUI5卡片规范(最低版本1.87.0;推荐使用更新版本以获取最新功能)。
Content Packages
内容包
Collections of artifacts (cards, workflows, workspace templates) bundled in ZIP files for distribution.
将工件(卡片、工作流、工作区模板)打包为ZIP文件以便分发的集合。
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
- 订阅SAP BTP上的SAP Build Work Zone(高级版)
- 订阅SAP Business Application Studio
- 分配Workzone_Admin角色集合
- 配置到内容仓库的目标地址
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 space1. 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 spaceUI Integration Cards Development
UI Integration Cards开发
Creating a UI Card
创建UI卡片
- 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
- 打开SAP Business Application Studio
- 选择“从模板创建新项目”
- 选择“UI Integration Card”
- 配置:
- Project Name: 您的标识符
- Card Sample: 模板选择
- NameSpace: 用于Card ID(namespace.projectname)
- Card Title/Subtitle: 显示文本
- Mobile Compatibility: 启用以支持移动设备
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- 列表卡片
- 对象卡片
- 表格卡片
- 时间线卡片
- 分析卡片
- 日历卡片
- 组件卡片
如需完整的卡片开发指南,请查看。
references/ui-integration-cards.mdContent Packages
内容包
Supported Artifacts
支持的工件
- UI Integration Cards
- Workflows
- Workspace templates
- Exported workspace configurations
- Homepage configurations
- UI Integration Cards
- 工作流
- 工作区模板
- 导出的工作区配置
- 首页配置
Package Types
包类型
- Centrally-provided: Auto-available to all customers, non-customizable
- Local packages: Custom packages uploaded by administrators
- Centrally-provided: 自动对所有客户可用,不可自定义
- Local packages: 由管理员上传的自定义包
Development Flow
开发流程
Create in BAS → Build package → Deploy → Install in Admin ConsoleFor complete content package guide, see .
references/content-packages.mdCreate in BAS → Build package → Deploy → Install in Admin Console如需完整的内容包指南,请查看。
references/content-packages.mdWorkspace 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- 设计工作区结构
- 定义小部件布局
- 配置默认设置
- 打包并部署
如需模板开发指南,请查看。
references/workspace-templates.mdChatbot 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.
SAP Conversational AI自2023年1月起进入维护模式。现有聊天机器人可能仍可正常运行,但SAP不建议创建新的实现。请考虑替代方案来实现聊天机器人功能。
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
- 自定义聊天机器人: 使用SAP Conversational AI构建(https://cai.tools.sap/)- ⚠️ 维护模式
- 预构建聊天机器人: 复刻并配置SAP Build Work Zone聊天机器人 - ⚠️ 不推荐用于新项目
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- 在SAP Conversational AI中复刻聊天机器人
- 使用SAP Jam Collaboration连接器连接
- 在Admin Console中注册OAuth客户端
- 配置机器人发布的别名账户
- 设置推送通知和webhooks
如需聊天机器人配置指南,请查看。
references/chatbots.mdAPI Reference
API参考
SCIM API
SCIM API
Endpoint:
/api/v1/scimAuthentication: 2-legged OAuth using "Workzone API Client"
Rate Limits:
| Limit Type | Value |
|---|---|
| Hourly limit | 10,000 requests/tenant |
| Burst limit | 200 requests/minute |
Headers:
- : Maximum hourly requests
X-RateLimit-Limit - : Available requests
X-RateLimit-Remaining - : Seconds until reset
X-RateLimit-Reset
Content-Type: (required for POST/PUT)
application/jsonEndpoint:
/api/v1/scimAuthentication: 使用"Workzone API Client"的双腿OAuth
Rate Limits:
| 限制类型 | 数值 |
|---|---|
| 每小时限制 | 10,000请求/租户 |
| 突发限制 | 200请求/分钟 |
Headers:
- : 每小时最大请求数
X-RateLimit-Limit - : 可用请求数
X-RateLimit-Remaining - : 重置剩余秒数
X-RateLimit-Reset
Content-Type: (POST/PUT请求必填)
application/jsonOData API
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.mdSAP Build Work Zone使用带有v4扩展的OData v2。
Format: XML(AtomPub)或JSON
如需完整的API参考,请查看。
references/api-reference.mdAdministration Console
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
- Users: 管理内部/外部用户、用户列表
- Authentication: SAML身份提供商、OAuth客户端、SSO
- Theming: 分配主题、自定义邮件模板
- Areas & Workspaces: 首页、工作区设置
- Integrations: Microsoft Teams、移动应用、聊天机器人
- Features: 启用/禁用站点功能
- Compliance: 内容管理、监控
- Analytics: 使用报告、采用指标
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
- Compliance Monitor: 标记包含合规词典术语的内容
- Profanity Monitor: 标记存在脏话违规的内容
- Unscannable Filter: 标记无法扫描的文件
Content Features
内容功能
- File sharing, feed sharing
- Content rating
- Wikis, blogs, knowledge bases
- Video/audio uploads
- PDF viewing
- 文件共享、信息流共享
- 内容评分
- 维基、博客、知识库
- 视频/音频上传
- PDF查看
Integration Features
集成功能
- API access
- Microsoft Teams integration
- Office 365 SharePoint integration
- Google Drive integration
- API访问
- Microsoft Teams集成
- Office 365 SharePoint集成
- Google Drive集成
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 |
| 集成项 | 用途 |
|---|---|
| Microsoft Teams | 协作、通知 |
| Office 365 SharePoint | 文档共享、站点 |
| Google Drive | 云存储 |
| SAP SuccessFactors | HR集成 |
| SAP Cloud for Customer | CRM集成 |
| SAP Task Center | 统一任务管理 |
| SAP Build Process Automation | 工作流自动化 |
Security
安全
Authentication
认证
- SAML Identity Providers
- OAuth 2.0 clients
- Single Sign-On (SSO)
- Trusted Certificate Authorities
- SAML身份提供商
- OAuth 2.0客户端
- Single Sign-On(SSO)
- 可信证书颁发机构
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- 基于角色的访问控制
- HTTP安全头(点击劫持防护、XSS防护)
- 内容提供商安全指南
- 安全事件审计日志
如需安全配置指南,请查看。
references/security.mdWebhooks
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
- 定义要监控的事件
- 配置回调URL
- 设置认证令牌
- 处理推送通知
Theming and Branding
主题与品牌定制
Options
选项
- Assign themes to site
- Customize email templates
- Local themes (partial UI coverage)
- Theme Manager for custom branding
- 为站点分配主题
- 自定义邮件模板
- 本地主题(部分UI覆盖)
- 使用主题管理器进行自定义品牌定制
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| 问题 | 解决方案 |
|---|---|
| HTTP 503 | 服务维护中,稍后重试 |
| 超出速率限制 | 查看X-RateLimit请求头,等待重置 |
| OAuth认证失败 | 验证Workzone API Client凭证 |
| 卡片未显示 | 检查SAPUI5版本兼容性 |
如需故障排查指南,请查看。
references/troubleshooting.mdBundled Resources
捆绑资源
Reference Documentation
参考文档
- (331 lines) - Complete UI Integration Cards development guide
references/ui-integration-cards.md - (266 lines) - Content package creation and deployment
references/content-packages.md - (159 lines) - Workspace template development
references/workspace-templates.md - (297 lines) - Chatbot configuration (maintenance mode notice included)
references/chatbots.md - (306 lines) - SCIM and OData API documentation
references/api-reference.md - (128 lines) - Security configuration best practices
references/security.md - (299 lines) - Administration Console guide
references/administration.md - (176 lines) - Audit and compliance features
references/auditing.md - (124 lines) - Mobile app configuration
references/mobile-app.md - (147 lines) - Notification system setup
references/notifications.md - (124 lines) - Common error resolution
references/troubleshooting.md - (213 lines) - Widget development guide
references/widgets.md - (295 lines) - Workspace management
references/workspaces.md
- (331行)- 完整的UI Integration Cards开发指南
references/ui-integration-cards.md - (266行)- 内容包创建与部署
references/content-packages.md - (159行)- 工作区模板开发
references/workspace-templates.md - (297行)- 聊天机器人配置(包含维护模式通知)
references/chatbots.md - (306行)- SCIM和OData API文档
references/api-reference.md - (128行)- 安全配置最佳实践
references/security.md - (299行)- Administration Console指南
references/administration.md - (176行)- 审计与合规功能
references/auditing.md - (124行)- 移动应用配置
references/mobile-app.md - (147行)- 通知系统设置
references/notifications.md - (124行)- 常见错误解决
references/troubleshooting.md - (213行)- 小部件开发指南
references/widgets.md - (295行)- 工作区管理
references/workspaces.md
Templates
模板
- - UI Integration Card manifest template
templates/card-manifest.json - - Content package manifest template
templates/content-package-manifest.json - - Deployment configuration template
templates/dt-configuration.js - - Workspace template configuration
templates/workspace-template-config.json
- - UI Integration Card清单模板
templates/card-manifest.json - - 内容包清单模板
templates/content-package-manifest.json - - 部署配置模板
templates/dt-configuration.js - - 工作区模板配置
templates/workspace-template-config.json
Documentation Links
文档链接
- SAP Help Portal: https://help.sap.com/docs/build-work-zone-advanced-edition
- GitHub Docs: https://github.com/SAP-docs/sap-btp-build-work-zone-advanced
- SAP API Hub: https://api.sap.com/ (search "SAP Cloud Portal Service")
- OData API Docs: https://jam2.sapjam.com
- SAPUI5 Card Explorer: https://ui5.sap.com/test-resources/sap/ui/integration/demokit/cardExplorer/
Last Updated: 2025-11-27
Documentation Version: Based on SAP documentation as of November 2025
- SAP帮助门户:https://help.sap.com/docs/build-work-zone-advanced-edition
- GitHub文档:https://github.com/SAP-docs/sap-btp-build-work-zone-advanced
- SAP API Hub:https://api.sap.com/(搜索“SAP Cloud Portal Service”)
- OData API文档:https://jam2.sapjam.com
- SAPUI5 Card Explorer:https://ui5.sap.com/test-resources/sap/ui/integration/demokit/cardExplorer/
最后更新:2025-11-27
文档版本:基于2025年11月的SAP文档