Go back to the main page

SAP Management Cockpit

Complete Technical Documentation
Overview

The SAP Management Cockpit is a centralized web dashboard that provides a single-pane-of-glass view of the entire SAP landscape managed by the Fivetran SAP Specialist Team. It serves as the top-level entry point for all system cockpits, monitoring, and operational links.

Key Features

  • Live reachability checks for all 6 servers
  • Direct links to individual system cockpits
  • GCP infrastructure details per server
  • Quick access to SAP and Fivetran tools
  • Color-coded status indicators (green/red/gray)

Technical Stack

TypeStatic HTML + JavaScript
Serversapidesecc8 (port 443)
Path/usr/sap/sap_skills/docs/
ThemeTeal (#0d7377)
GitHubfivetran/SAPManagementCockpit
Reachability API

The cockpit performs automatic health checks on page load for all 6 servers. Each server card displays a color-coded status indicator.

API Endpoint

MethodGET
URL/sap_skills/api/reachability?system={system}
AuthNone required
Response{ "reachable": true|false }

System Identifiers

System ParameterServer CheckedStatus Element ID
s4hanasapidess4reach-s4hana
ecc8sapidesecc8reach-ecc8
sq1sap-sql-idesreach-sq1
saproutersaprouterreach-saprouter
hvrhubsaphvrhubreach-hvrhub
sshtunnelts-sap-hana-s4-ssh-tunnelreach-sshtunnel

Status Indicators

ColorMeaningHex
GrayInitial state (checking...)#ccc
GreenServer reachable#27ae60
RedServer unreachable or check failed#e74c3c
Implementation: The checkReachability(system, elementId) JavaScript function is called 6 times on DOMContentLoaded, one for each server. The server-side handler in gcs_explorer_server.py performs the actual connectivity check.
Individual Cockpit Pages

Each server has its own dedicated cockpit page with server details, start/stop controls, backup management, disk space monitoring, and more.

PageFileFeatures
S/4HANA 2023 SAP_S4HANA_2023.html SAP + HANA start/stop, BACKINT backup, disk space, status, Web IDE link
S/4HANA User Guide SAP_S4HANA_2023_Guide.html Step-by-step guide for using the S/4HANA cockpit
ECC6 EHP8 SAP_ECC6_EHP8.html Oracle DB status, SAP start/stop, BR*Tools backup, SBP patching
ECC6 SQ1 SAP_ECC6_SQ1.html SQL Server SAP instance, start/stop, disk space
SAPRouter SAP_SAPRouter.html SAPRouter service management, route table, connection testing
HVR Hub SAP_HVRHub.html HVR service status, location management, replication channels
SSH Tunnel SAP_SSHTunnel.html SSH key management, tunnel status, Fivetran connector access
GitHub Repository
Repositoryfivetran/SAPManagementCockpit
Local Directory~/SAP_Skills/docs/ (Management Cockpit files are part of the portal)
Production Path/usr/sap/sap_skills/docs/SAP_Management_Cockpit.html

Files

FilePurpose
SAP_Management_Cockpit.htmlMain cockpit dashboard page
SAP_Management_Cockpit_Documentation.htmlThis documentation page
SAP_S4HANA_2023.htmlS/4HANA system cockpit
SAP_S4HANA_2023_Guide.htmlS/4HANA cockpit user guide
SAP_ECC6_EHP8.htmlECC Oracle cockpit
SAP_ECC6_SQ1.htmlECC SQL Server cockpit
SAP_SAPRouter.htmlSAPRouter cockpit
SAP_HVRHub.htmlHVR Hub cockpit
SAP_SSHTunnel.htmlSSH Tunnel cockpit
Deployment

Deploy Cockpit Pages

All cockpit pages are static HTML served from disk. No server restart needed after updates.

scp ~/SAP_Skills/docs/SAP_Management_Cockpit.html root@sapidesecc8:/usr/sap/sap_skills/docs/
scp ~/SAP_Skills/docs/SAP_Management_Cockpit_Documentation.html root@sapidesecc8:/usr/sap/sap_skills/docs/

Adding a New Server

To add a new server to the Management Cockpit:

  1. Create a new cockpit page (e.g. SAP_NewServer.html) in ~/SAP_Skills/docs/
  2. Add a server card in SAP_Management_Cockpit.html inside the .status-grid div
  3. Add a reachability check identifier in gcs_explorer_server.py
  4. Add checkReachability('newserver', 'reach-newserver') in the DOMContentLoaded handler
  5. Deploy both the cockpit page and the new server page to sapidesecc8

Reachability API Implementation

The reachability check is handled server-side in gcs_explorer_server.py on sapidesecc8. The handler receives the system query parameter and performs a network connectivity check (typically SSH or ping) to the corresponding server.

Important: After modifying gcs_explorer_server.py, you must restart the service: systemctl restart gcs-explorer
Monitoring Agent

Email Notifications

The Management Cockpit includes a Monitoring Agent section for managing email distribution lists and sending test emails. All servers relay email via smtp2go using the fivetran-internal-sales.com verified domain.

PropertyValue
SMTP Providersmtp2go (mail.smtp2go.com:2525)
Portal Fromsap-skills@fivetran-internal-sales.com
Verified Domainfivetran-internal-sales.com
Vault Keysmtp2go

Distribution Lists

List NameRecipientsUsage
SAPSpecialistsantonio.carbone@fivetran.com, richard.brouwer@fivetran.comAlerts, notifications, reports

Distribution lists can be edited directly from the Management Cockpit or the Server Documentation page. Changes are persisted to the HTML files on disk.

APIs

EndpointMethodDescription
/sap_skills/api/get_mailing_listPOSTRead a distribution list by name
/sap_skills/api/update_mailing_listPOSTUpdate a distribution list (rewrites HTML)
/sap_skills/api/send_test_emailPOSTSend a test email to a distribution list
Service Monitor

How the Service Monitor Works

The Service Monitor is a real-time health dashboard embedded in the Monitoring page. It checks all 6 servers and their critical services every 5 minutes.

ComponentLocationPurpose
Health check script/usr/local/bin/sap_health_check.sh on sapidesecc8Runs every 5 min via cron, checks all servers and services
JSON status file/usr/sap/sap_skills/health_status.jsonWritten by the script, read by the web UI
History log/var/log/sap_health_check.logAppend-only log of all checks (last 2000 lines)
Health log APIPOST /sap_skills/api/admin/health_logReturns last 50 log entries
Web UISAP_Monitoring.htmlAuto-refreshing dashboard with status cards

Services Monitored per Server

ServerServicesCheck Method
sapidess4SAP Dispatcher, Gateway, ICM, IGS; HANA FIV; HANA PITsapcontrol via SSH (nr 03, 00, 96)
sapidesecc8SAP Dispatcher, Gateway, ICM; Oracle DB; Web Serversapcontrol local; ora_pmon process; HTTPS curl
saprouterServer reachability; SAPRouter serviceSSH; systemctl is-active saprouter
sap-sql-idesServer reachability; SAP Instance (SQ1); SQL Server DBPing; SOAP sapcontrol port 50013; WinRM via API
saphvrhubServer reachability; HVR Hub; PostgreSQL 14SSH; systemctl is-active for both
SSH TunnelServer reachabilitySSH to 10.142.0.37

Status Indicators

IndicatorMeaning
Green dotService is running
Red dotService is down or unreachable
Gray dotCheck in progress (initial state)
REACHABLEServer responds to SSH or ping
UNREACHABLEServer did not respond within timeout

Cockpit Links

Each server card has a Cockpit button that opens the individual server management page where you can start/stop services, view disk space, manage backups, and more.

ServerCockpit PageActions Available
sapidess4SAP_S4HANA_2023.htmlStart/stop SAP + HANA, backup, disk space
sapidesecc8SAP_ECC6_EHP8.htmlStart/stop SAP + Oracle, BR*Tools backup
saprouterSAP_SAPRouter.htmlStart/stop SAPRouter, edit route table
sap-sql-idesSAP_ECC6_SQ1.htmlStart/stop SAP, SQL Server backup
saphvrhubSAP_HVRHub.htmlStart/stop HVR + PostgreSQL, manage locations
SSH TunnelSAP_SSHTunnel.htmlManage SSH keys, view sessions

Full Monitoring Guide

For complete documentation on the email relay, SMTP configuration, distribution lists, health check script internals, and service restart procedures, see the Monitoring Agent User Guide.