Skip to main content
Theme

How-to

Test on a live instance safely

A copy runs on a real production instance, so a test submission to a moved form would email the site's real staff and customers, and a moved API call would post to the site's Zapier, Make or CRM. Tick Hold emails and outside connections until cutover on the plan and the site's own email, SMS and API call notifications are copied switched off until you turn them on. It does not hold everything that can send: the table below says what it holds and what it does not.

The plan option

The plan asks on every migration, on What the load carries, under Emails and outside connections. It is off unless you tick it: unticked, everything is copied and sends as it did on the old site, exactly as before this option existed.

Ticked, the site's own email, SMS and API call notifications are written to the new instance switched off. That covers form notifications, autoresponders, workflow emails, and the sends its code makes by name. A test submission does not email anyone or call Zapier, Make or other services through them. They stay off through every final sync and nightly sync of the migration, until you turn them on.

Held sends are skipped, not queued. Anything triggered while they are off, such as a form submitted by a real visitor, is never sent later. Turning them on only affects what happens from then on.

Under the option, What the hold covers names each one before anything is written: each email, SMS and API call by name, the forms that send it, and for an API call the host it posts to. It also names, under Not held, each code file that sends something the hold cannot stop, and each form from another service on the site's pages. The plan code changes when you tick it, so the code you type to confirm the load covers your choice.

Tick Turn them on by themselves at cutover as well, and the tool turns them on when you mark the cutover's Move the domain step done. Leave it unticked to press the button yourself.

What is held and what is not

What sendsHeldWhat the plan shows
Form notifications, autoresponders and workflow emails the migration copiesHeldEach by name, with the forms that send it
SMS notifications the migration copiesHeldEach by name
API call notifications the migration copies, such as calls to Zapier, Make or a CRMHeldEach by name, with the host it posts to
One of those sent by name from the site's code (email_send, sms_send or api_call_send naming a template)HeldCovered by the notification it names
A module email a moved form sends, such as the CRM's staff emailHeld for that formNot attached to the moved form until you turn them on. The module's email itself is not changed, so it still sends for other forms
A send written out in full in the site's code: an email, SMS or API call with every detail in the code, in a page, partial, layout, query, form, notification, callback or authorization policyNot heldEach file, under Not held
Code that sends through one of the new instance's modules, such as a call to modules/insites_crm/lib/emails/send_notification, or a send by name of a module's own notificationNot heldEach file, under Not held
Emails the new instance's modules and platform send for themselves: CRM emails for other forms, password resets, sign-in links, invitationsNot heldNot listed: they belong to the new instance, not to the copy
Forms embedded from other services, such as HubSpot, JotForm, Typeform or Google FormsNot heldEach form and the pages it is on, under Not held. A form you rebuild as an Insites form on Transform, Forms is an Insites form and its emails are held
Scripts in the pages that post to other sites, such as analytics, chat widgets or a script that sends a form to another serviceNot heldNot listed: the tool cannot tell what a script sends
Something a person switches on in the new instance's admin or the form builderSendsThe HOLD check names it

Check each file and form under Not held before you test, and decide whether to test it at all on a live instance.

Payments

Payment keys stored as constants for known providers, such as Stripe and PayPal, are not copied. The tool knows a payment key by the constant's name: a name that pairs a provider with a word like key, secret or token, and every insites_stripe_ constant. A key kept under another name, or in a database record, is copied like any other value. To test payments on the new site, add Stripe test keys there, and replace them with the live keys at cutover.

How a held email is switched off

Every email, SMS and API call notification on Insites has a setting that decides, each time, whether it sends: its trigger condition. The tool writes a held one with a trigger condition that never sends, and keeps the original on the notification itself, so you can see in the new instance's admin that it is held and why. A send it skips is not kept anywhere to send later. When you turn them on, the tool puts each original back exactly and reads it back. In the form builder, a held email shows as switched off.

Copy this one again puts the hold back. If someone switched a held form email on again on the new site, it keeps sending until the hold is written again. Press Copy this one again on it. The tool writes the hold on its own, leaves the sender and layout as the new site has them, reads it back, and says plainly if the email still sends.

The tool measured this on a production instance before relying on it: a held email sent nothing when a form was submitted or when code sent it by name, and the same email sent once it was turned on.

Verify reminds you

While the hold is on, every verification shows Emails and outside connections as a note: how many are held, and any that send anyway because someone switched them on. It never fails the migration. Once they are turned on, it says when and by whom. The To do list has the job Turn on emails and connections at the cutover.

Turn on emails and connections

  1. Open Launch, Cutover. Under the four steps, Emails and outside connections lists what is held.
  2. Once the domain points at the new site, press Turn on emails and connections. Each one gets back exactly what it had on the old site, and the forms are attached to the module emails they send. The tool reads every one back. One that someone already switched on is left as it is, and one that could not be turned on is named, so you can switch it on in the admin.
  3. Check the result. Cutover says when they were turned on, by whom, and anything that could not be. Activity records it, and the To do job is ticked.

It needs the operator role, and waits while a run of the migration is working, such as a final sync that is loading. After they are turned on, a later sync copies them as the old site has them, so nothing is held again.

A rollback puts the new instance back as it was before the load, held or turned on.