Skip to main content

Migration Guide

This guide details the changes and how to change your code to migrate to Pexip Engage plugin version 2.0.

We made sure you can migrate to v2 without having to do any changes1. Your current v1 setup and configuration is completely backwards compatible2 with v2. However, it is recommended to switch to the new, v2 configuration as soon as possible. This way you'll have access to new features that are only available in the v2 version of the plugin.

Important functional changes​

  • ⛱️ Step by step encapsulation
    • Separate meeting type step
    • Separate employee step
  • 📍Proper support for coverage regions
  • 🚀 Speed and performance improvements
  • ⏩ Timetable scrolls to first available slot
  • 👮🏻‍♀️ Improved security with SSR
  • 🔒 Base64 support for encoded hash (see FAQ section)

Gotchas​

Because we now run the plugin in an isolated iFrame, we no longer interact and impact the parent website. This is a good thing for security and not interfering with the functionality of your own website. However, this could also introduce some minor gotchas:

  • We no longer inherit the font family from the parent website. This means during the styling process, we will have to ask for the parent's website's font and implement it from our side.
  • Our Google Maps service is no longer shared with the parent website, which was necessary since Google only allows a single instance of the service per website. However, if you are currently showing a map without having a Google Maps service yourself, this will be breaking. You will need to setup Google Maps yourself.
  • If you're using a CSP, make sure to correctly configure it. Only including a script-src or connect-src is not enough anymore.

Migrating without changes​

We offer quite some flexibility when you decide to move over to v2. We can either move all your current setup to v2, or you can decide to opt in through configuration. The latter allows you to try out v2 configuration per configuration.

Move over completely​

Ask your Pexip Engage customer success responsible to switch on the v2 feature flag. From then on all your current plugin v1 links and implementations will automatically move to the v2.

Try out v2 for some specific flows​

When you want to try out v2 for separate flows, you can simply add ?pexip-engage-plugin=v2 to the URL of the website where plugin v1 is hosted. (e.g. www.my-company.com/make-an-appointment?pexip-engage-plugin=v2) to switch the flow to the v2 plugin. You can also use this parameter on the plugin domain URL itself: /<enterprise-name>/?pexip-engage-plugin=v2#skedifyeyJmbG8iOiJTT0VUUUMifQg, just make sure to add a / before the ?.

Migrating to new configuration​

To be future proof and get the newest features, we recommend you to switch to the newest configuration as soon as possible.

Migration assistant​

Moving over to plugin v2 will include some breaking changes, but we tried to make it easy for you and your developers. For that, we created the migration assistant which will help you move your current configuration to the new one.

Using React?​

When you are using React, we created a package to help you integrate the package into your application. See https://www.npmjs.com/package/@pexip-engage-public/plugin-react for more info on usage.

Migration check list​

  • Create and deploy styling for new plugin (i.e. CSS) (done by Pexip Engage engineering team)
  • Decide on migration strategy
  • Check migration gotchas

Notes​

Styling

The current v1 styling will not work for the v2 plugin. So we are breaking there. However, the Pexip Engage engineering team will help you migrate.

Backwards compatibility

Backwards compatibility for configuration only works from v1 to v2, meaning v1 configuration is compatible with v2, not vice versa.