kintoneのデータのバックアップと新しい環境への復元方法

目次

はじめに

このTipsでは、kintoneのデータをバックアップし、新しい環境へ復元する方法を説明します。

バックアップが必要なデータ

次のデータをバックアップし、新しい環境に復元してください。

  • アプリ
    • アプリの設定情報
    • アプリのレコード情報
    • アプリに適用したJavaScriptやCSSカスタマイズのファイル
  • スペース
    • スペースの設定情報
  • kintone全体
    • プラグイン
    • kintone全体に適用したJavaScriptやCSSカスタマイズのファイル
  • 連携サービスの設定

kintone上にあるデータを、一括でバックアップする機能はありません。
専用の連携サービスの利用、または手動での作業が必要です。

手動でのバックアップ方法や復元方法の詳細は、次を参照してください。
バックアップと新しい環境への復元

バックアップできない情報

APIトークンやWebhookのURL

移行前の環境で生成したAPIトークンやWebhookのURLは、新しい環境に引き継ぐことができません。
新しい環境で生成し直してください。
これらをkintoneカスタマイズや連携で使用している場合には、生成し直した値に書き換えてください。

ファイル入出力やAPIで取得できない情報

以下の情報は、製品の仕様上、ファイル入出力やAPIでのデータ取得ができないため、バックアップ・移行のいずれもできません。
証跡としてデータ保管が必要な場合は、元の環境で保持しておくようにしてください。

  • レコードの変更履歴
  • プロセス管理のステータス履歴
  • 作成時に自動採番される番号・ID
    • レコード番号
    • スレッドID(スペース内スレッド)
    • コメントID
    • プロセス管理のアクション履歴ID
    • 添付ファイルID
    • アプリID
    • スペースID
  • レコードのコメント
  • 定期レポート
tips
補足

レコードのコメントは、内容の取得・登録はできますが、日時と投稿者が再現できないため完全に復元はできません。

バックアップと新しい環境への復元

アプリ

アプリの設定情報
バックアップ

アプリの情報を、アプリテンプレートとしてファイルに書き出してダウンロードします。
手順の詳細は、次のページを参照してください。
移行元のkintoneでの操作|kintone ヘルプ (External link)

なお、スペース内アプリの設定情報は、スペーステンプレートで書き出しできます。
スペース内アプリとして引き続き利用する場合には、スペーステンプレートとして書き出してください。
スペースの設定情報

アプリテンプレートに書き出せない設定もあります。
アプリテンプレートに含まれない設定 | kintone ヘルプ (External link)
これらの設定が必要な場合には、アプリを復元した後に再設定してください。

新しい環境への復元

書き出したアプリテンプレートを、新しい環境に読み込みます。
移行先のkintoneでの操作 | kintone ヘルプ (External link)

アプリのレコード情報
バックアップ

kintoneのファイルに書き出す機能やcli-kintoneを使用して、レコードのデータをファイルに書き出します。
添付ファイルは、 kintoneのファイルに書き出す機能では書き出しできません。
添付ファイルフィールドを含むアプリをバックアップしたい場合には、cli-kintoneを使用してください。

新しい環境への復元

kintoneのファイルを読み込む機能やcli-kintoneを使用して、書き出したレコードのデータを新しい環境に読み込みます。

アプリに適用したJavaScriptやCSSカスタマイズのファイル
バックアップ

アプリに適用したJavaScriptやCSSのカスタマイズファイルは、スペーステンプレートやアプリテンプレートとしてバックアップしたzipファイルに含まれます。
ただし、テンプレートとして書き出さずにカスタマイズファイルだけをバックアップしたい場合には、自身でファイルをダウンロードしてください。

新しい環境への復元

アプリテンプレートやスペーステンプレートで、アプリやスペースを復元すると、JavaScriptやCSSカスタマイズファイルも自動で復元されます。
手動でカスタマイズファイルをダウンロードしている場合には、作成したアプリにファイルを適用し直してください。
ただし、コード内でアプリ番号、レコード番号、APIトークン等を利用している場合、新しい環境に合わせて書き換えが必要となります。

スペース

スペースの設定情報
バックアップ

スペースの情報を、スペーステンプレートとしてファイルに書き出してダウンロードします。
手順の詳細は、次のページを参照してください。
スペーステンプレートをファイルに書き出す | kintone ヘルプ (External link)

スペーステンプレートに書き出せない設定もあります。
スペーステンプレートに含まれないデータ | kintone ヘルプ (External link)
これらの設定が必要な場合には、スペースを復元した後に再設定してください。

新しい環境への復元

書き出したスペースのテンプレートを、新しい環境に読み込みます。
ファイルからスペーステンプレートを読み込む | kintone ヘルプ (External link)

kintone全体

プラグイン
バックアップ

kintoneに読み込んだプラグインファイルは、バックアップできません。
プラグインファイルを紛失した場合には、プラグインの開発者に問い合わせてください。

また、プラグインの設定情報もバックアップできません。
移行前の設定情報を、メモして控えてください。

新しい環境への復元
  1. 新しい環境で、プラグインを読み込みます。
    ファイルを読み込んでプラグインを追加する|kintone ヘルプ (External link)
  2. プラグインを適用していたアプリを開き、プラグインを設定し直します。
kintone全体に適用したJavaScriptやCSSカスタマイズのファイル
バックアップ

kintone全体のカスタマイズとして適用しているJavaScriptやCSSファイルは、次の手順でバックアップします。

  1. kintoneシステム管理の「JavaScript / CSSカスタマイズ」画面を開く。
  2. URL指定で追加している、JavaScriptファイルやCSSファイルのURLをコピーして控えておく。
  3. アップロードして追加している、JavaScriptファイルやCSSファイルをダウンロードする。
新しい環境への復元

新しい環境で、kintone全体のカスタマイズの設定を適用し直します。
控えておいたJavaScriptファイルやCSSファイルのURLを設定し、バックアップしたファイルを新しい環境にアップロードします。

連携サービスの設定

連携サービスについては、新しい環境に再設定する必要があります。
詳しくは連携サービスの開発者に問い合わせてください。

移行後の確認とテスト

新しい環境にデータを移行した後は、データの整合性やカスタマイズ、プラグイン、連携サービスの動作確認を実施してください。

まとめ

このTipsでは、kintoneを新しい環境に移行する際の、バックアップが必要なデータや移行方法について説明しました。
kintoneを新しい環境に移行する際は、手順を確認してから作業することをおすすめします。
また、プラグインや連携サービスについては、新しい環境に再設定する必要があるため、移行前に設定内容を確認してください。