Skip to Content

Upload & Auto Upload

Upload files on save or by hand, watch each upload in the editor and Project view, and find every upload in the Code Upload tab of B2C Sync

Auto Upload sends every change as you work, and Upload Item sends what you select. Both go to the selected code version of the active connection. The editor and the Project view show each upload as it happens, and the Code Upload tab of B2C Sync keeps the history. To push whole cartridges, use Deploy Code

With Auto Upload on, each file you save in a linked cartridge goes to the code version picked in the toolbar. The line under the tab follows it and the Code Upload tab of B2C Sync lists it

Auto Upload

Turn it on with the Auto Upload button in the main toolbar, or the same button in the Code Upload tab of B2C Sync. The icon shows the state: Auto Upload Enabled or Auto Upload Disabled

  • It is off by default
  • The state is saved per connection and follows the active connection
  • Tools › Salesforce B2C Commerce › Auto Upload toggles it too
  • It needs a valid license or trial, otherwise the button is disabled. If you activate the plugin while the project is open, reopen the project, see Purchase & License
  • Files under .idea, .git or node_modules, and .DS_Store files, are never uploaded
  • A file saved again before its upload started goes up once
You do thisAuto Upload does this
Create, edit, paste or copy a fileUploads the file
Delete a fileRemoves it from the code version
Move or rename a fileMoves it on the server
Change files outside the IDE, for example by switching Git branchesSyncs the changes from disk the same way

Branch switches are synced too

A branch switch that changes hundreds of files uploads and removes all of them. For big switches, turn Auto Upload off first and run Deploy Code afterwards

What gets uploaded

Only files in Cartridge Root, B2C Module Root and Modules (Global Modules) Root folders are uploaded, see Cartridges & Modules. Skipped files are logged in the B2C Sync console:

LineWhy
[EXCLUDED] You are trying to upload excluded item ...The file is in a folder marked Excluded or Test Sources Root in the IDE
[NOT ALLOWED] ... Please link cartridge '...' to your projectThe file belongs to a cartridge that is not linked

Uploads and code deployments never send credential and key files, whatever the upload skip list in the project settings says. That covers .env and .env.*, and files ending in .creds, .p12, .pfx, .pem, .key, .jks or .keystore

Upload selected items

Right-click files or folders in the Project view, an editor tab or the editor, and choose Upload ... to your connection . The label follows the selection, for example Upload Controller to Dev 01. The shortcut is Cmd+Shift+I on macOS and Ctrl+Shift+I on Windows and Linux

Right-click a file in the Project view or the editor and choose Upload Controller to Sandbox 01, or press ⇧⌘I. A line under the editor tab and a mark in the Project view show it going up
You selectThe item reads
.js files in a controllers folderUpload Controller to or Upload Controllers to
.js files in a models folderUpload Model to or Upload Models to
.isml templatesUpload Template to or Upload Templates to
.properties filesUpload Properties to
Other .js or .ds filesUpload Script to or Upload Scripts to
Cartridge foldersUpload Cartridge to or Upload Cartridges to
Other foldersUpload Folder to or Upload Folders to
Anything else, or a mixUpload File to or Upload Files to
  • A cartridge folder uploads as a whole cartridge, other folders with their content
  • A single file shows its progress in the status bar for as long as it goes up. The progress's Stop button stops the request
  • An upload you start brings the Code Upload tab forward, unless a deployment runs in B2C Sync
  • With no active connection, the item ends in B2C Instance and shows No Valid B2C Commerce Connection
  • Without a valid license or trial, the license dialog opens instead

Progress in the editor

A file that uploads, on save or by Upload, shows its progress in its editor. A folder's upload shows it in the editors of its files

Line at the Top of the Editor, the default: a thin line under the tab fills as the file goes up, turns green and fades once the instance has it, or turns red for a moment when the upload failed

Pick the style under Upload Progress in Editor in the Options menu of the Code Upload tab, or in the ⋮ menu of B2C Sync. The choice applies to every project

StyleShows
Line at the Top of the Editor (default)A thin line under the editor tab. It fills as the file goes up, turns green and fades once the instance has it, or turns red for a moment when the upload failed
Indicator in the Floating ToolbarA ring in the editor's floating toolbar, before Override, that fills and changes colour the same way. Its tooltip reads "Uploading Cart.js", "Uploaded Cart.js" or "Upload of Cart.js failed" with the error. Click it to open the upload in the Code Upload tab
NoneNothing in the editor. The Code Upload tab still lists every upload

Progress in the Project view

Files and folders that upload show it on their row the moment it happens, in the Project view, the Salesforce B2C Commerce view and the other views of the project's files

The Project view follows every upload: a still spinner while a file waits its turn, a turning one while it goes up, with how far once it takes a while, and a green check that fades. A closed folder counts what goes up under it, and a failure stays as upload failed until the file goes up again
MarkWhat it means
Still spinnerThe file waits for a free upload thread
Turning spinnerThe file goes up. A file that takes a while shows how far, for example "64%"
Green checkThe instance has the file. The check fades after a moment
Closed folder that turns, "3 uploading"Files under the folder or cartridge go up, and how many
Red mark, "upload failed"The upload failed. The tooltip names the code version and the error, for example "Upload to version3 failed: Read timed out". The row says so until the file goes up again
Folder with "2 failed"Files under it failed. Open it to find them

The marks are painted over the rows, so 20 files picked and uploaded show at once, even while the IDE is busy

Compare with the instance

Compare with B2C Instance diffs a file against its copy in the selected code version. Right-click one file of a linked cartridge or module in the Project view, an editor tab or the editor. It's also in the View menu, on the editor's floating toolbar and in the row menu of the Code Upload tab. The shortcut is Cmd+Option+Shift+O on macOS and Ctrl+Alt+Shift+O on Windows and Linux

Right-click a file in a linked cartridge and choose Compare with B2C Instance. The diff puts your local text, unsaved edits included, next to the copy in the active code version. Upload Local sends your side, and Take Remote replaces it as one edit that Undo reverts

The diff is titled after the file and the instance, for example Checkout.js: Local ↔ Sandbox 01 (version2)

SideWhat it shows
LocalThe file in the editor, unsaved changes included. Editable in the diff
Sandbox 01 (version2)The file in that code version, read-only
Diff toolbar buttonWhat it does
Upload LocalSaves and uploads the file to the code version
Take RemoteReplaces the local file with the one from the instance. Undo brings your version back

B2C Sync

The B2C Sync tool window sits low on the left bar. The active instance has its tab on top right away, and each instance holds two tables: Code Deployment and Code Upload

B2C Sync opens on the active instance right away, with a tab on top for each instance in its colour. The buttons at the end of the tabs put Code Deployment and Code Upload side by side, each with its own toolbar, or bring the console in, and the ⋮ menu picks how uploads show in the editor
  • Another instance's tab is added by its first upload, deploy or clean. A tab you close stays closed until another instance turns active
  • The tabs stay in the tool window's header, whichever table you look at
  • A Production, Staging or Development tab takes its instance's colour, with matching hover and selected states. The row behind Code Deployment and Code Upload takes a soft shade of it and underlines the selected table in it, as in the Log Center. A sandbox stays neutral, see Instance colours
  • Each table has its own toolbar on its left

It opens on the tables alone. The buttons at the end of the tables' tab row pick the layout, and the choice is kept for every project and follows every instance's tab. While the console shows alone, they move to the top of its toolbar

ButtonLayout
Show Code Deployment and Code Upload Side by Side Both tables next to each other, each under its own tab with its own toolbar and request details. In a tall tool window they stack. Click it again for one table at a time
Hide Console (default)The tables alone
Show Console Beside The tables with the console beside them
Show Console Only The console alone
  • Show in Console in a row's menu brings the console in beside the tables and selects the row's line
  • The tab icons show a running badge while a deployment or uploads run, and a red badge when the deployment failed or an upload failed since you last looked
  • On another connection's tab, the Code Upload table reads Not the active connection, since files upload to the active one only
  • The ⋮ menu has Upload Progress in Editor, see Progress in the editor, with the usual tool window options
  • Hide or Shift+Esc hides the tool window

For the Code Deployment tab, see Follow a deployment

The console

LineMeaning
[version] :: path [size] updated | Open on serverThe file was uploaded to that code version
[version] :: path removedThe file was removed from the code version
[401] Invalid credentials. Please check your connection settingsThe instance rejected the account or access key

Local paths open the file in the editor, Open on server opens it in the browser. For deploy and clean output, see Deploy Code

Request details

Show Request Details on the toolbar or in a row's menu opens every request behind the selected row on the right of the table. Until then the table keeps its full width

The details stay closed until you ask for them, on the toolbar or in a row's menu. They show every request behind the row, a failed one first. Here the folder didn't exist yet, so it was created and the file went up again
PartWhat it shows
The line on topThe selected request's status, how long it took, its method and its full URL
The list of requestsEvery request behind the row, when there is more than one. A failed request is selected first, otherwise the last one
ResponseThe instance's answer as it came back: status, headers and body. This tab opens first
RequestWhat went up: method, URL, headers and any form fields
  • Copy URL and Copy Request and Response sit on the line on top
  • Show Request Details Below on the line on top moves them under the table, and Show Request Details on the Right moves them back. The choice is kept for every table
  • With no row selected, Show Request Details selects the first row in sight. On Code Deployment it shows the deployment's own requests instead, once it sent any
  • Hide Request Details gives the table its room back. The details start closed each time the IDE starts. Open or closed, the choice holds for each table until you close the IDE
  • Sign-in details, cookies, tokens and other secret values are masked, and an uploaded file shows only its size
  • Code Upload keeps these details for the newest 500 uploads of each instance, also after a restart

Parallel requests

Parallel requests at the end of the line on top of both tables shows how many requests a deployment sends to an instance at once, and how many saves go up at a time. Click it to change the number. It is the same setting as Concurrent Threads in Settings, and some sandboxes take only 2. Saves and B2C Explorer never wait behind a deployment

Code Upload

The Code Upload tab lists every file and folder that Auto Upload or Upload sent, removed, moved or renamed on this instance, newest first with running uploads on top

Save a file with Auto Upload on and its row comes in on top: Uploading with the percentage sent, then Updated, how long it took and when. The headline counts what runs, the details link the code version and the host to B2C Explorer

The summary

The line on top says what goes on, and ends with the file watcher that runs and Parallel requests

SummaryWhen
Auto upload is on or Auto upload is offNothing runs. It follows the Auto Upload button
Uploading 3 filesUploads run
Not the active connectionThis tab is another connection's. Its history stays, new uploads go to the active connection

After it come the code version and the host, then "1,284 uploads · 2 failed · kept 30 days". The version and the host are links: the version opens B2C Explorer with the version selected under its connection's Code versions, and the host opens it with the connection selected

"2 failed" counts only the files whose newest upload failed. Once a file goes up again, even while that upload still runs, its older failure leaves the count and the Failed button and stays in the history under All. The red count is a link: it selects Failed, clears the search, and resets the source and period filters when they hide one of the failures

Find an upload

  • The pills All, Running, Uploaded, Removed, Moved and Failed show how many uploads each has and filter the table. A pill with nothing to show hides
  • Filter files narrows the table by path as you type. Cmd+F on macOS, Ctrl+F elsewhere, puts the cursor in it
  • The Filter Uploads button beside the pills shows a blue dot while a filter is on. Its choices are kept for every project
FilterWhat it keeps
Latest Upload of Each FileOne row per file, its newest upload, with "×4" after the name when it went up 4 times
Any Source, Uploaded on Save, Uploaded by HandEvery upload, Auto Upload's, or the ones you started
Any Time, Today, Last 7 DaysHow far back the table goes
Reset FiltersBack to every upload

With nothing left, the table reads No uploads match

The table

ColumnWhat it shows
FileThe file or folder with its icon, and its folder in grey. Search matches are marked. The tooltip gives the local path
StatusWhat happened, see below. A failed upload shows its error in red
SourceAuto for Auto Upload, Manual for Upload, MCP for an agent. Hover MCP to see which client sent it
SizeThe size. While it goes up, hover it to see how much went up, for example "12.4 kB of 46.2 kB"
TookHow long it took, counting while it runs
WhenThe day and the time, for example "Oct 21, 14:33:02", with the year for older ones

Each column is as wide as its words, and File takes the rest. When the table gets narrow, Source goes first and then When

StatusMeaning
Uploading 38%The file goes up. At Uploading 100% it waits for the instance to answer, and hovering it says so
Removing, Moving, RenamingThe change runs on the server
CreatedA new file on the instance
UpdatedThe file replaced its older copy
UploadedThe file went up, and the instance didn't say whether it was new
Uploaded and unzippedA folder went up as a zip and was unzipped
RemovedThe file was removed from the code version
Moved from scripts/helpersThe file moved from that folder
Renamed from pricingHelpers.jsThe file was renamed
An error in redThe upload failed, for example "Read timed out", "The folder is not in a cartridge" or "Stopped"

Row menu and toolbar

Right-click a row, or several, for its menu

ItemWhat it does
Open in Editor Opens the file. Enter and a double-click do the same. For a folder, or a file that is gone, they show its line in the console instead
Compare with Instance Opens the file beside its copy in the active code version, see Compare with the instance. On the active connection's tab, for one file
Upload Again Uploads the selected files and folders again. Removed ones are skipped
Show Uploads of This File Puts the file's path in the search and lists all its uploads, whatever the filters keep. Change the search to see the others again
Show in Console Brings the console in beside the table and selects the upload's line
Show Request Details Opens or closes the request details beside the table
Select in Project View Selects the file in the Project view
Copy Copies the rows as text: path, status, source and time. Cmd+C or Ctrl+C
Remove from History Removes the rows that ended from the history. Delete does the same
Toolbar buttonWhat it does
Upload Again Uploads the selected rows again
Retry Failed Uploads Uploads again each file whose newest upload failed
Stop Uploads Stops the selected uploads that run, or all that run when none of them is selected
Auto Upload Turns Auto Upload on or off. Only on the active connection's tab
Keep History Keeps the history for 1 day, 7 days, 30 days (default) or 90 days. Older uploads go at once
Options Upload Progress in Editor: Line at the Top of the Editor, Indicator in the Floating Toolbar or None
Clear History Asks "Remove 1,284 uploads from the history? Uploads that still run stay." and clears it on Clear History
Show Request Details Shows or hides the request details beside the table

Long histories

The history keeps up to 10,000 uploads per instance, for as long as Keep History says, across IDE restarts. The table holds the newest 200 that match and takes the next 200 each time you scroll to its end. The footer reads "Showing the newest 200 of 1,284" with Show 200 More and Show All

Before the first upload, the tab reads No uploads yet: "Files show here as they upload on save or as you upload them"

File watcher

Changes made outside the IDE, for example by Git or a build, reach Auto Upload through a file watcher. The end of the line on top of the Code Upload tab names the one that runs, and hovering it says what that means for your changes

Code Upload names the running file watcher. Hover it to see how the native watcher syncs external changes right away. If it cannot run, the IDE file watcher takes over and the status bar says so, the card gives the exact reason, and Try Again brings real-time sync back
It readsWhat it means
Native watcher The native file watcher runs as its own process and syncs external changes right away, even while the IDE is in the background
IDE watcher The native file watcher cannot run, so the IDE file watcher stands in. External changes sync only while the IDE window is active
Native and IDE watchers The native file watcher cannot watch every folder, and the IDE file watcher covers those folders

While the IDE file watcher stands in, an IDE file watcher item shows in the status bar. Its card gives the exact reason, with Try Again to start the native file watcher again, and Real-time sync is back shows once it runs. The plugin also keeps trying by itself for as long as the project is open

Every start and stop of the native file watcher is recorded in sfcc-file-watcher.log in the IDE log folder, and the logs you collect from the IDE include it

With an AI agent

An agent connected to B2C MCP can plan an upload of the files it changed. The plan runs with the tools you gave the agent, and each upload shows in B2C Sync, see Files & Deploys

Troubleshooting

SymptomWhat to do
Nothing uploads on saveCheck that Auto Upload is enabled for the active connection and that the file's cartridge is linked
Upload ... to is missing from the menuPart of the selection is outside a linked cartridge or module. Link it in Cartridges & Modules
Upload ... to does nothingA deploy, a clean or a cartridge upload is still running, wait for it. Also check that the connection has a hostname, an account and a code version
A row in the Project view says "upload failed"Hover it for the error, fix the cause and save or upload the file again. Retry Failed Uploads in the Code Upload tab sends all of them again
The Code Upload tab reads Not the active connectionFiles go to the active connection. Select this one in the main toolbar to upload to it
The Auto Upload button is greyed out in the Code Upload tabIt works on the active connection's tab only, with a valid license or trial
Old uploads are gone from the Code Upload tabKeep History removed them. Pick a longer period
No progress line in the editorUpload Progress in Editor is set to another style or None. Change it in the Options menu of the Code Upload tab
External changes upload only while the IDE window is activeThe native file watcher isn't running and the status bar shows IDE file watcher. Click it for the exact reason and Try Again, see File watcher
An upload fails with 403 or another HTTP errorOpen Request details for its row and read the instance's answer. A 403 for a folder that doesn't exist yet needs nothing from you: the plugin creates the folder and sends the file again
Connection Error balloonThe upload failed for a connection reason. Use Edit Connection in the balloon and run Test Connection
Sandbox is downStart the sandbox, for example from On-Demand Sandboxes, then save the file again
Files land in the wrong code versionCheck the code version selected in the toolbar, see Deploy Code
Compare with B2C Instance is missing from the menuSelect a single file, not a folder or several files, inside a linked cartridge or module
"Remote file ... not found on ... instance"The file isn't in the selected code version yet. Upload it, or check the code version selected in the toolbar
No Valid B2C Commerce Connection after Compare with B2C InstanceSelect a connection with Select Connection in the main toolbar
"Connection ... needs a hostname, an account and a code version"Complete the connection in Connections Settings

On this page