Upgrading Safeguard

From SDL Tridion 2013 onwards, SDL Safeguard is delivered as part of the suite and not as a separate add-on to SDL Tridion. When you install the Content Manager of SDL Tridion, your Safeguard installation is upgraded for you including your configuration settings in the Safeguard.config file.

About this task

When you upgrade to SDL Tridion 2013 SP1, the structure of the Safeguard configuration file Safeguard.config has changed. Although the installer upgrades your configuration file for you automatically, the upgraded file contains a new element <astApiKey> for which you will need to get an API key for your account: Safeguard will not work until you enter your API key.

Procedure

  1. Run the Content Manager installer to upgrade Safeguard:
    1. Access the SDL Tridion installation media.
    2. Navigate to the Content Manager\ directory.
    3. Double-click the executable SDLTridion2013SP1CM.exe.
    4. In the Advanced View of the Features pane, you need to make sure User Interfaces > Experience Manager > Safeguard is selected.
    5. Follow the instructions on the screen.
  2. On the Content Manager, access the %TRIDION_HOME%\web\WebUI\Editors\Safeguard\Configuration directory.
  3. Open Safeguard.config in a text editor:
    Previous version of Safeguard.config
    The following is an example of Safeguard.config before you upgraded:
    <clientconfiguration>
         <publication id="1">
              <divisionIdentifier>55d632e121c082180121c45da19a5670</divisionIdentifier>
              <quickCheckURL>http://www.activestandards.com/my/quickcheck/quickcheck.js</quickCheckURL>
         </publication>
         <publication id="2">
              <divisionIdentifier>55d632e121c082180121c45da19a5670</divisionIdentifier>
              <quickCheckURL>http://www.activestandards.com/my/quickcheck/quickcheck.js</quickCheckURL>
         </publication>
         <publication id="3">
              <divisionIdentifier>55d632e121c082180121c45da19a5670</divisionIdentifier>
              <quickCheckURL>http://www.activestandards.com/my/quickcheck/quickcheck.js</quickCheckURL>
         </publication>     
    </clientconfiguration>
    Upgraded version of Safeguard.config
    After upgrading, the Safeguard.config will look as follows:
    <clientconfiguration>
         <contextURL>http://www.activestandards.com/my/</contextURL>
         <astApiKey></astApiKey>
         <websiteId pub="1">55d632e121c082180121c45da19a5670</websiteId>
         <websiteId pub="2">67455d632e121c082180121c45da19a5</websiteId>
         <websiteId pub="3">875876863455d632e121c082180121c4</websiteId>    
    </clientconfiguration>
    Changes to Safeguard.config
    In new version of Safeguard.config:
    • the <publication> element was renamed to <websiteId>
    • the <publication> element attribute id was renamed to pub
    • the <websiteId> element no longer contains the child elements <divisionIdentifier> and <quickCheckURL>: the value of <divisionIdentifier> is now used as value of <websiteId>
    • <contextURL> is a new element (static value)
    • <astApiKey> is a new element
  4. Configure Safeguard.config as follows:
    <contextURL>
    Contains the static value http://www.activestandards.com/my/.
    <astApiKey>
    You require an API key for your Safeguard account. To get an API key, go to: http://dev.activestandards.com/.
    <websiteId>
    You configure Safeguard publication-by-publication. Specify a publication item ID in the pub attribute and the value as the ID identifying your Safeguard account.
  5. Save and close Safeguard.config.