The Audience Manager Service is the endpoint for interacting with a Content Delivery environment. When upgrading to SDL Tridion Sites 9.5, you need to upgrade to a new version of the Audience Manager Service.
Before you begin
You must have a valid customer ID, as provided to you by RWS Customer Support.
About this task
You may want to add one or more parameters (without values, acting as Booleans) or parameter-value pairs to your installation script. To do so, edit the installation script to append them to your command in the form --PARAMETER or --PARAMETER=VALUE, where PARAMETER is the name of the parameter, and VALUE (when using) is the value you want to set it to. Alternatively, instead of editing the script, you can also enter them by hand on the command line.
You can install the microservice in one of the following ways:
-
As a Windows service
-
Choose this option for long-term use, say on a production system. The microservice continues to run when you close the PowerShell prompt, it can be stopped and restarted from the Windows Control Panel, and it outputs its log as a file. The installation script to use is installService.ps1.
-
As a standalone Windows process
-
Choose this option for short-term use, say on a test system. The microservice stops running when you close the PowerShell prompt and it outputs its log in the command prompt window. The installation script to use is start.ps1.
-
As a standalone Unix process
-
Choose this option if you are installing on a Unix-based operating system. The installation script to use is start.sh.
Procedure
- If the server on which this microservice is installed is a Windows machine, uninstall the Windows service by doing the following:
- On the server, open a Powershell command prompt.
- Access the bin\ subfolder of the microservice root folder.
- Run the script called uninstallService.ps1. (If you are running the service on a different default HTTP port than the default, add a
server.port parameter and set it to your custom port number.)
- On the server on which this microservice is installed, navigate to the configuration location of the microservice.
- Back up the contents of this folder to a safe location.
- Back up any custom microservice extensions you have created to a safe location.
- Delete all files and subfolders from the microservice location.
- Access your SDL Tridion Sites 9.5 installation media and locate the folder Audience Manager\roles\audience manager\standalone\.
- Copy the contents of the installation media folder, including subfolders, to your installed microservice location.
- For each of your configuration files, do one of the folllowing:
- If you have previously made changes to the file that you backed up, compare your backed-up version to the new version you just copied to the configuration location of the microservice, and merge your old file into the new file.
- Alternatively, if you have not changed your backed-up file, ignore it and use the new file instead.
- Restore any backed-up custom microservice extensions to your microservice.
- If the server on which this microservice is installed is a Windows machine, install the Windows service by doing the following:
- On the server, open a Powershell command prompt.
- Access the bin\ subfolder of the microservice root folder.
- Run the script called installService.ps1.
On a non-Windows machine, simply run the start script in the bin/ subdirectory.
- If you are running this microservice script on a machine on which the Discovery Service is also running (that is, if you are not in a scaled-out setup), pass a
DependsOn script parameter, set to the value TridionDiscoveryService.