Upgrading Curator 3.3.1 to 3.4

Updated on December 10th, 2022

This section will assist you in upgrading from an existing Curator 3.3.1 system to the Curator 3.4 software release.

Services and applications in white below have a new version. Those in grey have not received an upgrade between these releases:

Service Previous Version - 3.3.1 Current Version - 3.4 
Analytics 1.1.1.7 1.2.1.2 (Hotfix, replaces 1.1.1.7) 
Curator Server 4.0.1.177 (HotFix, replaces 4.0.1.151) 4.0.1.185 (HotFix, replaces 4.0.1.177)
Curator Media Agent 1.1.1.7 1.1.1.9 (Hotfix, replaces 1.1.1.7)  
Device Director 5.17.1.39 5.18.1.68 (Hotfix, replaces 5.18.1.61)
Licence Manager 1.7.1.13 1.7.1.13
Metadata Central Teragator (optional) - 2.0.4
Process Engine 2.16.1.23 2.17.1.43 (Hotfix, replaces 2.17.1.30)
Workflow Agent (optional) - 1.0.1.15
XChange Manager 2.6.1.76 2.6.1.76
XCode 4.0.1.81 4.0.1.81
XFer 2.13.1.17 2.13.1.24 (HotFix replaces 2.13.1.18)
Application Previous Version - 3.3.1 Current Version - 3.4 
Curator Clip Link 3.2.1.67 (Hotfix, replaces 3.2.1.45) 3.2.1.67
Curator Clip Select 2.13.1.29 (HotFix, replaces 2.13.1.21) 2.13.1.29 (Hotfix, replaces 2.13.1.21)
Curator File Service 1.0.1.100 1.1.1.34 (HotFix, replaces 1.0.1.100)
Curator Gateway 1.5.1.156 (Hotfix, replaces 1.5.1.151) 1.5.1.156 (Hotfix, replaces 1.5.1.151)
Curator Logger 2.2.1.43 2.3.1.67 (Hotfix, replaces 2.3.1.55)
Curator System Administrator 1.6.1.93 1.6.1.93
Curator Connect 1.6.1.42 (PC) 1.6.1.45 (Mac) 1.6.1.42 (PC) 1.6.1.45 (Mac)
IPV Curator For Adobe 3.1.1.23 (PC) \ 3.1.17 (Mac) (Hotfix, replaces 3.1.1.20 \ 3.1.15) 3.2.1.11 (Win) \ 3.2.14 (Mac)(HotFix, replaces 3.2.1.9 \ 3.2.13)



Upgrading Software

Backups

Databases

Open MySQL Workbench

Open Data Export panel Under Server, open a Data Export tab:

Tick Objects to Export

Tick all three options under Objects to Export:

  • Dump Stored Procedures and Functions
  • Dump Events
  • Dump Triggers

Set Export Options Under Export Options, choose Export to Self-Contained File:

Export curatordb Under Tables to Export, tick curatordb only:

Set the export path and filename under Export Options:
Click Start Export and confirm the export is successful:

Export device director Under Tables to Export, tick devicedirector only:

Set the export path and filename under Export Options:
Click Start Export and confirm the export is successful:

Export process engine Under Tables to Export, tick processengine only:
Set the export path and filename under Export Options:
Click Start Export and confirm the export is successful:
Delete

Solr Directory

Navigate to Solr Folder

As part of the backup process with regards to Curator services, it is recommended to make a backup of the Solr folder structure in the event of needing to roll back. 

Note: This is a manual step and should only be attempted when the Curator Server Service has been stopped, making a backup copy while it is running may lead to corruption of the copied database.

By default, the Solr folder to copy is found here: C:\Program Files\IPV\Curator\Server\Solr\server\


Back up Solr Folder Copy and Paste the entire Solr folder into the same folder with other backups. 
Delete

Workflows

Open Process Designer

Select Bulk Export Under File, select Bulk Export:

Set Export Directory Enter a suitable output path.
Do not use the Browse button.
Copy and paste a path into the box:
Please note: Files are saved individually, not in a packaged zip.

Click All and Export

Confirm Successful Export

Check the output folder for the saved xml files:

When finished, click the X in the top right of the confirmation dialog box:
Delete

Plugins

Browse to Curator Server Installation

Copy Config Folder Copy the entire Config folder to a safe location.

Copy Options Folder Copy the entire Options folder to a safe location.

Browse to Clip Link Folder

Copy Plugins Folder

Copy the entire Plugins folder to a safe location.


Browse to Clip Select Folder

Browse to:

%ROOT_TO_INETPUB%\inetpub\wwwroot\CuratorClipSelect  


Make a Copy of Plugins Folder Copy the entire Plugins folder to a safe location.
Delete

Content Images

Browse to Clip Link Folder

Open the Content Folder

Copy the Pinned Searches Folder Copy the entire PinnedSearches folder to a safe location.
Delete

Config Files

Curator Server Config Under Curator Server's install directory, make a copy of the Config folder and Services.CuratorServer.Hosts.WindowsService.exe.Config files.

Device Director Config Under Device Director's install directory, make a copy of the Services.XCodeManager.Hosts.WindowsService.exe.Config file.

Process Engine Config Under Process Engine's install directory, make a copy of the Services.ProcessEngine.Hosts.WindowsService.exe.Config file.

Curator Clip Link Config Under Clip Link's install directory, make a copy of the Web.config file.

Curator Clip Select Config Under Clip Select's install directory, make a copy of the Web.config file

Curator Gateway appsettings.json JSON file Under Curator Gateways install directory, make a copy of the appsettings.json file.

Curator Logger Config If Curator Logger is installed, under its install directory, make a copy of the Web.config file.
Delete

Resources

Browse to Curator Folder Share Browse to the Curator Folder Share created by Process Engine during initial setup:

Make a copy of the Resources Folder Make a copy of the entire Resources folder:
Delete


Services

Prerequisites


Note: Yellow-labeled prerequisites denote previously installed prerequisites from 3.3.1.
Green-labeled prerequisites are new for Curator 3.4.
 
File Service storage considerations The Hotfix File Service version 1.1.1.34 is capable of delivery of High Resolution files from a broad range of locations, but some specific prerequisites remain. Please read this article to ensure the correct Curator File Server storage method is set in order to allow users to have access to all assets including High Resolution files. 
SSL Certificate An SSL Certificate is required by default for Curator Server and should be acquired and installed before continuing.
.NET 4.7.2

dotNET 4.7 is required for certain Curator Services and Applications. If not already installed by default on the system, Windows 2016 Servers and earlier will not have it by default - download it and install it from Microsoft's website.

VC Runtimes

The Microsoft Visual C++ Runtime libraries are required. Download and run the installers using the links below and accept default settings.

Visual Studio 2013 C++ Redistributable can be downloaded from Microsoft's Website.

Visual Studio 2015-2019 C++ Redistributable can be downloaded from Microsoft's Website.

QuickTime

Only install Apple's ProRes codecs if the system needs to support ProRes material - this is an optional component.

The ProRes codecs are included as "QuickTime Essentials" within the QuickTime installer from Apple's Website.

Install IIS

Click Install IIS to look at a detailed install guide if required.

IIS (Internet Information Services) is a webserver which can be selected as a Server Role in the OS Server Manager.

Add all dot net options to the default features and select all the Application Development options under Role Services when prompted.

WebDeploy 3.6

WebDeploy is an IIS tool that enables Curator Web applications to be easily imported into the webserver.

Download the 64-bit installer from Microsoft's official website.

Note: You may already have WebDeploy installed as part of your previous install.
Please ensure you have upgraded to version 3.6 Refer to the guide here on how to upgrade if necessary.

URL Rewrite Module

URL Rewrite is a module for IIS

Download an installer from Microsoft's Website.

Install ASP dotNET Core Runtime

Runtime version .Net Core 3.1 and .Net Core 5.0 (new) are required support for Curator Gateway. Download the installers from Microsoft's Website.  

Java

Java provides features to the Curator Server Service and is required for services with Neo4j databases. Metadata Central Teragator has a new Java 11 version requirement.

Click here to view the recommended Java options.

MySQL

Some IPV Services require the MySQL relational database.

Download the installer from MySQL's Official Website.

Neo4j

The Neo4J is required in specific versions by these services:

- for Analytics Service 1.2.1.2 recommended update to Neo4j 4.4 
for Metadata Central Teragator 2.0.4 is new: Neo4J 4.3/4.4

See Neo4J for installation and upgrade details. Download the Community version zip file from Neo4j's website.

GhostScript Ghostscript is a standalone installer required for creating thumbnail previews of graphic files, providing support for .ai,  .eps and .psd files. Download version 9.25 from Ghostscripts github. 
Install Erlang First, install Erlang on the server where Curator Server is going to be installed. Refer to the guide below for RabbitMq, which includes both Erlang and RabbitMq.
Install RabbitMq 

Install RabbitMq on the server where Curator Server is going to be installed. Refer to the guide here.
Delete

Curator Server - in Curator 3.3.1 updated to HotFix 4.0.1.151 

Required Prerequisites

SSL Certificate
Erlang and RabbitMQ
- Net Framework 4.6.2
- MySQL 5.7 & Workbench 6.3.9 Minimum
- OpenJDK/ Eclipse or Amazon Corretto
- Curator Server upgraded to 4.0.1.151 (HotFix for 3.3.1)  and service started to complete database operations 


Run Installer

Accept Licence Agreement

Set Service Account Choose the Service Account option and enter valid credentials for a user with local administrative rights.
Click Test Credentials, and after confirming your details, click Next:

Enter MySQL Details

Click Test Connection:

A dialog box will appear confirming if the credentials are valid:

If the MySQL Dump Fullpath field is not already configured as shown in the screenshots, find the MySQL installation directory and the mysqldump.exe file under the Bin folder.

After confirming valid details, click Next:



Enter RabbitMq details Then click Next.

Set Install Directory

Set Logging Level

Configuration Details

Note: Do not change the Solr core configuration. Solr is installed alongside Curator Server.

Enter an SSL certificate thumbprint for setting up HTTPS connectivity.

For finding a Certificate thumbprint, click here.

Change the Curator Gateway host with the IIS hosts FQDN/IP.

Replace:

https://localhost/CuratorGateway 

With:

https://IIS_HOST/CuratorGateway 


Click Install

Click Finish
Delete

Analytics Service


Delete

Curator File Service


Delete

Device Director

Required Prerequisites Device Director requires the following prerequisites:

Run Installer

Accept Licence Agreement


Set Service Logon Account

Specify logon details for a service account here. This can be left as Local System and changed to a user with sufficient access rights later:

Enter and confirm  MySQL details Enter your MySQL database details: Host, Username, and Password. The default schema name of devicedirector will be created when the Device Director Service starts.
Enter the relevant details where appropriate and click Test Connection, if valid:Proceed to the next step:

If the connection fails, check for errors and confirm the login details with the client and/or IPV (The login details or the MySQL database were created during the Prerequisites install stage).

Set Gateway Host

Change the Curator Gateway host with the IIS host FQDN/IP.

Replace:

https://localhost/CuratorGateway 

With:

https://IIS_HOST/CuratorGateway

Client ID for IPV Device Director Service and Client Secret for IPV Device Director Service can be left blank. 


Choose Installation Destination


Set Logging Options

Click Install

Restart Services Prompt A prompt may appear to close MySQL, SpectreView Server and Licence Manager for updates. It is not necessary to close the application at this time, but this is advised:

Click Finish
Delete

(Optional) Metadata Central Teragator


Delete

Process Engine Service

Required Prerequisites Process Engine Service requires the following Prerequisites:

Note on post-installation optional configuration: In extremely overloaded systems, PE Service 2.17.1.30, due to its increased processing speed, may bring about the risk of occasional failures in database updates and as a result even occasional failed workflows. If failures should occur in a system, it would be necessary to reduce the maximum concurrent workload by reducing the maximum number of simultaneous workflows run via the Process Engine Monitor website e.g. the MaxIngestProcesses number configured within the XCHANGEMANAGER-INGEST-TO-CURATOR MediaStore for watch folder ingest. 

Run Installer

Accept Licence Agreement


Set Service Logon Account

Specify logon details for a service account here. This can be left as Local System and changed to a user with sufficient access rights later:

Enter MySQL Details


Set Curator Gateway Host

Change the Curator Gateway host with the IIS hosts FQDN/IP.

Replace:

https://localhost/CuratorGateway 

With:

https://IIS_HOST/CuratorGateway 


Choose Installation Destination


Set Logging Options

Click Install

Click Finish
Delete

Process Engine Agent


Delete

Process Designer

Required Prerequisites Process Designer requires the following Prerequisites.

Run the Process Designer installer and click Next

Accept the licence terms and click Next

Enter Process Engine Service Host If the Process Designer is being installed on the same host as the Process Engine Service, localhost will connect.

Choose the log location and click Next

Set logging options and click Next

Click Install

Click Finish
Delete

(Optional) Workflow Agent


Delete

XFer

Required Prerequisites XFer requires the following Prerequisites.


Run Installer

Accept Licence Agreement

Set Logon details

Click Next

Edit logging configuration

Click Install

Click Finish
Delete


Websites and Applications

Websites

Delete Application and Content Right-click on the application. Under Deploy, click the Delete Application and Content option: 
Click OK to the following prompt:

If prompted for recycling content, click OK.

Import Application

Remove and Import the following applications:

  • Curator Clip Link
  • Curator Logger
  • Device Director Website
  • Process Engine Monitor

For a reminder on how to import applications in IIS, click here.

Delete

Curator for Adobe

Required Prerequisites Curator for Adobe 3.2 requires Adobe Creative Cloud 2021 or newer, including AME.
Curator for Adobe is compatible with Illustrator 2022 v26 and 2021 v25.3.1 and earlier only.

On installation of Curator 3.4, you must deploy or update Curator for Adobe to version 3.2 to users' machines to take advantage of the now default method of authentication via opening a browser page (Authentication Code). If an upgrade of Curator for Adobe above version 3.0 is not possible at this time then client authentication grant types should be manually changed from Authentication Code to Implicit for the application. To do this, go to Curator Gateway>Authentication>Clients and update all Curator for Adobe clients, with the exception of Curator for Adobe Importer/Exporter. Please check to ensure this has been changed on upgrade, updating these manually if necessary.

When using the Curator for Adobe panel with Mac OS on M1 /ARM architecture, Rosetta must be used. Please see this article for further information.
 
For use of remote AME with Curator, you need to deploy AME Win Service on the server. For details see the AME section of the New System Deployment linked from the Curator version main installation page; e.g. expand AME on this page for Curator 3.4.

Run Installer

Note: If upgrading from any previous release of this product on a PC, please uninstall the previous release and check that the following folder locations are empty before attempting to install this version:
- C:\Program Files\Adobe\Common\Plug-ins\7.0\MediaCore
C:\Program Files\IPV\IPV Curator For Adobe\ 
Also delete: C:\Users[user]\AppData\Roaming\IPV\Premiere Extensions\IPVExtension.config.json
This will ensure correct installation, especially of the correct importer and exporter components (which cannot be directly visually verified)


Accept Licence Agreement

Click Install

Click Finish
Note: If you're attempting to use Adobe 2021 and experiencing login issues, you may need to move the Access-Control-Allow-Origin HTTP Response header from the IIS Default Website to your virtual proxy directory. If the virtual proxy directory does not exist or is hosted in AWS, remove the HTTP Response header and re-attempt login. 

Open Specific Adobe Product Configure Gateway host through the cog wheel (as demonstrated in the below Curator Connect configuration steps). This applies to Adobe Premiere Pro, Photoshop, Illustrator, and others.
Delete




Configuration Overview

Curator File Service Configuration


Start Services

Setting Service Account Ensure that all Curator Services are set to run as the previously configured values prior to upgrade.

Start Curator Server

If you haven't already, start the Curator Server.

Start Device Director Service If you haven't already, start the Device Director Service.

Start XCode Service If you haven't already, start your XCode Services.

Start Xfer Service If you haven't already, start the Xfer Service.
Delete

Configuration Overview

Process Engine Setup

Start Process Engine Service

In the services panel, start the IPV Process Engine Service if it has not already been started.

Start Process Engine Agent Service In the services panel, start the IPV Process Engine Agent service if it has not already been started.

Browse to Process Engine Monitor Modules Webpage

Browse to:

http://localhost/ProcessEngineMonitor/Modules 


Click Choose file Click Open.

Open new Workflow Module

Browse to the Process Engine install directory and select the corresponding version package:

%INSTALL_PATH%\Program Files\IPV\Process Engine Service\BundledModules\Workflows-Core-3.3.0.5.zip


Click Install Click Install, and a System Setup workflow will start:

From the Modules screen, click "Choose File" 

Choose the appropriate Adobe workflow zip file, then click Open:


Click Install

Confirm Successful System Setup A System Setup workflow will start:

Confirm Updated Module Version Numbers

Confirm GLOBAL MediaStore settings Browse to the MediaStores tab, select the GLOBAL MediaStore and check the key FileTypesImage to make sure that the values include ai and psd. If not, manually add these values.
Delete

Websites Config

Curator Service Administrator Config

Modify the Curator Service Administrator web.config (if needed)

Additional web.config modification is needed in systems running Curator 3.4 or newer with CSA version 1.6 where the TSL1 has been removed as is possible from Curator 3.4 onwards. This will be automatically set from CSA 2.0 (scheduled for Curator 3.6)

The CSA 1.6 web.config needs to be modified where TSL1 is not available. You will need to add the following two lines to the CSA web.config file:

<add key="AppContext.SetSwitch:Switch.System.Net.DontEnableSchUseStrongCrypto" value="false" />

<add key="AppContext.SetSwitch:Switch.System.Net.DontEnableSystemDefaultTlsVersions" value="false" />

Delete

Curator Clip Link Config

Open web.config in text editor On the IIS server, open IIS manager and browse to the Curator Clip Link directory by right-clicking and  selecting the Explore option:  
Open the web.config file in a text editor.

Update Delete Configuration

Ensure that the delete configuration date matches the previous configuration:

<DeleteConfiguration>
    <add name="delay" years="1" months="0" days="0" hours="0" minutes="0" seconds="0" />
    <add name="neverDelete" neverDelete="false" />
  </DeleteConfiguration>

Recover Old Config The next few steps regard recovering the old configuration from the backed up Curator Clip Link config file from the previous version.  

Replace Metadata View names

Find the following keys and replace the value with the required metadata views:  

<add key="SearchFilterViewName" value="SearchLevelView" />

Replace Pinned Searches Find the PinnedSearches tag and add all the missing lines below the clear tag:
<pinnedSearches>
<searches>
<clear />
<add imageFileName="Example.svg" tooltip="Example Search" searchParameters="?assetFilter=159&amp;s=ingestdate&amp;d=descending" />

Replace Add To Collections

Find the AddToCollection tag and change the values as required, adding missing metadata names within the Path Metadata tag if necessary.  

<AddToCollection>
<MetadataView name="Collections" />
<BaseLocation name="Library" /
<PathMetadata>
<Metadata name="CollectionType" />
<Metadata name="CollectionDestination" />
<Metadata name="Priority" />
</PathMetadata>
</AddToCollection>

Replace Metadata Tabs

Find the AssetPopupInfo tag and add any missing tabs:

<AssetPopupInfo>
<Tabs>
<View name="Example MetadataView" display="Display Name" parent="false" />

Finish Save the file.

Recover Pinned Searches Images

Replace any missing images in:

%INSTALL_PATH%\inetpub\wwwroot\CuratorClipLink\Content\Images\PinnedSearches\

Recover Custom Plugins

Replace any missing custom plugins in the plugins top-level folder:

%INSTALL_PATH%\inetpub\wwwroot\CuratorClipLink\Plugins\
Delete

Curator Logger Config

Open web.config in text editor

On the IIS server, open IIS manager and browse to the Curator Logger directory by right-clicking and selecting the Explore option:

Open the web.config file in a text editor.

Replace

"Video Server

Address" key value

Set the value for the VideoServerAddress key with the fully qualified domain name for the IIS host.

Replace: 

<add key="VideoServerAddress" value="https://WEBSERVER" /> 

With:

<add key="VideoServerAddress" value="https://IIS_HOST" />

Finish Save the file.
Delete

Clean up of unnecessary elements

Removing Apache and Perl - if not already removed


Note: When upgrading from 3.3.1 to 3.4, Apache and Perl should already be uninstalled. Should they need to be removed, reference the provided steps. 

Uninstall Apache

Open a Command Prompt window and execute the following two lines separately:

cd C:\Apache24\bin

.\httpd.exe -k uninstall

  

 

Remove Apache files

After Apache has been uninstalled, close the open Command Prompt window. It is now safe to delete the Apache24 folder.

 

Open Programs and Features

Open Control Panel and go to Programs and Features

(Optional) Performing Essence removal from the database


Delete


Was this article helpful?