ImportExportObject プラグインの機能により、ユーザー/記事/ウェブページ/カテゴリ/フォルダ/アイテム/カスタムフィールド(これらのデータの種類を総称して「オブジェクト」と呼びます)のインポートとエクスポートが可能です。インポートでは既存データの更新を行うことも可能です。特筆しない限り、どのオブジェクトに対しても共通の操作が可能です。
レガシーな機能である、記事/ウェブページの拡張フィールドには対応していません。拡張フィールドを含めたインポート、エクスポートについては、CSVインポート機能、PowerCMS形式でのインポート&エクスポートを利用してください。
上記に記載のない場合でも、各機能を提供しているプラグインが個別にインポートやエクスポートの機能を提供していることがあります。
サイドメニュー [インポート/エクスポート] - [インポート/エクスポート] から行うことができます。システム管理者またはワークスペース/スペース管理者のみ実行できます。
ユーザーのインポート/エクスポートは、システムレベルで、システム管理者のみ行うことができます。
[オブジェクト] ドロップダウンからインポート/エクスポート対象のオブジェクトを選択すると [インポート] および [エクスポート] ボタン、添付ファイル入力欄が表示されます。インポートする場合は CSV ファイルを選択して [インポート] を、エクスポートする場合は [エクスポート] ボタンをクリックしてください。
エクスポートのオプション
- IDを除外する
- エクスポート CSV に ID 列を含めないようにします。キーとなる列の情報を含めないことにより、エクスポートした CSV そのままで新規のデータ投入ができるようにするものです。
- ワークスペース/スペースIDを除外する
- ID の除外と合わせて、エクスポートした CSV を使って、別のワークスペース/スペースに新規のデータ投入できるようにするものです。
- UTF-8 エンコーディングを使用する
- 通常、エクスポートファイルはエクセルで開けるよう、Shift_JIS エンコーディングになっていますが、エディタ等で編集する場合はこのオプションを指定します。
- CSV ファイルに id 列が存在する場合、指定された ID を持つ既存データに対して CSV ファイルの内容で上書きを行う動作となります。
- CSV ファイルに id 列が存在しない場合、CSV ファイルの内容でデータを新規追加する動作となります。
一覧画面でのエクスポート
各オブジェクトでは、一覧画面からの CSV エクスポートが可能です。この場合はチェックを入れたデータだけを対象とするエクスポートが可能です。
インポート CSV
インポート CSV には1行目にオブジェクトのカラム名を入力し、2行目以降に対応するデータを入力します。
CSV の作成にあたっては、エクスポートしたファイルを雛形として利用するのが確実です。
既存データの更新と新規追加について
使用する CSV のフォーマットによって、既存データの更新か新規追加のどちらかに切り替わります。
※ id 列へは空の指定ができません。id 列が存在する場合は既存オブジェクトの ID を必ず指定してください。新規インポートを行う場合は id 列ごと削除してください。
スニペットフィールドのインポートについて
スニペットフィールドのインポートについては、他カスタムフィールドとデータの記述形式が異なります。name 属性と値は「: (コロン)」で区切り、name 属性と値のセットは「; (セミコロン)」で区切ります。
スニペットフィールド hoge の foo に1 を、bar に2 を設定する場合
foo:1;bar:2
※ コロンとセミコロンの区切り文字については環境変数の指定によって変更可能です。
アイテムのインポート
アイテムのインポートについては、CSV ファイルと Zip ファイルで行います。アイテムはワークスペース/スペースの公開パス以下に Zip ファイル作成時の階層を保ってアップロードされます (CSV を添付しなくてもアイテムは登録されます)。
同一階層に同一ファイル名のアイテムが存在する場合は名前をユニークなものに変更して登録を行います。既存アイテムの上書きはされません。
ユーザーのインポート
ユーザーのインポートでは、以下の形式で CSV を作成します。
name | nickname | password | status | field.author_category | (空欄) | (空欄) | |
username | username@example.jp | システム管理者 | ****** | 1 | 1_ワークスペース管理者 | 2_スペース管理者 |
1行目 (項目名) はユーザー情報を格納する mt_author テーブルのカラム名です。カスタムフィールドの値については field.カスタムフィールドのベースネーム
の形式で指定してください。
ロールの割当て
ユーザーのインポート/エクスポートでは、ユーザーに割り当てたいロールを指定することができます。アンダースコア ( _ ) で区切られたロール名の前の数字は登録するワークスペース/スペースの ID です (「0_システム管理者」とするとシステム管理権限が設定されます)。
※ ロールはいくつでも設定できますが、ひとつ以上の権限を指定した場合、該当ユーザに割り当てられていた他の権限は削除されます。権限についての指定がない場合は削除は行いません
ユーザーを新規作成する場合
name / nickname / email / password 列とその内容が必須となります。
既存ユーザー情報を更新する場合
インポート/エクスポートの機能を使って既存ユーザーの情報を更新することができます。対象となるユーザーの特定は、id 列ではなく name 列の値を使って行われます。password 列を空にしておくと、既存のパスワードが維持されます。
環境変数
環境変数 | 解説 | 初期値 |
---|---|---|
ImportExportSnippetSeparator | スニペットフィールドをインポートする際、name 属性と値の区切り文字を任意に指定変更できます。 | : (コロン) |
ImportExportSnippetDelimiter | スニペットフィールドをインポートする際、name 属性単位の区切り文字を任意に指定変更できます。 | ; (セミコロン) |