View as Markdown
You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

Upgrading the Design Editor

Applies to: Customer's Canvas On-Premises; Design Editor 5.35.9, 5.x (may differ) · Archived documentation

Aurigma updates Customer's Canvas on a regular basis. Once a new version is released, it appears in your account in My Licenses & Downloads. You may want to test new features of the Design Editor and see how they can improve your project. This topic will help you ensure a smooth transition to the new version of the editor.

Important

When you need to run both old and new versions of the Design Editor, run them in separate application pools.

If you customized a UI theme for earlier versions, it may become incompatible with new versions of the Design Editor.

The Standard Upgrade Process

When there are no breaking changes between the old and new versions, the upgrade process includes the following steps:

  1. In the File Explorer, navigate to your application's web directory, for example, D:\inetpub\CustomersCanvas\.
  2. Unzip cc-<new-version-number> from the package CustomersCanvasServer.zip to this folder.
  3. Copy your configuration changes, if any, from the \cc-<old-version-number>\Configuration folder:
    • clientConfig.json
    • AppSettings.config, Aurigma.DesignAtoms.config, FileCache.config, and Converters.config
    • TemplateConfigShortcuts.json
    • translations.json
    • Custom CSS
    • Email notifications
    • Themes
  4. In the IIS manager, stop your application.
  5. In the Basic Settings of your application, change the Physical path to the new folder (D:\inetpub\CustomersCanvas\cc-<new-version-number>).
  6. In the IIS manager, start your application.

Since the Design Editor introduced significant changes in versions 4.4.0, 5.0.0, 5.1.0, and 5.5.0, you must perform additional steps to upgrade to these versions:

Upgrading the Design Editor from 5.4 to 5.5

To upgrade the Design Editor from 5.4 to 5.5 or more recent versions:

  1. Complete the standard steps 1-3.
  2. In \Configuration\AuthSettings.config, find: 
    <route
  name="Color convertor API"
  *path="api/ColorConvertor/{action}/{color}/{id}"
  methods="POST"
  authRequired="false"
  unsafeHttpMode ="enabled"
/>
    and replace it with: 
    <route
  name="Color convertor API"
  *path="api/ColorConvertor/{action}/{color}"
  methods="POST"
  authRequired="false"
  unsafeHttpMode ="enabled"
/>
  3. In the IIS manager, stop your application, change the Physical path to the folder D:\inetpub\CustomersCanvas\cc-<new-version-number>, and start your application again.

Upgrading the Design Editor from 5.0 to 5.1

  1. Complete the standard steps 1-3.
  2. (Optional) If you enabled the auto-start provider, replace the <serviceAutoStartProviders> node in %WINDIR%\System32\inetsrv\config\applicationHost.config with: 
    <serviceAutoStartProviders>
  <add name="CcAutoStartProvider" type="Aurigma.DesignEditor.CustomersCanvasInitialization, Aurigma.DesignEditor" />
</serviceAutoStartProviders>
  3. In the IIS manager, stop your application, change the Physical path to the folder D:\inetpub\CustomersCanvas\cc-<new-version-number>, and start your application again.

Upgrading the Design Editor from 4.4 to 5.0

Important

In Design Editor 5, assets were moved from the editor's folder to ..\assets\. You can move them from ~\ProductTemplates, ~\PublicGalleryFolder, ~\UserDataFolder, and ~\Fonts to their new location and update asset paths in the config files. However, you can leave them where they are until further upgrades.

In Design Editor 5, the format of configuration files has changed. To upgrade earlier versions of the Design Editor to 5.0, you must either copy and paste parameters you have changed in .config files or modify section names in your configuration files. The following instruction describes the latter way.

  1. Stop your application in the IIS manager.
  2. Backup your old instance.
  3. Delete all folders and files except for:
    • ~\App_Data
    • ~\ProductTemplates, ~\PublicGalleryFolder, ~\UserDataFolder
    • ~\Fonts
    • ~\bin\Aurigma.GraphicsMill.lic
  4. Unzip the new release into the root folder.
  5. Recover your configuration changes, if any, in the ~\Configuration folder:
    • clientConfig.json
    • AppSettings.config, VectorObjects.config, FileCache.config, and Converters.config
    • TemplateConfigShortcuts.json
    • translations.json
    • Custom CSS
    • Email notifications
    • Themes
  6. (Optional) Rename root nodes in your .config files if you recovered them in the old format:
    • VectorObjects.config: rename this file to Aurigma.DesignAtoms.config and rename the root node to: 
      <Aurigma.DesignAtoms>
    ...
</Aurigma.DesignAtoms>
    • FileCache.config: 
      <Aurigma.DesignAtoms.FileCacheConfiguration>
    ...
</Aurigma.DesignAtoms.FileCacheConfiguration>
    • Converters.config: 
      <Aurigma.DesignAtoms.Converters>
    ...
</Aurigma.DesignAtoms.Converters>
  7. (Optional) Rename section names in Web.config if you recovered this file in the old format:
    • In <configSections>, find: 
      <section name="Aurigma.GraphicsMill.AjaxControls.VectorObjects" type="System.Configuration.NameValueSectionHandler, System, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
<section name="Aurigma.GraphicsMill.AjaxControls.VectorObjects.FileCacheConfiguration" type="System.Configuration.NameValueSectionHandler, System, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
<section name="Aurigma.GraphicsMill.AjaxControls.VectorObjects.Converters" type="Aurigma.GraphicsMill.AjaxControls.VectorObjects.Config.ConvertersConfigSection, Aurigma.GraphicsMill.AjaxControls.VectorObjects" />
      and replace it with: 
      <section name="Aurigma.DesignAtoms" type="System.Configuration.NameValueSectionHandler, System, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
<section name="Aurigma.DesignAtoms.FileCacheConfiguration" type="System.Configuration.NameValueSectionHandler, System, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
<section name="Aurigma.DesignAtoms.Converters" type="Aurigma.DesignAtoms.Configuration.ConvertersConfig.ConvertersConfigSection, Aurigma.DesignAtoms" />
    • In <nlog>/<rules>, find: 
      <logger name="Aurigma.GraphicsMill.AjaxControls.VectorObjects.ExternalConverter" minlevel="Warn" writeTo="ExternalConverter" />
<logger name="CustomersCanvas.Licensing.License" minlevel="Info" writeTo="LicenseLogTarget" />
      and replace it with: 
      <logger name="Aurigma.DesignAtoms.Common.ExternalConverter.ExternalConverter" minlevel="Warn" writeTo="ExternalConverter" />
<logger name="Aurigma.DesignAtoms.Licensing.License" minlevel="Info" writeTo="LicenseLogTarget" />
    • Find sections: 
      <Aurigma.GraphicsMill.AjaxControls.VectorObjects configSource=".\Configuration\VectorObjects.config" />
<Aurigma.GraphicsMill.AjaxControls.VectorObjects.Converters configSource=".\Configuration\Converters.config" />
<Aurigma.GraphicsMill.AjaxControls.VectorObjects.FileCacheConfiguration configSource=".\Configuration\FileCache.config" />
      and replace them with: 
      <Aurigma.DesignAtoms configSource=".\Configuration\Aurigma.DesignAtoms.config" />
<Aurigma.DesignAtoms.Converters configSource=".\Configuration\Converters.config" />
<Aurigma.DesignAtoms.FileCacheConfiguration configSource=".\Configuration\FileCache.config" />
  8. Start your application in the IIS manager.

Upgrading to Design Editor 4.4

Important

Design Editor 4.4.0 introduced the new licensing engine. You must get a new license key in your account to upgrade earlier versions of the Design Editor to 4.4.

  1. Stop your application in the IIS manager.
  2. Backup your old instance.
  3. Delete all folders and files except for:
    • ~\App_Data
    • ~\ProductTemplates, ~\PublicGalleryFolder, ~\UserDataFolder
    • ~\Fonts
  4. Delete the \GraphicsMill.Core\ subfolder from ~\App_Data, if any.
  5. Unzip the new release into the root folder.
  6. Recover your configuration changes, if any, in the ~\Configuration folder:
    • clientConfig.json
    • AppSettings.config, VectorObjects.config, FileCache.config, and Converters.config (former Web.config)
    • TemplateConfigShortcuts.json
    • translations.json
    • Custom CSS
    • Email notifications
    • Themes
  7. Register your new license key.
  8. Start your application in the IIS manager.

See Also

Manual