6.8 インポート/エクスポート
FAQ記事(Ops Iでのナレッジ記事)、カテゴリーの一覧はCSVファイルでインポートやエクスポートができます。
ある時点でのFAQ記事、カテゴリーの一覧をファイルに保存することや、複数のFAQ記事、カテゴリーを一括で作成、編集できます。
インポート/エクスポートを行う環境で、目的に応じたテンプレートを使用します。テンプレートはあらかじめ用意されたテンプレートを使用するか、新規に作成します。ITSMアプリケーションでは次の3つのテンプレートが用意されています。
エクスポート:マッピングしたFAQ記事の値がCSVファイルに記載される。
インポート:CSVファイルに記載されている「FaqNumber」とインポート先環境の「FaqNumber」が一致しているFAQ記事の内容が更新される。CSVファイルに記載した「FaqNumber」がインポート先環境にない場合、CSVファイルに記載した「FaqNumber」のままインポートされる。
エクスポート:マッピングしたFAQ記事の値がCSVファイルに記載される。
インポート:「FaqNumber」が新たに採番され、FAQ記事が追加される。
エクスポート:マッピングしたカテゴリーの値がCSVファイルに記載される。
インポート:カテゴリーの名前がインポート先環境にない場合、インポートされる。
①~③に設定されている値は、本節の表を参照してください。
ここでは次の項目について説明します。
(1)テンプレートを作成
テンプレートとは、OTOBOのオブジェクトの種類やそのフィールドと入出力ファイルの情報の対応付けや、ファイルの書式などを定めたルールです。用意されたテンプレート①~③を使用する場合、新しくテンプレートを作成する必要はありません。必要に応じて、①~③のテンプレートを編集して使用してください。
次の手順でテンプレートを作成します。
メインメニューから[管理]を選択し、[管理]-[インポート/エクスポート]をクリックします。[インポート/エクスポートの管理]画面で[テンプレートを追加]ボタンをクリックします。 遷移する表示に従い、次のフィールドを入力します。
(表)基本情報の設定
| フィールド | 必須 | 説明 |
|---|---|---|
| 名前 | Yes | テンプレートの名前 任意の名前を入力します。 ①Overwrite FAQ articles (Built-in template) ②Add FAQ articles (Built-in template) ③Add categories (Built-in template) |
| 対象 | Yes | 「FAQ」または「カテゴリー」を選択します。 ①FAQ ②FAQ ③カテゴリー |
| 書式 | Yes | 「CSV」を選択します。 ①~③CSV |
| 有効 | Yes | 「有効」を選択します。 ①~③有効 |
| コメント | No | 任意のコメントを入力します。 ①~③空欄 |
(表)オブジェクト情報の設定
| フィールド | 必須 | 説明 |
|---|---|---|
| マッピング未設定の項目を空文字で上書きしない | Yes | 既存のFAQ記事またはカテゴリーを更新する場合、キー(インポート/エクスポートポートの対象になる項目)として選択されていないフィールドへの影響は以下になります。
|
| 既存のFAQを更新しない※1 | Yes | チェックすると、「FaqNumber」が一致しているFAQ記事を更新しません。CSVファイルで「FaqNumber」が空欄になっているなど識別子が設定されていない場合、エラーになります。 ①②チェックなし |
| 既存のカテゴリーを更新しない※2 | Yes | チェックすると、「Name」が一致しているカテゴリーを更新しません。 ③チェックあり |
| 添付ファイルを(各行の最後のエントリとして)インポート/エクスポートする※1 | Yes | 添付ファイルをインポート/エクスポートする場合、チェックしてください。 ①②チェックあり |
(表)フォーマット情報の設定
| フィールド | 必須 | 説明 |
|---|---|---|
| 桁のセパレータ | Yes | 「カンマ (,)」を選択します。 ①~③カンマ (,) |
| キャラクタセット | Yes | 「UTF-8」を選択します。 ①~③UTF-8 |
| ヘッダ情報を含む | Yes | 「はい」を選択します。 ①~③はい |
[マッピング要素の追加]をクリックし、CSVファイルの列に対応するフィールドを追加します。詳細は、「マッピング情報の設定」を参照してください。
FAQ記事とカテゴリーで設定できるキーは次の通りです。用意されたテンプレート①~③の設定値は説明欄を参照してください。
(表)FAQ記事のキー一覧
| キー | 必須 | 説明 |
|---|---|---|
| FaqNumber | No | FAQ記事に割り振られるユニークな番号 識別子として認識されます。 ①マッピング済み ②マッピングなし |
| Title | Yes | FAQ記事のタイトル ①マッピング済み ②マッピング済み <CSVファイルの記載> 全角/半角の区別なく合計で最大200文字を入力できます。 |
| Keywords | No | FAQ記事のキーワード ①マッピング済み ②マッピング済み <CSVファイルの記載> 全角/半角の区別なく合計で最大200文字を入力できます。 |
| Validity | Yes | FAQ記事の有効/無効の設定 ①マッピング済み ②マッピング済み <CSVファイルの記載> 対応する数字を入力してください。
|
| Language | Yes | FAQ記事の言語 ①マッピング済み ②マッピング済み <CSVファイルの記載> 対応する数字を入力してください。
|
| CreatedOn | No | FAQ記事が作成された時間(UTC形式) ①マッピングなし ②マッピングなし <CSVファイルの記載> 「YYYY/MM/DD hh:mm:ss」の形式で入力してください。 |
| UpdatedOn | No | FAQ記事が更新された時間(UTC形式) ①マッピングなし ②マッピングなし <CSVファイルの記載> 「YYYY/MM/DD hh:mm:ss」の形式で入力してください。 |
| Symptom | No | FAQ記事の事象 ①マッピング済み ②マッピング済み <CSVファイルの記載> 入力できる文字数に制限はありません。 |
| Problem | No | FAQ記事の問題 ①マッピング済み ②マッピング済み <CSVファイルの記載> 入力できる文字数に制限はありません。 |
| Solution | No | FAQ記事の解決 ①マッピング済み ②マッピング済み <CSVファイルの記載> 入力できる文字数に制限はありません。 |
| Comment | No | FAQ記事のコメント ①マッピング済み ②マッピング済み <CSVファイルの記載> 入力できる文字数に制限はありません。 |
| Category※ | Yes | FAQ記事のカテゴリー ①マッピング済み ②マッピング済み |
| ViewedNumber | No | FAQ記事が参照された回数 ①マッピングなし ②マッピングなし |
| State | Yes | FAQ記事のステータス ①マッピング済み ②マッピング済み <CSVファイルの記載> 対応する数字を入力してください。
|
(表)カテゴリーのキー一覧
| キー | 必須 | 説明 |
|---|---|---|
| Name | Yes | カテゴリーの名前 識別子として認識されます。 ③マッピング済み <CSVファイルの記載> 各階層のカテゴリーが「::」で区切られて表示されます。区切られた各カテゴリー名は、全角/半角の区別なく合計で最大50文字を入力できます。 |
| Label(ja) | No | カテゴリーの表示名(日本語) ③マッピング済み <CSVファイルの記載> 全角/半角の区別なく合計で最大50文字を入力できます。 |
| Label(en) | No | カテゴリーの表示名(英語) ③マッピング済み <CSVファイルの記載> 全角/半角の区別なく合計で最大50文字を入力できます。 |
| Validity | Yes | カテゴリーの有効/無効の設定 ③マッピング済み <CSVファイルの記載> 対応する数字を入力してください。
|
| Comment | Yes | カテゴリーのコメント ③マッピング済み <CSVファイルの記載> 全角/半角の区別なく合計で最大80文字を入力できます。 |
| CustomerID※1 | No | カテゴリーの顧客 ③マッピング済み |
| UserGroup※2 | No | カテゴリーのユーザーグループ ③マッピング済み |
| CreatedOn | No | カテゴリーが作成された時間(UTC形式) ③マッピングなし <CSVファイルの記載> 「YYYY/MM/DD hh:mm:ss」の形式で入力してください。 |
| UpdatedOn | No | カテゴリーが更新された時間(UTC形式) ③マッピングなし <CSVファイルの記載> 「YYYY/MM/DD hh:mm:ss」の形式で入力してください。 |
以下の条件のテンプレートでインポート/エクスポートする場合のCSVファイルの例を示します。
- 対象:FAQ
- 書式:CSV
- 添付ファイルを(各行の最後のエントリとして)インポート/エクスポートする:チェックあり
- 桁のセパレータ:カンマ (,)
- キー:FaqNumber、Title、Keywords、Validity、Language、CreatedOn、UpdatedOn、Symptom、Problem、Solution、Comment、State
- FAQ1(添付ファイルなし)
- FAQ2(添付ファイル2件)
- FAQ3(添付ファイル1件)
"10001","FAQ1","テスト用FAQ","1","3","2025/7/18 12:00","2025/7/18 12:00","このFAQはテストデータです。","このFAQはテストデータです。","このFAQはテストデータです。","このFAQはテストデータです。","2"
"10002","FAQ2","テスト用FAQ","1","3","2025/7/18 12:00","2025/7/18 12:00","このFAQはテストデータです。","このFAQはテストデータです。","このFAQはテストデータです。","このFAQはテストデータです。","2","Filename###dGVzdDEudHh0###ContentType###YXBwbGljYXRpb24vb2N0ZXQtc3RyZWFt###Content###dGVzdDFmaWxlDQrjgZPjgozjga/jg4bjgrnjg4jjgafjgZk=###Inline###0###","Filename###dGVzdC50eHQ=###ContentType###YXBwbGljYXRpb24vb2N0ZXQtc3RyZWFt###Content###dGVzdGZpbGUNCuOBk+OCjOOBr+ODhuOCueODiOOBp+OBmQ==###Inline###0###"
"10003","FAQ3","","1","3","2025/7/18 12:00","2025/7/18 12:00","このFAQはテストデータです。","このFAQはテストデータです。","このFAQはテストデータです。","このFAQはテストデータです。","2","Filename###dGVzdDEudHh0###ContentType###YXBwbGljYXRpb24vb2N0ZXQtc3RyZWFt###Content###dGVzdDFmaWxlDQrjgZPjgozjga/jg4bjgrnjg4jjgafjgZk=###Inline###0###"
また、FAQ記事の「事象」、「問題」、「解決」、「コメント」に添付された画像は、HTMLタグを利用して次のようにエクスポートされます。
注意事項
- FAQ記事、カテゴリーの作成/編集の際のフィールド名は主に日本語表記ですが、マッピング情報の設定画面でキーに表示される選択肢は英語表記となります。出力されるCSVファイルのヘッダー行の値も英語表記になります。
- 仕様範囲外の値を含むFAQ記事およびカテゴリーはエラーとなり、インポートされません。
- インポート先の環境でキーに選択した順番と、CSVファイルの列の順番は合わせてください。
- Ops I以外の環境からインポートするなど、インポート用のCSVファイルを自作する場合、上記の仕様に合わせてください。また、不要な列(Ops Iのテンプレートではキーに設定していない項目が記載された列など)がある場合、列ごと削除してください。
エクスポート対象を制限したい場合は、[検索条件を適用する:]をチェックし、残りのフィールドで検索条件を設定します。
検索条件はすべてand条件です。条件に一致する対象がない場合、ヘッダー情報のみエクスポートされます。
用意されたテンプレート①~③では、検索条件は設定されていません。
FAQ記事とカテゴリーで設定できる検索条件は次の通りです。
(表)FAQ記事の検索条件一覧
| フィールド | 説明 |
|---|---|
| 検索条件を適用する | チェックすると、検索条件が適用されます。 |
| キーワード | 入力した値と完全一致する「キーワード」を持つFAQ記事を指定します。 |
| 言語 | 選択した値と一致する「言語」を持つFAQ記事を指定します。 |
| カテゴリー | 選択した値と一致する「カテゴリー」を持つFAQ記事を指定します。選択したカテゴリーの親カテゴリーに属するFAQ記事は対象になりません。 |
| ステータス | 選択した値と一致する「ステータス」を持つFAQ記事を指定します。 |
| 有効/無効 | 選択した値と一致する「有効/無効」を持つFAQ記事を指定します。 |
| FAQ作成日時 (入力時間より後) | 入力した時間より後に作成されたFAQ記事を指定します。 |
| FAQ作成日時 (入力時間より前) | 入力した時間より前に作成されたFAQ記事を指定します。 |
| FAQ最終更新日時 (入力時間より後) | 入力した時間より後に更新されたFAQ記事を指定します。 |
| FAQ最終更新日時 (入力時間より前) | 入力した時間より前に更新されたFAQ記事を指定します。 |
(表)カテゴリーの検索条件一覧
| フィールド | 説明 |
|---|---|
| 検索条件を適用する | チェックすると、検索条件が適用されます。 |
| 親カテゴリー | 選択した値と一致する「親カテゴリー」を持つカテゴリーを指定します。 |
| 有効/無効 | 選択した値と一致する「有効/無効」を持つカテゴリーを指定します。 |
| 顧客 | 選択した値と一致する「顧客」を持つカテゴリーを指定します。 |
| ユーザーグループ | 選択した値と一致する「ユーザーグループ」を持つカテゴリーを指定します。 |
| カテゴリー作成日時 (入力時間より後) | 入力した時間より後に作成されたカテゴリーを指定します。 |
| カテゴリー作成日時 (入力時間より前) | 入力した時間より前に作成されたカテゴリーを指定します。 |
| カテゴリー最終更新日時 (入力時間より後) | 入力した時間より後に更新されたカテゴリーを指定します。 |
| カテゴリー最終更新日時 (入力時間より前) | 入力した時間より前に更新されたカテゴリーを指定します。 |
(2)FAQ記事、カテゴリーのエクスポート
メインメニューから[管理]を選択し、[管理]-[インポート/エクスポート]をクリックすると、[インポート/エクスポートの管理]画面に遷移し、テンプレートの一覧が表示されます。
エクスポート対象のテンプレートの[エクスポート開始]カラムにある[エクスポート]をクリックすると、テンプレートの設定内容に基づいたCSVファイルがダウンロードできます。
【CSVファイルのファイルサイズに関する制限と対応】
- ファイルサイズ:
インポートできるCSVファイルのサイズは500MBまでです。エクスポートしたCSVファイルをそのままインポートしたい場合は、ファイルサイズが500MB以内になるように調整してください。一部添付ファイルを含むFAQ記事の場合、700件が限度となります。カテゴリー、FAQ記事ともに700件以内を目安にしてください。 - タイムアウト:
CSVファイルのサイズが大きい場合、インポートまたはエクスポート処理に30分以上かかり、タイムアウトすることがあります。 - タイムアウトの対応:
- エクスポート:検索条件を設定し、ファイルを分割してエクスポートしてください。
- インポート:タイムアウトしても内部で処理が続いている場合があるので、時間をおいてからFAQ記事やカテゴリーを確認し、不足分を用意されたテンプレート①③でインポートしてください。
- エクスポートすると、BOM無しのUTF-8でエンコードしたファイル(CSV形式)がダウンロードされます。このファイルをテキストエディタで開いた場合は正常に表示されます。Excelで開いた場合は文字化けするので、ファイルをBOM付きのUTF-8にエンコードして保存し直してください。
- 検索情報の設定でカテゴリーをフィルタした場合、そのカテゴリーのみがエクスポートの対象になります。親カテゴリー、サブカテゴリーはエクスポートされません。
- CSVファイルの該当列に適切な値を記述していること
- 新規クラスの作成やクラスの編集によって必須のフィールドが存在する場合、そのフィールドのマッピング要素を含め、CSVファイルに適切な値を記述していること
- CSVファイルのインポートではFAQ記事、カテゴリーの削除はできません。
- インポートしたFAQの投票情報は初期化されます。
- CSVファイルは、一度に500MBまでインポートできます。1つのCSVファイルのFAQ記事、カテゴリーの件数は700件以内を目安にしてください。インポートに30分以上かかる場合はタイムアウトが発生します。その場合の対応手順について、「CSVファイルのファイルサイズに関する制限と対応」を参照してください。
- FAQ記事の「事象」、「問題」、「解決」、または「コメント」に添付された画像がある場合も、「添付ファイルを(各行の最後のエントリとして)インポート/エクスポートする」にチェックをしてください。チェックがない場合、添付された画像はインポートされません。添付された画像の代わりに、壊れた画像のアイコンが表示されます。
- 更新時は以下に注意してください。
- CreatedOnはマッピングの有無にかかわらずインポートされません。
- 「マッピング未設定の項目を空文字で上書きしない」をチェックしていない、かつ、UpdatedOnをマッピングしていない場合、UpdatedOnにはインポートされた時刻が入ります。
- 新規作成時は以下に注意してください。
- 「マッピング未設定の項目を空文字で上書きしない」のチェックの有無に影響を受けません。
- CreatedOnとUpdatedOnをマッピングする場合、CreatedOnとUpdatedOnにはCSVファイルに記載された時刻が入ります。
- CreatedOnとUpdatedOnをマッピングしない場合、CreatedOnとUpdatedOnにはインポートされた時刻が入ります。
注意事項
(3)FAQ記事、カテゴリーのインポート
メインメニューから[管理]を選択し、[管理]-[インポート/エクスポート]をクリックすると、[インポート/エクスポートの管理]画面に遷移し、テンプレートの一覧が表示されます。
インポート対象のテンプレートの[インポート開始]カラムにある[インポート]をクリックし、インポートするCSVファイルを選択すると、テンプレートの設定内容に基づいてCSVファイルからFAQ記事、カテゴリーの情報を取得しインポートします。
カテゴリーは階層構造になっているため、CSVファイル内で上位の階層のカテゴリーを下位の階層より上の行に記載してください。また、カテゴリーが存在しないFAQ記事はエラーとなりインポートされないため、FAQ記事より先にカテゴリーをインポートしてください。
1件以上のインポートが成功した場合にはFAQ記事、カテゴリーのインポートサマリーにインポートに成功した件数と失敗した件数が表示されます。インポート自体に失敗した場合はエラーの原因が表示されます。
インポートの一部、およびインポート自体の失敗の詳細はメインメニュー[管理]の[管理]-[システムログ]から確認できますが、ログの表示件数が200件前後のため、ログの確認はインポート後すぐに実施してください。また、CSVファイルの文字コードが間違っているためインポートされたデータが欠損している場合などもログに表示されますので、インポートが成功した場合もログを確認することを推奨します。
失敗したFAQ記事、カテゴリーがある場合、対象、原因を特定し、修正した上で再度インポートしてください。
CSVファイルで新しいFAQ記事、カテゴリーを作成するには、次の事項を記述している必要があります。
注意事項
(4)ユースケース
用意されたテンプレートの使用例は次の通りです。①~③は以下のテンプレートを示します。
①Overwrite FAQ articles (Built-in template)
②Add FAQ articles (Built-in template)
③Add categories (Built-in template)
詳細は「テンプレートを作成」を参照してください。
sandbox環境で事前に用意したFAQ記事をFAQ記事が何も登録されていない本番環境に登録する場合、次の操作を行ってください。
sandbox環境で事前に用意した新規顧客用のFAQ記事を、新規顧客用のFAQ記事が登録されていない本番環境に登録する場合、次の操作を行ってください。ただし、本番環境側で個別にFAQ記事を登録している場合、sandbox環境と本番環境の「FaqNumber」が重複している可能性があるため、「FaqNumber」が被らないようにしてください。
sandbox環境から本番環境にインポート済のFAQ記事をsandbox環境で更新し、更新内容を本番環境に反映したい場合、次の操作を行ってください。このとき、すでに同じFAQ記事を本番環境に登録しているため、同じ「FaqNumber」を指定して更新してください。
なお、本番環境で個別にFAQ記事を作成するなどして、sandbox環境と本番環境の「FaqNumber」が一致していない場合、手動で本番環境の「FaqNumber」に変更してからインポートしてください。
本番環境で個別に作成したFAQ記事をsandbox環境に登録する場合、次の操作を行ってください。
本番環境からsandbox環境にインポートしていたFAQ記事を本番環境で更新し、更新内容をsandbox環境に反映したい場合、次の操作を行ってください。このとき、すでに同じFAQ記事をsandbox環境に登録しているため、同じ「FaqNumber」を指定して更新してください。
なお、sandbox環境で個別にFAQ記事を作成するなどして、sandbox環境と本番環境の「FaqNumber」が一致していない場合、手動でsandbox環境の「FaqNumber」に変更してからインポートしてください。
顧客の既存環境からOps Iに移行するなど、Ops I以外の環境で用意したFAQ記事をFAQ記事が何も登録されていないOps Iに登録する場合、次の操作を行ってください。
このとき、添付ファイルのファイルパスをBase64にエンコードしてください。
sandbox環境で事前に用意したカテゴリーをカテゴリーが何も登録されていない本番環境に登録する場合、次の操作を行ってください。
本番環境で個別に作成したカテゴリーをsandbox環境に登録する場合、次の操作を行ってください。