Managing Personalisation framework

Contact Squiz Support if you need help with managing the personalisation framework in your Matrix installation.

Upgrading from v1.1 to v1.2

Upgrading to the latest version of Personalisation framework requires manual changes to asset IDs declared in the Personalisation Edit+ include file.
  1. Download the Personalisation-Framework-1.2.0.tgz import file from the Squiz Marketplace.

  2. Navigate to the Personalisation  Configuration  Core folder.

  3. Replace all the HTML, CSS, and JS files within the Core folder with the corresponding files in the upgrade files distribution.

  4. Navigate to the Paint Layout of the Settings Content Template.

  5. Replace the existing code inside the Paint Layout with this upgraded code:

    <!--@@ Conditionally DDS JS SDK @@--><!--@@ Conditionally DDS JS SDK @@-->
    %begin_asset_metadata_sq-personalise-ds-url%
    <script src="https://dds-static.dds.squiz.systems/dds%asset_metadata_sq-personalise-ds-env^eq:dev:sim:%.js"></script>
    %end_%
    
    <!-- Personalisation Framework settings data -->
    <script>const personalisationFrameworkSettings = {
    data: {
    // Wrapping page ID
    parentID: '%asset_metadata_sq-personalise-content-wrapper-id%',
    // Optional
    Mapbox token mapToken: '',
    // Data storage options
    dataStoreEndpoint: '%asset_metadata_sq-personalise-ds-url%'
    },
    tracking: {
    // Stuff you fill in under "tracking rules"
    rules: %asset_metadata_sq-personalise-tracking-rules^empty:{}^replace:\r\n:^replace: +: %,
    // 'Output the user's country - not IE11 compatible
    country: '<esi:vars>$(GEOIP_COUNTRY_CODE)</esi:vars>'
    }};
    </script>
  6. Click Save to update the Paint Layout.

  7. Navigate to the Personalisation  Configuration  Includes folder.

  8. Replace the content of the Personalisation editplus include with the following upgraded code.

    Make sure you update each asset ID with care, paying particular attention to the asset tree location in each call-out.
    <script>
        // Required to save the persona's metadata in the settings screen
        const SQ_PERS_PERSONA_FIELDS = %globals_asset_children:ASSET_ID_1^as_asset:asset_name,asset_assetid^empty:[]%; (1)
        // Template URL: these are used to render the different interfaces
        const SQ_PERS_TEMPLATES = './?a=ASSET_ID_2'; (2)
        // The persona folder
        const SQ_PERS_PERSONA_DIR = '%globals_asset_assetid:ASSET_ID_3%'; (3)
    </script>
    
    <!-- personalisation-framework-edit.min.css -->
    <link href="./?a=ASSET_ID_4?%globals_asset_version:ASSET_ID_4%" rel="stylesheet"> (4)
    <!-- personalisation-framework-edit.min.js -->
    <script src="./?a=ASSET_ID_5?%globals_asset_version:ASSET_ID_5%"></script> (5)
    <!-- personalisation-framework-interface.min.js -->
    <script src="./?a=ASSET_ID_6?%globals_asset_version:ASSET_ID_6%"></script> (6)
    1 Replace ASSET_ID_1 with the asset ID of the Personalisation  Configuration  Core  Persona schema  Details asset.
    2 Replace ASSET_ID_2 with the asset ID of the Personalisation  Configuration  Core  templates.html asset.
    3 Replace ASSET_ID_3 with the asset ID of the Personalisation  Personas asset.
    4 Replace ASSET_ID_4 in both locations with the asset ID of the Personalisation  Configuration  Core  personalisation-framework-edit.min.css asset.
    5 Replace ASSET_ID_5 in both locations with the asset ID of the Personalisation  Configuration  Core  personalisation-framework-edit.min.js asset.
    6 Replace ASSET_ID_6 in both locations with the asset ID of the Personalisation  Configuration  Core  personalisation-framework-interface.min.js asset.
  9. Click Save to update the Personalisation editplus include and complete the upgrade process.

  10. Verify that all assets you edited as part of this procedure are Live.

If you notice any odd behavior with personalization on your site after upgrading, double-check that you have replaced all files specified in Step 3 and that the asset IDs you updated in Step 7 point to the asset locations specified in the call-outs.

You have now completed the upgrade process from v1.1 to v1.2 of Personalisation framework.

© 2015-2020 Squiz Pty Ltd