Adding Pipelines to your Content Deployer

To complete the installation, update your Content Deployer configuration by loading a product Add-on to match the features you intend to use.

Procedure

  1. Choose a Content Deployer extension package and accompanying configuration file to download from the list below, and copy it to a folder of your choosing from the installation media folder indicated. The specific extension package you need depends on your setup:
    Basic mashup setup
    Description: Your setup combines Tridion Sites and Tridion Docs in a mashup, using neither Experience Optimization nor Context Expression Extension.
    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: udp-deployer-dx-extension-assembly-VERSION-search-config.json
    Mashup setup with Context Expression Extension added
    Description: Your setup combines Tridion Sites and Tridion Docs in a mashup, using the Context Expression Extension, but not Experience Optimization.
    Copy from folder: \Content Delivery\roles\expression\add-ons\
    ZIP file to copy: udp-cx-deployer-dx-extension-assembly-VERSION-search.zip
    JSON configuration file to copy: udp-cx-deployer-dx-extension-assembly-VERSION-search-config.json
    Basic Tridion Sites setup
    Description: Your setup runs Tridion Sites alone, and you use neither Experience Optimization nor the Context Expression Extension.
    Copy from folder: \Content Delivery\roles\deployer\add-ons\
    ZIP file to copy: udp-deployer-web-extension-assembly-VERSION-core.zip
    JSON configuration file to copy: None
    Tridion Sites setup with Experience Optimization added
    Description: Your setup runs Tridion Sites alone, and you use Experience Optimization but not the Context Expression Extension.
    Copy from folder: \Content Delivery\roles\xo\add-ons\
    ZIP file to copy: xo-deployer-extension-assembly-VERSION-core.zip
    JSON configuration file to copy: xo-deployer-extension-assembly-VERSION-core-config.json
    Tridion Sites setup with Context Expression Extension added
    In this setup, do not use the Add-on Service, but add Context Expression Extension by manually copying resources. Refer to the installation section for the Context Expression Extension for more information.
    Tridion Sites setup with Experience Optimization and Context Expression Extension added
    Description: Your setup runs Tridion Sites alone, and you use both Experience Optimization and the Context Expression Extension.
    Copy from folder: \Content Delivery\roles\xo\add-ons\
    ZIP file to copy: xo-deployer-cx-extension-assembly-VERSION-core.zip
    JSON configuration file to copy: xo-deployer-cx-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.

  2. Open the JSON configuration file you copied, if any, and edit it as follows:
    udp-deployer-dx-extension-assembly-VERSION-search-config.json
    • Replace the root-level string staging with a value that reflects the type of Content Delivery environment you are implementing. The value must be equal to the value of the cdenvironment environment variable on the machine on which the Content Deployer runs.
    • Replace QUERY_URL with the endpoint URL of the IQ Query Service.
    • Replace INDEX_URL with the endpoint URL of the IQ Index Service.
    • Replace DISCOVERY_URL with the endpoint URL of the Discovery Service.
    • Replace PASSWORD with a valid password to access the Discovery Service.
    • Modify any default values in this file as needed.
    udp-cx-deployer-dx-extension-assembly-VERSION-search-config.json
    • Replace the root-level string staging with a value that reflects the type of Content Delivery environment you are implementing. The value must be equal to the value of the cdenvironment environment variable on the machine on which the Content Deployer runs.
    • Replace QUERY_URL with the endpoint URL of the IQ Query Service.
    • Replace INDEX_URL with the endpoint URL of the IQ Index Service.
    • Replace DISCOVERY_URL with the endpoint URL of the Discovery Service.
    • Replace PASSWORD with a valid password to access the Discovery Service.
    • Modify any default values in this file as needed.
    xo-deployer-extension-assembly-VERSION-core-config.json
    • Replace the root-level string staging with a value that reflects the type of Content Delivery environment you are implementing. The value must be equal to the value of the cdenvironment environment variable on the machine on which the Content Deployer runs.
    • Replace ES_HOST with the host that runs your Elasticsearch instance.
    • Modify any default values in this file as needed.
    xo-deployer-cx-extension-assembly-VERSION-core-config.json
    • Replace the root-level string staging with a value that reflects the type of Content Delivery environment you are implementing. The value must be equal to the value of the cdenvironment environment variable on the machine on which the Content Deployer runs.
    • Replace ES_HOST with the host that runs your Elasticsearch instance.
    • Modify any default values in this file as needed.
  3. In Content Manager Explorer, select Add-ons from the slide-out navigation and from the Manager tab, upload the ZIP file you downloaded.
  4. If you copied a JSON configuration file, in the same screen, use the Add button in te Configuration area to also upload the JSON configuration file as a custom configuration for your Add-on.
  5. Restart your Content Deployer microservice.