How To Migrate Kintone Data To A New Environment

Contents

Overview

This tutorial explains how to migrate Kintone data to a new environment.

Kintone data is migrated by retrieving data from the original environment and restoring it in the new environment.

Data That Can Be Retrieved

The following data can be retrieved and restored in the new environment.

  • Apps

    • App settings
    • Records
    • JavaScript and CSS customization files applied to Apps

  • Spaces

    • Space settings

  • Kintone system-wide

    • Plug-ins
    • JavaScript and CSS customization files applied to Kintone system-wide

  • Integration service settings

Kintone does not have a feature to retrieve all data at once.
Use a dedicated integration service or do it manually.

Data That Cannot Be Retrieved

API tokens and webhook URLs

API tokens and Webhook URLs cannot be carried over to the new environment. Users have to regenerate them in the new environment.

Data that cannot be retrieved via import/export or API

The following data cannot be retrieved via file import/export or API. If data retention is required for audit purposes, keep the data in the original environment.

  • Record change history

  • Process management status history

  • Automatically assigned numbers and IDs at creation:

    • Record number

    • Thread ID

    • Comment ID

    • Process management action history ID

    • Attachment file ID

    • App ID

    • Space ID

  • Record comments
    Record comments can be retrieved, but cannot be fully restored because the date, time, and poster cannot be retrieved.

  • Periodic reports

Data Migration

This section explains the retrieval and restoration methods for each data type.

Apps

App settings
Retrieval / Restoration Method
Retrieval Export App information as an App template and download it. For detailed steps, refer to the following help page.
Downloading apps as templates (External link)

In-space App settings can be exported as a Space template.
Space settings

Some settings cannot be exported as an App template.
Settings that are not included in app templates (External link)

If these settings are needed, reconfigure them after restoring the App.
Restoration Import the exported App template into the new environment.
Creating apps from template files (External link)
Records
Retrieval / Restoration Method
Retrieval Export record data to a file using Kintone's file export feature or cli-kintone. Attached files cannot be exported using Kintone's file export feature. To retrieve Apps that include attachment fields, use cli-kintone.
Restoration Import the exported record data into the new environment using Kintone's file import feature or cli-kintone.
JavaScript and CSS customization files applied to Apps
Retrieval / Restoration Method
Retrieval JavaScript and CSS customization files applied to Apps are included in the zip file exported as a Space template or App template.
To retrieve only customization files without exporting as a template, download the files directly from the App settings.
Restoration When restoring Apps or Spaces using App templates or Space templates, JavaScript and CSS customization files are automatically restored.
If the files are manually downloaded, reimport the files to the new App. If the code uses App IDs, record IDs, or API tokens, update them to match the new environment.

Space

Space settings
Retrieval / Restoration Method
Retrieval Export Space information as a Space template and download it. For detailed steps, refer to the following help page.
Exporting a space template to a file (External link)

Some settings cannot be exported as a space template.
Data that is not included in space templates (External link)

If these settings are needed, reconfigure them after restoring the space.
Restoration Import the exported Space template into the new environment.
Importing a space template from a file (External link)

Kintone System-wide

Plug-ins
Retrieval / Restoration Method
Retrieval Plug-in files loaded into Kintone cannot be retrieved. If a plug-in file is lost, contact the plug-in developer. Plug-in settings also cannot be retrieved. Take note of the settings before migration.
Restoration
  1. Import the plug-in to the new environment.
    Adding plug-ins by importing plug-in files (External link)
  2. Open the App where the plug-in was applied, and reconfigure the plug-in.
JavaScript and CSS customization files applied to Kintone system-wide
Retrieval / Restoration Method
Retrieval Retrieve JavaScript and CSS customization files applied to Kintone system-wide using the following steps.
  1. Open the JavaScript and CSS Customization under Kintone administration.
  2. Copy and save the URLs of JavaScript files and CSS files added via URL.
  3. Download JavaScript files and CSS files that were uploaded and added.
Restoration Apply the customization settings in the new environment. Configure the saved URLs and upload the retrieved files to the new environment.

Integration service settings

Integration services need to be reconfigured in the new environment.
For more information, contact the integration service developer.

Confirmation And Testing

After migrating data to the new environment, verify data integrity, and test customizations, plug-ins, and integration services.