SFCC services.xml Generator — B2C Commerce
Skip to main content
Dev Toolkitby salesforceapp.tech

App

🕐History⚙️Settings1d

services.xml Generator

Build SFCC services.xml with linked services, profiles, and credentials. Cross-link validation surfaces missing references before import.

Services

Profiles

Credentials

All references resolved — XML ready

services.xml
<?xml version="1.0" encoding="UTF-8"?>
<services xmlns="http://www.demandware.com/xml/impex/services/2014-09-26">
    <service service-id="orders.api">
        <profile>orders.profile</profile>
        <credential>orders.cred</credential>
        <type>HTTP</type>
        <enabled>true</enabled>
        <log-name-prefix>orders</log-name-prefix>
        <comm-log-enabled>true</comm-log-enabled>
    </service>
    <profile profile-id="orders.profile">
        <timeout-conn>5000</timeout-conn>
        <timeout-read>10000</timeout-read>
        <cb-enabled>true</cb-enabled>
        <cb-calls>5</cb-calls>
        <cb-interval>60</cb-interval>
    </profile>
    <credential credential-id="orders.cred">
        <url>https://api.example.com/orders</url>
        <user>svc</user>
    </credential>
</services>

About services.xml Generator

Build SFCC services.xml with linked services, profiles, and credentials. The generator validates cross-references (a service referencing a non-existent profile is a silent runtime error) and checks timeout ranges before generating the XML.

Pipeline

Frequently asked

What is services.xml in SFCC?
services.xml declares the web service integrations your cartridge uses — HTTP, SOAP, FTP, Mail, and Generic services. Each service entry references a profile (timeout and circuit breaker settings) and a credential (URL and authentication). Business Manager reads this file to populate the Services configuration UI.
What is the difference between a service, profile, and credential?
A service is the logical integration point (e.g. "orders.api"). A profile defines non-functional behaviour: connection timeout, read timeout, circuit breaker thresholds, and rate limits. A credential holds the endpoint URL and authentication details. The three-way split lets you reuse profiles across services and rotate credentials without changing service definitions.
What is the circuit breaker?
The circuit breaker prevents cascading failures. When a service fails more than cbCalls times within cbInterval seconds, the circuit opens and subsequent calls fail immediately without hitting the external endpoint. This protects your storefront from slow or unavailable third-party services. The circuit resets automatically after the interval.
Should I put real credentials in services.xml?
No. services.xml is committed to source control and deployed with your cartridge. Use placeholder values in the file and override them in Business Manager > Administration > Operations > Services after deployment. The BM values take precedence over the XML values.
How do I import services.xml?
Place it at sites/site_template/services.xml inside a site archive, then import via Business Manager or the SFCC CLI. Alternatively, configure services directly in BM without importing XML.