kintoneのフィールドコードってなに?使い道や設定方法について学ぼう!
バンブロをご覧いただきまして、誠にありがとございます!
テクバンのITたまごぐみです!
本日はkintoneのフィールドコードについて紹介します。
フィールドコードとは
突然ですが、皆さんはフィールドコードを見たことがありますでしょうか?
なにそれ?知らない!という方へ、フィールドコードの設定はkintoneのフィールドの設定の下のほうにありますよ~
あるのは知っていたけど、使ったことがない…という方もいるかもしれませんね!
フィールドコードを何に使うかというと、Javascriptを使ってカスタマイズするときや、計算をするとき、プラグインの設定に使います!
特に使う機会が多いのは文字列(1行)フィールドや計算フィールドで自動計算する場合だと思います。
以下の画像をご覧ください。
単価を個数で掛けた合計が自動的に表示されていますね。
このテーブルの場合は合計が計算フィールドになっています。
合計の設定の中を見てみましょう。
赤枠の中に計算式が設定されていますね。
この「個数」と「単価」が何を指しているかというと、フィールド名ではなく、フィールドコードなんです。
個数の設定を見てみましょう。
下のフィールドコードにフィールド名と同じ名前が設定されていますね。
ここが計算式と一致しないと保存時にエラーが出ることや、思った通りの計算ができないことがあります。
次によく使うのがプラグインの設定だと思います。
プラグインによってはフィールド名で設定することもありますが、フィールドコードを使って設定することも多くあります。
プラグインを使い始めて、いざアプリとの連携設定をするときにフィールドコードが必要です、と出てきてしまい、
デフォルトで設定されている「文字列__1行__2」ってなんのフィールド…?となってしまうことも。
Javascriptでも同じく、フィールドコードを使ってフィールドを指定するので、
フィールドコードが間違っていたらもちろん正しく動きません…
途中でカスタマイズしたくなったり、プラグインと連携するときにフィールドコードをいちいち設定するのは面倒ですよね。
フィールドコードはアプリを作ったときに一緒に設定しちゃいましょう!
フィールドコードを決めるときに注意すること
フィールドコードの設定は、フィールドの設定画面で編集アイコンを押して保存するだけでできるので、とっても簡単です。
ただ、フィールドコードを決める際にいくつかの約束があります。
- 同じ名前のフィールドコードを使わないようにしよう
同じフィールドコードは使うことができません。
同じフィールドコードがあると、自動でkintone側が末尾に__0のように数字を付けて差別化してくれます。
ただ、それだと設定の際にややこしくなるので、できるだけわかりやすい別の名前を付けることをオススメします。 - 使用できない文字があるので注意しよう
フィールドコードには設定できない文字があります。
@、+、~、#、%、&、’、=、|、^、*、;、:、?などの記号や、
丸かっこ()、かぎかっこ「」、角かっこ[]、隅付きかっこ【】、波かっこ{}が使用できません。
使用できない文字を使うと、エラーが出たり、他の記号に置き換わってしまうので、あらかじめ使用できない文字がないか確認しましょう。
ほかにも細かいルールがいくつかあるので、kintoneの公式サイトで確認してみてください。
フィールドコードの設定上の注意
https://jp.cybozu.help/k/ja/id/040504.html#autocalc_fieldcode_20
Javascriptやプラグインで使うから英語で設定したほうがいいの?という疑問があるかもしれません。
なんと、kintoneのフィールドコードは日本語でもOKなんです!
せっかく日本語が使えるのでわかりやすいフィールドコードを付けたいですね♪
フィールドコードを決めるときのコツ
とはいえ、わかりやすいフィールドコードとは何ぞや?という方へ、
安直かもしれませんが、基本的にはフィールド名と同じにするとわかりやすいです。
同じフィールド名がある場合のみ、アンダーバー( _ )などを使って区別がつくようにすると良いでしょう。
また先ほどは日本語でもOKとお伝えしましたが、
「Javascriptのなかに日本語が入っているのは気持ちわるいので英語にしたい」という方もいらっしゃるでしょう。
そういった場合は全部英語にするなど、日本語と英語が混在しているより統一したほうが望ましいです。
他にも命名規則などを決めておくと、スムーズにわかりやすいフィールドコードを設定できそうですね。
最後までご覧いただきありがとうございました!
またお会いしましょう~!