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
<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.
URLMappingsTCDLEngineWebCapability
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.
Publication element has two attributes, both optional:
Id, to identify the PublicationNamespaceId, for the ID of a namespace that this Publication belongs to
Publication element also has one or more Host child elements with four attributes, all optional:
| Attribute name | Description of value |
|---|---|
Domain | The domain name where the publication is hosted (say www.example.com or example.com) |
Port | The port number of the host where the publication is hosted |
Protocol | What protocol is used to access the publication (say http or https) |
Path | If 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
TCDLEngine, has the following child elements and child sections:
- The optional
DefaultTagschild element specifies a default tags set through itsNameattribute, which defaults tocombined(meaning it can process both Tridion Sites and Tridion Docs content) if left unspecified. Other possible values aretcm(for Tridion Sites only) orish(for Tridion Docs only). - The optional
Propertieschild section defines one or morePropertyelements to configure supplementary property-value pairs to control code generation, specified in theNameandValueattributes. - The optional
Tagschild section defines one or moreTagelements each defining a tag and its handler. EachTagelement has:NamespaceandNameattributes- a
Handlerchild element to specify its handler, with two attributes, aClassattribute for the Java class that implements the tag handler, and a BooleanAllowCodeBlockattribute to specify whether this tag should generate code start and end markers. Set this attribute tofalseif this tag generates code within a code block.
- Zero or more
TagBundlechild 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 theResourceattribute) that defines the tags. The configuration file follows the same format as theTCDLEnginesection here, except that it may only contain theTagsandPropertiessections. 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.
BaseURLs child element has the following attributes, all optional:
| Attribute name | Description of value |
|---|---|
Host | The host name of the base URL |
Protocol | The protocol of the base URL (http or https) |
Port | The port number of the base URL |
Publications child element has the following attributes, all optional:
| Attribute name | Description of value |
|---|---|
id | The unique identifier of this Publication |
Path | The path to this Publication |
NamespaceId | The unique identifier of the namespace to which this Publication belongs |