Documentation Center

Dynamic Content Delivery configuration reference

The Content Delivery configuration file, cd_dynamic_conf.xml, maps Content Manager Publications to friendly URLs.

Overall structure of file

The file has the following basic structure:
<Configuration>
  <URLMappings>
    <StaticMappings>
      <Publications>
        <Publication>
          <Host/>
          ...
        </Publication>
        ...
      </Publications>
    </StaticMappings>
    <StorageMapping/>
  </URLMappings>
  <TCDLEngine>
    <DefaultTags/>
    <Properties>
      <Property/>
      ...
    </Properties>
    <Tags>
      <Tag>
        <Handler/>
        ...
      </Tag>
      ...     	
    </Tags>
    <TagBundle>
    ...
  </TCDLEngine>
  <WebCapability>
    <BaseURLs/>
    ...
    <Publications/>
    ...
  </WebCapability>
</Configuration>

Configuration root element

The root element has a required Version attribute that is to be set to the version of the file, that is, the Content Delivery version (without specifying a service pack), which is 12.0 in this release.

The file has the following subsections, each of which is optional:
  • URLMappings
  • TCDLEngine
  • WebCapability

URLMappings section

This section has an optional PathScanDepth attribute, which defines the deepest level at which the URI will be looked for. If omitted, this value defaults to 100. Any value lower than 1 will be considered as a value 1.

The section has two subsections: StaticMappings and StorageMappings.

The StaticMappings section contains a Publications subsection with 0 or more Publication elements in it.

Each Publication element has two attributes, both optional:
  • Id, to identify the Publication
  • NamespaceId, for the ID of a namespace that this Publication belongs to
Each Publication element also has one or more Host child elements with four attributes, all optional:
Attribute nameDescription of value
DomainThe domain name where the publication is hosted (say www.example.com or example.com)
PortThe port number of the host where the publication is hosted
ProtocolWhat protocol is used to access the publication (say http or https)
PathIf the publication is not hosted on the root path, then the relative path to the host should be specified

The second subsection, StorageMapping, has one attribute, IdentifyPublicationByProperty, which describes the property of the Publication object that can be used to identify the desired Publication.

TCDLEngine section

The second section, TCDLEngine, has the following child elements and child sections:
  • The optional DefaultTags child element specifies a default tags set through its Name attribute, which defaults to combined (meaning it can process both Tridion Sites and Tridion Docs content) if left unspecified. Other possible values are tcm (for Tridion Sites only) or ish (for Tridion Docs only).
  • The optional Properties child section defines one or more Property elements to configure supplementary property-value pairs to control code generation, specified in the Name and Value attributes.
  • The optional Tags child section defines one or more Tag elements each defining a tag and its handler. Each Tag element has:
    • Namespace and Name attributes
    • a Handler child element to specify its handler, with two attributes, a Class attribute for the Java class that implements the tag handler, and a Boolean AllowCodeBlock attribute to specify whether this tag should generate code start and end markers. Set this attribute to false if this tag generates code within a code block.
  • Zero or more TagBundle child elements to add the tags in a tag bundle to the TCDL Engine. A tag bundle is a JAR file containing a set of tags and a configuration file (specified in the Resource attribute) that defines the tags. The configuration file follows the same format as the TCDLEngine section here, except that it may only contain the Tags and Properties sections. The tag bundle JAR file and its configuration file must both be on the classpath.

WebCapability section

The third section, WebCapability, has 0 or more BaseURLs child elements, followed by 0 or more Publications elements.

The WebCapability element itself has an optional ContextPath attribute.

Each BaseURLs child element has the following attributes, all optional:
Attribute nameDescription of value
HostThe host name of the base URL
ProtocolThe protocol of the base URL (http or https)
PortThe port number of the base URL
Each Publications child element has the following attributes, all optional:
Attribute nameDescription of value
idThe unique identifier of this Publication
PathThe path to this Publication
NamespaceIdThe unique identifier of the namespace to which this Publication belongs