はじめに
以下のようなChatter通知をレコードトリガフローで行う方法をご紹介します。
しかし、フローのみで変更された項目を抽出するのはかなり面倒でメンテナンスも大変です。
そこで今回は一部Apexを使用し、どのオブジェクトに対しても使用可能かつ項目が増えても修正不要な汎用クラスを実装します。
フローからApexを呼び出す基本的な方法についても解説するので、苦手意識がある方もぜひ挑戦してみてください！
1. Apex実装
【1】Apexを使う理由
リリースの度にアップデートされどんどん使いやすくなっているフローですが、ちょっと複雑な処理になるとついついApexで書いたほうが早いな、、となりがちです。
Apexを使用せずフローのみで今回のような通知機能を実装しようとすると、項目の数だけ数式や割り当て要素を使って判定する地道な方法を取らざるを得ないです。
しかも項目が増える度にフローの修正が必要になるのでメンテナンスしきれない事態に、、
しかしApexを使用すればオブジェクトが持つ全項目が取得できるので、項目が増えてもフローの修正は必要ありません。
今回は「値が変更されたかどうか」「変更された項目名の文字列」「変更前後の値を格納するリスト」の3つを情報を取得できるクラスを紹介します。
【2】Apex実装
// 変更された項目毎の情報を管理するクラス
global without sharing class FieldModification {
@AuraEnabled
global String fieldLabel;
@AuraEnabled
global String oldValue;
@AuraEnabled
global String newValue;
public FieldModification(String fieldLabel, Object oldValue, Object newValue) {
this.fieldLabel = fieldLabel;
this.oldValue = oldValue != null ? String.valueOf(oldValue) : '\"\"';
this.newValue = newValue != null ? String.valueOf(newValue) : '\"\"';
}
}
// フローから呼び出し、変更された項目情報を抽出するクラス
global without sharing class FieldModificationObserver {
// フローから受け取る情報を格納するクラス
global class Input {
@InvocableVariable(required=true label='変更前のレコード')
global SObject oldRecord;
@InvocableVariable(required=true label='変更後のレコード')
global SObject newRecord;
@InvocableVariable(required=true label='区切り文字')
global String separator;
}
// フローへ返却する情報を格納するクラス
global class Output {
@InvocableVariable
global List<FieldModification> fieldDetails;
@InvocableVariable
global String changedFieldLabel;
@InvocableVariable
global Boolean hasFieldChanged;
Output(List<FieldModification> fieldDetails, String changedFieldLabel) {
this.fieldDetails = fieldDetails;
this.changedFieldLabel = changedFieldLabel;
this.hasFieldChanged = !fieldDetails.isEmpty();
}
}
@InvocableMethod(label='変更された項目情報を取得')
global static List<Output> verifyFieldModification(List<Input> inputList){
Output outputResult = getChangedFields(inputList[0]);
return new List<Output>{outputResult};
}
/**
* @description 変更された項目情報を特定する
* @param input フローから渡される変更前後のレコードと区切り文字
* @return 変更された項目の情報
*/
private static Output getChangedFields(Input input){
SObject oldRecord = input.oldRecord; // 変更前のレコード
SObject newRecord = input.newRecord; // 変更後のレコード
String separator = input.separator; // 文字列として返却する項目名の区切り文字
List<FieldModification> fieldDetails = new List<FieldModification>();
List<String> changedFieldLabels = new List<String>();
// 対象オブジェクトの項目情報を取得してループ
for(SObjectField field : newRecord.getSObjectType().getDescribe().fields.getMap().values()){
DescribeFieldResult result = field.getDescribe();
// ユーザが更新可能な変更された項目の場合
if(oldRecord.get(field) != newRecord.get(field) && result.isUpdateable()){
// 変更された項目ラベル名・変更前の値・変更後の値を保持するクラスを生成してリストへ格納
FieldModification fieldDetail = new FieldModification(result.getLabel(), oldRecord.get(field), newRecord.get(field));
fieldDetails.add(fieldDetail);
// 項目ラベル名のみを保持するリストへ格納
changedFieldLabels.add(result.getLabel());
}
}
// 項目ラベル名リストを区切り文字で連結
String changedFieldLabel = String.join(changedFieldLabels, separator);
// フローへの返却用クラスとして返す
return new Output(fieldDetails, changedFieldLabel);
}
}
【3】Apex解説
【3-1】 フローからの入力
// フローから受け取る情報を格納するクラス
global class Input {
@InvocableVariable(required=true label='変更前のレコード')
global SObject oldRecord;
@InvocableVariable(required=true label='変更後のレコード')
global SObject newRecord;
@InvocableVariable(required=true label='区切り文字')
global String separator;
}
まずはフローからの入力に使用するクラスを定義しています。
@InvocableVariableを変数に付与することでフローからApexに値を渡すことができます。
今回は全オブジェクトに対応させるため、型を特定のオブジェクトではなくSObjectに設定しています。
【3-2】フローからの呼び出し
@InvocableMethod(label='変更された項目情報を取得')
global static List<Output> verifyFieldModification(List<Input> inputList){
Output outputResult = getChangedFields(inputList[0]);
return new List<Output>{outputResult};
}
@InvocableMethodを付与することでフローの「Apexアクション」で選択可能になります。
引数は【3-1】で定義したクラスのList型で指定する点に注意してください。
List型といっても、結果的には最初の要素に全ての入力値が格納されているため、今回のメイン処理部分であるgetChangedFields()に最初の要素のみを渡します。
最後にのちほど説明するフローへの返却用クラスを同じくList型にして返却しています。
【3-3】メイン処理
/**
* @description 変更された項目情報を特定する
* @param input フローから渡される変更前後のレコードと区切り文字
* @return 変更された項目の情報
*/
private static Output getChangedFields(Input input){
SObject oldRecord = input.oldRecord; // 変更前のレコード
SObject newRecord = input.newRecord; // 変更後のレコード
String separator = input.separator; // 文字列として返却する項目名の区切り文字
List<FieldModification> fieldDetails = new List<FieldModification>();
List<String> changedFieldLabels = new List<String>();
// 対象オブジェクトの項目情報を取得してループ
for(SObjectField field : newRecord.getSObjectType().getDescribe().fields.getMap().values()){
DescribeFieldResult result = field.getDescribe();
// ユーザが更新可能な変更された項目の場合
if(oldRecord.get(field) != newRecord.get(field) && result.isUpdateable()){
// 変更された項目ラベル名・変更前の値・変更後の値を保持するクラスを生成してリストへ格納
FieldModification fieldDetail = new FieldModification(result.getLabel(), oldRecord.get(field), newRecord.get(field));
fieldDetails.add(fieldDetail);
// 項目ラベル名のみを保持するリストへ格納
changedFieldLabels.add(result.getLabel());
}
}
// 項目ラベル名リストを区切り文字で連結
String changedFieldLabel = String.join(changedFieldLabels, separator);
// フローへの返却用クラスとして返す
return new Output(fieldDetails, changedFieldLabel);
}
Winter22以前はRecord__PriorをSObject型に代入しようとするとUnable to convert value...とエラーが発生していましたが、Spring22から使用可能になりました！
参考：[Trial] Record__Prior variable passed on to Apex Invocable is throwing 'Cannot convert to Apex type' error
ここではnewRecord.getSObjectType().getDescribe().fields.getMap().values()でオブジェクトの全項目を取得し、field.getDescribe()で項目の詳細情報を取得しています。
項目情報をループさせレコードの値を取得することで、自動的に全項目の値が変更されたか判定できる流れです。
この項目情報には「所有者」「最終更新日」などが含まれてしまうため、現在のユーザが編集できるかどうかをisUpdateable()を用いて判定しています。
FieldModificationは変更された項目の情報格納クラス（【3-4】参照）
また、変更された項目名をフロー側でそのまま表示できるようseparatorを用いて項目名を連結させておきます。
出力用クラスを生成しつつ返却してメイン部分の処理は完了です！
isUpdateable()を用いる弊害として、他のフローやトリガで「実行ユーザに編集権限が与えられていない項目」が変更された場合は、今回のフローによる通知対象に含まれません。
通知を行うためにはisUpdateable()を削除し、必要に応じて「最終更新日」「System Modstamp」など通知不要な項目を除外してください。
【3-4】フローへの出力
// フローへ返却する情報を格納するクラス
global class Output {
@InvocableVariable
global List<FieldModification> fieldDetails;
@InvocableVariable
global String changedFieldLabel;
@InvocableVariable
global Boolean hasFieldChanged;
Output(List<FieldModification> fieldDetails, String changedFieldLabel) {
this.fieldDetails = fieldDetails;
this.changedFieldLabel = changedFieldLabel;
this.hasFieldChanged = !fieldDetails.isEmpty();
}
}
global without sharing class FieldModification {
@AuraEnabled
global String fieldLabel;
@AuraEnabled
global String oldValue;
@AuraEnabled
global String newValue;
public FieldModification(String fieldLabel, Object oldValue, Object newValue) {
this.fieldLabel = fieldLabel;
this.oldValue = oldValue != null ? String.valueOf(oldValue) : '\"\"';
this.newValue = newValue != null ? String.valueOf(newValue) : '\"\"';
}
}
FieldModificationがフローへ返却するOutputクラスにList型で格納されている形です。
@AuraEnabledを付与することでフロー内で変数の型として使用可能になり、のちほどフローで行うループ処理に役立ちます。
oldValueとnewValueは文字列・数値・真偽値など様々な型が想定されるためObject型で受け取り、Stringに変換しておきます。
2. フロー実装
【1】レコードトリガフロー作成
今回は取引先レコードが更新される度にフローを起動したいので下記の設定で作成します。
【2】変数の作成
Apexの実行結果を受け取るため事前に3つの変数を作成しておきます。
・レコードが更新されたか判定する真偽値
・変更された項目名の文字列（「取引先名 / 業種 / 郵便番号」の部分）
・変更された項目の詳細（FieldModificationクラスの情報）
【3】Apexアクションの設定
【2】で作成した変数を使用してApexアクションを設定します。
Recordが更新後、Record__Priorが更新前のレコードです。
区切り文字はお好みで設定してください。
【4】決定要素の作成
レコードが変更されていない時（ただ保存された時）は通知が不要なので、決定要素を挟みます。
【5】ループ
FieldModificationのリストをループして以下の部分を作成します。
・ループ対象はFieldModification
・一時的に文字列を保管する変数を作成して割り当て
・1つ前で成型した文字列を格納する変数を作成して割り当て、次のループに備えるため一時保管用変数を初期化
以上で「どの項目がどのように変更されたか」を出力するための文字列が作成できました。
【6】Chatter投稿
3. おわりに
実装手順は以上です、お疲れ様でした！
最初は取っ付きにくいフローからのApex呼び出しですが意外と簡単、、！と感じてもらえると嬉しいです。
今回のようにフローから呼び出せる汎用的なApexクラスを用意すれば開発効率アップ間違い無しなので、ぜひぜひ挑戦してみてください！
最後までご覧いただきありがとうございました！