kintoneの設計情報からリポジトリを生成する

最終更新日: 2020年3月14日
R8 | R9

kintoneの設計情報から Wagby のリポジトリを半自動生成する方法を説明します。

概要

サイボウズ社が提供する「kintone」アプリケーションの設計情報を、本ページに記載する方法で記述することで、Wagbyのリポジトリへと変換できます。

用意するファイル	必須	説明
モデルID.csv	○	1ファイル=1モデル定義です。
モデルID-コンテナ名.csv	-	モデルに含まれる明細情報の定義を行います。
master.csv	-	Wagbyの選択肢モデルに該当します。

次節より、それぞれのファイルの詳細なフォーマットを説明します。

モデルID.csvファイル

「モデルID.csv」ファイルは、1ファイルで1つのモデル定義を構成します。内容は次のとおりです。

列	説明
label	項目名。日本語表記。
type	型。(後述)
code	項目ID。英数字表記。

先頭行はヘッダとして扱われます。「label,type,code」と記載してください。 2行目以降から、モデル項目情報を記載します。例を示します。

label,type,code
氏名,SINGLE_LINE_TEXT,ApplicantName
氏名かな,SINGLE_LINE_TEXT,ApplicantNameKana

メニューへの配置

モデルID.csv に用意されたモデルは、メニュータブ「サービス」内に配置されます。

その他のルール

ファイル名はモデルIDとなるため、Wagbyが「モデルIDとして利用できる名前」ルールに準拠します。例：customer.csv。詳細は"モデルIDの命名規則"をお読みください。
Wagbyの「モデル名 (日本語)」は、モデルIDと同じとなっています。変換後、Wagby Designer を用いてモデル名を指定してください。
「label」をシングルクォートで囲っていた場合、シングルクォートを除いた部分が有効になります。例："氏名"と記載していた場合、前後のシングルクォートは除かれます。
「code」は英数字表記としてください。日本語で表記されていた場合、内部で自動的に「item+数字(連番)」に置換されます。
「code」はモデル項目IDとなるため、Wagbyが「項目IDとして利用できる名前」ルールに準拠します。詳細は"項目IDの命名規則"をお読みください。

「型」について

「モデルID.csv」ファイルに記載する「型」は次のいずれかを指定してください。

表記	Wagbyへ取り込む場合の型
RECORD_NUMBER	数値 (整数)、主キー。
SINGLE_LINE_TEXT	文字列型
NUMBER	数値 (整数)
MULTI_LINE_TEXT	文字列型 (テキストエリア)
RICH_TEXT	文字列型 (テキストエリア・リッチ)
CHECK_BOX	選択肢モデルの参照 (チェックボックス) ※後述
RADIO_BUTTON	選択肢モデルの参照 (ラジオボタン) ※後述
DROP_DOWN	選択肢モデルの参照 (リストボックス) ※後述
FILE	文字列型 (ファイル)
LINK	文字列型 (URL)
DATE	日付型
TIME	時刻型
DATETIME	日付時刻型
CREATOR	固定値 - 登録ユーザ
CREATED_TIME	固定値 - 登録時刻
MODIFIER	固定値 - 更新ユーザ
UPDATED_TIME	固定値 - 更新時刻
SUBTABLE	繰り返しコンテナ ※後述

RECORD_NUMBER が主キーとなります。一つだけ用意してください。

上記で示した以外の形式は、未サポートです。

選択肢モデルの扱い

master.csv

Wagbyの選択肢モデルを用意することができます。ファイル名を「master.csv」とします。内容は次のとおりです。

列	説明
label	項目名。日本語表記。
type	型。
code	項目ID。英数字表記。
options	選択肢の値。

例を示します。1行目は「label,type,code,options」というヘッダ行とします。2行目以降に実際のデータを記述していきます。

label,type,code,options
性別,DROP_DOWN,Gender,男
性別,DROP_DOWN,Gender,女
職業,DROP_DOWN,Job,会社員
職業,DROP_DOWN,Job,学生
職業,DROP_DOWN,Job,主婦

このように、label,type,code が同じで、optionsが異なる行を連ねてください。

モデルID.csv との関係

モデルID.csvのcode部と、master.csvのcode部が一致していた場合、当該項目と (master.csvで用意された)選択肢モデルとの紐付けが行われます。

例えば customer.csv に次の行があった場合：

性別,DROP_DOWN,Gender

master.csvの "Gender" と紐づくため、「男」「女」という選択肢を、リストボックス形式で選べるようになります。

メニューへの配置

master.csv に用意された選択肢モデルは、メニュータブ「マスタ管理」内に配置されます。

サブテーブルの扱い

kintoneの「サブテーブル」は、Wagbyの「繰り返しコンテナ」として移行されます。

モデルID-コンテナ名.csv

「コンテナ名」は英数字になります。

列	説明
fields_name	モデルID.csv に記載された項目名。
label	項目名。日本語表記。
type	型。
code	項目ID。英数字表記。

例を示します。ファイル名を customer-operator.csv とします。 1行目は「fields_name,label,type,code,options」というヘッダ行とします。2行目以降に実際の定義を記述していきます。

fields_name,label,type,code
OperatorTable,操作日時,DATETIME,OperatorDate
OperatorTable,操作内容,MULTI_LINE_TEXT,OperatorMemo

モデルID.csv との関係

モデルID.csvの型が SUBTABLE で、かつcode部と、モデルID-コンテナ名.csvのfields_name部が一致していた場合、モデルID.csvの当該位置に、サブテーブル項目が「繰り返しコンテナ」として挿入されます。

例えば customer.csv に次の行があった場合：

,SUBTABLE,OperatorTable

customer-operator.csv の "OperatorTable" として記載された 4 つの項目が、customer.csv の当該位置に含まれるようになります。

注意事項

サブテーブル定義（上記では customer-operator.csv) の code 部は、Wagbyの「項目ID」に相当するため、重複してはなりません。具体的には、モデルID.csv のどの項目名 (code部) とも重複しないようになっている必要があります。

使い方

「運用 > その他」のタブにある「インポート」を選択します。

パラメータ欄に "kintone" と記述します。上で説明した csv ファイルを圧縮した zip ファイルをアップロードし、「インポート実行」ボタンを押下します。

サンプルの設定情報

kintone_sample.zip を用意しています。お試しください。

手動で修正すること

フィールド長や NOT NULL 制約、式などは移行されません。Wagby Designer にて改めて設定してください。
モデルID(英語)と項目ID(英語)が日本語の場合、それぞれ「modelXX」「itemXX」を自動で設定します。XXは数字(連番)です。
モデルID(英語)と項目ID(英語)がWagbyの名前付ルールに合致しないとき、それぞれ「modelXX」「itemXX」を自動で設定します。XXは数字(連番)です。