Overview
A System in S4Kit represents an SAP landscape—a collection of related environments (instances) that share the same SAP system configuration.
System Types
S4Kit supports different SAP system types:
| Type | Description |
|---|
| S/4HANA Cloud Public | SAP S/4HANA Cloud, public edition |
| S/4HANA Cloud Private | SAP S/4HANA Cloud, private edition |
| S/4HANA On-Premise | On-premise S/4HANA installation |
| SAP BTP | SAP Business Technology Platform services |
| Other | Other SAP or compatible systems |
Creating a System
Via Dashboard
- Navigate to Systems in the sidebar
- Click Add System
- Fill in the system details:
- Name: A friendly name (e.g., “Production ERP”)
- Alias: A short identifier used in code (e.g., “production”)
- Type: Select the SAP system type
- Description: Optional description
System Fields
| Field | Description | Example |
|---|
| Name | Display name | ”Production S/4HANA” |
| Alias | Code identifier | ”production” |
| Type | SAP system type | ”s4_public” |
| Description | Optional notes | ”Main production ERP” |
How Connection Works
The SDK’s connection parameter uses fixed instance environment values, not custom aliases:
const client = new S4Kit({
apiKey: 'sk_live_...',
connection: 'production' // Fixed environment type
});
Available environments: sandbox, dev, quality, preprod, productionYour API key determines which system’s instance is used. If your key only has access to “ERP Americas”, then connection: 'production' connects to ERP Americas’ production instance.
Managing Systems
Edit System
Update system details from the dashboard:
- Go to Systems
- Click on the system to edit
- Update the fields
- Click Save
Delete System
Deleting a system removes all associated instances, services, and API key access configurations. This action cannot be undone.
- Go to Systems
- Click on the system
- Click Delete System
- Confirm the deletion
Best Practices
Naming Conventions
Use consistent naming that reflects your SAP landscape:
| System Name | Alias | Description |
|---|
| Production S/4HANA | production | Live production system |
| Development S/4HANA | dev | Development environment |
| QA S/4HANA | quality | Quality assurance |
| Sandbox | sandbox | Testing and exploration |
One System Per Landscape
Create one S4Kit system per SAP landscape. For example, if you have:
- A production ERP
- A development ERP
- A separate CRM system
Create three S4Kit systems, each with their own instances.
Multi-Region Setup
For global deployments with regional SAP systems, create separate S4Kit systems for each region. Use different API keys to control access:
| System Name | Region | API Key Scope |
|---|
| ERP Americas | US | sk_live_us_... |
| ERP EMEA | EU | sk_live_eu_... |
| ERP APAC | Singapore | sk_live_apac_... |
connection: 'production' with the US key connects to ERP Americas’ production.
System Configuration
After creating a system, you’ll need to:
- Add Instances: Configure the environment endpoints
- Bind Services: Select which OData services to expose
- Configure Authentication: Set up SAP credentials
