Documentation Center

Mergeable Configuration Extension

Use a Mergeable Configuration Extension to merge your own custom Content Delivery configuration with a corresponding default Content Delivery configuration file. Note that you don't need to use this Extension to add Pipeline elements to the Content Deployer configuration file, deployer-conf.xml: you can already do so in the Content Deployer Extension.

A Mergeable Configuration Extension is configured as follows in the extensions array in your Add-on manifest file:
{
  "type": "CDMergeableConfigurationExtension",
  "name":"EXTENSIONNAME",
  "supportedVersions":"11.5.0.0",
  "properties": {
    "entryPoint": "com.sdl.delivery.service.extension.impl.CDMergeableConfigurationActivator",
    "loadingPhase": "BEFORE_APP_INITIALIZED",
    "configurationSources": [
      {
        "name": "MERGENAME",
        "type": "mergeableconfig",
        "properties": {
          "OriginalConfigFile": "DEFAULTCONFIGFILE",
          "ExtensionConfigFile": "CUSTOMCONFIGFILE"
        }
      }
    ],
    "capabilities": ["CAPABILITYNAME"]
  }
}
where:
  • EXTENSIONNAME is the unique name you want to give to this Extension
  • configurationSources is an array of configuration merges (you can configure multiple merges in one Extension)
  • MERGECHANGE is the unique name you want to give to one merge
  • DEFAULTCONFIGFILE is the name of a default Content Delivery configuration file, for example, tcdl-conf.xml or cd_ambient_conf.xml
  • CUSTOMCONFIGFILE is the name of the file containing your custom Content Delivery configuration, for example, my-tcdl-conf.xml or my_cd_ambient_conf.xml. This file must be a well-formed XML file, but it does not need to validate against its schema. Rather, it can contain only the elements you want to add, contained in otherwise empty sections. You must add this file to the Add-on package.
  • CAPABILITYNAME is the Content Delivery Capability you want to merge configurations with, either ContentServiceCapability if you want to merge a configuration file of the Content Service, or DeployerCapability if you want to merge a configuration file of the Content Deployer. To merge both, set capabilities to the value ["DeployerCapability", "ContentServiceCapability"] instead.

When the Add-on containing this Extension is loaded, the contents of your custom configuration file is merged with the default configuration file.