Documentation Center

Content Deployer endpoint configuration reference

The Content Deployer configuration file, deployer-conf.xml, configures the behavior of the Content Deployer endpoint.

Overall structure of file

The file has the following basic structure:
<Deployer>
  <Queues>
    <Queue/>
    ...
    <Adapter/>
    ...
    <Worker/>
  <Queues>
  <State>
    <Storage>
      <ExtendedProperties/>
    </Storage>
  </State>
  <BinaryStorage/>
  <RMIChannel/>
  <Pipelines>
    <Pipeline>
      <Steps>
        <Step/>
        ...
      </Steps>
    </Pipeline>
    ...
  </Pipelines>
</Deployer>

Deployer root element

The root element has the following attributes:
Attribute nameTypeRequired?Description of value
VersionstringyesThe version of the file, that is, the Content Delivery version (without specifying a service pack), which is 12.0 in this release.
InProcessDeployBooleannoIf set to true, the Content Deployer runs inside the microservice process; otherwise, it runs outside of it.
LegacyTransportBooleannoIf set to true, the Content Deployer accepts legacy transport. Defaults to false if omitted.
The child elements and sections of Deployer, all optional, are:
  • Queues child section
  • State child section
  • BinaryStorage child section
  • RMIChannel child element
  • Pipelines child section

Queues child section

The configuration of Content Deployer queues. This section contains one or more Queue sections, followed by one or more Adapter sections, followed by a Worker section.

Each of these child sections can contain any number of Property elements with Name and Value child elements, to represent named properties and their values.

A Queue section has the following attributes, all strings, for its Queue element:
Attribute nameRequired?Description of value
IdyesThe identifier of this queue
VerbsyesThe verbs applicable to this queue
AdapteryesThe identifier of the Adapter applicable to this queue
DefaultnoWhether this queue is the default queue
The named properties of the Queue section are:
Property nameDescription of value
ReceiveTimeoutThe number of milliseconds after which ActiveMQ stops waiting for more data.
CleanupA Boolean indicating whether to clean up the folder with incoming deployment packages
MaxRetriesThe maximum number of times that the Content Deployer retries if the package failed
MaxSizeThe maximum size of a deployment package, in bytes
PollingIntervalThe interval (in milliseconds) used when polling
RetriesIntervalThe number of milliseconds to wait before retrying deployment
WorkersThe maximum number of threads that the Content Deployer starts in order to process incoming packages. If your database pool configuration in the Storage Layer configuration file has the type tridion, this number must be lower than, or equal to, the pool size configured in the Storage Layer configuration. If left unspecified, the number of workers per queue defaults to 10.
An Adapter section has an Id attribute for the unique identifier for this Adapter, for example, FileSystem or JMS. The named properties of the Adapter section are:
PropertyDescription
DestinationFor a File System Adapter, the path to publish to
JMSUriFor a JMS queue Adapter, the full URI of the Apache ActiveMQ server, in the format tcp://AMHOST:AMPORT, where AMHOST is the host name, and AMPORT the port number, of the Apache ActiveMQ server.
UsernameFor a JMS queue Adapter, the name of a user who can access a remote Apache ActiveMQ server.
PasswordFor a JMS queue Adapter, a valid password for the user listed under Username

The Worker section has no attributes and no out-of-the-box named properties.

State child section

This section configures the State Store database through its Storage child section, which has an Adapter attribute and a driver attribute. Storage has:
  • any number of named properties, expressed through Property child elements
  • an ExtendedProperties child section, which expands characteristics for a JDBC connection. These properties are added to the end of the full JDBC URL for possible database-specific tuning. This section contains any number of named properties, expressed through Property child elements.

BinaryStorage child section

This section configures binary storage. The BinaryStorage element has:
  • an Id attribute to uniquely identify this storage
  • an Adapter attribute

You can also set one named property, Path, to set to the path to the location where incoming deployment packages arrive.

RMIChannel child element

This element lets you configure the port of the RMI channel through the ListenerPort attribute, of type short.

Pipelines child section

This section lets you configure the Content Deployer pipelines in zero or more Pipeline sections. Each Pipeline section contains a Steps section with zero or more Step sections for the steps of that pipeline.

A Pipeline section has the following attributes, all required:
Attribute nameTypeDescription of value
ActionstringThe action (Deploy or Undeploy) that this pipeline should perform
VerbstringThe verb associated with this pipeline, one of processing, commit or rollback
IdstringA unique identifier for this pipeline
FinalizeBooleanWhether to clean up the contents of your folder for incoming content, left behind after failed transactions.
A Step section has the following attributes, all required and all strings:
  • Factory is the fully qualified class name of the Factory that implements this step. If you are implementing Tridion Sites, this attribute must always be set to the value com.sdl.delivery.deployer.steps.TridionExecutableStepFactory.
  • Id is a unique identifier for this pipeline, for example, FooDeploy if the step deploys items of the item type "Foo".
A Step section can have any number of child elements or child sections. Common child items are:
Module section
This section has two required string attributes, Type and Class. Type is a unique, symbolic identifier for this Module. Class defines the Java class that implements the Module, for example, com.tridion.deployer.modules.PageDeploy.
Module, like its parent Step element, can have any number of child elements or child sections. A common child item is Transformer, whose Class attribute is set to the class that implements the transformation, say, com.tridion.deployer.TCDLTransformer.
RetryPoint element
This element specifies an instruction to retry if the step raises an exception, either to retry the step itself, or to try another step (possibly in another pipeline). If you want configure another step than this one, you configure the two optional attributes: PipelineId, to specify the pipeline of the other step to try, and StepId, to specify the other step itself.
the Module section and the RetryPoint element.