Skip to Content

Pipeline Editor

Edit SFCC pipelines as a graph in JetBrains IDEs - select, move and copy nodes, find pipelines with Pipeline Groups, follow scripts and routes, set breakpoints

The Pipeline Editor opens SFCC pipeline XML as an interactive graph. Edit nodes and transitions, follow the scripts and templates they use, open routes and set breakpoints. The graph writes every change back to the XML

Select a node to edit it in the Details panel, or hold Shift and drag a rectangle to select several, as on a desktop, and move them together. Pinch on a trackpad, or hold Cmd or Ctrl and scroll, to zoom at the pointer, something the Eclipse pipeline editor never had. Set a breakpoint and the debugger centres each node it stops on

Open a pipeline

Open any XML file in a pipelines folder, for example app_custom/cartridge/pipelines/Cart.xml. The graph opens in a "Cart Pipeline Editor" tab before the XML source tab

To switch views, right-click the file or its editor tab and choose Show Pipeline Source or Show Pipeline Editor

Create a pipeline

Right-click a cartridge folder and choose New › Pipeline . Enter a name in the New Pipeline dialog and the plugin creates <cartridge>/cartridge/pipelines/<name>.xml with a starter pipeline and opens it in the graph

Other ways in

These open the pipeline on the start node you picked:

Pipeline Groups

Click Groups in the editor toolbar, or choose Navigate › Pipeline Groups… or Tools › Salesforce B2C Commerce › Pipeline Groups…, to search every pipeline of your linked cartridges

Pipeline Groups opens on the group of the pipeline you are in. Option+Up and Option+Down walk the groups, the search finds pipelines, groups, start nodes and cartridges, and Enter opens the pipeline at the start node that matched

The left list holds All pipelines and every group from the group attribute of the <pipeline> tag. Pipelines without one sit in Ungrouped

Type part of a pipeline name, start node, route such as Cart-RemoveProduct, group, cartridge or type. All cartridges next to the search field limits the results to the cartridges you check, and Show all cartridges in its list clears the choice

Keys and actions

KeyWhat it does
⌥↑ ⌥↓ (Alt+↑ Alt+↓)Switch the group
Enter, or double-clickOpens the pipeline in the Pipeline Editor, on the matched start node
Shift+EnterOpens the XML source
Cmd+Enter (Ctrl+Enter)Selects the file in the Project view

Right-click a result for Open in Pipeline Editor, Open at Start Node, Open XML Source, Reveal in Project View, Copy Pipeline Name and Copy Path

Edit the graph

Click a node to select it and edit its properties in the Details panel

Shift-drag to select an area, copy and paste nodes from the right-click menu, and use the halo around a node to unlink it. Delete asks before it removes anything, and the Script File field suggests matching scripts, with Use cartridge to add the cartridge prefix

Select and move nodes

MouseWhat it does
Click a node or transitionSelects it. A node also gets its halo
Shift + drag on empty canvasSelects every node the rectangle touches
Cmd-click (Ctrl-click)Adds or removes a node
Drag a selected nodeMoves the whole selection
Click or drag empty canvasClears the selection. A drag also pans the graph
Double-click a nodeOpens its script, template or pipeline, or edits a Text node
Right-clickCopy on a node, Paste on empty canvas

Copy and Delete act on the whole selection, and the Details panel closes while more than one node is selected

Copy, paste and delete

Copy copies the selected nodes and the transitions between them. Paste on empty canvas puts the copies on the cell you clicked, and Cmd+V (Ctrl+V) pastes where you last clicked. Pasted start nodes get a unique name. The editor keeps its own clipboard, so paste in the same Pipeline Editor tab

Halo tools

A selected node gets a halo of buttons:

  • Top removes the node, after the same confirmation as Delete
  • Middle rotates the node between vertical and horizontal. Text and Join nodes don't rotate
  • Bottom unlinks the node, removing every transition to and from it without asking

Start nodes get three more buttons, see Follow scripts, templates and routes

Transitions

Drag from a node's connector to another node to add a transition, then edit its Connector Name, Transactional Control and Description in the Details panel. Drag a selected transition's line to add a bend point, or click its remove button to delete it. Drop an unconnected node onto a transition to insert it between the two nodes

Text nodes

Drag Text Node from the flow sidebar to add a note. Double-click it to edit: Enter starts a new line, Cmd+Enter (Ctrl+Enter) or a click outside keeps the text, and Esc cancels. Drag the handles of a selected Text node to resize it

Keyboard

KeyWhat it does
Delete, BackspaceDeletes the selection after a Confirm Action prompt where Cancel has the focus
↑ ↓ ← →Selects the nearest node in that direction, joined nodes first
EnterOpens the script, template or pipeline of the selected node
Cmd+C, Ctrl+CCopies the selection
Cmd+V, Ctrl+VPastes
Cmd+Z, Ctrl+ZUndoes the last editor change
Cmd+Shift+Z, Ctrl+Shift+Z or Ctrl+YRedoes it
Cmd+S, Ctrl+SWrites pending changes to the XML and saves the file

The keys work while the graph has the focus and follow your IDE keymap

Toolbar

ControlWhat it does
Back, ForwardPrevious or next focused node
Undo, RedoUndo or redo the last editor change
RefreshReloads the pipeline XML from the editor document
GroupsOpens Pipeline Groups
Breakpoint, Skip breakpoint, BreakpointsSee Breakpoints
More actionsButtons that don't fit a narrow tab
SidebarShows or hides the flow sidebar
DetailsShows or hides the details panel of the selected node or transition
Search nodes or breakpointsSee Node search

The toolbar, the node search and the right-click menu follow your system language when it is Russian or Ukrainian

Saving

The editor writes graph changes to the XML document shortly after each change, and the toolbar shows the status

StatusMeans
ModifiedChanges are waiting to be written to XML
SavingWriting changes to XML
SavedChanges are written to XML
No changesThe XML is up to date

The IDE then saves the file like any other document, and with Auto Upload on, uploads it

Flow sidebar

Pipeline type and group

  • Type is View or Process. A Process pipeline hides Interaction Node and Interaction Continue Node from the Flow tab, and its new start nodes get Call Mode Private
  • Group is the group Pipeline Groups sorts it into

Add nodes

The Flow tab lists the flow nodes and the Pipelets tab the pipelets by group, with deprecated ones marked "(deprecated)". Filter a list, then drag a node onto the canvas

A new start node gets a unique name. An empty or duplicate name shows "Start node name is required." or "Start node 'Show' already exists." under the field and keeps the old name

Search nodes or breakpoints in the toolbar finds nodes in the open pipeline whose label, type or property names and values contain every word you type. ↑ ↓ or the pointer previews a result on the canvas, Enter or a click selects it. Entries lists the start nodes, and All types narrows the results to one kind of node

Zoom and pan

The zoom is anchored at the pointer, so the node under it stays in place, and goes from 5% to 300%

GestureWhat it does
Pinch on a macOS trackpad, or hold Cmd or Ctrl and scrollZooms in or out
Scroll, or swipe with two fingersPans the graph
Hold Shift and scrollPans sideways

Minimap

Minimap in the bottom-right corner shows the part of the pipeline in view. Drag its title bar to move it and its edges to resize it. Reset returns to 100%, Hide closes it and the Minimap button brings it back

Follow scripts, templates and routes

For a script node, the dictionary inputs and outputs come from the @input and @output header of the linked .ds script, see Script nodes

A selected start node gets three more buttons:

  • Top opens the route on the storefront, for example https://<host>/on/demandware.store/Sites-RefArch-Site/default/Cart-Show
  • Middle copies that URL
  • Bottom opens References with the scripts, templates and XML that call the route

The URL uses the host of the active connection and the selected site scope. With Global scope the editor asks you to "Select a site scope before opening a storefront route."

Resource fields

Script, template and pipeline fields in the Details panel suggest files from your linked cartridges, matching anywhere in the file name or path

  • Use cartridge on a script suggestion writes the value with its cartridge prefix, for example app_custom:cart/AddProduct.ds. Type a prefix such as app_custom: to see only that cartridge's files
  • Script values start after cartridge/scripts, template values after the locale folder and without .isml, for example cart/minicart. Pipeline fields also suggest routes such as Cart-Show

Go To opens the file. With a site scope selected it opens the copy that site uses, otherwise a chooser lists the cartridges that have it. Browse lists every file the field accepts, with a search field and an All cartridges filter

Breakpoints

Select a node and click Breakpoint to set or remove a breakpoint, or click the gutter of the XML source on a line that belongs to a node. Skip breakpoint disables it without removing it. While the pipeline has a breakpoint, Breakpoints shows up in the toolbar and lists the nodes that have one in the node search

Pipeline breakpoints show up as SFCC Pipeline in the IDE breakpoints dialog. They live in the IDE, not in the XML. To pause on them, start a debug session, see Pipeline debugging

Performance

The graph runs in the IDE's embedded browser, JCEF. On some IDE builds, out-of-process JCEF forces off-screen rendering, and scrolling, trackpad gestures and pinch zoom feel delayed

When the plugin detects off-screen rendering it shows a Make Pipeline Editor Smoother balloon with Apply for Next Restart, Open VM Options and Read Docs, a panel above the graph and a Pipeline editor performance button in the toolbar. Do not show again hides only the panel

Known IDE crash risk

In some IDE and runtime combinations, -Djcef.remote.enabled=false can cause IntelliJ IDEA or another JetBrains IDE to crash at startup or when an embedded browser opens. This is a known native issue in the JCEF/Chromium runtime bundled with JetBrains IDEs, reproduced on macOS with CEF 150. The setting affects every JCEF view, including Markdown previews, and removes their process isolation

On IDE builds that force off-screen rendering, disabling out-of-process JCEF is currently the only known way to retain windowed rendering and smooth native scrolling, trackpad gestures and pinch zoom in the Pipeline Editor and other JCEF views. We keep recommending it for that experience, with this stability tradeoff. If crashes occur, undo the change; scrolling and gestures may become less smooth again

Open the custom VM options with Open VM Options in the panel above the graph or Help › Edit Custom VM Options…, add -Djcef.remote.enabled=false on its own line, save, then quit the IDE and start it again

Apply the setting

Try Apply for Next Restart

Click Apply for Next Restart in the balloon if it is offered. It sets the registry key ide.browser.jcef.out-of-process.enabled to false

Or add the VM option

Click Open VM Options, or use Help › Edit Custom VM Options, and add this line. If the file already has -Djcef.remote.enabled=true, change it instead

-Djcef.remote.enabled=false

Restart the whole IDE

Quit the IDE and start it again. Closing the project or the tab is not enough

If the plugin can't open the VM options file, it shows Improve Pipeline Editor Smoothness with Copy VM Option and Copy Manual Steps

InstallationCustom VM options file
JetBrains ToolboxToolbox › the IDE › Settings › Configuration › Java Virtual Machine options › Edit
macOS~/Library/Application Support/JetBrains/<Product><Version>/<product>.vmoptions
Windows%APPDATA%\JetBrains\<Product><Version>\<product>64.exe.vmoptions
Linux~/.config/JetBrains/<Product><Version>/<product>64.vmoptions

Edit only the custom copy. The .vmoptions file inside the IDE installation is replaced by updates

Check the result

After the restart, open Help › Show Log in Finder (or Explorer) and look for the latest Pipeline editor JCEF rendering mode: line in idea.log. windowed means the fix worked, osr means the editor still renders off-screen

After the restartWhat to check
The log still says osrCheck that you edited the VM options of the IDE you launch and restarted fully
The log says windowed but a big graph is slowCompare with a small pipeline and wait for indexing to finish

Undo the change

  1. Remove the -Djcef.remote.enabled=false line from the custom VM options, or restore its old value
  2. If you used Apply for Next Restart, open Find Action (Cmd+Shift+A or Ctrl+Shift+A), search for Registry and reset ide.browser.jcef.out-of-process.enabled
  3. Restart the IDE

Troubleshooting

SymptomWhat to do
"Opening the pipeline editor..." stays on screenUse Reconnect editor, or Open XML source to open the file as text
Pipeline XML Changed after reconnectingThe XML changed while the editor was locked. Reload XML drops the graph changes that weren't written yet, Keep Editor Locked keeps both while you decide
A script or template is missing from BrowseIts cartridge isn't linked or indexing is still running, see Cartridges & Modules
Go To says "No script found for ..."Check the value against the field's suggestions. A cartridge: prefix only finds files in that cartridge
A transition's Connector Name shows "... already exists from this output port."Each output port needs its own connector names
A start node's endpoint button shows "Select an active B2C Commerce connection first."Select a connection in the main toolbar
Scrolling or zoom is slowSee Performance
Pipeline Groups shows "No pipelines in the linked cartridges" or misses a pipelineLink the cartridge and wait for indexing. The file must be in a pipelines folder and have a <pipeline> root tag

On this page