Documentation Center

Dynamic Linking configuration reference

The Dynamic Linking configuration file, cd_link_conf.xml, specifies how to generate links dynamically.

Overall structure of file

The file has the following basic structure:
<Configuration>
  <Global>
    <RMIChannel/>
  </Global>
  <Publications>
    <Publication>
      <Host/>
      ...
      <Linking/>
    </Publication>
    ...
  </Publications>
</Configuration>

Configuration root element

The root element, Configuration, has a 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.

Within this element, there are two subsections: an optional Global section and a required Publications section.

Global section (optional)

This section, if present, contains only an RMIChannel element, which has one attribute: ListenerPort, a required attribute of type short, which specifies the RMI listener port.

Publications section

The Publications element has one attribute: OverrideDiscoveryService, an optional Boolean attribute that defaults to true. The attribute specifies whether the current linking configuration should override the Discovery Endpoint configuration. If set to true, all linking APIs return relative URLs only (without a host, port or protocol) and don't use any mappings from the Discovery Service.

The section can contain 0 or more Publication elements, to be used for Publication-specific locations for metadata, binaries and Pages.

Each Publication element has an optional Id attribute, an integer containing the unique ID of this Publication.

Publication can have one or more Host child elements, and, optionally, one Linking child element.

The Host child element has the following attributes, all optional:
Attribute nameTypeDefault valueDescription
DomainstringlocalhostThe domain of the host you are specifying.
Portshort80The port number of the host you are specifying. Ignored if Domain is empty.
ProtocolstringhttpThe protocol of the host you are specifying. If Domain is empty, any value other than file is ignored.
Pathstring(empty string)The path of the virtual directory of your website on the host you are specifying.
The Linking child element has the following attributes, all optional:
Attribute nameTypeDefault valueDescription
ComponentAnchorsBooleantrueIndicates if anchors should be added to Component links so that the browser jumps to the position of the targeted Component Presentation.
AddComponentLinkInfoBooleanfalseThe port number of the host you are specifying. Ignored if Domain is empty.