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
<Deployer>
<Queues>
<Queue/>
...
<Adapter/>
...
<Worker/>
<Queues>
<State>
<Storage>
<ExtendedProperties/>
</Storage>
</State>
<BinaryStorage/>
<RMIChannel/>
<Pipelines>
<Pipeline>
<Steps>
<Step/>
...
</Steps>
</Pipeline>
...
</Pipelines>
</Deployer>
Deployer root element
| Attribute name | Type | Required? | Description of value |
|---|---|---|---|
Version | string | The version of the file, that is, the Content Delivery version (without specifying a service pack), which is 12.0 in this release. | |
InProcessDeploy | Boolean | If set to true, the Content Deployer runs inside the microservice process; otherwise, it runs outside of it. | |
LegacyTransport | Boolean | If set to true, the Content Deployer accepts legacy transport. Defaults to false if omitted. |
Deployer, all optional, are:
Queueschild sectionStatechild sectionBinaryStoragechild sectionRMIChannelchild elementPipelineschild 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.
Queue section has the following attributes, all strings, for its Queue element:
| Attribute name | Required? | Description of value |
|---|---|---|
Id | The identifier of this queue | |
Verbs | The verbs applicable to this queue | |
Adapter | The identifier of the Adapter applicable to this queue | |
Default | Whether this queue is the default queue |
Queue section are:
| Property name | Description of value |
|---|---|
ReceiveTimeout | The number of milliseconds after which ActiveMQ stops waiting for more data. |
Cleanup | A Boolean indicating whether to clean up the folder with incoming deployment packages |
MaxRetries | The maximum number of times that the Content Deployer retries if the package failed |
MaxSize | The maximum size of a deployment package, in bytes |
PollingInterval | The interval (in milliseconds) used when polling |
RetriesInterval | The number of milliseconds to wait before retrying deployment |
Workers | The 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. |
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:
| Property | Description |
|---|---|
Destination | For a File System Adapter, the path to publish to |
JMSUri | For 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. |
Username | For a JMS queue Adapter, the name of a user who can access a remote Apache ActiveMQ server. |
Password | For 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
Storage child section, which has an Adapter attribute and a driver attribute. Storage has:
- any number of named properties, expressed through
Propertychild elements - an
ExtendedPropertieschild 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 throughPropertychild elements.
BinaryStorage child section
BinaryStorage element has:
- an
Idattribute to uniquely identify this storage - an
Adapterattribute
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.
Pipeline section has the following attributes, all required:
| Attribute name | Type | Description of value |
|---|---|---|
Action | string | The action (Deploy or Undeploy) that this pipeline should perform |
Verb | string | The verb associated with this pipeline, one of processing, commit or rollback |
Id | string | A unique identifier for this pipeline |
Finalize | Boolean | Whether to clean up the contents of your folder for incoming content, left behind after failed transactions. |
Step section has the following attributes, all required and all strings:
Factoryis 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.Idis a unique identifier for this pipeline, for example,FooDeployif the step deploys items of the item type "Foo".
Step section can have any number of child elements or child sections. Common child items are:
Modulesection-
This section has two required string attributes,
TypeandClass.Typeis a unique, symbolic identifier for this Module.Classdefines the Java class that implements the Module, for example, com.tridion.deployer.modules.PageDeploy. RetryPointelement-
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, andStepId, to specify the other step itself.
Module section and the RetryPoint element.