取引プロモーション管理の変換エンジンワークフロー

例

指定された新しい値を使用して Tactic Comment (戦略コメント) 項目を更新する完全なワークフローを新規に作成します。

1. [Business Object APIs (ビジネスオブジェクト API)] タブに移動して、セールス組織 0001 の Promotion エントリに移動します。存在しない場合は、それらの属性を持つレコードを作成します。
2. BO API の出力エンティティを設定します。BO API の出力エンティティでは、API で処理されるオブジェクトの種別を定義します。Output Entities 関連リストで、次のエンティティが表示されることを確認します。関連リストにない場合は追加します。
   1. TPM_Promotion (メインのプロモーションオブジェクトラッパー)
   2. TPM_Promotion.Tactic (戦略レコード)
   3. TPM_Promotion.Promotion (プロモーションレコード)
3. ワークフロータブで、次の属性を持つワークフローを作成します。
   1. 名前: updateTacticComments
   2. 説明: 入力パラメータを使用して Tactic Comment (戦略コメント) を更新します。
4. 新しいワークフローレコードに移動します。
5. 入力レコードを出力レコードに対応付ける方法を設定します。これを行うには、「入力エンティティおよび対応付け」関連リストにエントリを追加します。関連リストで次のレコードを作成します。

   レコード 1

   1. ビジネスオブジェクト API エンティティ: Promotion
   2. 出力エンティティ: TPM_Promotion.Promotion
   3. 入力対応付け項目: Id
   4. 出力対応付け項目: Id、cgcloud__ExternalId__c

   レコード 2

   1. ビジネスオブジェクト API エンティティ: Tactic
   2. 出力エンティティ: TPM_Promotion.Tactic
   3. 入力対応付け項目: Id
   4. 出力対応付け項目: Id、cgcloud__ExternalId__c
6. ワークフローにステップを追加します。必要なプロモーションデータをすべて読み込むには、管理パッケージで提供されるワークフローステップを再利用します。ワークフローステップ関連リストで、次のレコードを作成します。

   レコード 1

   1. ビジネスオブジェクト API ワークフローステップ: loadPromotionDefaults(update)2
   2. 有効化: チェック済み
   3. 並び替え: 10

   レコード 2

   1. ビジネスオブジェクト API ワークフローステップ: loadTacticDefaults(update)2
   2. 有効化: チェック済み
   3. 並び替え: 20
7. [ワークフロー] ヘッダーの [スキーマを参照] ボタンをクリックして、この API の入力ペイロード構造を確認します。スキーマは次のようになります。
   1{
   2  "required" : [ "Id" ], // Promotion requires an Id because of the Promotion workflow step
   3  "properties" : {
   4    "Tactics" : {
   5      "items" : {
   6        "required" : [ "Id" ], // Tactic requires an Id because of the Tactic workflow step
   7        "properties" : {
   8          "TacticTemplate" : {
   9            "pattern" : null,
   10            "minLength" : null,
   11            "maxLength" : 40,
   12            "type" : "string"
   13          },
   14          "Id" : {
   15            "pattern" : null,
   16            "minLength" : null,
   17            "maxLength" : 40,
   18            "type" : "string"
   19          }
   20        },
   21        "additionalProperties" : false,
   22        "type" : "object"
   23      },
   24      "type" : "array"
   25    },
   26    "PromotionTemplate" : {
   27      "pattern" : null,
   28      "minLength" : null,
   29      "maxLength" : 40,
   30      "type" : "string"
   31    },
   32    "Id" : {
   33      "pattern" : null,
   34      "minLength" : null,
   35      "maxLength" : 40,
   36      "type" : "string"
   37    }
   38  },
   39  "additionalProperties" : false,
   40  "type" : "object"
   41}

8. カスタム動作を追加します。別のワークフローステップを追加するには、入力の入力属性を SObject 項目の Comment__c にコピーする APEX クラスを作成します。組織で次の APEX クラスを作成します。
   1global with sharing class SetCommentValue implements System.Callable {
   2    public class SetCommentValueException extends Exception {}
   3    /**
   4    * This Sample Business Rule copies the value from the MyComment input attribute,
   5    * into the Output Comment__c field
   6    */
   7    public static Object call(String method, Map<String, Object> context) {
   8        // We use the context to extract variables
   9        // The type of the output object is defined by it's output entity in the mapping.
   10        cgcloud.TPM_Promotion.TacticRecord tactic = (cgcloud.TPM_Promotion.TacticRecord)
   11            context.get('currentOutput');
   12        // For input entities, it's type is always Map<String, Object>
   13        Map<String, Object> input = (Map<String, Object>) context.get('currentInput');
   14        
   15        // Set the value to the record
   16        cgcloud__Tactic__c myRecord = (cgcloud__Tactic__c) tactic.getRecord();
   17        
   18        myRecord.Comment__c = input.get('MyComment') != null 
   19            ? String.valueOf(input.get('MyComment'))
   20            : '';
   21            
   22        // After setting the value, we can return. The promotion and its
   23        // related records will be saved
   24        
   25        // If any exception is thrown, no data is committed
   26        return null;
   27    }
   28}

9. BO API ワークフローステップレコードを作成します。[Business Object API Workflow Steps (ビジネスオブジェクト API ワークフローステップ)] タブに移動して、新しいレコードを作成します。
   1. ビジネスオブジェクト API ワークフローステップ名: SetCommentValue
   2. クラス名: SetCommentValue (APEX クラスの名前)
   3. 説明: 入力属性からの Tactic (戦略) の Comment Value (コメント値) を設定します。
   4. メソッド: test (メソッドはコール可能なクラスに渡されます。この方法により、さまざまなメソッドを使用して、同じクラスが複数の動作を実装できます。)
   5. エンティティ: Tactic (このステップを各入力戦略で適用したいため)。
   6. セールス組織: 0001
10. ステップで必要な入力構造を定義します。ワークフローステップのステップ入力構造関連リストのレコードを作成します。ステップ入力構造の属性は、入力に必要なスキーマを決定するために使用されます ([スキーマを参照] ボタン)。入力がスキーマに一致しない場合は、エラーが表示されます。
    1. レコードタイプ: String
    2. 説明: 新しいコメント属性の値
    3. パス: .MyComment
    4. 必須: チェックしない
    5. 最大文字数: 80
11. ワークフローステップをワークフローレコードに追加します。
    1. ビジネスオブジェクト API ワークフローステップ: SetCommentValue
    2. 有効化: チェック済み
    3. 並び替え: 30
12. [スキーマを参照] をクリックします。スキーマの構造は、次のようになります。

    スキーマは、新規の MyComment 属性を受け入れます。

    メモ

    1{
    2  "required" : [ "Id" ],
    3  "properties" : {
    4    "Tactics" : {
    5      "items" : {
    6        "required" : [ "Id" ],
    7        "properties" : {
    8          "MyComment" : {
    9            "pattern" : null,
    10            "minLength" : null,
    11            "maxLength" : 80,
    12            "type" : "string"
    13          },
    14          "TacticTemplate" : {
    15            "pattern" : null,
    16            "minLength" : null,
    17            "maxLength" : 40,
    18            "type" : "string"
    19          },
    20          "Id" : {
    21            "pattern" : null,
    22            "minLength" : null,
    23            "maxLength" : 40,
    24            "type" : "string"
    25          }
    26        },
    27        "additionalProperties" : false,
    28        "type" : "object"
    29      },
    30      "type" : "array"
    31    },
    32    "PromotionTemplate" : {
    33      "pattern" : null,
    34      "minLength" : null,
    35      "maxLength" : 40,
    36      "type" : "string"
    37    },
    38    "Id" : {
    39      "pattern" : null,
    40      "minLength" : null,
    41      "maxLength" : 40,
    42      "type" : "string"
    43    }
    44  },
    45  "additionalProperties" : false,
    46  "type" : "object"
    47}

13. プロモーション BO API エンドポイントに対して REST コールを実行し、必要なパラメータを渡して、API をテストします。
    1POST /services/apexrest/cgcloud/promotions/ingest
    2
    3{
    4  "workflow": "updateTacticComments", // Name of your workflow
    5  "salesOrg": "0001",
    6  "promotions": [
    7    {
    8      "Id": "a2VTC0000001lJR2AY",  // A promotion in the system
    9      "Tactics": [
    10        {
    11          "Id": "a36TC0000000XYfYAM", // It's tactics
    12          "MyComment": "Comment 1 - updated"
    13        },
    14        {
    15          "Id": "a36TC0000000XYgYAM",
    16          "MyComment": "Comment 2 - updated"
    17        }
    18      ]
    19    }
    20  ]
    21}

14. 返された importId で要求を参照して、[Business Object API Transaction Logs (ビジネスオ��ジェクト API トランザクションログ)] タブから実行状況を追跡します。

コーディングのガイドライン

• Business Rules コードでは、コストが高い操作は避けてください (大規模な JSON 逐次化や並列化など)。
• 他のルールが影響を受ける恐れがあるため、データベースからの SObject レコードはキャッシュします。(SimplePromotionCoreBusinessRules.readSObjectById を確認します)
• モジュール形式および設定可能なアプローチを行えるようにするため、Business Rules では、必ず単一のジョブに焦点を当てます。