コンフィグセットのエクスポート・インポート (Ver. 3.2.29 ~)


Ver. 3.2.29 よりコンフィグセット単位でのエクスポート・インポートができるようになりました。

コンフィグセット1件分の設定(基本設定・編集画面設定・テーマ設定のいずれか)を書き出し(エクスポート)、別のブログ・別サイトの a-blog cms に取り込む(インポート)機能です。次のような場面で使えます。

  • 本番環境で作成したコンフィグセットを、同じ構成のステージング環境や開発環境に複製する

  • 複数のブログを運用していて、あるブログのコンフィグセットを別のブログでも使う

  • コンフィグセットの内容を変更する前に、現状をファイルとして保存しておく

対象になるデータ

選択したコンフィグセット(基本設定・編集画面設定・テーマ設定のいずれか)に保存されている設定値がまるごと対象です。

  • ルール別に上書きされた設定は対象になりません。インポート後、必要であればルールごとに再設定してください。

  • カテゴリーを参照する設定値は、インポート先のブログに同じカテゴリーコードのカテゴリーが一意に存在する場合のみ引き継がれます。見つからない場合や、同じカテゴリーコードのカテゴリーが複数存在し一意に決まらない場合は未設定にリセットされます。

  • メディアを参照する設定値は、インポート先のブログでは引き継がれず、常に未設定にリセットされます。

必要な権限

エクスポート・インポートいずれも、ロール機能を使っている場合は「コンフィグの編集」権限が必要です。ロール機能を使っていない場合は、管理者権限を持つユーザーのみ実行できます。

エクスポートの手順

  1. 管理ページの「コンフィグ」(編集画面設定なら「編集画面」、テーマ設定なら「テーマ」)から、コンフィグセット管理画面を開きます。

  2. エクスポートしたいコンフィグセットの行にある「コンフィグ」ボタン横のプルダウンから「エクスポート」を選びます。

  3. yamlファイルがダウンロードされます。ファイル名は config_set_YYYYMMDD_HHmm.yaml の形式です。

インポートの手順

  1. コンフィグセット管理画面上部の「インポート」ボタンから、コンフィグセットインポート画面を開きます。

  2. エクスポートでダウンロードしたyamlファイルをアップロードします。

  3. 「インポート方法」で「新しいコンフィグセットとして作成する」か「既存のコンフィグセットを上書きする」を選びます。

  4. 「インポートを実行する」をクリックします。

運用・移行時の注意点

  • 「既存のコンフィグセットを上書きする」を選んだ場合、対象のコンフィグセットの既存の設定内容はすべて失われます。誤って本番環境のコンフィグセットを上書きしないよう、事前にエクスポートしてバックアップを取っておくことを推奨します。

  • 上書きは、同じブログ内にある同じ種類(基本設定・編集画面設定・テーマ設定)のコンフィグセットにのみ実行できます。異なる種類のコンフィグセットを上書き先に選んだ場合はエラーになります。

  • 「新しいコンフィグセットとして作成する」を選んだ場合、作成されるコンフィグセットの公開範囲は常に「ローカル」(インポートを実行したブログ専用)になります。グローバルなコンフィグセットとして使いたい場合は、インポート後に設定を変更してください。

  • 異なるバージョンの a-blog cms 間でのインポートは動作保証されていません。できるだけ同じバージョン同士で利用してください。

「コンフィグの部分エクスポート・インポート」は別機能です

コンフィグの各設定ページ(編集中の画面)から進める「部分エクスポート・インポート」は、ここで説明したコンフィグセット単位のエクスポート・インポートとは別の機能です。混同しないよう注意してください。

  • 部分インポートは、yamlにある項目だけを上書きする「部分マージ」です。yamlにない項目は削除されず、既存の設定が保持されます。

  • ここで説明したコンフィグセットのエクスポート・インポートは、コンフィグセットそのもの(名前付きの設定のまとまり)を対象に、新規作成または全項目の置き換え(上書き)を行います。