kintoneのフィールドコードを活用しよう 外部サービスを連携したアプリ開発とは?
本記事はCDataが提供する「CData Software Blog」に掲載された「kintone のフィールドコード活用のススメ!|外部サービス連携を意識したkintone アプリ開発 」を再編集したものです。
表計算に困ったら、でおなじみのkintone(キントーン)。
kintoneは、プログラミングをすることなくアプリ開発ができるノーコードツールです。
開発できるアプリは、売上管理、勤怠管理、受発注管理、顧客管理、案件・工程・プロジェクト管理、アンケート、日報、報告書、ワークフロー…「こんなアプリ、あったらいいな!」と思うものは、ほぼ作れてしまうといっても過言ではありません!
しかもkintoneは、kintone以外の外部サービスと連携が可能。kintone内のデータを外部システムに渡すことはもちろん、外部システムから kintoneへデータを登録・更新・削除することができます
(※kintoneと外部サービスとの連携に関してはプログラミングが必要な場合があります)。
例えば、kintoneで商談の進捗状況を管理する「案件管理」アプリを作成し、顧客の会社名や連絡先、担当者氏名などの顧客情報はご利用中の名刺管理アプリなどからkintoneに登録することができます。案件管理アプリに顧客情報を人手をかけて手入力しないで済むのは効率的ですし、入力ミスなどのリスクも避けることができます。
このように、kintoneは単体で使っても十分便利なのですが、外部サービスと連携させることでもっともっと便利になります!
なのでkintoneアプリをつくる際は、直近で予定がないとしても外部サービスと連携させることを視野に入れて作成したほうがよいでしょう。
具体的には「フィールドコード」を意識してkintoneアプリを作成されることをオススメします。
kintoneの「フィールドコード」とは?|フィールド名との違い
kintoneのアプリは、文字列やラジオボタン、チェックボックスなど「フィールド」と呼ばれるパーツを組み合わせて作成します。
各フィールドには「フィールド名」と「フィールドコード」を設定する必要があります。それぞれの役割と性質の違いは、下記のとおりです。
・フィールド名
画面表示用の値(ユーザー用の値)、値が重複してもOK
・フィールドコード
JavaScriptなどのプログラムやkintone以外のツールで使用する値(管理者、開発者用の値)、同一アプリ内で重複しない値(重複NG)
フィールドコードの活用をすすめる理由|フィールド名の重複が引き起す問題
kintoneで複数のアプリを使用しているとき、アプリ間でフィールド名が重複してしまうことがあります。
例えば、kintoneですぐに使えるサンプリアプリ「営業支援パック」内の「案件管理」と「顧客管理」を見てみましょう。どちらも同じフィールド名の「顧客名」を持っています。
この「案件管理」と「顧客管理」のフィールド名を外部サービスで取得してみましょう。
本来ならフィールド名取得プログラムを書く必要がありますが、プログラミングするのは面倒なので、弊社CDataの「CData JDBC Driver for kintone」とDbVisualizerを使って取得してみました。
CData JDBC Driver for kintoneを含むCData kintone Driversは、スクラッチ開発でご利用いただけるのはもちろん、各種ツールからkintone への接続を実現します!
全てのCData kintone Driversは30日間無償でご利用いただけます。ぜひ一度お試しください!
→ CData kintone Driversの情報はこちら! ←
どのドライバーを使えばよいかわからない場合は、右上のチャットなどからお気軽にお問合せください。
下記画像がフィールド名の取得結果です。
どちらが「案件管理」の持つ「顧客名」で、どちらが「顧客管理」の持つ「顧客名」なのかを判別することができません。
同様に、一つのアプリの中でフィールド名が重複していた場合も生じます。
とはいえ、画面にも表示されるフィールド名を「案件管理_顧客名」や「顧客管理_顧客名」などにするのは、ユーザーにとって読みづらいですし、ちょっと格好悪いですよね。
このように、フィールド名が重複している場合にkintone以外の外部サービスでフィールド名を取得すると、どれがどのフィールド名なのか判別できない!ということが起きる場合があります。この問題の回避策がフィールドコードになります。
また、上記フィールド名の取得で使用したCData JDBC Driver for kintoneを含むCData kintone Driversは、 2022年(V22)のアップデートでフィールド名ではなくフィールドコードを取得するよう指定する接続文字列オプション「UseCodeForFieldName」が実装されました!
以下では、kintoneアプリにおけるフィールドコードの設定方法と接続文字列オプション「UseCodeForFieldName」の使い方を解説します。
kintoneアプリにおけるフィールドコードの設定方法と接続文字列オプション「UseCodeForFieldName」の使い方
フィールド名が重複しているとkintone以外の外部サービスとの連携時に不便! とはいえ、画面にも表示されるフィールド名を「案件管理_顧客名」や「顧客管理_顧客名」などにするのは、ユーザーにとって読みづらいですし、ちょっと格好悪い。
この問題は、画面には表示されないフィールドコードを複数アプリ間でも重複しない文字列に変更することで回避することができます。
と、いってもイメージしづらいと思いますので具体例で確認してみましょう!
先ほどの「案件管理」アプリと「顧客管理」アプリがそれぞれ持つ「顧客名」を例に説明します。
なお、これから先ほども使用したJDBC(CData JDBC Driver for kintone)とDbVisualizerという組み合わせで説明をしますが、下記説明中で使用する接続文字列オプション「UseCodeForFieldName」はJDBCだけでなくODBCやADOなどのCData kintone Driversであれば同様に利用できます!
kintone アプリにおけるフィールドコードの設定方法
はじめに注意点です。繰り返しになりますが、フィールドコードは、複数アプリ間でも重複しない文字列に変更するようにしてください。でないと、元の木阿弥ですので…
フィールドコードは、「アプリの設定」画面において各フィールドの「設定」より編集することができます。編集・保存後、アプリの設定画面右上の「アプリを更新」のクリックも忘れずに実施しましょう
(参考リンク:kintoneヘルプ「フィールドコードとは>設定手順」)。
(例)フィールド名「顧客名」のフィールドコードをそれぞれ「案件管理_顧客名」、「顧客管理_顧客名」に変更
接続文字列オプション「UseCodeForFieldName」の使い方
使い方はとても簡単です。接続文字列に「UseCodeForFieldName=true」を追加するだけです。
(例)jdbc:kintone:Url=https://サブドメイン.cybozu.com;UseCodeForFieldName=true
すると、フィールドコードが取得できます!(フィールドコードがカラム名として返されます)
まとめ
フィールドコードを活用すると、kintoneアプリ上の表示(ユーザーのアプリ使用感)はそのままに、kintoneに登録されているデータがより活用しやすくなります。
kintoneを活用される際は、フィールドコードがどのアプリとも重複しないユニークな値になるように意識的に設定し、ぜひご利用中/ご利用予定の外部サービスとの連携を試してみてください!
外部サービスとの連携にあたっては、2022年(V22)のアップデートでフィールドコードを活用できる接続文字列オプション「UseCodeForFieldName」が実装された、CData kintone Driversをぜひご利用ください!
CData kintone Driversをご利用いただくとJavaやPythonのプログラム、各種データベース、Excel、Power BI、Tableauなど、さまざまなツールでフィールドコードを項目名としてkintoneに登録されているデータに接続することができます。
この記事で取り上げたJDBC(CData JDBC Driver for kintone)だけでなく、CData kintone Driversは、いずれの製品も30日間無料の評価版をご利用いただけます。
既存ユーザーの皆さまも、CData kintone Drivers のご利用を検討中の方も、ぜひ一度お試しください!
→ CData kintone Drivers の情報はこちら! ←
「XXXというツールでkintone アプリの登録データって取得できるの?」「どの製品を使えばよいかわらかない」「ダウンロードしてみたけど使い方がよくわからない」などお困りの方は、どうぞ遠慮なく画面右上のチャットなどからお気軽にお問合せください。
CData 社員一同、お問合せをお待ちしております!