こんにちは！かねごん（@hrbk25）です！
kintoneのプロセス管理機能を活用すると、業務の進捗管理や承認フローを効率化できます。しかし、カスタマイズを行う際にはいくつかの落とし穴があり、つまずきやすいポイントが存在します。
そこで、今回はkintoneでプロセス管理のステータスを扱うカスタマイズの注意点、解決策について簡単にまとめてみました。
どんな人向けの記事か
- kintoneのカスタマイズを始めたばかりの方
- プロセス管理のステータスを使ったカスタマイズをしようとしている方
kintoneプロセス管理のステータスカスタマイズ 注意点
今回の内容は、公式ドキュメントと併せてご確認ください。
1. レコード追加画面ではステータスを取得できない
注意点:
app.record.create.show などレコード追加画面のイベントでは、レコードが未作成のためステータス情報を取得できません。
想定する場面:
- レコード編集画面でステータスを取得していたため、同じコードをレコード追加画面でも適用しようとしたが、エラーが発生。
- ステータス情報を元に処理を記述したが、追加画面では想定通り動作しない。
解決策:
-
app.record.create.submit.successイベントを利用し、レコード作成後に処理を行う。 - プロセス管理の設定情報を取得して、処理を行う。（詳細は以下を参照。）
2. ステータスのアクション名を複数同じにするとエラーが発生する
注意点:
kintoneのプロセス管理では、同じステータス内で同名のアクションが複数存在すると、どのアクションを実行するのか判別できず、エラーが発生します。
REST API（PUT /k/v1/record/status.json または PUT /k/v1/records/status.json）を使用してステータスを変更する場合、指定したアクション名が一意でないと、エラーが発生する可能性があります。
想定する場面:
- 承認フローをシンプルにするため、「承認」や「完了」など、よく使うアクション名を複数のステータスで重複して設定してしまい、エラーが発生。
- ステータス変更をREST APIで自動化しようとしたが、アクションの識別ができずエラーになる。
解決策:
- アクション名を一意にする。命名ルールを統一し、可読性を向上させる。
- 「承認（上司）」と「承認（管理者）」のように役割を明確にする。
- プラグインに用いる際は、プロセス管理の設定情報を取得して、設定画面で事前にチェックをかけて警告を行う。
3. APIトークンを使用してステータス変更時にエラーが発生する
注意点:
APIトークンを使用してステータスを更新しようとした際、以下の条件に該当するとエラーが発生します。
-
「Administrator」以外の作業者が指定されている
APIの実行ユーザーが作業者に含まれていない場合、エラーが発生します。 -
APIトークンの権限が不足している
APIトークンに必要な閲覧・編集権限がない場合、ステータスの更新ができません。
想定する場面:
- 元々、ユーザー認証でAPIを実行する場合を想定したコードになっていたため、エラーが発生。
- APIトークンを使用して「Administrator」以外の作業者が指定されたレコードのステータスを変更しようとしたが、エラーが発生。
解決策:
- 実行する内容に合わせて、適切なプロセス管理の設定であるか、作業者の指定が正しく行われているか確認し、必要に応じて修正する。
- APIトークンに、レコードやフィールドの閲覧・編集権限を適切に付与する。
さいごに
いかがでしたでしょうか？
今回は、kintoneのプロセス管理をカスタマイズする際に注意すべきポイントを簡単にまとめてみました。
本記事が少しでもお役に立てれば嬉しいです！