Skip to Content
Debugging

Pipeline Debugging

Pause SFCC pipelines on nodes, step through them and read the Pipeline Dictionary in the same debug session as your scripts

Intellij SFCC pauses a running pipeline on a node, opens the Pipeline Editor at that node and lists what the pipeline has collected so far in the Pipeline Dictionary

When a request reaches a node breakpoint, the Pipeline Editor centres the node it stopped on, Frames shows the pipeline and node ID, and Variables lists the Pipeline Dictionary. The console logs every stop with its pipeline and node

How it works

Pipeline debugging runs in the same Salesforce B2C Commerce (SFCC) debug session as the Script Debugger: script breakpoints stop JavaScript and Digital Script, pipeline breakpoints stop nodes

With a site scope selected, the session sends that site to the instance. With Global scope no site is sent

Set a breakpoint

Open the pipeline

Open the pipeline XML, for example app_custom/cartridge/pipelines/Cart.xml. It opens in the Pipeline Editor

Mark a node

Select a node and click Breakpoint in the editor toolbar, or click the gutter of a node's line in the XML source. It's listed under SFCC Pipeline in Run › View Breakpoints, see Breakpoints

Start the session

Start the Salesforce B2C Commerce (SFCC) configuration with Debug, see Start a session

Run the pipeline

Open the storefront URL that runs it, for example https://<host>/on/demandware.store/Sites-RefArch-Site/default/Cart-Show. The start node buttons of the Pipeline Editor open or copy that URL for you

  • A breakpoint marked Skip breakpoint isn't sent
  • When the same pipeline is in several linked cartridges, only breakpoints in the first one in your cartridge list are sent
  • Suspend, Condition and logging options don't apply. Every hit pauses the pipeline

The session console

The Console tab also logs the pipeline debugger, next to the script debugger lines

LineWhen it appears
"Pipeline debugger remote sessions reset before launch."Every session start
"Pipeline debugger connected to" the host, with the site in bracketsThe session registered with the pipeline debugger, once you have a pipeline breakpoint
"Pipeline debugger installed 1 breakpoint(s) on" the siteThe instance confirmed your pipeline breakpoints
"Waiting for pipeline breakpoint" with the file, line, node label and "(Pipeline:NodeID)"A breakpoint was added or changed
"Removed pipeline breakpoint" and the same detailsA breakpoint was removed or skipped

When a pipeline stops

The console prints why the pipeline stopped, with the pipeline and node ID, for example "Pipeline breakpoint hit. (Cart:Show.1:DPipeletNode:GetBasket.1)"

ReasonMeaning
"Pipeline breakpoint hit."The pipeline reached one of your node breakpoints
"Pipeline step paused."A step or Run to Cursor finished
"Pipeline execution paused."The pipeline paused for another reason
The exception message or class, in redThe instance reported an exception at that node

The Pipeline Editor then centres the paused node and marks it with a red dashed frame until the pipeline runs on

While paused

ControlWhat it does
Step Over, Step Into, Step OutMove node by node
ResumeRuns to the next pipeline or script breakpoint
Run to CursorRuns to the node on the cursor's XML line, or steps over on a line outside a node

Frames shows a Pipeline stack. Each frame reads as the pipeline name in bold, then the node ID. A called pipeline adds a frame

Pipeline Dictionary

Pipeline Dictionary opens expanded with the keys the pipeline has set so far, such as pipelet objects and script node outputs, sorted by name. Use Evaluate Expression to check a value or a decision condition. A missing key evaluates to undefined

After an error, an Exception entry above the dictionary shows the type, message and stack trace

Every frame shows the same dictionary, the one of the paused node. To see an earlier node's values, set a breakpoint there and run the request again

Completion

In Evaluate Expression and Watches, completion lists the dictionary keys and, after . or :, the object's members from the paused instance, marked "(intellij sfcc)". Completion needs a valid license

Troubleshooting

SymptomWhat to do
The session stops with "Debugger failed to initialize pipeline state before launch."The pipeline debugger couldn't reach the instance. Check the connection and start again
"Debugger access was denied for" the host, with the HTTP codeThe instance refused the pipeline debugger. Check the selected account, its WebDAV and Business Manager permissions, and client certificate access
"Debugger request failed for" the host, with the HTTP codeThe instance returned an error. Start the session again
The session stops with "Debugger stopped while polling pipeline state."The connection broke while waiting for a stop. Start the session again
"Pipeline debugger installed 1/2 breakpoint(s). Missing:" and the missing nodesUpload the pipeline, check that the node exists on the instance and pick the right site scope
A pipeline breakpoint is never hitUpload the pipeline, check that the request runs that node, and select the site in the site scope widget
You can't set a breakpoint on an XML lineThe line doesn't belong to a node. Use the node's own line, or set it in the graph
A script node doesn't stopSet a script breakpoint in its .ds or .js file. Pipeline breakpoints stop on nodes, not inside scripts

On this page