テンプレートCSVフォーマット
タスク管理利用ガイドの「CSVでテンプレートをまとめて登録・更新する(インポート)」で使用するCSVファイルの、具体的な書き方をまとめた資料です。
ファイルの基本ルール
-
文字コード: UTF-8(BOM付)または Shift-JIS(CP932)。取り込み時に自動判別されます。
-
拡張子: .csv
-
ファイルサイズ: 最大4MB
-
行数: 最大2,500行
-
ブロック数(テンプレート件数): 最大500ブロック
-
1つのファイルに複数のテンプレート(複数ブロック)をまとめて記載できます。
サンプル
以下は、テンプレートを1件新規登録するCSVの例です。
CREATE-START
SYSTEMUID,tpl-001
TITLE,月次決算処理テンプレート
TASK-TITLE,月次決算処理
DESCRIPTION,毎月の決算処理の標準的な手順です。
STEP,"前月データの回収(経理, 総務共同)",https://example.com/manual/step1
ITEM,売上データのインポート,
STEP,帳票の作成,
EDOC,d1234567890,https://edoc.example.com/nodes/d1234567890,月次帳票作成手順書.pdf
ITEM,承認申請,
APP,pca-cloud-sacc20,A010
CREATE-END
この例では、1つ目の作業手順(「前月データの回収(経理, 総務共同)」)には手順書のURLを直接指定し、2つ目の作業手順(「帳票の作成」)にはeDOCへアップロード済みのファイルをEDOC行で紐づけ、作業内訳(「承認申請」)にはアプリケーション連携をAPP行で設定しています。
1つ目の作業手順名のように、値にカンマを含める場合は値全体をダブルクォートで囲みます。
ブロック(CREATE/UPDATE/DELETE)
CSVは、以下の3種類のブロックを組み合わせて作成します。1つのファイルに異なる種類のブロックを混在させることができます。
|
ブロック |
開始行 |
終了行 |
動作 |
|---|---|---|---|
|
新規登録 |
CREATE-START |
CREATE-END |
SYSTEMUIDが既存のどのテンプレートとも一致しない場合に新規登録します。一致するものが既にある場合はエラーになります。 |
|
変更 |
UPDATE-START |
UPDATE-END |
SYSTEMUIDが既存のテンプレートと一致する場合に、その内容を丸ごと更新します。一致するものが無い場合はエラーになります。 |
|
削除 |
DELETE-START |
DELETE-END |
SYSTEMUIDが既存のテンプレートと一致する場合に、そのテンプレートを削除します。 |
UPDATEブロックは対象テンプレートの内容を全て置き換えます。CSVに書かれていない作業手順・作業内訳は削除されるので注意してください。
各行の書き方
CREATE/UPDATEブロックの中には、以下の行を書きます。1行は「項目名」に続けて、行の種類ごとに定められた数の値をカンマ区切りで並べます(例: STEPは「項目名,値1,値2」の2値、EDOCは「項目名,値1,値2,値3」の3値)。
TITLE・TASK-TITLE・DESCRIPTION・STEP・ITEMの名称部分に、カンマ・改行・ダブルクォートを含めたい場合は、一般的なCSVの引用規則に従い、値全体をダブルクォート(")で囲んでください。
値中のダブルクォートは""のように2つ重ねてエスケープします(例: STEP,"手順A, ""特急""対応", )。
エクスポートしたCSVも同じ規則で出力されるため、そのまま再インポートできます。
|
行 |
必須 |
内容 |
|---|---|---|
|
SYSTEMUID |
CREATEは任意/UPDATE・DELETEは必須 |
照合キー。英数字とハイフンのみ使用できます。CREATEで省略した場合は自動的に採番されます(AUTO-で始まる値を自分で指定することはできません)。テンプレート一覧・詳細・変更画面に表示される「システムUID」がこの値です。 |
|
SHARED |
任意 |
SYSTEMUIDの直後にのみ書ける、値を持たない行です。指定すると、システム共通テンプレートを保守できる組織からのインポート時に限り、システム共通テンプレートとして登録されます(保守権限が無い組織からインポートした場合は、このブロック自体が取り込まれずに破棄されます)。 |
|
TITLE |
CREATE・UPDATEで必須 |
テンプレート名。 |
|
TASK-TITLE |
CREATE・UPDATEで必須 |
このテンプレートから作成されるタスクの名前。 |
|
DESCRIPTION |
任意 |
テンプレートの説明。 |
|
STEP |
任意(複数可) |
作業手順。「作業手順名,手順書URL」の形式です。手順書を紐づけない場合はURLを空欄にします。 |
|
ITEM |
任意(複数可) |
作業内訳。直前のSTEPに属します。書き方はSTEPと同じです。 |
|
EDOC |
任意 |
直前のSTEPまたはITEMにeDOC手順書を紐づけます。「eDOCのノードID,eDOCのURL,ファイル名」の3つの値を指定します。値は、対象の作業手順・作業内訳の詳細画面、またはエクスポートしたCSVから確認できます。STEP/ITEM行の手順書URLが指定されている場合は、同じ行にEDOC行を続けることはできません(どちらか一方のみ)。 |
|
APP |
任意 |
直前のSTEPまたはITEMにPCAクラウドアプリケーションを連携します。「アプリケーションのID,アイテムのID」の2つの値を指定します。実際に存在するアプリケーション・画面の組み合わせのみ指定できます。値は、エクスポートしたCSVから確認するのが確実です。 |
EDOC・APPは、直前に出現したSTEPまたはITEM1件につき、それぞれ1回だけ指定できます。STEP/ITEM行が無い状態でいきなりEDOC・APPを書いたり、同じ作業手順に2回続けて書いたりするとエラーになります。
よくあるエラー
|
状況 |
結果 |
|---|---|
|
TITLE・TASK-TITLE(CREATE・UPDATE共通)、SYSTEMUID(UPDATE・DELETEのみ必須)など、ブロック種別ごとの必須項目が未入力 |
エラーとなり、該当の行番号とともに表示されます。1件でもエラーがあるファイルは、正常なブロックを含めて一切取り込まれません。 |
|
SYSTEMUIDに英数字・ハイフン以外の文字を使用 |
エラー |
|
手順書URLがhttp://・https://以外で始まる、または2,048文字を超える |
エラー |
|
APP行に指定したアプリケーション・アイテムの組み合わせが実在しない |
エラー |
|
ファイルが4MBを超える、または2,500行を超える |
エラー(アップロードできません) |
|
CSV以外の形式のファイルをアップロードした |
エラー |
既知の制限
-
作業手順・作業内訳の「説明」欄は、このCSVフォーマットに対応する項目がありません。エクスポートしたCSVにはこの内容が含まれないため、そのままUPDATEで再インポートすると、対象テンプレートの「説明」欄は消去されます。
-
EDOC・APPのどちらも、システム共通テンプレート(SHARED指定ブロック)では使用できません。
-
エクスポートしたCSVは、内容を変更せずにそのまま同じ組織へ再インポートしても、エラーにはなりません(UPDATEブロックとして出力されるため)。
-
TITLE・TASK-TITLE・DESCRIPTION・STEP・ITEMの値が=・+・-・@で始まる場合、表計算ソフトで数式として誤実行されるおそれがあるため、先頭にシングルクォート(')を付与して記述することを推奨します。このシングルクォートはインポート時に除去されず、値の一部としてそのまま保存されます。