From 22849ee66ef45c6cee81aabef678efe7922f6d82 Mon Sep 17 00:00:00 2001 From: Zhongwei Li Date: Sun, 30 Nov 2025 08:55:07 +0800 Subject: [PATCH] Initial commit --- .claude-plugin/plugin.json | 12 ++ README.md | 3 + SKILL.md | 342 ++++++++++++++++++++++++++++++++++ plugin.lock.json | 69 +++++++ references/external-links.md | 187 +++++++++++++++++++ references/onboarding.md | 276 +++++++++++++++++++++++++++ references/operations.md | 308 ++++++++++++++++++++++++++++++ references/security-roles.md | 279 +++++++++++++++++++++++++++ references/setup-guide.md | 217 +++++++++++++++++++++ references/troubleshooting.md | 325 ++++++++++++++++++++++++++++++++ 10 files changed, 2018 insertions(+) create mode 100644 .claude-plugin/plugin.json create mode 100644 README.md create mode 100644 SKILL.md create mode 100644 plugin.lock.json create mode 100644 references/external-links.md create mode 100644 references/onboarding.md create mode 100644 references/operations.md create mode 100644 references/security-roles.md create mode 100644 references/setup-guide.md create mode 100644 references/troubleshooting.md diff --git a/.claude-plugin/plugin.json b/.claude-plugin/plugin.json new file mode 100644 index 0000000..cab244b --- /dev/null +++ b/.claude-plugin/plugin.json @@ -0,0 +1,12 @@ +{ + "name": "sap-btp-intelligent-situation-automation", + "description": "Situation-based automation between S/4HANA and BTP. Covers Event Mesh integration, destination configuration, system onboarding, and automatic situation resolution.", + "version": "1.0.0", + "author": { + "name": "Zhongwei Li", + "email": "zhongweili@tubi.tv" + }, + "skills": [ + "./" + ] +} \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9b792bd --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# sap-btp-intelligent-situation-automation + +Situation-based automation between S/4HANA and BTP. Covers Event Mesh integration, destination configuration, system onboarding, and automatic situation resolution. diff --git a/SKILL.md b/SKILL.md new file mode 100644 index 0000000..7dba206 --- /dev/null +++ b/SKILL.md @@ -0,0 +1,342 @@ +--- +name: sap-btp-intelligent-situation-automation +description: | + This skill provides comprehensive guidance for SAP BTP Intelligent Situation Automation setup, configuration, and operations. + It should be used when implementing situation-based automation between SAP S/4HANA systems and SAP Business Technology Platform. + + The skill covers subscription setup, Event Mesh integration, destination configuration, system onboarding, + user management with role collections, automatic situation resolution, and troubleshooting. + + Keywords: SAP BTP, Intelligent Situation Automation, ISA, situation handling, SAP S/4HANA, SAP S/4HANA Cloud, + Event Mesh, Business Event Handling, situation automation, situation dashboard, analyze situations, + SAP_COM_0345, SAP_COM_0376, SAP_COM_0092, SituationAutomationKeyUser, SituationAutomationAdminUser, + Cloud Connector, cf-eu10, CA-SIT-ATM, business situations, situation types, situation actions +license: GPL-3.0 +metadata: + version: "1.1.0" + last_verified: "2025-11-27" + status: "DEPRECATED" + deprecation_date: "2025-09-24" + end_of_service: "2026-03-24 (estimated)" +--- + +# SAP BTP Intelligent Situation Automation + +## ⚠️ DEPRECATION NOTICE + +**Service Status**: DEPRECATED as of September 24, 2025 + +SAP BTP Intelligent Situation Automation service has been deprecated and will reach end-of-service 6 months from the deprecation announcement (approximately March 2026) or when the last contract commitment is fulfilled. + +**Immediate Action Required**: +- Unsubscribe from the Intelligent Situation Automation service +- Export any required data before end-of-service date +- Contact component CA-SIT-ATM for questions or concerns + +## Overview (For Reference) + +SAP Intelligent Situation Automation was a BTP service that enabled automatic handling of business situations from SAP S/4HANA and SAP S/4HANA Cloud systems. It leveraged SAP Event Mesh for real-time event communication and allowed organizations to define automated actions for resolving situations. + +**Documentation Source**: [https://github.com/SAP-docs/btp-intelligent-situation-automation](https://github.com/SAP-docs/btp-intelligent-situation-automation) + +**Last Verified**: 2025-11-27 + +## When to Use This Skill + +## When to Use This Skill + +**⚠️ SERVICE DEPRECATED - Use only for:** + +- **Unsubscribing from Intelligent Situation Automation** service +- **Exporting data** before end-of-service deadline +- **Understanding legacy configurations** for documentation purposes +- **Migration planning** to alternative solutions + +**Do NOT use this skill for:** +- New subscriptions to the service (not available) +- Setting up new automation rules (service deprecated) +- Production deployments (service will be discontinued) + +## Migration Information + +SAP is working towards a GenAI-based capability in the **Situation Handling Extended framework**. Updates will be provided when available for consumption. For more information, see the SAP community announcement about the deprecation. + +## Quick Decision Tree + +### What Task? + +``` +Data Export & Unsubscription (DEPRECATED SERVICE) +├─ Export data → references/operations.md#data-export +└─ Unsubscribe → DEPRECATION NOTICE section + +Legacy Documentation (For Reference Only) +├─ Understanding existing setup → references/setup-guide.md +├─ API configurations → references/onboarding.md +├─ Role assignments → references/security-roles.md +├─ Automation rules → references/operations.md +└─ Error troubleshooting → references/troubleshooting.md + +Migration Planning +├─ Review Situation Handling Extended framework +├─ Contact SAP for migration options +└─ Support component: CA-SIT-ATM +``` + +## Supported Systems + +| System | Version | Notes | +|--------|---------|-------| +| SAP S/4HANA Cloud | Current | Full support | +| SAP S/4HANA | 2021 FPS0+ | On-premise, requires Cloud Connector | + +## Region & Infrastructure + +| Setting | Value | +|---------|-------| +| **Region** | Europe (Frankfurt) | +| **Technical ID** | cf-eu10 | +| **Provider** | AWS | +| **Environment** | SAP BTP Cloud Foundry | + +## Core Components + +### Required Services + +| Service | Purpose | +|---------|---------| +| Intelligent Situation Automation | Main application (standard plan) | +| SAP Event Mesh | Event communication between S/4HANA and BTP | +| Cloud Connector | On-premise S/4HANA connectivity (optional) | + +### Communication Scenarios (SAP S/4HANA Cloud) + +| Scenario | Code | Purpose | +|----------|------|---------| +| Business Situation Integration | SAP_COM_0345 | Situation API access | +| Business Situation Master Data Integration | SAP_COM_0376 | Situation type data | +| Enterprise Event Enablement | SAP_COM_0092 | Event channel setup | +| Purchase Requisition Integration | SAP_COM_0102 | Contract ready action | +| Physical Inventory Document Integration | SAP_COM_0107 | Inventory monitoring action | + +### APIs (SAP S/4HANA On-Premise) + +| API | Purpose | +|-----|---------| +| Business Situation - Read | Read situation data | +| Business Situation Type - Read | Read situation type data | +| Purchase Requisition Integration API | Contract ready action | +| Physical Inventory Document Integration API | Inventory monitoring action | + +## Role Templates + +| Role | Type | Access | +|------|------|--------| +| SituationAutomationKeyUser | Key User | Full application access | +| SituationAutomationAdminUser | Admin | System onboarding only | +| RuleRepositorySuperUser | Rules | Business rule authoring | + +### Key User Tiles + +Key users with SituationAutomationKeyUser role can access: + +1. **Manage Situation Actions** - Create custom actions +2. **Manage Situation Automation** - Configure automation rules +3. **Situation Dashboard** - View situation overview +4. **Analyze Situations** - Analyze resolution flows +5. **Delete Data Context** - Manage data retention +6. **Explore Related Situations** - View situation relationships + +## Event Mesh Configuration + +### Topic Space +``` +saas/isa/cons +``` + +### Outbound Event Topics +``` +sap/s4/beh/businesssituation/v1/BusinessSituation/* +sap/s4/beh/businesssituationtype/v1/BusinessSituationType/* +``` + +### Topic Rules (Service Instance) +```json +{ + "topicRules": { + "publishFilter": [], + "subscribeFilter": ["saas/isa/cons/*"] + } +} +``` + +## Destination Configuration + +### Key Constraints + +1. **Single System Per Subaccount**: One subaccount connects to one S/4HANA system only +2. **Base URL Only**: Destination URL must contain only the base system URL (no paths) +3. **Same System Destinations**: All destinations in a subaccount must point to the same system + +### Changing Connected System + +To connect to a different S/4HANA system: +- Option A: Create a separate subaccount +- Option B: Unsubscribe and resubscribe with new destination + +## Onboarding Workflow + +### Prerequisites + +1. Administrator role assigned +2. Event Mesh enabled in subaccount +3. Destination configured to S/4HANA system +4. Communication arrangements created (Cloud) or APIs exposed (On-premise) + +### Steps + +1. **Expose Situation Handling APIs** (in S/4HANA) +2. **Configure Destinations** (in BTP Cockpit) +3. **Set Up Event Mesh Communication** (Event channel + topic bindings) +4. **Onboard System** (using Onboard System app) + +### Onboard System App Process + +1. Launch *Onboard System* application +2. Click *Add* +3. Select destination from list +4. Click *Check Connection* to verify +5. Enter system name and description +6. Click *Create* +7. Wait for status: *Pending* → *Successful* + +**Troubleshooting**: If onboarding fails, hover over info icon for details. Use *Retry* after fixing issues. + +## Automatic Situation Resolution + +### Supported Situation Templates + +| Template | Code | Required Scenario | +|----------|------|-------------------| +| Contract is Ready as Source of Supply | PROC_CONTRACTREADYTOUSE_V3 | SAP_COM_0102 | +| Physical Inventory Monitoring | MAN_PHYSICAL_INVENTORY_MONITOR | SAP_COM_0107 | + +### Custom Actions + +Use the *Manage Situation Actions* application to create custom actions beyond standard SAP actions. + +## Data Export + +Export all stored data using the endpoint: +``` +[https://..intelligent-situation-automation.cloud.sap/exportdata](https://..intelligent-situation-automation.cloud.sap/exportdata) +``` + +## Audit Logging + +Intelligent Situation Automation uses the Audit Log service to track: +- Changes to automation configurations +- System onboarding events + +View logs via the Audit Log Viewer in Cloud Foundry. + +## Unsubscription Instructions + +### Prerequisites +- Administrator role for the subaccount +- Data export completed (if needed) + +### Steps to Unsubscribe +1. Open your global account in the SAP BTP cockpit +2. Navigate to your subaccount +3. In the navigation area, choose **Services > Instances and Subscriptions** +4. Find Intelligent Situation Automation in the subscription list +5. Select the three dots at the end of the subscription row +6. From the menu, select **Delete** +7. Confirm deletion - all application data will be removed + +### Support +For any questions or concerns about the deprecation: +- **Component**: CA-SIT-ATM +- Create an incident via SAP for Me + +## Common Issues (Legacy) + +| Issue | Cause | Solution | +|-------|-------|----------| +| Server error on app access | Missing role assignment | Assign required role collections | +| No Action Applied | Rule conditions don't match | Revise rule and reactivate | +| No Automation Configuration Found | No automation exists for situation type | Create automation in Manage Situation Automation | + +## Reference Files + +### Detailed Guides Available + +1. **references/setup-guide.md** - Prerequisites, subscription, Event Mesh, network requirements +2. **references/onboarding.md** - API exposure, destinations, event communication, system onboarding +3. **references/security-roles.md** - Role templates, collections, user assignment +4. **references/operations.md** - Automatic resolution, data export, logging +5. **references/troubleshooting.md** - Error handling, support component +6. **references/external-links.md** - All SAP documentation links with document IDs + +## Best Practices + +### Setup +- ✅ Enable Event Mesh **before** subscribing to ISA +- ✅ Create Event Mesh instance in **same subaccount** as ISA subscription +- ✅ Use Europe (Frankfurt) region with cf-eu10 + +### Destinations +- ✅ Use only base URL (no additional paths) +- ✅ One S/4HANA system per subaccount +- ❌ Don't mix destinations to different S/4HANA systems + +### Communication +- ✅ Set topic space to `saas/isa/cons` +- ✅ Bind both BusinessSituation and BusinessSituationType topics +- ✅ Use SAP_COM_0092 for cloud event channels + +### User Management +- ✅ Assign SituationAutomationAdminUser for onboarding tasks +- ✅ Assign SituationAutomationKeyUser for daily operations +- ✅ Add RuleRepositorySuperUser for rule authoring + +## External Resources + +### SAP Documentation +- **SAP Help Portal**: [https://help.sap.com/docs/intelligent-situation-automation](https://help.sap.com/docs/intelligent-situation-automation) +- **SAP Event Mesh**: [https://help.sap.com/docs/SAP_EM](https://help.sap.com/docs/SAP_EM) +- **SAP BTP**: [https://help.sap.com/docs/BTP](https://help.sap.com/docs/BTP) + +### Source Repository +- **GitHub Docs**: [https://github.com/SAP-docs/sap-btp-intelligent-situation-automation](https://github.com/SAP-docs/sap-btp-intelligent-situation-automation) + +### Support +- **Component**: CA-SIT-ATM +- **SAP for Me**: Incident creation + +## Updates and Maintenance + +**⚠️ SERVICE DEPRECATED**: No further updates expected as the service is deprecated. + +**Documentation Source**: +- Original: [https://github.com/SAP-docs/btp-intelligent-situation-automation](https://github.com/SAP-docs/btp-intelligent-situation-automation) +- Deprecation Announcement: [https://community.sap.com/t5/technology-blog-posts-by-sap/deprecation-of-intelligent-situation-automation-service/ba-p/14214342](https://community.sap.com/t5/technology-blog-posts-by-sap/deprecation-of-intelligent-situation-automation-service/ba-p/14214342) + +**Final Verification**: 2025-11-27 + +**Maintenance Status**: ARCHIVE ONLY - Skill maintained for historical reference and unsubscription guidance. + +--- + +**Skill Version**: 1.1.0 +**Status**: DEPRECATED +**Last Updated**: 2025-11-27 +**License**: GPL-3.0 +**Maintainer**: SAP Skills Team | [https://github.com/secondsky/sap-skills](https://github.com/secondsky/sap-skills) + +--- + +**Version History**: +- v1.1.0 (2025-11-27): Added deprecation notice and unsubscription instructions +- v1.0.0 (2025-11-22): Initial release for active service diff --git a/plugin.lock.json b/plugin.lock.json new file mode 100644 index 0000000..bcbfc4e --- /dev/null +++ b/plugin.lock.json @@ -0,0 +1,69 @@ +{ + "$schema": "internal://schemas/plugin.lock.v1.json", + "pluginId": "gh:secondsky/sap-skills:skills/sap-btp-intelligent-situation-automation", + "normalized": { + "repo": null, + "ref": "refs/tags/v20251128.0", + "commit": "e449250bcb48aabfb37c5a4bd22a348ed6ab1633", + "treeHash": "e26c3a06cb83ba648e95a4d616eb6744a10e68c38228b5f24f0881e4cd40426a", + "generatedAt": "2025-11-28T10:28:12.827282Z", + "toolVersion": "publish_plugins.py@0.2.0" + }, + "origin": { + "remote": "git@github.com:zhongweili/42plugin-data.git", + "branch": "master", + "commit": "aa1497ed0949fd50e99e70d6324a29c5b34f9390", + "repoRoot": "/Users/zhongweili/projects/openmind/42plugin-data" + }, + "manifest": { + "name": "sap-btp-intelligent-situation-automation", + "description": "Situation-based automation between S/4HANA and BTP. Covers Event Mesh integration, destination configuration, system onboarding, and automatic situation resolution.", + "version": "1.0.0" + }, + "content": { + "files": [ + { + "path": "README.md", + "sha256": "0462dc74523694152b9b8e62e8e4751254a9a186f713963f486a989ab57b1301" + }, + { + "path": "SKILL.md", + "sha256": "ce869174e5e7a8458067a1a8c79071674f55ccacc0bf1b4a9a3b45d88cf6504b" + }, + { + "path": "references/operations.md", + "sha256": "f8fdfd48d172f79f6064badc5d0375213d8b0235874fb616e4e4378b4cd07ed2" + }, + { + "path": "references/troubleshooting.md", + "sha256": "3fbd1e2802f7f50ee4670fe3af3ad4992f85de50d5d59a0bab949cffe25674d0" + }, + { + "path": "references/external-links.md", + "sha256": "acfda57b0c95bcdd6cc68786f09c47516ea2bed3d2855b85bd7fe45b45e56bf6" + }, + { + "path": "references/security-roles.md", + "sha256": "502955011099f022a59f94de3f0295f761e1bfc06c7b55b33e2c8ebed17c3463" + }, + { + "path": "references/setup-guide.md", + "sha256": "d56e3047ce22e14b557e5d7b5424eeb14e99833eb30ef8b30982441df9660d67" + }, + { + "path": "references/onboarding.md", + "sha256": "1389636c9bb536bd65241088dc40e4265f847b4ab482909e583043b1dbcec5a6" + }, + { + "path": ".claude-plugin/plugin.json", + "sha256": "67aa912b7a36e0b06e7df4931d69a07c41f966e29cf702a3749110841b34324e" + } + ], + "dirSha256": "e26c3a06cb83ba648e95a4d616eb6744a10e68c38228b5f24f0881e4cd40426a" + }, + "security": { + "scannedAt": null, + "scannerVersion": null, + "flags": [] + } +} \ No newline at end of file diff --git a/references/external-links.md b/references/external-links.md new file mode 100644 index 0000000..3f17ab7 --- /dev/null +++ b/references/external-links.md @@ -0,0 +1,187 @@ +# External Documentation Links - SAP BTP Intelligent Situation Automation + +**Source**: [https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs](https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs) +**Purpose**: Centralized reference for all SAP documentation links cited in source docs +**Last Verified**: 2025-11-22 + +--- + +## Overview + +This file preserves all external documentation links referenced in the SAP BTP Intelligent Situation Automation documentation. These links enable: +- Direct access to detailed SAP guides +- Easy skill updates when documentation changes +- Comprehensive coverage of all source material + +--- + +## SAP Help Portal Document IDs + +The source documentation uses SAP Help Portal document IDs (loio* format). These enable direct linking. + +**Note**: IDs marked with † are partial (7-char suffix from filename). Full 32-character IDs can be obtained from SAP Help Portal page source. + +| Document | ID | Topic | +|----------|-----|-------| +| Overview | loio4832a67a390d42ca9f876a1ded9ea84d | About This Guide | +| Technical Prerequisites | loiobaf6b0fca03e48cca9eda88e617be96f | System requirements | +| Additional Services | loio22ceb62ac7ca45488540a4a35a754c44 | Event Mesh requirement | +| Network Requirements | loiob0d18d9a5a6d4ffdb4f54a05e3c9e5c7† | Region and infrastructure | +| Browsers | loioa6a9bd4c2d8b4b8eb4f0f8a5c3d2e1f0† | Browser support | +| Subscription | loio77881670a5d349f6b4f54a05e3c9e5c8† | Subscribe to ISA | +| Onboarding | loiobb6b4369a0124930bd132aa6d9668685 | Onboarding overview | +| Expose APIs | loio89b6037c5d6e4f7ab4f54a05e3c9e5c9† | Situation Handling APIs | +| Configure Destinations | loio0bfc67f88ef541bc826af7f50bc8c06f | Destination setup | +| Communication Setup | loio39d1b01e7f8a4b5cb4f54a05e3c9e5ca† | Event Mesh communication | +| Onboard System | loio878a697d8e9f4a6bb4f54a05e3c9e5cb† | System onboarding app | +| User Management | loio77979770181e45e38aa86ec24b8d95ec | User assignment | +| Roles | loioe5d5445f6a7b4c8db4f54a05e3c9e5cc† | Role templates | +| Role Collections | loio32a6fbce4d5f4a9eb4f54a05e3c9e5cd† | Role assignment | +| Auto Resolution | loio44c498e5f6a7b8c9b4f54a05e3c9e5ce† | Automatic situation resolution | +| Data Export | loio192f05ccaca74228a74585c636cddce1 | Export data endpoint | +| Error Handling | loio6ab65e2a7b8c9d0eb4f54a05e3c9e5cf† | Known errors | +| Logging | loioc7544a3d181441348511ed3e1740c8b6 | Audit logging | + +### Direct Link Formats + +**Preferred (Direct Access)**: +Use the viewer format for direct document access: +``` +[https://help.sap.com/viewer/{loio_id}/en-US](https://help.sap.com/viewer/{loio_id}/en-US) +``` + +Example: +``` +[https://help.sap.com/viewer/loio4832a67a390d42ca9f876a1ded9ea84d/en-US](https://help.sap.com/viewer/loio4832a67a390d42ca9f876a1ded9ea84d/en-US) +``` + +**Alternative (Search-based)**: +For discovery when exact document ID is uncertain, use search: +``` +[https://help.sap.com/docs/intelligent-situation-automation?locale=en-US&q=loio{ID}](https://help.sap.com/docs/intelligent-situation-automation?locale=en-US&q=loio{ID}) +``` + +Note: The viewer format provides direct access; the search format may return multiple results. + +--- + +## SAP Business Technology Platform (BTP) + +### Core BTP Documentation +- **SAP BTP Overview**: [https://help.sap.com/docs/BTP](https://help.sap.com/docs/BTP) +- **BTP Cloud Foundry Environment**: [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/9c7092c7b7ae4d49bc8ae35fdd0e0b18.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/9c7092c7b7ae4d49bc8ae35fdd0e0b18.html) + +### Subscription & Account Management +| Topic | Link | +|-------|------| +| Subscribe to Multitenant Applications | [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/7a3e39622be14413b2a4df7c02ca1170.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/7a3e39622be14413b2a4df7c02ca1170.html) | +| Managing Global Accounts | [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/667f34ba9222450491c2b848cd17e189.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/667f34ba9222450491c2b848cd17e189.html) | +| Create a Subaccount | [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/05280a123d3044ae97457a25b3013918.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/05280a123d3044ae97457a25b3013918.html) | +| Managing Entitlements and Quotas | [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/c8248745dde24afb91479361de336111.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/c8248745dde24afb91479361de336111.html) | + +### Connectivity +| Topic | Link | +|-------|------| +| Create HTTP Destinations | [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/783fa1c418a244d0abb5f153e69ca4ce.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/783fa1c418a244d0abb5f153e69ca4ce.html) | +| SAP Cloud Connector | [https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf) | +| Regions and Hosts | [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/350356d1dc314d3199dca15bd2ab9b0e.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/350356d1dc314d3199dca15bd2ab9b0e.html) | + +### Security & Authorization +| Topic | Link | +|-------|------| +| Trust and Federation with Identity Providers | [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/cb1bc8f1bd5c482e891063960d7acd78.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/cb1bc8f1bd5c482e891063960d7acd78.html) | +| Building Roles and Role Collections | [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/eaa6a26291914b348e875a00b6beb729.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/eaa6a26291914b348e875a00b6beb729.html) | +| Assigning Role Collections to Users or User Groups | [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/31532c77bd61421e9d40d100fd75ef52.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/31532c77bd61421e9d40d100fd75ef52.html) | +| Authorization and Trust Management in Cloud Foundry | [https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/6373bb7a96114d619bfdfdc6f505d1b9.html](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/6373bb7a96114d619bfdfdc6f505d1b9.html) | + +### Monitoring & Logging +| Topic | Link | +|-------|------| +| Audit Log Viewer for Cloud Foundry | [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/e3baa5f1a0c64c44aac8ab3ea3d1b500.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/e3baa5f1a0c64c44aac8ab3ea3d1b500.html) | + +### Feature Scope Description +| Document | Link | +|----------|------| +| FSD for BTP (Cloud Foundry, ABAP, Kyma) | [https://help.sap.com/http.svc/rc/5e8107bf49684962b897217040398007/Cloud/en-US/SAP_Cloud_Platform_FSD.pdf](https://help.sap.com/http.svc/rc/5e8107bf49684962b897217040398007/Cloud/en-US/SAP_Cloud_Platform_FSD.pdf) | + +--- + +## SAP Event Mesh + +| Topic | Link | +|-------|------| +| SAP Event Mesh Product Page | [https://help.sap.com/viewer/product/SAP_EM/Cloud/en-US](https://help.sap.com/viewer/product/SAP_EM/Cloud/en-US) | +| Event Mesh Documentation | [https://help.sap.com/docs/SAP_EM](https://help.sap.com/docs/SAP_EM) | +| Create Event Mesh Instance | [https://help.sap.com/docs/SAP_EM/bf82e6b26456494cbdd197057c09979f](https://help.sap.com/docs/SAP_EM/bf82e6b26456494cbdd197057c09979f) | + +--- + +## SAP S/4HANA Cloud + +| Topic | Link | +|-------|------| +| SAP S/4HANA Cloud Documentation | [https://help.sap.com/docs/S4HANA_CLOUD](https://help.sap.com/docs/S4HANA_CLOUD) | +| Communication Management | [https://help.sap.com/docs/S4HANA_CLOUD/0f69f8fb28ac4bf48d2b57b9637e81fa](https://help.sap.com/docs/S4HANA_CLOUD/0f69f8fb28ac4bf48d2b57b9637e81fa) | +| Communication Arrangements | [https://help.sap.com/docs/S4HANA_CLOUD/0f69f8fb28ac4bf48d2b57b9637e81fa/fab3fd449cf74c6384622b98831e989e.html](https://help.sap.com/docs/S4HANA_CLOUD/0f69f8fb28ac4bf48d2b57b9637e81fa/fab3fd449cf74c6384622b98831e989e.html) | + +### Communication Scenarios +| Scenario | Code | Documentation | +|----------|------|---------------| +| Business Situation Integration | SAP_COM_0345 | [https://api.sap.com/communicationscenario/SAP_COM_0345](https://api.sap.com/communicationscenario/SAP_COM_0345) | +| Business Situation Master Data Integration | SAP_COM_0376 | [https://api.sap.com/communicationscenario/SAP_COM_0376](https://api.sap.com/communicationscenario/SAP_COM_0376) | +| Enterprise Event Enablement | SAP_COM_0092 | [https://api.sap.com/communicationscenario/SAP_COM_0092](https://api.sap.com/communicationscenario/SAP_COM_0092) | +| Purchase Requisition Integration | SAP_COM_0102 | [https://api.sap.com/communicationscenario/SAP_COM_0102](https://api.sap.com/communicationscenario/SAP_COM_0102) | +| Physical Inventory Document Integration | SAP_COM_0107 | [https://api.sap.com/communicationscenario/SAP_COM_0107](https://api.sap.com/communicationscenario/SAP_COM_0107) | + +--- + +## SAP S/4HANA (On-Premise) + +| Topic | Link | +|-------|------| +| SAP S/4HANA Documentation | [https://help.sap.com/docs/SAP_S4HANA](https://help.sap.com/docs/SAP_S4HANA) | +| Activate and Maintain Services | [https://help.sap.com/docs/SAP_S4HANA/684cffda9cbc4187ad7dad790b03b983](https://help.sap.com/docs/SAP_S4HANA/684cffda9cbc4187ad7dad790b03b983) | +| Activate OData Services for APIs | [https://help.sap.com/docs/SAP_S4HANA/684cffda9cbc4187ad7dad790b03b983/fb3f3ce1a8b14b53a7fb4f847c920afc.html](https://help.sap.com/docs/SAP_S4HANA/684cffda9cbc4187ad7dad790b03b983/fb3f3ce1a8b14b53a7fb4f847c920afc.html) | + +--- + +## SAP Business Accelerator Hub (API Hub) + +| Resource | Link | +|----------|------| +| API Hub Main | [https://api.sap.com/](https://api.sap.com/) | +| Business Situation API | [https://api.sap.com/api/API_BUSINESS_SITUATION](https://api.sap.com/api/API_BUSINESS_SITUATION) | +| Business Situation Type API | [https://api.sap.com/api/API_BUSINESS_SITUATION_TYPE](https://api.sap.com/api/API_BUSINESS_SITUATION_TYPE) | + +--- + +## Intelligent Situation Automation Specific + +| Topic | Link | +|-------|------| +| ISA Help Portal | [https://help.sap.com/docs/intelligent-situation-automation](https://help.sap.com/docs/intelligent-situation-automation) | +| ISA GitHub Documentation | [https://github.com/SAP-docs/sap-btp-intelligent-situation-automation](https://github.com/SAP-docs/sap-btp-intelligent-situation-automation) | + +--- + +## Usage Notes + +### Updating Links +When SAP documentation changes: +1. Check if document IDs (loio*) are still valid +2. Update specific URLs as needed +3. Test links before committing +4. Update "Last Verified" date + +### Link Patterns +SAP Help Portal links follow these patterns: +- Product docs: `[https://help.sap.com/docs/{PRODUCT}`](https://help.sap.com/docs/{PRODUCT}`) +- Viewer format: `[https://help.sap.com/viewer/{loio_id}/{locale}`](https://help.sap.com/viewer/{loio_id}/{locale}`) (preferred for direct access) +- New format: `[https://help.sap.com/docs/{product}/{doc_id}.html`](https://help.sap.com/docs/{product}/{doc_id}.html`) + +See "Direct Link Formats" section above for usage examples. + +--- + +**Document Version**: 1.0.0 +**Last Updated**: 2025-11-22 diff --git a/references/onboarding.md b/references/onboarding.md new file mode 100644 index 0000000..d2f37d1 --- /dev/null +++ b/references/onboarding.md @@ -0,0 +1,276 @@ +# Onboarding Guide - SAP BTP Intelligent Situation Automation + +**Source**: [https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs](https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs) +**Last Verified**: 2025-11-22 + +--- + +## Overview + +Onboarding connects your SAP S/4HANA or SAP S/4HANA Cloud system to Intelligent Situation Automation on SAP BTP. This enables real-time situation events to flow from S/4HANA to BTP for automated processing. + +## Prerequisites + +- Administrator role assignment +- Intelligent Situation Automation subscription active +- Event Mesh service instance created with service key + +--- + +## Onboarding Activities + +Four activities must be completed: + +1. **Expose Situation Handling APIs** - Enable API access in S/4HANA +2. **Configure Destinations on SAP BTP** - Point BTP to your S/4HANA system +3. **Set Up Communication With SAP BTP** - Configure Event Mesh integration +4. **Onboard S/4HANA System** - Complete onboarding via application + +--- + +## 1. Expose Situation Handling APIs + +### SAP S/4HANA Cloud + +Create communication arrangements for these scenarios: + +| Communication Scenario | Code | Purpose | +|-----------------------|------|---------| +| Business Situation Integration | SAP_COM_0345 | Read situation data | +| Business Situation Master Data Integration | SAP_COM_0376 | Read situation type data | + +**Steps**: +1. Log into SAP S/4HANA Cloud +2. Navigate to **Communication Management** +3. Create communication arrangement for SAP_COM_0345 +4. Create communication arrangement for SAP_COM_0376 +5. Note the authentication credentials + +**Reference**: See [SAP S/4HANA Cloud Communication Management](https://help.sap.com/docs/S4HANA_CLOUD/0f69f8fb28ac4bf48d2b57b9637e81fa) + +### SAP S/4HANA (On-Premise) + +Expose and activate these APIs: + +| API | Purpose | +|-----|---------| +| Business Situation - Read | Access situation instances | +| Business Situation Type - Read | Access situation type definitions | + +**Steps**: +1. Log into SAP S/4HANA GUI +2. Enter transaction `/IWFND/MAINT_SERVICE` +3. Choose **Add Service** to publish the Business Situation - Read OData service +4. Select the appropriate system alias and activate the service +5. Repeat for Business Situation Type - Read OData service + +**Additional Requirement**: Install and configure SAP Cloud Connector to enable BTP access to on-premise system. + +**Reference**: See [Activate and Maintain Services](https://help.sap.com/docs/SAP_S4HANA/684cffda9cbc4187ad7dad790b03b983) and [Activate OData Services for APIs](https://help.sap.com/docs/SAP_S4HANA/684cffda9cbc4187ad7dad790b03b983/fb3f3ce1a8b14b53a7fb4f847c920afc.html) + +--- + +## 2. Configure Destinations on SAP BTP + +### Create Destination + +1. Open SAP BTP Cockpit +2. Navigate to your subaccount +3. Go to **Connectivity** → **Destinations** +4. Click **New Destination** +5. Configure destination pointing to S/4HANA system + +### Destination URL Requirements + +**Critical**: The URL must contain **only the base URL** of the SAP S/4HANA system. + +| ✅ Correct | ❌ Incorrect | +|-----------|-------------| +| `[https://my-s4hana.company.com`](https://my-s4hana.company.com`) | `[https://my-s4hana.company.com/sap/opu/odata/`](https://my-s4hana.company.com/sap/opu/odata/`) | +| `[https://my-s4hana.s4hana.ondemand.com`](https://my-s4hana.s4hana.ondemand.com`) | `[https://my-s4hana.company.com/api/v1`](https://my-s4hana.company.com/api/v1`) | + +### Subaccount Constraints + +**Important Limitation**: A single subaccount must connect to **one** SAP S/4HANA or SAP S/4HANA Cloud system only. + +- All destinations in a subaccount must reference the **same** S/4HANA system +- You cannot mix destinations to different S/4HANA systems + +### Connecting to a Different System + +If you need to connect to a different S/4HANA system: + +| Option | Action | +|--------|--------| +| Option A | Create a **separate subaccount** for the new system | +| Option B | **Unsubscribe** from ISA and **resubscribe** with new destination | + +--- + +## 3. Set Up Communication With SAP BTP + +Communication uses the Business Event Handling framework with SAP Event Mesh. + +### Create Event Mesh Service Instance + +Ensure the Event Mesh instance exists in the same subaccount as ISA subscription. + +**Topic Rules Configuration**: +```json +{ + "topicRules": { + "publishFilter": [], + "subscribeFilter": ["saas/isa/cons/*"] + } +} +``` + +### Create Event Mesh Service Key + +1. Open Event Mesh service instance +2. Navigate to **Service Keys** +3. Click **Create Service Key** +4. Save credentials for event channel setup + +### Create Event Channel + +#### SAP S/4HANA Cloud + +Use communication scenario SAP_COM_0092 (Enterprise Event Enablement): + +1. Create communication arrangement for SAP_COM_0092 +2. Use Event Mesh service key credentials +3. Set **Topic Space**: `saas/isa/cons` + +#### SAP S/4HANA (On-Premise) + +Follow the on-premise event channel creation procedure using Event Mesh service key. + +### Maintain Outbound Event Topic Bindings + +Bind these topics as **outbound topics**: + +| Topic Pattern | +|---------------| +| `sap/s4/beh/businesssituation/v1/BusinessSituation/*` | +| `sap/s4/beh/businesssituationtype/v1/BusinessSituationType/*` | + +#### SAP S/4HANA Cloud +Use the Maintain Outbound Event Topic Bindings application. + +#### SAP S/4HANA (On-Premise) +Use the on-premise topic binding maintenance procedure. + +--- + +## 4. Onboard S/4HANA System + +### Prerequisites + +- SituationAutomationAdminUser role assigned +- Destination configured and accessible +- Event channel configured with topic bindings + +### Using the Onboard System Application + +**Step 1**: Launch Application +- Access the *Onboard System* application from your BTP subscription + +**Step 2**: Add New System +- Click **Add** to start adding a new system + +**Step 3**: Select Destination +- Choose the destination from the list that points to your S/4HANA system + +**Step 4**: Test Connection +- Click **Check Connection** to verify connectivity +- Ensure the test passes before proceeding + +**Step 5**: Enter System Details +- **Name**: Enter a descriptive system name +- **Description**: Add system description + +**Step 6**: Create System +- Click **Create** to initiate onboarding + +**Step 7**: Monitor Progress +- Watch the progress indicator +- Status transitions: **Pending** → **Successful** or **Failed** + +### Onboarding Status + +| Status | Meaning | +|--------|---------| +| Pending | Onboarding in progress | +| Successful | System onboarded and ready | +| Failed | Onboarding encountered errors | + +### Troubleshooting Failed Onboarding + +If onboarding fails: + +1. **Hover over info icon** to see error details +2. **Fix the issue** based on error message +3. Click **Retry** to attempt onboarding again + +**Common Issues**: +- Destination URL incorrect (not base URL only) +- Event channel not configured +- Topic bindings missing +- Authentication credentials invalid + +**Persistent Failures**: After multiple retry attempts, create an incident under component **CA-SIT-ATM**. + +### Editing Onboarded System + +To modify system details: + +1. Click the **edit icon** next to the onboarded system +2. Update name or description +3. **Note**: Destination must still point to the same system +4. Click **Save** + +--- + +## Verification Checklist + +After onboarding, verify: + +- [ ] APIs exposed in S/4HANA (SAP_COM_0345, SAP_COM_0376) +- [ ] Destination configured with base URL only +- [ ] Event Mesh service instance in same subaccount +- [ ] Event channel created with correct topic space +- [ ] Topic bindings for BusinessSituation and BusinessSituationType +- [ ] System shows "Successful" status in Onboard System app + +--- + +## Event Flow Diagram + +``` +S/4HANA Event Mesh BTP (ISA) + │ │ │ + │ Business Situation Event │ │ + ├──────────────────────────►│ │ + │ │ saas/isa/cons/* │ + │ ├───────────────────────►│ + │ │ │ + │ │ │ Process Situation + │ │ │ Execute Actions + │ │ │ +``` + +--- + +## External Resources + +For a complete list of SAP documentation links and document IDs, see `references/external-links.md`. + +Key resources: +- **Cloud Connector**: [https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf](https://help.sap.com/docs/connectivity/sap-btp-connectivity-cf) +- **Event Mesh**: [https://help.sap.com/docs/SAP_EM](https://help.sap.com/docs/SAP_EM) + +--- + +**Document Version**: 1.0.0 +**Last Updated**: 2025-11-22 diff --git a/references/operations.md b/references/operations.md new file mode 100644 index 0000000..81f4378 --- /dev/null +++ b/references/operations.md @@ -0,0 +1,308 @@ +# Operations Guide - SAP BTP Intelligent Situation Automation + +**Source**: [https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs](https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs) +**Last Verified**: 2025-11-22 + +--- + +## Overview + +This guide covers operational aspects of Intelligent Situation Automation including automatic situation resolution, data export, and audit logging. + +--- + +## Automatic Situation Resolution + +### How It Works + +Situations can be resolved automatically using: +1. **Standard SAP Actions** - Pre-built actions for specific situation templates +2. **Custom Actions** - User-defined actions created in Manage Situation Actions + +### Manage Situation Actions Application + +Use this application to: +- View available standard actions +- Create custom actions +- Configure action parameters +- Test action execution + +--- + +## Standard SAP Actions + +### Supported Situation Templates + +| Situation Template | Template Code | Description | +|-------------------|---------------|-------------| +| Contract is Ready as Source of Supply | PROC_CONTRACTREADYTOUSE_V3 | Procurement contract automation | +| Physical Inventory Monitoring | MAN_PHYSICAL_INVENTORY_MONITOR | Inventory management automation | + +### Required Communication Scenarios + +#### SAP S/4HANA Cloud + +| Situation Template | Required Scenario | Code | +|-------------------|-------------------|------| +| Contract Ready | Purchase Requisition Integration | SAP_COM_0102 | +| Physical Inventory | Physical Inventory Document Integration | SAP_COM_0107 | + +#### SAP S/4HANA (On-Premise) + +| Situation Template | Required API | +|-------------------|--------------| +| Contract Ready | Purchase Requisition Integration API | +| Physical Inventory | Physical Inventory Document Integration API | + +### Configuring Standard Actions + +1. Open **Manage Situation Automation** app +2. Select the situation type +3. Enable automation for the situation +4. Configure the standard action +5. Set conditions (optional) +6. Activate the automation + +--- + +## Custom Actions + +### Creating Custom Actions + +1. Open **Manage Situation Actions** app +2. Click **Create** +3. Define action properties: + - Name and description + - Action type + - Target endpoint + - Parameters +4. Save and activate + +### Action Configuration Options + +| Option | Description | +|--------|-------------| +| Name | Unique action identifier | +| Description | Action purpose and behavior | +| HTTP Method | GET, POST, PUT, DELETE | +| Endpoint URL | Target API endpoint | +| Headers | Custom HTTP headers | +| Parameters | Input parameters from situation data | + +--- + +## Manage Situation Automation Application + +### Purpose + +Configure which situations are automated and how they are resolved. + +### Key Functions + +| Function | Description | +|----------|-------------| +| View Situation Types | See available situation types from S/4HANA | +| Enable Automation | Turn on automation for a situation type | +| Configure Rules | Define conditions for action execution | +| Assign Actions | Link actions to situation types | +| Activate/Deactivate | Control automation status | + +### Creating Automation Rules + +1. Select a situation type +2. Define rule conditions based on situation data +3. Assign action to execute when conditions match +4. Set priority if multiple rules exist +5. Activate the rule + +--- + +## Situation Dashboard + +### Purpose + +Monitor situation status and automation performance. + +### Available Views + +| View | Information | +|------|-------------| +| Overview | Total situations, resolution status | +| By Type | Situations grouped by type | +| By Status | Open, resolved, failed | +| Trends | Historical automation performance | + +--- + +## Analyze Situations Application + +### Purpose + +Deep analysis of individual situations and resolution flows. + +### Resolution Flow + +The Resolution Flow shows the complete processing history: +- When situation was received +- Which rules were evaluated +- What action was applied +- Resolution outcome + +### Status Indicators + +| Status | Meaning | +|--------|---------| +| Resolved | Action successfully executed | +| No Action Applied | Rule conditions not matched | +| No Automation Configuration Found | No automation configured for type | +| Failed | Action execution failed | + +--- + +## Data Export + +### Purpose + +Export all data stored by Intelligent Situation Automation. + +### Export Endpoint + +``` +[https://..intelligent-situation-automation.cloud.sap/exportdata](https://..intelligent-situation-automation.cloud.sap/exportdata) +``` + +### URL Components + +| Component | Description | +|-----------|-------------| +| subdomain | Your BTP subdomain | +| region | BTP region (e.g., eu10) | + +### Example + +``` +[https://mycompany-dev.eu10.intelligent-situation-automation.cloud.sap/exportdata](https://mycompany-dev.eu10.intelligent-situation-automation.cloud.sap/exportdata) +``` + +### Export Content + +The export includes: +- Situation records +- Automation configurations +- Resolution history +- System onboarding data + +--- + +## Audit Logging + +### Audit Log Service + +Intelligent Situation Automation uses the SAP BTP Audit Log service to track changes. + +### Logged Events + +| Event Category | Examples | +|----------------|----------| +| Configuration Changes | Automation rule creation, modification | +| System Management | System onboarding, updates | +| User Actions | Action creation, activation | + +### Viewing Audit Logs + +Access logs through the **Audit Log Viewer** in Cloud Foundry environment: + +1. Navigate to BTP Cockpit +2. Go to your subaccount +3. Open **Audit Log Viewer** service +4. Filter by application or time range +5. Review logged events + +**Reference**: SAP Help documentation for Audit Log Viewer for Cloud Foundry Environment + +--- + +## Delete Data Context Application + +### Purpose + +Manage data retention and cleanup of situation data. + +### Available Functions + +| Function | Description | +|----------|-------------| +| View Data | See stored situation data | +| Delete Specific | Remove individual records | +| Bulk Delete | Remove data by criteria | + +### Data Retention Considerations + +- Review data retention policies before deletion +- Deleted data cannot be recovered +- Audit logs may retain references + +--- + +## Explore Related Situations Application + +### Purpose + +Discover relationships between situations. + +### Relationship Types + +| Relationship | Description | +|--------------|-------------| +| Same Object | Situations for same business object | +| Same Type | Situations of same template | +| Temporal | Situations in same time period | + +### Use Cases + +- Identify patterns across situations +- Find root causes +- Optimize automation rules + +--- + +## Operational Best Practices + +### Monitoring + +- ✅ Regularly review Situation Dashboard +- ✅ Check for failed automations +- ✅ Monitor resolution rates +- ✅ Track automation performance trends + +### Rules Management + +- ✅ Start with simple rules +- ✅ Test rules before production activation +- ✅ Document rule logic +- ✅ Review and optimize regularly + +### Data Management + +- ✅ Export data periodically for backup +- ✅ Implement data retention policies +- ✅ Review audit logs for compliance + +### Troubleshooting + +- ✅ Use Analyze Situations for detailed investigation +- ✅ Check Resolution Flow for specific situations +- ✅ Verify rule conditions match actual data + +--- + +## External Links + +- **Audit Log Viewer**: [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/) +- **Data Protection**: [https://help.sap.com/docs/btp/sap-business-technology-platform/data-protection-and-privacy](https://help.sap.com/docs/btp/sap-business-technology-platform/data-protection-and-privacy) +- **Business Rules**: [https://help.sap.com/docs/business-rules](https://help.sap.com/docs/business-rules) + +--- + +**Document Version**: 1.0.0 +**Last Updated**: 2025-11-22 diff --git a/references/security-roles.md b/references/security-roles.md new file mode 100644 index 0000000..7f1d9d8 --- /dev/null +++ b/references/security-roles.md @@ -0,0 +1,279 @@ +# Security and Roles Guide - SAP BTP Intelligent Situation Automation + +**Source**: [https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs](https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs) +**Last Verified**: 2025-11-22 + +--- + +## Overview + +Intelligent Situation Automation uses role-based access control through SAP BTP role templates and role collections. Users must be assigned appropriate role collections to access application features. + +--- + +## Role Templates + +Intelligent Situation Automation provides two role templates: + +| Role Template | Purpose | Attributes | +|---------------|---------|------------| +| SituationAutomationKeyUser | Key user for daily operations | None | +| SituationAutomationAdminUser | Admin user for system management | None | + +**Note**: Since these templates have no attributes, corresponding roles are created automatically. Templates with attributes require manual role creation with specified attribute values. + +--- + +## SituationAutomationKeyUser + +### Purpose +Key user access for managing situation automation on a daily basis. + +### Access Level +Full application access including all operational tiles. + +### Available Tiles + +| Tile | Function | +|------|----------| +| **Manage Situation Actions** | Create and manage custom actions | +| **Manage Situation Automation** | Configure automation rules and conditions | +| **Situation Dashboard** | View situation overview and status | +| **Analyze Situations** | Analyze resolution flows and outcomes | +| **Delete Data Context** | Manage data retention and cleanup | +| **Explore Related Situations** | View relationships between situations | + +### Typical Users +- Business process owners +- Operations managers +- Situation analysts +- Automation administrators + +--- + +## SituationAutomationAdminUser + +### Purpose +Admin access for system onboarding and technical configuration. + +### Access Level +Limited to system onboarding tasks only. + +### Available Functions + +| Function | Description | +|----------|-------------| +| Onboard System | Add and configure S/4HANA systems | +| Edit System | Modify onboarded system details | +| Retry Onboarding | Retry failed onboarding attempts | + +### Typical Users +- System administrators +- Technical architects +- Initial setup personnel + +--- + +## RuleRepositorySuperUser + +### Purpose +Business rules management for authoring automation rules. + +### Origin +This role comes from SAP Business Rules service, not Intelligent Situation Automation. + +### Requirement +Key users who need to author rules must have both: +- SituationAutomationKeyUser +- RuleRepositorySuperUser + +--- + +## Role Collections + +### What Are Role Collections? + +Role collections bundle one or more roles from one or more applications. They provide a convenient way to assign multiple permissions at once. + +### Creating Role Collections + +1. Navigate to SAP BTP Cockpit +2. Go to your subaccount +3. Navigate to **Security** → **Role Collections** +4. Click **Create** +5. Enter name and description +6. Add roles from role templates + +### Recommended Role Collections + +| Role Collection Name | Included Roles | Target Users | +|---------------------|----------------|--------------| +| ISA Key Users* | SituationAutomationKeyUser, RuleRepositorySuperUser | Business users | +| ISA Administrators* | SituationAutomationAdminUser | Technical admins | + +*Example names; customize based on your organization's naming conventions. + +**Reference**: See [Building Roles and Role Collections for Applications](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/eaa6a26291914b348e875a00b6beb729.html) + +--- + +## Assigning Role Collections to Users + +### Prerequisites + +Users must exist in one of: +- SAP ID service +- Identity Authentication service (IAS) +- Another configured identity provider (IdP) + +### Assignment Methods + +| Identity Provider | Assignment Method | +|-------------------|-------------------| +| SAP ID service | Individual user assignment only | +| Identity Authentication | Individual users OR user groups | +| Other IdP | Individual users OR user groups | + +### Individual User Assignment + +1. Navigate to SAP BTP Cockpit +2. Go to your subaccount +3. Navigate to **Security** → **Users** +4. Select the user +5. Click **Assign Role Collection** +6. Select appropriate role collection +7. Confirm assignment + +### User Group Assignment (IAS/Custom IdP) + +1. Navigate to SAP BTP Cockpit +2. Go to your subaccount +3. Navigate to **Security** → **Role Collections** +4. Select the role collection +5. Go to **User Groups** tab +6. Add user group from IdP +7. All users in group receive the role collection + +--- + +## Required Role Collections by User Type + +### For Key Users (Daily Operations) + +| Role Collection | Required | +|-----------------|----------| +| SituationAutomationKeyUser | Yes | +| RuleRepositorySuperUser | Yes (for rule authoring) | + +### For Admin Users (Setup Only) + +| Role Collection | Required | +|-----------------|----------| +| SituationAutomationAdminUser | Yes | + +--- + +## Trust and Federation + +### Identity Provider Configuration + +For detailed guidance on configuring trust with identity providers, see SAP BTP documentation for Trust and Federation with Identity Providers. + +### Common Configurations + +| Configuration | Use Case | +|---------------|----------| +| SAP ID service | Default BTP identity provider | +| SAP Cloud Identity Services | Enterprise SSO integration | +| Corporate IdP (SAML/OIDC) | Integration with existing IdP | + +--- + +## Authorization Flow + +``` +User Login + │ + ▼ +Identity Provider + │ + ▼ +BTP Authentication + │ + ▼ +Role Collection Check + │ + ├─── SituationAutomationKeyUser ───► Access operational tiles + │ + └─── SituationAutomationAdminUser ──► Access onboarding only +``` + +--- + +## Best Practices + +### Role Assignment + +- ✅ Create dedicated role collections for your organization +- ✅ Use descriptive names for role collections +- ✅ Document which users/groups have which roles +- ✅ Assign minimum necessary roles (least privilege) +- ✅ Use group-based assignment when possible (with IAS) + +### Security + +- ✅ Review role assignments regularly +- ✅ Remove roles when users change responsibilities +- ✅ Separate admin and key user roles +- ✅ Track changes via audit logs + +### Common Mistakes + +- ❌ Assigning SituationAutomationAdminUser to all users +- ❌ Forgetting RuleRepositorySuperUser for rule authors +- ❌ Not removing roles when users leave +- ❌ Over-permissioning for convenience + +--- + +## Troubleshooting Access Issues + +### "Server Error" on Application Access + +**Symptom**: Error message when accessing Manage Situation Automation app + +**Cause**: User not assigned required role collection + +**Solution**: Assign SituationAutomationKeyUser role collection to the user + +### Cannot Access Onboard System + +**Symptom**: Onboard System app not visible or accessible + +**Cause**: Missing admin role + +**Solution**: Assign SituationAutomationAdminUser role collection + +### Cannot Create/Edit Rules + +**Symptom**: Rule authoring functions unavailable + +**Cause**: Missing rule repository role + +**Solution**: Assign RuleRepositorySuperUser role collection in addition to SituationAutomationKeyUser + +--- + +## External Links + +For a comprehensive list of SAP documentation links with document IDs, see `references/external-links.md`. + +Key resources for role and security management: +- **Building Roles and Role Collections**: [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/eaa6a26291914b348e875a00b6beb729.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/eaa6a26291914b348e875a00b6beb729.html) +- **Trust Configuration**: [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/cb1bc8f1bd5c482e891063960d7acd78.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/cb1bc8f1bd5c482e891063960d7acd78.html) +- **Authorization Management**: [https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/6373bb7a96114d619bfdfdc6f505d1b9.html](https://help.sap.com/viewer/65de2977205c403bbc107264b8eccf4b/Cloud/en-US/6373bb7a96114d619bfdfdc6f505d1b9.html) + +--- + +**Document Version**: 1.0.0 +**Last Updated**: 2025-11-22 diff --git a/references/setup-guide.md b/references/setup-guide.md new file mode 100644 index 0000000..75da1f5 --- /dev/null +++ b/references/setup-guide.md @@ -0,0 +1,217 @@ +# Setup Guide - SAP BTP Intelligent Situation Automation + +**Source**: [https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs](https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs) +**Last Verified**: 2025-11-22 + +--- + +## Technical Prerequisites + +### Supported SAP Systems + +| System | Minimum Version | Notes | +|--------|-----------------|-------| +| SAP S/4HANA Cloud | Current | Full cloud-native support | +| SAP S/4HANA | 2021 FPS0 | On-premise, requires Cloud Connector | + +### Administrator Requirements + +You must have administrator role assignments for: +- SAP BTP global account +- SAP BTP subaccount (for subscription) +- SAP S/4HANA system (for API configuration) + +--- + +## Additional Services + +### Event Mesh Requirement + +**Critical**: You must enable Event Mesh for your SAP BTP subaccount before subscribing to Intelligent Situation Automation. + +Event Mesh enables: +- Real-time event communication between S/4HANA and BTP +- Business situation event publishing +- Situation type synchronization + +**Documentation**: [https://help.sap.com/docs/SAP_EM](https://help.sap.com/docs/SAP_EM) + +### Event Mesh Service Instance + +Create the Event Mesh instance in the **same subaccount** where you subscribe to Intelligent Situation Automation. + +--- + +## Network Requirements + +### Region Selection + +| Setting | Value | Notes | +|---------|-------|-------| +| **Region** | Europe (Frankfurt) | Required for ISA | +| **Technical ID** | cf-eu10 | Use this in configurations | +| **Provider** | AWS | Amazon Web Services | +| **Environment** | Cloud Foundry | BTP CF environment | + +**Documentation**: See SAP Help for available regions and hosts. + +### Internet Connectivity + +Ensure network access to: +- SAP BTP Cloud Foundry endpoints +- SAP Event Mesh endpoints +- Your S/4HANA system (via Cloud Connector for on-premise) + +--- + +## Browser Support + +Intelligent Situation Automation supports the standard browsers supported by SAP BTP. + +**Reference**: [Feature Scope Description for SAP BTP, Cloud Foundry, ABAP, and Kyma Environments (PDF)](https://help.sap.com/http.svc/rc/5e8107bf49684962b897217040398007/Cloud/en-US/SAP_Cloud_Platform_FSD.pdf) + +Consult the FSD document for specific browser versions and settings. + +--- + +## Subscription Process + +### Prerequisites Checklist + +Before subscribing, ensure: +- [ ] Global account configured +- [ ] Administrator role assigned for global account +- [ ] Subaccount created in cf-eu10 region +- [ ] Event Mesh enabled in subaccount + +### Step 1: Create Subaccount + +Create a new subaccount with these settings: + +| Setting | Value | +|---------|-------| +| Region | Europe (Frankfurt) | +| Technical ID | cf-eu10 | +| Environment | Cloud Foundry | + +### Step 2: Configure Entitlements + +1. Navigate to your global account in BTP Cockpit +2. Go to **Entitlements** → **Subaccount Assignments** +3. Select your subaccount +4. Add entitlement for **Intelligent Situation Automation** +5. Select the **standard** plan + +### Step 3: Subscribe to Service + +1. Navigate to your subaccount +2. Go to **Services** → **Service Marketplace** +3. Find **Intelligent Situation Automation** +4. Click **Create** +5. Select **standard** plan +6. Complete the subscription + +### Subscription Plans + +| Plan | Purpose | +|------|---------| +| standard | Production use with full features | + +--- + +## Event Mesh Configuration + +### Create Service Instance + +1. Navigate to your subaccount +2. Go to **Services** → **Instances and Subscriptions** +3. Click **Create** +4. Select **Event Mesh** +5. Configure topic rules: + +```json +{ + "topicRules": { + "publishFilter": [], + "subscribeFilter": ["saas/isa/cons/*"] + } +} +``` + +### Create Service Key + +After creating the service instance: + +1. Open the Event Mesh service instance +2. Go to **Service Keys** +3. Click **Create Service Key** +4. Save the credentials for S/4HANA configuration + +The service key credentials are needed to: +- Create the event channel in S/4HANA +- Configure SAP_COM_0092 communication scenario + +--- + +## Post-Subscription Steps + +After successful subscription: + +1. **Assign Roles**: Grant SituationAutomationAdminUser to administrators +2. **Configure Destinations**: Create destination to your S/4HANA system +3. **Expose APIs**: Configure communication arrangements in S/4HANA +4. **Set Up Event Communication**: Create event channel and topic bindings +5. **Onboard System**: Use Onboard System app to complete setup + +See `references/onboarding.md` for detailed onboarding steps. + +--- + +## Verification Checklist + +After setup, verify: + +- [ ] Subscription status shows "Subscribed" +- [ ] Event Mesh instance created in same subaccount +- [ ] Event Mesh service key generated +- [ ] Subaccount region is cf-eu10 +- [ ] Administrator roles assigned + +--- + +## Troubleshooting Setup Issues + +### Subscription Fails + +**Possible Causes**: +- Missing entitlements +- Wrong region selected +- Quota exceeded + +**Resolution**: +1. Verify entitlements are assigned to subaccount +2. Ensure subaccount is in cf-eu10 region +3. Check quota limits + +### Event Mesh Instance Creation Fails + +**Possible Causes**: +- Event Mesh not entitled +- Topic rules syntax error + +**Resolution**: +1. Add Event Mesh entitlement +2. Verify JSON syntax in topic rules + +--- + +## External Links + +- **SAP BTP Documentation**: [https://help.sap.com/docs/BTP](https://help.sap.com/docs/BTP) +- **Event Mesh Documentation**: [https://help.sap.com/docs/SAP_EM](https://help.sap.com/docs/SAP_EM) +- **Subscription Guide**: [https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/7a3e39622be14413b2a4df7c02ca1170.html](https://help.sap.com/docs/BTP/65de2977205c403bbc107264b8eccf4b/7a3e39622be14413b2a4df7c02ca1170.html) + +--- + +**Document Version**: 1.0.0 +**Last Updated**: 2025-11-22 diff --git a/references/troubleshooting.md b/references/troubleshooting.md new file mode 100644 index 0000000..ccfeb6c --- /dev/null +++ b/references/troubleshooting.md @@ -0,0 +1,325 @@ +# Troubleshooting Guide - SAP BTP Intelligent Situation Automation + +**Source**: [https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs](https://github.com/SAP-docs/sap-btp-intelligent-situation-automation/tree/main/docs) +**Last Verified**: 2025-11-22 + +--- + +## Overview + +This guide covers common errors, their causes, and solutions for Intelligent Situation Automation. For issues not covered here, create an incident with SAP Support. + +--- + +## Support Component + +**Component**: CA-SIT-ATM + +Use this component when: +- Creating support incidents +- Escalating unresolved issues +- Reporting bugs or defects + +--- + +## Known Errors and Solutions + +### Error 1: Server Error on Application Access + +**Symptom**: +``` +"A server error has occurred. Please try again later" +``` + +This error appears when accessing the Manage Situation Automation app after onboarding. + +**Root Cause**: User lacks required authorization. + +**Solution**: +1. Navigate to SAP BTP Cockpit +2. Go to **Security** → **Users** +3. Select the affected user +4. Assign the required role collection: + - **SituationAutomationKeyUser** for key users + - **SituationAutomationAdminUser** for administrators +5. User should log out and log in again +6. Retry accessing the application + +**Reference**: See `references/security-roles.md` for role assignment details. + +--- + +### Error 2: No Action Applied + +**Symptom**: +Resolution Flow in Analyze Situations app shows "No Action Applied" + +**Location**: Analyze Situations app → Select situation → Resolution Flow + +**Root Cause**: Rule conditions do not match the actual situation data. + +**Investigation Steps**: +1. Open **Analyze Situations** app +2. Find the affected situation +3. Review the **Resolution Flow** +4. Check which rules were evaluated +5. Compare rule conditions with actual situation data + +**Solution**: +1. Open **Manage Situation Automation** app +2. Find the automation rule for this situation type +3. Review and revise the rule conditions +4. Update conditions to match expected data patterns +5. **Deactivate** the rule +6. **Reactivate** the rule +7. Trigger automation again with current data + +**Important Note**: After revising a rule, previously processed situations with "No Action Applied" status will remain in manual processing queue. Only new situations will be evaluated against the updated rule. + +--- + +### Error 3: No Automation Configuration Found + +**Symptom**: +Resolution Flow shows "No Automation Configuration Found" + +**Location**: Analyze Situations app → Select situation → Resolution Flow + +**Root Cause**: No automation configuration exists in SAP BTP for the triggered situation type. + +**Investigation Steps**: +1. Open **Manage Situation Automation** app +2. Check if the situation type appears in the list +3. Verify if automation is configured and activated + +**Solution**: +1. Open **Manage Situation Automation** app +2. Find the situation type (or add if missing) +3. Configure automation: + - Enable automation for the type + - Create rules with conditions + - Assign actions to execute +4. Activate the automation configuration +5. New situations of this type will now be automated + +--- + +## Onboarding Issues + +### Connection Test Fails + +**Symptom**: "Check Connection" fails in Onboard System app + +**Possible Causes**: +| Cause | Check | +|-------|-------| +| Destination URL incorrect | Verify base URL only (no paths) | +| Authentication failure | Check credentials in destination | +| Network connectivity | Verify Cloud Connector (on-premise) | +| APIs not exposed | Confirm SAP_COM_0345/0376 configured | + +**Solutions**: +1. Review destination configuration in BTP Cockpit +2. Ensure URL contains only base URL +3. Verify authentication credentials +4. For on-premise: Check Cloud Connector status +5. Verify communication arrangements in S/4HANA + +### Onboarding Status: Failed + +**Symptom**: Onboarding status shows "Failed" after creation + +**Diagnosis**: +1. Hover over the **info icon** next to the failed system +2. Read the error details displayed + +**Common Causes and Solutions**: + +| Error Detail | Solution | +|--------------|----------| +| Destination not found | Create/correct destination in BTP Cockpit | +| Connection refused | Check network/Cloud Connector | +| Authentication failed | Update credentials in destination | +| API not available | Expose APIs in S/4HANA | + +**Retry Process**: +1. Fix the identified issue +2. Click **Retry** on the failed system +3. Monitor for success + +**Persistent Failures**: After multiple retry attempts, create incident with component **CA-SIT-ATM**. + +--- + +## Event Mesh Issues + +### Events Not Received + +**Symptom**: Situations not appearing in ISA despite being created in S/4HANA + +**Check List**: +| Check | Action | +|-------|--------| +| Event Mesh instance | Verify instance in same subaccount | +| Event channel | Confirm channel created in S/4HANA | +| Topic bindings | Verify BusinessSituation topics bound | +| Topic rules | Check subscribeFilter includes `saas/isa/cons/*` | + +### Topic Binding Errors + +**Symptom**: Error when binding topics in S/4HANA + +**Solution**: +1. Verify Event Mesh service key is valid +2. Confirm topic space is `saas/isa/cons` +3. Check correct topic patterns: + - `sap/s4/beh/businesssituation/v1/BusinessSituation/*` + - `sap/s4/beh/businesssituationtype/v1/BusinessSituationType/*` + +--- + +## Role and Access Issues + +### Missing Tiles/Apps + +**Symptom**: Some tiles not visible in launchpad + +**Cause**: Missing role collection assignment + +**Solution**: Assign appropriate role collection: +| Missing Access | Required Role | +|----------------|---------------| +| Operational tiles | SituationAutomationKeyUser | +| Onboard System | SituationAutomationAdminUser | +| Rule authoring | RuleRepositorySuperUser | + +### Cannot Edit Rules + +**Symptom**: Rule editing functions disabled + +**Cause**: Missing RuleRepositorySuperUser role + +**Solution**: Add RuleRepositorySuperUser role collection to user + +--- + +## Automation Execution Issues + +### Action Execution Failed + +**Symptom**: Resolution Flow shows failed action + +**Investigation**: +1. Open Analyze Situations app +2. Review Resolution Flow details +3. Check error message from action + +**Common Causes**: +| Cause | Solution | +|-------|----------| +| Target endpoint unreachable | Verify destination and connectivity | +| Authentication failed | Check credentials in action configuration | +| Invalid parameters | Review action parameter mapping | +| Timeout | Increase timeout or optimize action | + +### Wrong Action Executed + +**Symptom**: Different action executed than expected + +**Investigation**: +1. Review all rules for the situation type +2. Check rule priorities +3. Verify condition logic + +**Solution**: +1. Adjust rule conditions for specificity +2. Update rule priorities +3. Test with sample situation + +--- + +## Diagnostic Tools + +### Analyze Situations App + +Use for detailed situation analysis: +- Resolution Flow visualization +- Rule evaluation history +- Action execution details + +### Audit Log Viewer + +Use for tracking changes: +- Configuration modifications +- System onboarding events +- User actions + +### Situation Dashboard + +Use for monitoring: +- Overall automation status +- Resolution rates +- Trend analysis + +--- + +## Troubleshooting Checklist + +### Before Contacting Support + +- [ ] Verified user has required role collections +- [ ] Checked Resolution Flow in Analyze Situations +- [ ] Reviewed destination configuration +- [ ] Confirmed Event Mesh connectivity +- [ ] Checked audit logs for errors +- [ ] Attempted retry/reconfiguration +- [ ] Documented steps to reproduce + +### Information to Include in Incident + +1. **Error message** (exact text) +2. **Application** where error occurred +3. **User** experiencing the issue +4. **Timestamp** of occurrence +5. **Steps to reproduce** +6. **Screenshots** if applicable +7. **Subaccount ID** and region +8. **S/4HANA system** details + +--- + +## FAQ + +### Q: How long before situations appear after onboarding? + +**A**: Situations should appear within minutes after successful onboarding and proper event channel configuration. If not: +1. Verify Event Mesh configuration +2. Check topic bindings +3. Create a test situation in S/4HANA to verify flow + +### Q: Can I connect multiple S/4HANA systems to one subaccount? + +**A**: No. Each subaccount can connect to only one S/4HANA system. Use separate subaccounts for different systems. + +### Q: How do I change the connected S/4HANA system? + +**A**: Either: +1. Create a new subaccount for the new system, or +2. Unsubscribe from ISA and resubscribe with new destination + +### Q: Why are old situations not processed by new rules? + +**A**: Rules only apply to new situations. Situations processed before rule changes retain their original status. + +--- + +## External Links + +- **SAP for Me**: [https://me.sap.com/](https://me.sap.com/) (incident creation) +- **SAP Community**: [https://community.sap.com/](https://community.sap.com/) +- **SAP Help**: [https://help.sap.com/docs/intelligent-situation-automation](https://help.sap.com/docs/intelligent-situation-automation) + +--- + +**Document Version**: 1.0.0 +**Last Updated**: 2025-11-22