DC 6.0 Upgrade checklist

DC 6.0 Upgrade checklist

This page is only relevant when upgrading a customer from a 5.X version to 6.0. Thus, this page is not relevant for new-installs.

Before upgrading existing customers to 6.0, please take a look at the following checklist.

  1. Insights migration

    1. When 6.0 is installed, it is no longer possible to migrate data from the old insights system to the new insights system. If data from the old insights system needs to be migrated, this must happen on a 5.X version before upgrading, using the program that can be found here: https://digizuite.atlassian.net/wiki/x/TQHA2.

  2. Transcode system migration

    1. In 5.10, a new transcode system was introduced, but the old transcode system could still be used. As described in https://digizuite.atlassian.net/wiki/x/XQDG4g, the old transcode system is completely removed in 6.0.

    2. Existing customers must be upgraded to 5.10 before upgrading to 6.0. The purpose of this is to ensure that the old transcode system is properly migrated to the new transcode system before the old transcode system is removed in the 6.0 update. This is meant as a help for consultants since the data from the old transcode system is then still available. Consequently, it is not necessarily relevant for customers to know about this intermediate step.

    3. The main things to be aware of in relation to the transcode system migration are:

      1. Formats that can not be automatically generated (https://digizuite.atlassian.net/wiki/spaces/DD/pages/3710091372/DC+5.10+Formats+-+Migration#Manual-migration).

      2. Removal of profiles: Renditions are no longer generated based on profiles. Thus, if renditions of the old media format were previously being generated when an asset was published to a specific channel folder, this is no longer the case. Pre-generation can be set up for the new format. However, please carefully consider if this is necessary now that the transcode system supports on-demand transcoding.

      3. Format visibility: In the new transcode system, a format is indicated as downloadable for an asset if it can be generated. In the old transcode system, a format was only indicated as downloadable for an asset if it had already been generated. Please see https://digizuite.atlassian.net/wiki/spaces/DD/pages/3804632276/DC+6.0+Formats#Format-visibility for more information on how to control the format visibility.

  3. Automation migration

    1. Some automations might reference catalog folders. Since catalog folders are no longer supported in 6.0, these automations must be either deleted or re-written manually before upgrading to 6.0.

      1. Find relevant automations: Catalog folders are typically referenced via the “Move Asset To Folder” action or the “Asset Folder Updated Trigger”. For “Move Asset To Folder”, a catalog folder is referenced if folder = "1,<id>", where 1 indicates a catalog folder. Similarly, for “Asset Folder Updated Trigger”, a catalog folder is referenced if to_folder = "1,<id>".

      2. The following script can be used to identify these automations:

        select dw.Name from DslService_DslWorkflows dw where dw.Deleted = 0 and exists(select * from DslService_DslWorkflowVersions v where v.WorkflowId = dw.Id and ( v.Dsl like '%"1,%') and v.Id = (select max(id) from DslService_DslWorkflowVersions vi where vi.WorkflowId = dw.Id))
      3. Automatic cleanup: All OOBE automations that use catalog folders are removed in the 6.0 base layers automatically. Consequently, no manual actions are required for OOBE automations.

      4. If you try to export an automation that references a catalog folder after upgrading to 6.0, you will get an error similar to: Internal error: System.ArgumentOutOfRangeException: Folder with repositorytype 1 was not defined in the custom property serializer (Parameter 'folder').

    2. The following automation steps are no longer valid. Please rewrite automations that use these steps:

      1. “Asset Folder Updated Trigger” or “Move Asset To Folder”, where a catalog folder is referenced if folder = "1,<id>"

      2. “Asset Profile Published” trigger. The new trigger “Asset renditions available” can be used to react to the successful generation of renditions.

      3. “Search” step is no longer supported.

      4. “Publish Asset” step.

      5. “RePublish Asset” step.

      6. Automations that use these triggers and steps can be identified with the following script:

        select dw.Name from DslService_DslWorkflows dw where dw.Deleted = 0 and exists(select * from DslService_DslWorkflowVersions v where v.WorkflowId = dw.Id and ( v.Dsl like '%"1,%' or v.dsl like '%type = "Asset Profile Published%' or v.dsl like '%type = "Search"%' or v.dsl like '%type = "Publish Asset"%' or v.dsl like '%type = "RePublish Asset"%' ) and v.Id = (select max(id) from DslService_DslWorkflowVersions vi where vi.WorkflowId = dw.Id))
  4. Configuration Management

    1. As usual, it is highly recommended to ensure that all configuration changes have been exported into a configuration management layer. This is in particular important before upgrading to 6.0, since a lot of unsupported resources have been removed from the base layers.

  5. YouTube Service migration

    1. If you have a configured YouTube Client where the GetYoutubeInformation search has been configured to use different metafields than the defaults for “Title” and “Description”, the YouTube client must be re-configured manually after upgrading to 6.0. Please refer to https://digizuite.atlassian.net/wiki/spaces/DD/pages/3804631595/DC+6.0+YouTube+Service#YouTube-client-creation for more information on how to do this.

  6. Cleanup of old products and metadata

    1. Background: With long time customers chances are some old products still exist in the config manager. Old metadata outside of obvious product scope might also be present. To avoid that this metadata is shown in the metadata view on assets after updating, we recommend cleaning up the metadata before updating to 6.0. This step is optional, but note that the script can not be used after updating to 6.0.

    2. Preparation:

      1. Before cleaning up, please ensure that there are no actions when calculating a diff in Configuration Management.

      2. Make sure any customer metadata is moved to customer specific metafield groups or the main asset metadata group before running the script. The script will delete entire metafield groups, including all their metafields and all data associated with these metafields.

    3. Script: The following script can be used to perform the cleanup: TODO
      This script cleans up several old products and a lot of metadata which has been deemed safe to delete and should not impact any customer metadata.

    4. After running the script: Export the entire actual state in Configuration Management to ensure that the cleaned up metadata is not re-created the next time the desired configuration is applied.

    5. If you identify a metafield group or metafield that should be cleaned up by the script but isn’t cleaned up, please reach out to R&D.

After upgrading existing customers to 6.0, please take a look at the following checklist.

  1. Configuration Management

    1. When calculating a diff, all formats that were previously mapped to a media format will have an update action. These update actions must be exported before applying the desired state to ensure that the formats can still be requested with the old media format ids. This is very important for customers that use connectors such as DAM for Optimizely, DAM for Sitecore, and the Adobe Creative Cloud Connector since links and images embedded before upgrading to 6.0 will otherwise not work. On update, we change the existing mapped media format ids to invalid ids in custom Configuration Management layers (the maximum integer value 2147483647) to force you to remember to do this. The update will fail if you forget to export the format update actions and you have at least one format in a custom layer. The update actions will look something like this:

image-20240626-062630.png
  1. Metafield groups

    1. As part of the changes in 6.0, metafield groups can no longer be structured in nested metafield group folders. Please run through all metafield groups and ensure that “Show in list” is only enabled for the appropriate metafield groups, ensuring that these metafield groups are not suddenly shown in the metadata view on assets.

    2. If you cleaned up old products and metadata before upgrading, performing this step should not be necessary, although it is always a good idea to double check.

Related content