Migration Notes - ServiceCanada/invitation-manager GitHub Wiki

Update Invitation Manager to V1.2.2 - Fixing issues with Task Success Survey Referrer value being cut-off

Step 1: Downloading the installation files

Click this link to download the GC Invitation Manager tool: Download the Invitation Manager Zip file

Click to open the .zip file or use any tool to un-zip the file and save contents to your local drive.

Within the ZIP file you will find the following:

  • “invitation-manager” folder:
    • InvitationManager.js
    • Overlay.js
    • Overlay.css
    • config.json
    • im.json

Step 2: Upload the required files to your server

The following are the ONLY files that will need to be updated - copy and replace them into the location of the older files:

  1. InvitationManager.js
  2. Overlay.css
  3. config.json

Step 3: Configure your settings - Update parameters

  1. dbURL
    • Open the “config.json” file in the “invitation-manager” folder or in your alternative saved folder and locate the “dbURL” parameter. This parameter value should indicate the location of the im.json file.

      Update this to match the value you had in the previous config.json file. If the location of the im.json has changed, then update the value to reflect the new location.

      • Example: “/invitation-manager/im.json”.
  2. Adobe
    • If Analytics is already implemented on your site, you can enable tracking of the invitation manager pop-ups in the “config.json” file.

      Adobe Analytics tracking for the invitation manager is currently available on all Non-Canada.ca code versions.

      If Adobe Analytics is not implemented on your site, you will not be able to benefit from this feature.

    • Open the “config.json” file in the “invitation-manager” folder or your alternative saved folder, and locate the “Adobe” parameter.

      The value should equal “yes” or “no”.

      • Input “Adobe” : “no”, if your department site does not have Adobe Analytics tracking implemented or prefer not to enable Adobe Analytics tracking.
      • Input “Adobe” : “yes”, if your department site has Adobe Analytics tracking implemented and you would like to enable Adobe Analytics tracking.

Update from V1.2.0 to V1.2.1

Step 1: Downloading the installation files

Click this link to download the GC Invitation Manager tool: Download the Invitation Manager Zip file

Click to open the .zip file or use any tool to un-zip the file and save contents to your local drive.

Within the ZIP file you will find the following:

  • “invitation-manager” folder:
    • InvitationManager.js
    • Overlay.js
    • Overlay.css
    • config.json
    • im.json

Step 2: Upload the required files to your server

The following are the ONLY files that will need to be updated - copy and replace them into the location of the older files:

  1. InvitationManager.js
  2. Overlay.css
Update from V1.1.1 to V1.2.0

Step 1: Downloading the installation files

Click this link to download the GC Invitation Manager tool: Download the Invitation Manager Zip file

Click to open the .zip file or use any tool to un-zip the file and save contents to your local drive.

Within the ZIP file you will find the following:

  • “invitation-manager” folder:
    • InvitationManager.js
    • Overlay.js
    • Overlay.css
    • config.json
    • im.json

Step 2: Upload the required files to your server

The following are the ONLY files that will need to be updated - copy and replace them into the location of the older files:

  1. InvitationManager.js
  2. Overlay.css
Update from V1.1.0 to V1.1.1

Step 1: Downloading the installation files

Click this link to download the GC Invitation Manager tool: Download the Invitation Manager Zip file

Click to open the .zip file or use any tool to un-zip the file and save contents to your local drive.

Within the ZIP file you will find the following:

  • “invitation-manager” folder:
    • InvitationManager.js
    • Overlay.js
    • Overlay.css
    • config.json
    • im.json

Step 2: Upload the required files to your server

The following are the ONLY files that will need to be updated - copy and replace them into the location of the older files:

  1. InvitationManager.js
  2. Overlay.css
Update from V1.0.0 to V1.1.0

Step 1: Downloading the installation files

Click this link to download the GC Invitation Manager tool: Download the Invitation Manager Zip file

Click to open the .zip file or use any tool to un-zip the file and save contents to your local drive.

Within the ZIP file you will find the following:

  • “invitation-manager” folder:
    • InvitationManager.js
    • Overlay.js
    • Overlay.css
    • config.json
    • im.json

Step 2: Upload the required files to your server

The following are the ONLY files that will need to be updated - copy and replace them into the location of the older files:

  1. InvitationManager.js
  2. Overlay.css
  3. config.json

Step 3: Configure your settings - Update parameters

  1. dbURL
    • Open the “config.json” file in the “invitation-manager” folder or in your alternative saved folder and locate the “dbURL” parameter.

      This parameter value should indicate the location of the im.json file. Update this to match the value you had in the previous config.json file.

      If the location of the im.json has changed, then update the value to reflect the new location.

      • Example: “/invitation-manager/im.json”.
  2. Adobe
    • If Adobe Analytics is already implemented on your site, you can enable tracking of the invitation manager pop-ups in the “config.json” file.

      Adobe Analytics tracking for the invitation manager is currently available on all Non-Canada.ca code versions.

      If Adobe Analytics is not implemented on your site, you will not be able to benefit from this feature.

    • Open the “config.json” file in the “invitation-manager” folder or your alternative saved folder, and locate the “Adobe” parameter.

      The value should equal “yes” or “no”.

      • Input "Adobe" : "no", if your department site does not have Adobe Analytics tracking implemented or prefer not to enable Adobe Analytics tracking.
      • Input "Adobe" : "yes", if your department site has Adobe Analytics tracking implemented and you would like to enable Adobe Analytics tracking.
⚠️ **GitHub.com Fallback** ⚠️