Skip to main content
Theme

Connectors

Insites v5

An Insites v5 instance moves to Insites v6 with its rows, people, CRM, code and files. The tool only reads the old instance. Nothing is ever written back to it. Your first migration walks through the whole move.

Is it v4 or v5?

You do not need to know. When you connect, the tool reads which Insites the instance is from what it holds. If you chose Insites v5 for a v4 instance, it says so and stops before it reads anything: go back to Source and choose Insites v4. A v4 instance keeps its CRM in other tables, and only the v4 source places them on v6.

What you need

  • The instance's address, for example https://example.com. Use the live (production) instance, not a UAT or staging copy. The final sync copies the changes made on it.
  • One way in. Either the instance's GraphQL admin key, or your Insites v5 Console email, password and the instance UUID. Fill in one way, not both. The tool refuses a form with both.

With the Insites v5 Console sign-in, the tool signs in once, takes the instance's admin key, and keeps only that key. It never keeps the password. How to get the GraphQL admin key shows both ways.

The key that starts with instance_ is refused. That is the instance's REST API key. It cannot read ids or history, so the tool stops and asks for the GraphQL admin key.

Allow about an hour for an instance of around 10,000 records. A bigger one takes longer.

What is copied

The Insites v5 to Insites v6 preset sets where each part goes, and the plan shows every rule before anything loads.

On Insites v5On Insites v6
Every table and its rows, including the tables that modules keep (the CRM among them)Copied with their original ids and dates. The tool reads every record table, not only the tables the admin lists, because a module's own tables are not in that list.
PeopleTheir email, names, slug and the id the CRM uses for them. Their passwords move only when you choose to move them.
Data module and Content Manager tablesMoved to modules/ins_databases/, so they show in the v6 Databases screen, with fields and list columns v6 accepts. Transform says how.
Pages, partials, layouts, notifications, authorization policies and formsCopied as the live code. A setting kept as the text 'true' or 'false' on a switch, such as is_sitemap_enabled on a page or on a CMS database's list or details layout, is stored as a real true or false, which v6 reads. A page keeps the sitemap choice it had, and gains none. A trigger condition of t or f, as v5 exports it, is written as true or false. A form that saves to a CRM table, such as modules/insites_core/crm_company, saves to the v6 CRM's table of the same name.
The site's own migrationsRecorded as already run on the new instance, without running them, so a later deploy does not run them again over the copied data. Each keeps its body. If the new instance refuses a body, the file says it was skipped and why, the migration stays recorded as run, and the To do list names it.
Files: assets and uploaded filesCopied from the old instance to the new one while the load runs. The tool does not store them.
Links to the old instance's filesAfter the files are copied, every address in the code (pages, partials, layouts, emails, CSS and JavaScript) and in the records that names one of the old instance's files, on its own address, its file storage or its old CDN hosts, is changed to the copy on the new instance. An address changes only when its file was copied and the copy opens. Links to other sites, and the old instance's page addresses, are never changed. Anything left is listed under the Links check. The run log counts the changes by kind.
ConstantsCopied value for value, in memory, when you leave them ticked.
Module versionsRead, so the plan can check that every module the old instance uses is on the new one.
Translation files and the code that uses themListed in the plan as a code job. A row or a page is copied whatever language it is written in.

What is copied lists every part, module by module.

What stays behind, and why

  • Live keys. Two module tables hold live keys: the instance configuration key and the constants. The tool replaces each value with a fingerprint before the row is stored. One of these keys can be the instance's own REST API key.
  • Password reset links. Every value in a reset table is scrambled as it is read, except the email, and the table is left behind. The new instance makes its own.
  • Form Submission activities. The v5 CRM logged one activity for every form submission, with the type Other and a subject such as "Form Submission: Contact - 501". On v6 a submission is kept on its contact under Related data, which lists every record linked to that person, so these activities are left behind. The plan and the run report give the count and the reason. Every other activity is copied. The submissions themselves are copied with the person each one belongs to.
  • The API call that logged those activities. A form that sent the v5 CRM's create_crm_activity API call is copied without it, so a submission on the new instance creates no activity. The form's other emails and API calls are kept.
  • The private files of a module of your own. The admin API does not list them. Each module of your own is named in the plan under Left behind with the step to take: deploy its private files to the new instance from the module's repository with the Insites CLI.

After the first copy

An Insites v5 source supports a final sync, which copies only what changed on the old instance since the last copy, and a drift check that shows what changed there. Both are on the Load and Launch steps. Copy first, then cut over explains the order.