Salesforce Commerce Cloud
The document walks you through the step by step process of setting up the Firework SFCC Cartridge within your Salesforce Commerce Cloud backend.
The integration for this cartridge encompasses, the deployment of a generic cartridge combined with minor modification of templates inside the storefront code for the cartridge to be fully functional. No known dependency on any 3rd party product.
Now we’ll configure Cartridge Paths to ensure the Firework Cartridges are loaded.
In Administration > Sites > Manage Sites > YourSite > Settings we’ll add that Cartridges includes
int_firework_pd:
Next, in Administration > Sites > Manage Sites > Business Manager > Settings we’ll add that Cartridges includes
bm_firework_pd:bm_firework_dashboard:
There are 3 cartridges in the zip folder
- bm_firework_dashboard
- bm_firework_pd
- int_firework_pd
Please install these 3 cartridges on your SFCC cartridges directory
firework-sys-custom-obj-defs.xmlTo upload the file, navigate to Administration → Site Development → Import & Export → Import & Export Files → Upload →Choose File Upload
To Import the metadata, navigate to Administration → Site Development → Import & Export → Metadata → Import → Select the uploaded file → Click Next
Click Import
Upload the following files from the metadata folder:
- firework-job.xml
- firework-sfcc-services.xml
To upload the file, navigate to Administration → Operations → Import & Export Files
Import the SERVICES file after uploading it.
To import the file, navigate to Administration → Operation → Services → Import → Select the uploaded file (firework-sfcc-services.xml) → Click Next → Import
Import the JOBS file after uploading it.
To import the file, navigate to Administration → Operation → Jobs → Import → Select the uploaded file (firework-job.xml) → Click Next → Import
Navigate to Administration Organization Roles & Permissions Administrator Business Manager Modules
Then you can select the site or organization you want to enable the Firework Cartridge.
Setup API client on demandware Account Manager with the following Configuration:
Login to Demandware Account Manager and Navigate to API Client → Add API Client → Setup Display Name, Password and Select Your Organization → Roles → Select your Production / Sandbox Instance for Commerce Cloud Developer Experience and Salesforce Commerce API
Default Scopes
mail
roles
tenantFilter
profile
tenant
Filter
openId
Allowed Scopes
sfcc.shopper-customers.register
sfcc.shopper-customers.login
sfcc.products.rw
sfcc.catalogs.rw
Redirect URIs
http://localhost:8080
https://admin.us02.dx.commercecloud.salesforce.com/oauth2-redirect.html
https://your_admin_URL/on/demandware.store/Sites-Site/default/oauth-callback
Important Step: Your_admin_RedirectURL you will get it from Firework API Configuration Window:
To get the Redirect URL please navigate to Select Site, Merchant Tools → Manage Firework → Firework Dashboard
Token Endpoint Auth Method: private_key_jwt
Access Token Format: JWT
Once you click Save, it will generate the API Client ID and you need to remember the password you set during client Registration, we will need it for the next step.
Please Select Store and navigate to Merchant Tools → Site Preferences → Custom Site Preference Groups → fireworkDashboardConfig
Name | Value |
|---|---|
Firework API EndPoint URL | |
Firework Iframe URL | |
Currency | Your Store Currency |
Site Title | Your Store Title |
Provider | SALESFORCE |
Graphql Endpoint URL | |
Business Unique Id | Your Store Storefront URL |
Client Name | Salesforce Commerce Cloud |
Contact Email | Your Store Contact Email |
Please navigate to Select Site Merchant Tools → Manage Firework → Firework Dashboard
The ClientID and Password already obtained from the previous step will be used here.
Please navigate to Administration → Site Development → Salesforce Commerce API Settings
On the same page you see the Redirect URI, take the first part of the URL before .sandbox so in the above URL you can see zyei-002 is the ID so we convert that into tenant id like this zyei_002
Navigate to Merchant Tools → Manage Firework → Firework Dashboard
You will land on the Salesforce Product Feed / Import tool page
When you click Import you will get a list of all products from your salesforce store.
From here you can import products directly from your salesforce store to Firework business store.
Navigate to Merchant Tools → Content → Page Designer
Select your Page which you want to add Widget to
You can select the layout from the Firework Components
Select the Channel and Playlist from the Widget Settings
Click Save and Close, you can see the Carousel Widget added to the Page.
The Firework widgets, being asynchronous, gracefully degrades and don’t block the loading of any page element.
Last modified 6mo ago