Setting up your upgraded Content Deployer for your situation

If you upgrade your Content Deployer using the resources in the deployer/deployer/ folder, you will need to set up or update your Content Deployer for the specific products and product features you have set up. To do this, you must add an Add-on to your Content Deployer.

Procedure

  1. If you are upgrading from SDL Tridion Sites 9.1 or higher, do the following:
    1. In Content Manager Explorer, select Add-ons.
    2. If you have customized your Content Deployer by adding one or more custom Content Deployer extension of your own, download your Content Deployer Add-on by selecting it in the Manage tab and downloading its zip file by selecting Download.
    3. Select your Content Deployer Add-on in the Manage tab and select Remove to remove it from your system.
  2. Based on your preferred setup, choose a Content Deployer extension package to download from the list below, and copy it to a folder of your choosing from the installation media folder indicated. If you want to override any of your configured settings, also copy the JSON configuration file, located in the same folder. The supported setups are:
    Basic mashup setup
    Description: Your setup combines Tridion Sites and Tridion Docs in a mashup, and you are not using Experience Optimization.
    Copy from folder: \Content Delivery\roles\deployer\add-ons\
    ZIP file to copy: udp-deployer-dx-extension-assembly-VERSION-search.zip
    JSON configuration file to copy (optional): udp-deployer-dx-extension-assembly-VERSION-search-config.json
    Basic Tridion Sites setup
    Description: Your setup runs Tridion Sites alone, and you are not using Experience Optimization.
    Copy from folder: \Content Delivery\roles\deployer\add-ons\
    ZIP file to copy: udp-deployer-web-extension-assembly-VERSION-search.zip
    JSON configuration file to copy (optional): udp-deployer-web-extension-assembly-VERSION-search-config.json
    Tridion Sites setup with Experience Optimization added
    Description: Your setup runs Tridion Sites alone, and you are using Experience Optimization.
    Copy from folder: \Content Delivery\roles\xo\add-on\
    ZIP file to copy: xo-deployer-extension-assembly-VERSION-core.zip
    JSON configuration file to copy (optional): xo-deployer-extension-assembly-VERSION-core-config.json

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

  3. If you copied a JSON configuration file, modify any default values in this file as needed, and remove all other configuration settings.
  4. If you are upgrading from SDL Tridion Sites 9.1, and if you downloaded you old Add-on, do the following:
    1. Unzip the zipfile of your old Add-on to a folder of your choice.
    2. Unzip the zipfile of your new Add-on, which you just copied from the installation media, to another folder of your choice.
    3. Copy any JAR files representing your custom Content Deployer extension(s) from your old Add-on folder to your new Add-on folder.
    4. Open the deployer-conf.xml file in your old Add-on.
    5. Copy any changes you made in that file for the sake of your custom Content Deployer extension(s), and paste them into the deployer-conf.xml file of your new Add-on. These changes may include custom Step elements, and custom or modified Module elements.
    6. Open the manifest.json file in your old Add-on.
    7. Copy the values of the author and description properties from that file into the manifest.json file of your new Add-on.
    8. In the manifest.json file of your new Add-on, also increase the value of its version property.
    9. Save and close all modified files.
    10. Zip the folder representing your new Add-on to create an updated zip file.
  5. In Content Manager Explorer, select Add-ons from the slide-out navigation and from the Manager tab, upload the ZIP file you downloaded.
  6. If you also downloaded and modified the JSON configuration file, then in the same screen, use the Add button in the Configuration area to also upload the JSON configuration file as a custom configuration for your Add-on.
  7. Restart your Content Deployer microservice.