Getting Started

Connections

Create, organize, activate, import, and export SFCC sandbox connections

A connection describes one SFCC instance target. It combines a hostname, code version, account reference, optional API client references, certificate settings, site scope, and cartridge information. Only one connection should be active for a workspace at a time.

Before You Add A Connection

Make sure the Credentials page already contains the account and API clients you plan to use. Connections reference credentials by username or client ID; they should not duplicate secrets.

VS Code Connections

In VS Code, connection records are stored in extension workspace state. The extension restores connections on startup, rebinds each connection to the current credentials, and persists active connection, groups, code version, certificates, site scope, and cartridge data.

The export format is intellij-sfcc-connections. It contains connection metadata plus account username and API client ID references. It does not copy account passwords or client secrets.

JetBrains Connections

In JetBrains IDEs, ConnectionsStorage persists connection data in the project-level IntellijSFCCConnectionSettings state. CSService keeps the active connection, groups, code versions, and source-scanned state synchronized with the B2C Explorer and toolbar actions.

### Open B2C Explorer Open the B2C Explorer tool window from the right tool-window stripe.
### Add or edit a connection Use the explorer toolbar or context menu to create a connection or group.
### Refresh code versions Refresh code versions after changing credentials, hostname, or access keys.

Switching Connections

Use the Explorer panel context menu, active connection status-bar item, command palette, or Focus Active Connection command. Activating a connection clears the previous active flag and refreshes dependent views.

Use the main toolbar Select Connection action or the B2C Explorer connection context menu. The active connection is then used by upload, debug, code version, site scope, and remote explorer actions.

What Connections Control

FieldImpact
HostnameRemote WebDAV, Business Manager, OCAPI, SCAPI, logs, and debugger target.
AccountBusiness Manager/WebDAV identity used by upload, download, logs, and debugger operations.
API clientsOCAPI/SCAPI-backed operations, code version actions, and API panels.
Code versionUpload target and selected active code version for the sandbox.
CertificatesOptional client certificate settings for secured instances.
Site scopeStorefront route, site, cartridge, and debugger context.
CartridgesLocal-to-remote cartridge path mapping and override resolution.

Common Checks

  • If an upload goes to the wrong instance, confirm the active connection and selected code version.
  • If route or hook lookup looks stale, refresh cartridges and verify the active site scope.
  • If API actions fail, confirm that the connection references an API client with a stored secret.
  • If a connection import succeeds but credentials are missing, import or link the credentials file first.

On this page