The Cartridge Path Editor turns a colon-separated XML value into an ordered list. Add linked cartridges, enter a cartridge name, remove entries, and drag them into the order you need. The top entry loads first.
Open the editor
Open the local XML file
Open a site's site.xml containing <custom-cartridges>, or a preferences.xml containing <preference preference-id="CustomCartridges"> for the Business Manager path.
Use the cartridge path CodeLens
Above the XML element, select Edit [site ID] Cartridge Path ([count]) or Edit BM Cartridge Path ([count]). The editor opens for that specific value, with its source file shown below the title.
Change the order and save the XML
Drag entries in In cartridge path to change priority. Choose Open XML to review the updated value and save the document with VS Code. The editor shows Unsaved while that document has pending changes, then Saved after it is saved.
For example, a local site export might contain:
<custom-cartridges>app_demo_custom:app_storefront_base</custom-cartridges>Moving app_demo_custom below app_storefront_base changes the value to app_storefront_base:app_demo_custom. Review the order before applying it to a sandbox because it changes which implementation takes priority.
Add, find, and remove entries
| Control | Result |
|---|---|
| Filter cartridges in path | Find entries by name or location without changing the path. |
| Filter linked cartridges | Find linked cartridges that are available to add. |
| Add a linked cartridge | Use its add button to append it, or drag it to a specific position. |
| Add All | Append every linked cartridge not already in the path. |
| Add cartridge by name… | Add one name at the top, including a cartridge that is not linked locally. |
| Remove an entry | Remove that path entry from the XML. Its cartridge files remain in the project. |
| Open XML | Review or edit the source document. Source changes also refresh the list. |
Enter one cartridge name at a time. Names cannot contain spaces, :, <, >, or &. Adding an existing name focuses its current entry instead of inserting another copy.
Local XML and the active site
The editor updates the open XML document. It does not change the cartridge path in Business Manager or deploy cartridge files. Apply the saved XML to the target instance through your normal site import process when ready.
When the active B2C Site Scope comes from this local site.xml, saving a changed cartridge path refreshes that scope's code-assistance context. A scope selected from the remote instance uses the remote path, so editing a local export does not change that selection's source.
Troubleshooting
- The CodeLens is missing: check that the local file is named
site.xmlorpreferences.xml, contains the matching element, and VS Code CodeLens is enabled. This feature requires active Intellij SFCC access, including trial access. - A cartridge is marked “Not linked to this project”: its name is in the XML, but the extension has no linked local cartridge with that name. Link the local cartridge if you need its source for navigation.
- The path changed or was removed: close the panel and reopen it from the current XML CodeLens so it targets the correct element.
- Sandbox behavior is unchanged: saving the local XML updates your project. Review whether the path was applied to the intended site on the instance and whether its cartridges were deployed.
