Cartridge Management

Visual cartridge path management and overlay detection

The cartridge management system gives you full visibility into your SFCC cartridge overlay - see which cartridge provides each file, detect overrides, and manage your cartridge path visually.

Find local cartridges

Open the project root that contains your cartridge sources and let indexing finish. Use the toolbar's Scan for New Cartridges action if you have added or moved cartridge folders. Check the Project view to confirm the source files are included.

The local project contents and the storefront's cartridge path serve different purposes: local sources provide files to edit and upload, while the site cartridge path determines which cartridge supplies a storefront resource.

Confirm the site and cartridge order

Select the intended connection and site scope. Use the site's cartridge configuration in Business Manager to confirm the order expected by your team. A custom cartridge placed before a base cartridge can override matching resources.

For example, app_storefront_custom:app_storefront_base gives the custom cartridge priority over the base cartridge. Include both source trees locally when you need to navigate or compare their implementations.

Work with overrides

Use completion, Go to Declaration, and Search Everywhere to navigate the implementation you need. If a result points to an unexpected cartridge, first check the selected site, cartridge order, and whether all required source folders are included.

See Search and Navigation for navigation workflows.

Upload a change

Follow Deployment to review the target code version and included cartridges before uploading. Use the toolbar's Auto Upload control only when you want editing changes sent to the active sandbox.

Keyboard shortcuts depend on your IDE keymap and custom bindings. Find the action in Settings → Keymap if you want to assign a shortcut.

Common problems

What you seeWhat to check
A new cartridge is not discoveredInclude its source folder in the project and scan for new cartridges.
The storefront uses the base implementationCheck that the custom cartridge is on the selected site's cartridge path in the intended order.
Navigation opens an unexpected implementationConfirm site scope, cartridge order, and the local source roots.
Local edits do not appear remotelyCheck auto-upload state, the deployment result, and the target code version.

On this page