Skip to Content

Settings

General Project Settings, custom SFCC Route Calls, where every other Intellij SFCC setting lives, and which files keep the plugin's state

Intellij SFCC adds three pages to the IDE's Settings dialog, all under Languages & Frameworks: Digital Script, see Compatibility mode, ISML, see ISML settings, and SFCC Route Calls. Every other setting lives next to the feature it changes, and the few project-wide options are in General Project Settings

General Project Settings

Open More › Instance › General Project Settings. The item is shown once the project has a linked cartridge. Click Save to apply

GroupSettingDefaultWhat it does
GeneralConcurrent Threads10How many requests deployments send to each instance at once, and how many saves go up at a time. Saves and B2C Explorer never wait behind a deployment. Also in B2C Sync, as Parallel requests
B2C ExplorerSelect and Expand server node on connection changeOnB2C Explorer selects and expands the new active connection
B2C ExplorerCollapse all nodes on connection changeOnEvery other node in B2C Explorer collapses when you switch the active connection

Lower the threads for small sandboxes

Some sandboxes handle only 2 parallel requests. If deploys or cleanups fail part of the way through, set Concurrent Threads to 2 and try again

Bulk File Upload has its own Concurrent Threads value for that dialog, see WebDAV Explorer

SFCC Route Calls

Route completion, Cmd+Click (Ctrl+Click) and route lens usage counts work in calls such as URLUtils.url('Cart-Show') and new URLAction('Cart-Show'). If your project wraps them in a helper of its own, such as urlHelper.getUrl('Account-Show'), add the helper here

Add your own URL helper on Settings › Languages & Frameworks › SFCC Route Calls. Its calls then complete routes, Cmd+Click to them and count in the usages of the route lenses, next to the built-in URLUtils and URLAction calls

Open Settings › Languages & Frameworks › SFCC Route Calls, click + and fill in the new row. Each row is one rule

ColumnRequiredWhat it means
Class (optional)NoLimits the rule to calls on this name, the one right before the method, such as urlHelper in urlHelper.getUrl(...). Left empty, the rule matches a plain call and a method call on any object
Methods (comma-separated)YesOne or more function or method names, for example getUrl, getAbsUrl
Argument indexYesThe zero-based position of the route argument, from 0 to 30. 0 is the first argument
Call in your codeClassMethodsArgument index
urlHelper.getUrl('Account-Show')EmptygetUrl0
links.forRoute('DemoSite', 'Product-Show')linksforRoute1

How rules match

  • Your rules are tried in order, from the top of the table, then the rules from the project's VS Code settings, and then the built-in ones: URLUtils.url/abs/http/https, any url/abs/http/https call and URLAction, all on argument 0. The built-in rules always stay on
  • The first rule that matches a call picks its route argument. A rule matches when the method and the class fit and its argument is a string literal
  • For the usage counts in ISML templates and in pipeline and other cartridge XML, a call counts when any rule names its method, with the route as its first argument
What the rules changeWhere
Route completion and Cmd+Click (Ctrl+Click) to the routeString arguments of script calls and of calls in the ${...} expressions of ISML templates
The usage count of the route Code Vision lenses and the list it opensScripts, ISML templates, pipelines and other cartridge XML, see Usages

A change applies as soon as you click Apply or OK, without indexing again. Each project has its own list

Rules from VS Code settings

If the project has a .vscode/settings.json with intellij-sfcc.completions.routes, the plugin reads those rules too, so a team that works in both editors keeps one list. The page shows them under the table. Edit them in the file: a change applies within a moment

.vscode/settings.json
{
  "intellij-sfcc.completions.routes": [
    { "className": "links", "methods": ["forRoute"], "paramIndex": 1 }
  ]
}

className is Class, methods is Methods and paramIndex is Argument index. Comments and trailing commas are fine, as in VS Code. See Scripting completion rules

Where the other settings are

To changeOpenRead more
Hostname, account, code version, OCAPI client, certificates, lowercase user namesConnections Settings from Add Connection or Edit ConnectionConnections Settings
Accounts, access keys, API clients, the shared credentials fileThe B2C Credentials tool windowCredentials
Full cleanup, tasks before a deployDeployment Settings... in the Deploy Code dialogDeployment Settings
Automatic uploadsThe Auto Upload button, saved per connectionUpload & Auto Upload
Linked cartridges and modulesMore › Instance › Cartridges and Modules…Cartridges & Modules
The site the plugin resolves forThe B2C Site Scopes widget in the status barSite Scopes
Sandbox realmsAdd Configuration in the B2C ODS tool windowOn-Demand Sandboxes
Pipeline Editor renderingThe VM option for the embedded browserPipeline Editor performance
Code Vision lensesSettings › Editor › Inlay Hints › Code vision, one group per kindCode Vision
Request hints after each custom API endpointSettings › Editor › Inlay Hints › URL path › SFCC custom API requestsRequest hints
ISML modules files, template target, banners and drag and dropSettings › Languages & Frameworks › ISMLISML settings
Script compatibility mode, parsing cartridge .js as Digital Script, optimizing imports on the flySettings › Languages & Frameworks › Digital ScriptDigital Script settings
ISML colors and the ISML inlay hintsSettings › Editor › Color Scheme › ISML and Settings › Editor › Inlay HintsColors and inlay hints
Gutter icons next to template, script, step type function, form and cartridge path strings, and on custom API endpointsSettings › Editor › General › Gutter Icons, the SFCC ... entriesGutter icons
Keyboard shortcutsSettings › KeymapKeyboard shortcuts
Notification balloonsSettings › Appearance & Behavior › Notifications, group INTELLIJSFCCTurn balloons off
Whether Getting Started opens by itselfDon't open automatically on the Getting Started pageUse Getting Started
Only the red panda in the Setup status bar item, without its textShow only the panda in the status bar on the Getting Started pageUse Getting Started

Where the plugin keeps its state

WhatStored inShared by
Connections, General Project Settings, deployment settings, the site scope, the code versions list.idea/workspace.xml of the projectThis project on this machine
Linked cartridges, B2C modules and the modules folderintellij-sfcc-cartridges.xml, intellij-sfcc-b2c-modules.xml and intellij-sfcc-b2c-global-modules.xml in .ideaThis project
Connections of the B2C OCAPI tool windowintellij-sfcc-commerce-ocapi-connections-config.xml in .ideaThis project
Accounts, access keys, API clients and sandbox configurationsThe IDE's own settings, with passwords and secrets in the IDE password safeEvery project in this IDE
Rules of SFCC Route Callsintellij-sfcc-route-call-rules.xml in .idea, and intellij-sfcc.completions.routes in .vscode/settings.jsonThis project
Don't open automatically and Show only the panda in the status bar of Getting Startedintellij-sfcc-getting-started.xml in the IDE's options folderEvery project in this IDE
Whether the project has SFCC code, and Set Up Anyway.idea/workspace.xml of the projectThis project on this machine
  • Credentials survive when you delete a project's .idea folder, but its connections, linked cartridges, route call rules and deploy settings don't. Find New Cartridges links the cartridges again, and connections need to be added again
  • To use the same accounts on several machines, link them to one encrypted file, see Sync credentials to a file

Troubleshooting

SymptomWhat to do
"Rule N names no method" when you apply SFCC Route CallsFill in Methods for that row, or remove the row. Rows with both Class and Methods empty are skipped
"Rule N: the argument index must be from 0 to 30"Set Argument index to a value from 0 to 30
A helper you added still gets no route completion or usage countCheck that Class is the name right before the method, that Argument index counts from 0, and that the route is a string literal passed straight to the call, not a variable or a + concatenation
Rules from .vscode/settings.json don't show under the tableThe plugin reads the .vscode folder at the root of the project. Each rule needs a methods list of names and a whole-number paramIndex, and a file that isn't valid JSON gives no rules

On this page