Rolling out your Content Deployer Extension

When you have tested and compiled the Java class for your Content Deployer Extension, add it as an Extension to your Add-on package.

Procedure

  1. Choose a Content Deployer extension package to download from the list below, and copy it from the installation media folder indicated to a folder of your choosing. The specific extension package you need depends on the setup you are running:
    Your setupFile to copy
    You are running SDL Tridion Sites alone, and you use neither Experience Optimization nor the Context Expression Extension.\Content Delivery\roles\deployer\add-ons\udp-deployer-dx-extension-assembly-VERSION-search.zip
    You are combining SDL Tridion Sites and SDL Tridion Docs in a mashup, using the Context Expression Extension, but not Experience Optimization.\Content Delivery\roles\expression\add-ons\udp-cx-deployer-dx-extension-assembly-VERSION-search.zip
    You are running SDL Tridion Docs alone.\Content Delivery\roles\deployer\add-ons\udp-deployer-ish-extension-assembly-VERSION-search.zip

    where VERSION is a string indicating the version and build number of the ZIP file at the time of release.

  2. Create a new folder on your system and unzip the ZIP file you downloaded to this new folder.
  3. Create a JAR file containing your compiled Java class, which implements an all-new custom Module or extends an existing Module. Also include any other Java classes you may have implemented to support your class.
  4. Add the resulting JAR file, plus any dependent JAR files (developed by your own organization or by third parties), to your new folder.
  5. Access the server on which your Content Deployer microservice runs, and in its config/ folder, open deployer-conf.xml for editing.
  6. Add Pipeline elements to the Pipelines section of the deployer-conf.xml file as needed, ensuring that theid attribute of each Pipeline element you add is unique and different from the id attribute of all Pipeline elements already present in deployer-conf.xml.
  7. If you have created an all-new custom Module for deployment or undeployment, find the Pipeline sections for the type of content that your custom Module deploys or undeploys. Within each of those Pipeline sections, add a new Step element as the last step (so that it is called after all other Steps have finished processing) that looks as follows:
    <Step Factory="com.sdl.delivery.deployer.steps.TridionExecutableStepFactory" Id="STEPID">
    	<Module Type="MODULETYPE" Class="CLASSNAME"/>
    </Step>
    where:
    • STEPID uniquely identifies this deployment or undeployment step
    • MODULETYPE is the simple Java class name of the Module you have built
    • CLASSNAME is the fully qualified Java class name of the Module you have built
  8. Alternatively, if you have extended an existing Module for deployment or undeployment, find the Pipeline sections that contain a Step element containing the existing Module you extended. Within each such Step element, in the Module subelement referencing the existing Module's Java class, replace the value of the Class element with the fully qualified classname of your own Java class. For example:
    <Module Type="ComponentDeploy" Class="CLASSNAME"/>

    where CLASSNAME is the fully qualified Java class name of the new Module class that you have built.

  9. If your Module class uses a custom configuration, add that configuration in the form of one or more subelements within the Module element. In the following example, the Module has an AppInstance configuration subelement to identify which instance of the Module this is.
    <Module Type="MODULETYPE" Class="CLASSNAME">
      <AppInstance>default</AppInstance>
    </Module>
  10. Save your changes to deployer-conf.xml.
  11. In the new folder, open the extension package manifest file manifest.json for editing.
  12. Increase the value of the version property.
  13. Set the value of the author property to your name.
  14. Update the value of the description property to include a description of the functionality you are adding.
  15. Save your changes to manifest.json.
  16. Zip your resources back into a ZIP package. Give it the same name as the ZIP file in step 1, but with VERSION set to the new value of the version property in manifest.json.
  17. In Content Manager Explorer, select Add-ons from the slide-out navigation and from the Manager tab, upload your new ZIP file.
  18. Restart your Content Deployer microservice.