Intellij SFCC adds its controls to the main toolbar, the Tools and Navigate menus, the context menus of the Project view and the editor, eight tool windows and the status bar. Most of them appear once a cartridge is linked, see Projects without SFCC code
At a glance
| To | Use | Read more |
|---|---|---|
| Link the cartridges of a project | Find New Cartridges , Cmd+Option+] | Project view setup |
| Switch the instance | Select Connection on the toolbar | Main toolbar |
| Upload the open file or the selection | Upload ... to ... , Cmd+Shift+I | Context menus |
| Upload every file you save | Auto Upload on the toolbar | Auto Upload |
| Deploy every linked cartridge | Deploy Code , Cmd+Ctrl+Z | Deploy Code |
| Find a route, hook or pipeline | Navigate › B2C Entry Points | Navigate menu |
| Open any plugin tool window | Its button, or More › Tool Windows | Tool windows |
| Work on one site's cartridge path | The B2C Site Scopes widget in the status bar | Pick a site scope |
Shortcuts are for macOS, see Keyboard shortcuts for Windows and Linux
Main toolbar
In the New UI the plugin's buttons sit on the right of the main toolbar. In the classic UI they follow an "SFCC:" label on the main toolbar and the navigation bar
| Button | What it does | Read more |
|---|---|---|
| Open Selected Connection | Opens Business Manager or a storefront of the active connection | Connections |
| Select Connection | Shows the active connection and switches to another one. Reads Add Connection while there is none | Connections |
| Select Code Version | The code version that uploads and deploys go to | Deploy Code |
| Switch to Active Code Version | Asks the instance which code version is active and selects it | Deploy Code |
| Find New Cartridges | Looks for cartridges in the project that aren't linked yet | Cartridges & Modules |
| Deploy Code | Opens the Deploy Code dialog to upload the linked cartridges and modules to one instance or several | Deploy Code |
| Auto Upload | Turns automatic upload of changed files on or off for the active connection | Upload & Auto Upload |
| More | Opens the Intellij SFCC menu, see More menu |
Buttons appear as the project gets ready:
| Project state | Buttons you see |
|---|---|
| No linked cartridge | Find New Cartridges and More, plus Open Selected Connection when a connection is active |
| A linked cartridge, no connection | Select Connection shows Add Connection |
| A linked cartridge and an active connection | All of them |
More menu
More opens a menu titled Intellij SFCC, with every plugin tool window in one list
| Section | Items |
|---|---|
| Instance | Clean active code version, see Clean a code version. Cartridges and Modules…, see Review linked roots. General Project Settings, see Settings |
| Tool Windows | B2C Explorer, B2C Credentials, B2C Sync, B2C ODS, Log Center, B2C OCAPI, B2C Entry Points, B2C Metadata, see Tool windows |
| Plugin | Getting Started opens the setup guide, see Use Getting Started. All Release Notes opens What's new in Intellij SFCC, the release history, see Updates & Notifications. Plugin Documentation opens these docs, Report Bug and Rate the Plugin open in the browser |
| Support | Intellij SFCC Slack opens the community Slack. Email writes to [email protected] |
| Author | Opens the author's profile |
Clean active code version needs a linked cartridge and an active connection, General Project Settings a linked cartridge
Tools menu
Tools › Salesforce B2C Commerce repeats the main actions for keyboard and menu users
| Item | What it does | Read more |
|---|---|---|
| Auto Upload Enabled, Auto Upload Disabled | Names the current state. Click it to turn uploads on save on or off | Auto Upload |
| Deploy Code... | Opens the same dialog as the toolbar button | Deploy Code |
| Deployment Settings... | Full cleanup and the tasks, such as an npm build, that run before each deploy | Deployment Settings |
| Clean active code version | Removes every file from a code version after you confirm the host and version | Clean a code version |
| More Intellij SFCC actions | Opens the More menu | |
| Pipeline Groups… , B2C Entry Points , B2C Metadata | The same entries as the Navigate menu | |
| Log Center | Open Log Center, Open Instance…, Open in Editor Tab, Open in New Window, Stop All Log Tails, Export, Create Report, Create Errors Report File, Manage Stored Logs…, Show Stored Logs Location, Delete Stored Logs…, Copy Agent Fix Workflow and Log Center Settings | Log Center |
Navigate menu
Navigate (Go To in some IDEs) ends with three plugin entries. They need a linked cartridge
| Item | What it does | Read more |
|---|---|---|
| Pipeline Groups… | Opens a popup that searches every pipeline by name, group, start node, route and cartridge | Pipeline Groups |
| B2C Entry Points | Opens the tool window with every pipeline, controller route, hook, step type and custom API | B2C Entry Points |
| B2C Metadata | Opens the tool window with every site archive XML file and focuses its search | B2C Metadata |
None has a shortcut, add one in Settings › Keymap
Context menus
Right-click in the Project view, the editor or an editor tab. The plugin's items sit in one group: after New in the Project view, at the top of the editor menu and after the Close items on a tab. Their labels name what you selected and the active connection, for example Upload Controller to Sandbox 01
| Item | Shown for | Read more |
|---|---|---|
| Upload ... to ... | Files and folders in linked cartridges and modules. The label names the selection and the connection | Upload selected items |
| Compare with B2C Instance | A single file in a linked cartridge or module. Also in the View menu | Compare with the instance |
| Override ... in Another Cartridge | Files in a linked cartridge | Overrides |
| Show Pipeline Source, Show Pipeline Editor | Pipeline XML files | Pipeline Editor |
| Download SOAP Web Service API | .wsdl files | API & Types |
| Download SOAP Web Service API to Folder.. | .wsdl files. Asks for the folder first | API & Types |
| Compare with Default Copy, Compare with Overridden Copy, Compare with Copy in Use | Form XML files with a locale copy or a copy in another cartridge. Also under Compare With | Forms |
In form XML, Copy Path/Reference also offers Copy HTML Name, which copies the dwfrm_ name of the element at the caret, see HTML names
Right-click a folder in the Project view:
| Menu | Items | Read more |
|---|---|---|
| New | Cartridge | Create a cartridge |
| New | ISML File | New templates |
| New | Digital Script File | New script files |
| New | Pipeline , in cartridge folders | Create a pipeline |
| New | Metadata File | Open a metadata file |
| New | Site Archive File , the kind picked from the folder | New site archive files |
| Mark Directory as | Cartridge Root, B2C Module Root, Modules (Global Modules) Root and their unmark items. Remove Cartridge From Ignore List on a cartridge you ignored | Link folders by hand |
In B2C Explorer, connections and remote files have their own menus, see Connection menu and WebDAV Explorer
Project view setup
Uploads, deploys and the B2C views work on the folders you link. Link them once per project, then let the Project view show only them
Link your cartridges
Click Find New Cartridges on the toolbar or press Cmd+Option+]. It finds cartridges, B2C modules and the global modules folder that aren't linked yet, and a dialog lets you link or ignore each one. The same check runs when a project opens, see Find new cartridges
To link one folder, right-click it and open Mark Directory as. The plugin's items come first:
| Item | Shown for |
|---|---|
| Cartridge Root | A cartridge folder |
| B2C Module Root | A folder that isn't a cartridge and isn't inside one |
| Modules (Global Modules) Root | One folder named modules |
| Unmark as ... Root | A folder you linked |
| Remove Cartridge From Ignore List | A cartridge you ignored |
A project links one modules folder, and each cartridge name once, see One cartridge per name
Check the icons
Linked roots change their icon at once, so the Project view shows what the plugin sees
| Icon | Means |
|---|---|
| Linked cartridge | |
| Cartridge that is not linked yet | |
| Ignored cartridge | |
| Linked B2C module | |
| Linked modules folder | |
| Modules folder that is not linked yet |
Controllers, models, forms, templates, pipelines and hooks.json get icons too, see Folder and file icons
Switch to the Salesforce B2C Commerce view
Open the Project tool window with Cmd+1 (Alt+1 on Windows and Linux), click its title, Project, and pick Salesforce B2C Commerce . Show B2C project view on the Getting Started tab does it in one click
The view shows only your linked roots under one node, with totals such as "(14) cartridges 12 | b2c modules 1 | modules 1". META beside it holds the site archive XML by organization and site, see META in the B2C project view. The IDE remembers the view for the project, see Salesforce B2C Commerce project view
Pick a site scope
Click the B2C Site Scopes widget in the status bar and pick a site. The root node takes the site's name, cartridges follow its cartridge path, and navigation and analysis follow that path too. Global scope goes back to every linked cartridge, see Pick a site
Review linked roots
More › Cartridges and Modules… lists every linked cartridge, B2C module and the modules folder, plus the folders you ignored. Add, remove or stop ignoring them in one place, then click Save, see Review linked roots
Tool windows
The plugin has eight tool windows. Open each with its button on a tool window bar, from View › Tool Windows or from More › Tool Windows
| Tool window | Button | Appears | What it's for |
|---|---|---|---|
| B2C Explorer | Right bar, first | With SFCC code | Connections and the instance's WebDAV folders |
| B2C Credentials | Right bar | With SFCC code | Accounts, access keys and API clients |
| B2C Entry Points | Right bar | With a linked cartridge | Pipelines, controller routes, hooks, step types and custom APIs in one searchable tree |
| B2C Metadata | Right bar, after B2C Entry Points | With a linked cartridge | Site archive XML by organization and site |
| B2C Sync | Left bar, bottom | With a linked cartridge | Each deployment by cartridge, every upload, and the console of uploads, deploys and cleanups |
| B2C ODS | Left bar, bottom | With SFCC code | On-demand sandboxes of your realms |
| Log Center | Left bar, bottom, after B2C ODS | With SFCC code | Your instances' logs parsed into issues and events, one tab per instance, with search, anomalies, tails and reports |
| B2C OCAPI | Right bar, bottom | With SFCC code | Jobs over OCAPI |
"With SFCC code" means the project has a cartridge, a dw.json or a connection, even before you link anything, see Projects without SFCC code
Shift+Esc hides the active tool window. Drag a button to move its window to another bar, and Window › Layouts › Default puts every button back
B2C Explorer
B2C Explorer is the first button on the right bar. It lists your connections, the instances the plugin talks to, and under each one the instance's WebDAV folders: code versions, logs, IMPEX, catalogs and more. Its toolbar adds, edits, copies and groups connections
See Add a connection, B2C Explorer toolbar, Connection menu, Work with remote files and Code versions
B2C Credentials
B2C Credentials sits below B2C Explorer. It holds every secret the plugin uses: Business Manager accounts, their per-host access keys and OCAPI API clients, in the IDE password safe or one encrypted file. Connections only point at an account, so one account serves many instances
See Accounts, Access keys, API clients and Sync credentials to a file
B2C Entry Points
B2C Entry Points lists every way a request, job or hook enters your code: pipelines, controller routes, hooks, step types and custom APIs. One search covers every tab, and each row opens the code that runs. Navigate › B2C Entry Points opens it too
See Open the tool window, What it lists and Search
B2C Metadata
B2C Metadata lists the site archive XML of your project under the organization or site each file belongs to: metadata, catalogs, price books, libraries, preferences, jobs, services, slots and more. Navigate › B2C Metadata opens it and focuses its search
See Open the tool window, Organization and sites, Group by type and META in the B2C project view
B2C Sync
B2C Sync sits low on the left bar. The active instance has its tab right away, another instance's tab is added by its first upload, deploy or clean, and each holds two tables: Code Deployment with a row per cartridge of the last deployment, and Code Upload with every file that went up. Select a row to see its requests below the table. Show Code Deployment and Code Upload Side by Side puts the tables next to each other. It opens on the tables alone. Hide Console , Show Console Beside and Show Console Only on its toolbar pick the layout for every project. In the console, local paths open the file in the editor, and Open on server opens it in the browser
See B2C Sync, Code Upload tab and Follow a deployment
B2C ODS
B2C ODS sits low on the left bar. It creates, starts, stops, resets and deletes the on-demand sandboxes of your realms through the Salesforce ODS API, with an API client instead of a project connection
See Add a configuration, Sandboxes table and Start, stop and restart
Log Center
Log Center sits low on the left bar, after B2C ODS. It parses and tails your instances' logs into a store on your machine, one tab per instance, each with six views: Files, Issues, Events, Anomalies, Monitor and Storage. Its title bar has Export, Create Report, Open in New Window, Open in Editor Tab and Maximize Log Center
See Log Center, Search & Filters and Files & Tails
B2C OCAPI
B2C OCAPI sits low on the right bar. Find Jobs in jobs.xml fills its Jobs tab from your project, Run Job starts the selected jobs, and their status refreshes every 2 seconds until the run ends
See B2C OCAPI tool window, Jobs list and Run jobs
Elsewhere in the IDE
| Where | What the plugin adds | Read more |
|---|---|---|
| Status bar | The B2C Site Scopes widget, which reads Global scope or the selected site, once a cartridge is linked | Site Scopes |
| Status bar | Setup 2/5 while a main setup step is open, Setup once all five are done, or only the red panda. A click opens Getting Started. It shows in projects with SFCC code | Use Getting Started |
| Status bar | Log Center, which reads, for example, 12.4K events · Tailing 2 while logs are stored, with a card of every instance under the pointer. A click opens the instance, on Monitor while it's busy | Status bar |
| Help menu | Intellij SFCC Getting Started opens Getting Started | Use Getting Started |
| Editor floating toolbar | Override ... in Another Cartridge, Show Overrides for the open file when it exists in several cartridges, Compare with B2C Instance, Show Template Graph on an ISML template, the upload ring when Upload Progress in Editor is Indicator in the Floating Toolbar, and Open in Log Center on an SFCC log | Overrides, Compare with the instance, Template Graph, Progress in the editor, Open in Log Center |
| Project tool window | The Salesforce B2C Commerce view with only your linked roots, and META with the site archive files | Project view setup |
| Refactor › Extract in an ISML template | Include File... and Custom Tag... move the selection to a new template | Editing, Custom Tags |
| Editor gutter | The error or warning icon on script and ISML lines that logged errors or warnings, grey once you change the line. A click lists the line's issues | Errors in the gutter |
| Pipeline Editor toolbar | Groups opens Pipeline Groups | Pipeline Editor |
| Search Everywhere | The B2C Entry Points tab with pipelines, controller routes, hooks, step types and custom APIs, and the Site Archive tab with services, jobs, preferences, custom objects, slots and library contents | Search Everywhere |
| Run › Edit Configurations | The Salesforce B2C Commerce (SFCC) configuration for debugging | Script Debugger |
Keyboard shortcuts
| Action | macOS | Windows and Linux |
|---|---|---|
| Find New Cartridges | Cmd+Option+] | Ctrl+Alt+] |
| Upload ... to ... | Cmd+Shift+I | Ctrl+Shift+I |
| Compare with B2C Instance | Cmd+Option+Shift+O | Ctrl+Alt+Shift+O |
| Deploy Code | Cmd+Ctrl+Z | Ctrl+Meta+Z |
| Clean active code version | Cmd+Shift+X | Ctrl+Shift+X |
With the macOS System Shortcuts keymap, Find New Cartridges is Ctrl+Option+]. Many Windows and Linux keyboards have no Meta key, so give Deploy Code your own shortcut there
To change a shortcut, search for the action in Settings › Keymap
IDE shortcuts that work well with the plugin:
| Action | macOS | Windows and Linux |
|---|---|---|
| Open the Project tool window | Cmd+1 | Alt+1 |
| Hide the active tool window | Shift+Esc | Shift+Esc |
| Search Everywhere, with the B2C Entry Points and Site Archive tabs | Shift twice | Shift twice |
Troubleshooting
| Symptom | What to do |
|---|---|
| Only Find New Cartridges and More are on the toolbar | Link a cartridge, see Project view setup |
| Deploy Code, Auto Upload or Select Code Version is missing | Select a connection with Select Connection, see Connections |
| B2C Entry Points, B2C Metadata or B2C Sync is missing | They appear once a cartridge is linked |
| A tool window button is gone from its bar | Open the window from More › Tool Windows, or reset the buttons with Window › Layouts › Default |
| A shortcut does nothing | Another action or your operating system uses it. Assign a free one in Settings › Keymap |
Related
Cartridges & Modules
Link cartridges and modules, and the B2C project view
Connections
Add instances and pick the active one
Upload & Auto Upload
Single files and uploads on save
Deploy Code
Deploy, code versions and cleanup
B2C Entry Points
Every pipeline, route, hook, step type and custom API in one search
Settings
General Project Settings and where the plugin stores its state
Updates & Notifications
Release announcements, release history and plugin updates