Kintone ビーコン プラグインの説明書
プラグインの説明
Kintone専用ビーコン（ボタンコントローラー）プラグインは、細かい表示条件を指定できないアクションボタンや、レコード詳細画面のヘッダー部分へプラグインが追加した拡張ボタンについて、各ボタンごとに表示（押せる）条件を設定することができるKintoneプラグインです。
自社で実際にあるあるの問題を解決するために開発しましたが、Kintoneを使っていて、下記のような課題があれば、ビーコンプラグインが解決します！
承認ステータスの状態応じて、アクションボタンやプラグインの各ボタンの有効・無効を制御したい
フィールドに添付ファイルが添付されている場合だけ、メール送信プラグインのボタンを有効にしたい
メール送信ボタンが未承認の状態で押されて送信されると、誤送信のインシデントになるので、なんとかしたい
プラグインをインストールする
まずは、Kintoneのシステム設定からプラグインを追加しましょう！
Kintoneのホーム画面から、「歯車アイコン」をクリック、表示されたメニューから「Kintoneシステム管理」をクリックして、システム管理画面に進みます。
システム管理画面のメニューから「プラグイン」をクリックすると、プラグインの管理画面に進みます。
プラグイン管理画面に進むと、左上に「読み込む」ボタンがあります。
クリックして、プラグインファイル「b-controller.zip」を「参照」ボタンから選択して、プラグインを読み込みます。
プラグインが正しく読み込まれると、下記のようにプラグインが登録されます。（プラグインを削除したい場合は、登録されたプラグインの右端にある「ゴミ箱」アイコンをクリックします）
プラグインを各アプリへ追加しよう
プラグインの機能を使って、ボタンの有効・無効を切り替えたいアプリに進み、右上にある「歯車」ボタンを押してアプリの設定画面に進みます。
設定画面から、「設定」タブをクリック、カスタマイズ／サービス連携の「プラグイン」をクリックし、プラグイン画面に入ります
プラグイン画面から、「＋追加する」をクリックすると、プラグインの追加画面に進みます。
プラグインの追加画面では、Kintoneシステム設定で登録されているプラグインの一覧が表示されています。このアプリで追加（適用）したいプラグイン「ビーコン（ボタンコントローラー）」にチェックをつけ、「追加」ボタンを押すことで、プラグインの機能を利用できるようになります。
プラグインが利用できる状態になると、プラグイン画面にリスト表示されます。リスト内のプラグイン毎にある「歯車」アイコンをクリックすると、該当のプラグインの設定を行うことができます。
プラグインの設定
ライセンスの有効化（アクティベーション）
プラグインのライセンスを購入時に通知された「ライセンスキー」を入力し、「アクティベート」ボタンを押してください。
アクティベートを実行しないと、プラグインの設定を保存することはできません。（試用版は除きます）
ライセンスキーはKintoneのアカウント毎に割り当てられたサブドメインに紐付けられるため、複数のKintoneアカウントでご利用の場合には、アカウントの数だけライセンスキーを購入頂き、利用するKintoneアカウントに紐付けられたライセンスキーを入力してください。
プラグインの設定情報をすべて初期化し、アクティベートを解除する場合は、「アクティベート解除」ボタンを押してください。
アクションボタンの有効・無効・非表示の条件設定
◼︎ 条件毎の表示状態
各アクションに割り当てられたボタン毎に、プロセス管理のステータスやフィールドの値を条件に、ボタンの表示状態を設定します。
：アクション名（制御対象となるボタン）
どのアクションボタンを制御するのか、アプリに設定されているアクションの一覧から選択します。
＜注意＞
・アクションが何も登録されていないアプリでは一覧は表示されません
・アプリのアクション設定からアクションの名称を変更した場合、プラグイン側のアクション名の選択が解除されるため、ビーコンプラグインの設定画面から再設定をしてくださ。
：ステータス（条件）
プロセス管理が有効になっている場合のみ利用可能。どのステータスになったらアクションボタンを制御するのか、ステータスの一覧から選択します。
＜注意＞
・アプリのプロセス管理の設定からステータスの名称を変更した場合、プラグイン側のステータス名の選択が解除されるため、ビーコンプラグインの設定画面から再設定をしてくださ。
：状態（ボタンの状態）
条件が一致した場合のボタンの状態を、選択します。
：フィールドコード
レコード内のフィールドの値によって条件を設定するためのフィールドを一覧から選択します。また、「条件に含めない」を選択することで、フィールドの値を条件に含めないように指定することができます。
＜注意＞
・アプリの設定からフィールドコードの名称を変更した場合、プラグイン側のフィールドコード名の選択が解除されるため、ビーコンプラグインの設定画面から再設定をしてください。
・指定可能なフィールドのタイプは下記となります。
文字列（1行）
文字列（複数行）
数値
計算
ラジオボタン
チェックボックス
複数選択
ドロップダウン
日付（表記方法：2024-01-01）
時刻（表記方法：12:00）
日時（表記方法：2024-01-01T12:00、条件は、”含む”か”含まない”）
添付ファイル（添付されるファイル名）
リンク
：判定値、条件
各レコードのフィールドに設定された値を元に条件を設定します。
判定値を複数のキーワードで設定したい場合、キーワードをカンマで区切って入力（キーワードA,キーワードB,キーワードC）することにより、2つ以上の値を判定値として用いることができます。複数のキーワードを設定した場合、条件に対して各キーワードを評価し、一つでも一致したら条件に一致（OR条件）とします。
条件は下記の4つのパターンから選択します。
等しい：判定値に指定のキーワードと完全一致
異なる：判定値に指定のキーワードと完全一致しない
含む：判定値に指定のキーワードと部分一致
含まない：判定値に指定のキーワードと部分的にも一致しない
◼︎ 条件に一致しない場合の表示状態
設定された条件毎の表示状態に一致しなかった場合のボタンの状態を設定します。
有効：ボタンが押せる状態（基本のボタンの状態を維持）
無効：ボタンが押せない状態で、ボタンが薄く表示される
非表示：ボタンを消します（もちろん押せません）
リストに登録されていなアクションボタンについては、表示状態を制御しません。（ずっと表示されたまま）
ヘッダーボタンの有効・無効・非表示の条件設定
アクションボタンの設定とほぼ同じですが、1つだけ異なる点があります。
条件毎の表示状態
アクション名からボタン名に項目名が変更されています。選択方式ではなく、ボタン名は実際のボタンに記述されている名称を直接入力することで指定します。
設定の保存
プラグインの設定ができたら、ビーコンプラグイン設定画面の一番下にある「保存」ボタンで設定を保存しましょう。また、プラグインの設定後は、Kintoneアプリに設定を適用するため、「アプリを更新」ボタンで更新するのを忘れないようにしましょう！
もっと詳細な説明
ボタン表示・無効化の条件指定のコツ
判定値と条件の組み合わせの例です。あなたが作成されたアプリでのフィールドの値を使って、レコードの状態によって不要な時にはボタンを無効にしてみよう！
添付ファイルが添付されているかどうかを条件に指定
下記の設定で、添付ファイルに何かが添付されると条件が一致します。
フィールドコード：（添付ファイルのフィールドコード）
判定値：（空の状態）
条件：異なる
添付ファイル名の一部が固定の文字列であれば、下記の条件により、ファイル名でのチェックも可能です。
フィールドコード：（添付ファイルのフィールドコード）
判定値：（固定部分の文字列）
条件：含む
同じボタンに対して複数の条件を重ねて指定
上図の設定にように、同じボタンに対して、複数の条件を登録することで、複雑なボタンの制御を行うことが可能です。
最終的なボタンの状態はリストの上から順に条件を評価され、最後に一致した条件でボタンの状態が決定します。全く条件に一致しなかった場合は、初期の表示状態で設定した状態になります。
すべてが初期の表示状態
フィールド値での条件指定の解説
完全一致と部分一致の違いで、判定したい文字列のどの部分を条件にするのか、すべてなのか、一部なのか、それを見極めたら、あとは条件を指定するだけ。以下は条件指定の参考になります。
フィールド値：東京都 ／ 判定値：東京
「等しい」：条件不一致
「異なる」：条件一致
「含む」：条件一致（部分的に”東京”が含まれている）
「含まない」：条件不一致
フィールド値：東京都 ／ 判定値：東京都
「等しい」：条件一致
「異なる」：条件不一致
「含む」：条件一致
「含まない」：条件不一致
フィールド値：東京都 ／ 判定値：大阪府
「等しい」：条件不一致
「異なる」：条件一致
「含む」：条件不一致
「含まない」：条件一致
フィールド値：東京都 ／ 判定値：東京,大阪,京都
「等しい」：条件不一致
「異なる」：条件一致
「含む」：条件一致（部分的に”東京”が含まれている）
「含まない」：条件不一致
ヘッダーボタン制御の動作確認プラグイン
プリントクリエイター（トヨクモ株式会社）
kMailer（トヨクモ株式会社）
ボタンの数が多いため、ヘッダーボタンの初期状態は「有効」に設定し、レコードの詳細画面上部に表示される、「メールを作成する」「メール送信を予約する」「予約済みメール」のボタンに対してのみ、個別の条件ごとに無効条件を設定すると良いです。
その他、動作を確認いただけたプラグインがあれば、noteへのコメントを、ぜひご協力のほど、よろしくお願いします。
この記事が気に入ったらサポートをしてみませんか？