Trade Promotion Management Transformation Engine Workflows

Example

Create a complete new workflow that to update the Tactic Comment field with a new specified value.

1. Navigate to Business Object APIs Tab and navigate to the Promotion entry for Sales Org 0001. If it does not exist, create a record with those attributes.
2. Configure the BO API Output entities. The Output entities for a BO API define which kind of objects the API works with. In the Output Entities related list, ensure the following entities are displayed. If not present in the related list, add them:
   1. TPM_Promotion (Main promotion object wrapper)
   2. TPM_Promotion.Tactic (Tactic Records)
   3. TPM_Promotion.Promotion (Promotion Record)
3. In the workflows tab, create a workflow with the following attributes:
   1. Name: updateTacticComments
   2. Description: Updates Tactic Comments with the input parameters
4. Navigate to your new workflow record.
5. Configure how the input records are going to be mapped to the output records. To do so, add entries to the “Input Entities and Mapping” related list. Create the following records in the related list.

   Record 1

   1. Business Object API Entity: Promotion
   2. Output Entity: TPM_Promotion.Promotion
   3. Input Mapping Field: Id
   4. Output Mapping Field: Id, cgcloud__ExternalId__c

   Record 2

   1. Business Object API Entity: Tactic
   2. Output Entity: TPM_Promotion.Tactic
   3. Input Mapping Field: Id
   4. Output Mapping Field: Id, cgcloud__ExternalId__c
6. Add Steps into the workflow. To load all the required promotion data, we can reuse Managed Package provided workflow steps. In the Workflow Steps related list, create the following records:

   Record 1

   1. Business Object API Workflow Step: loadPromotionDefaults(update)2
   2. Enabled: checked
   3. Sort: 10

   Record 2

   1. Business Object API Workflow Step: loadTacticDefaults(update)2
   2. Enabled: checked
   3. Sort: 20
7. Check the input payloads structure for this API by clicking the “View Schema” button on the Workflow header. The schema should look like:
   {
     "required" : [ "Id" ], // Promotion requires an Id because of the Promotion workflow step
     "properties" : {
       "Tactics" : {
         "items" : {
           "required" : [ "Id" ], // Tactic requires an Id because of the Tactic workflow step
           "properties" : {
             "TacticTemplate" : {
               "pattern" : null,
               "minLength" : null,
               "maxLength" : 40,
               "type" : "string"
             },
             "Id" : {
               "pattern" : null,
               "minLength" : null,
               "maxLength" : 40,
               "type" : "string"
             }
           },
           "additionalProperties" : false,
           "type" : "object"
         },
         "type" : "array"
       },
       "PromotionTemplate" : {
         "pattern" : null,
         "minLength" : null,
         "maxLength" : 40,
         "type" : "string"
       },
       "Id" : {
         "pattern" : null,
         "minLength" : null,
         "maxLength" : 40,
         "type" : "string"
       }
     },
     "additionalProperties" : false,
     "type" : "object"
   }

8. Add custom behavior. To add additional workflow steps create an APEX class that copies an input attribute from the input into the SObject Field Comment__c. Create the following APEX class in your org:
   global with sharing class SetCommentValue implements System.Callable {
       public class SetCommentValueException extends Exception {}
       /**
       * This Sample Business Rule copies the value from the MyComment input attribute,
       * into the Output Comment__c field
       */
       public static Object call(String method, Map<String, Object> context) {
           // We use the context to extract variables
           // The type of the output object is defined by it's output entity in the mapping.
           cgcloud.TPM_Promotion.TacticRecord tactic = (cgcloud.TPM_Promotion.TacticRecord)
               context.get('currentOutput');
           // For input entities, it's type is always Map<String, Object>
           Map<String, Object> input = (Map<String, Object>) context.get('currentInput');
           
           // Set the value to the record
           cgcloud__Tactic__c myRecord = (cgcloud__Tactic__c) tactic.getRecord();
           
           myRecord.Comment__c = input.get('MyComment') != null 
               ? String.valueOf(input.get('MyComment'))
               : '';
               
           // After setting the value, we can return. The promotion and its
           // related records will be saved
           
           // If any exception is thrown, no data is committed
           return null;
       }
   }

9. Create the BO API Workflow Step record. Navigate to the “Business Object API Workflow Steps” Tab and create a new Record:
   1. Business Object API Workflow Step Name: SetCommentValue
   2. Classname: SetCommentValue (Name of the APEX class)
   3. Description: Sets the Comment Value for Tactic from the input attributes.
   4. Method: test (Method is passed to the callable class. This way, with different methods, the same class can implement multiple behaviors)
   5. Entity: Tactic (Since we want to apply this step on each Input Tactic)
   6. Sales Org: 0001
10. Define which input structures the step needs. Create records in the Step Input Structures related list of the Workflow Step. The attributes for the Step input structures are used to determine the schema that the input should have (View Schema button). If the input does not match the schema, an error is displayed.
    1. RecordType String
    2. Description: New Comment Attribute value
    3. Path: .MyComment
    4. Required: unchecked
    5. Maximum Length: 80
11. Add a Workflow step into the Workflow record.
    1. Business Object API Workflow Step: SetCommentValue
    2. Enabled: checked
    3. Sort: 30
12. Click View Schema and the schema should have the following structure.

    The schema accpets the new MyComment attribute.

    Note

    {
      "required" : [ "Id" ],
      "properties" : {
        "Tactics" : {
          "items" : {
            "required" : [ "Id" ],
            "properties" : {
              "MyComment" : {
                "pattern" : null,
                "minLength" : null,
                "maxLength" : 80,
                "type" : "string"
              },
              "TacticTemplate" : {
                "pattern" : null,
                "minLength" : null,
                "maxLength" : 40,
                "type" : "string"
              },
              "Id" : {
                "pattern" : null,
                "minLength" : null,
                "maxLength" : 40,
                "type" : "string"
              }
            },
            "additionalProperties" : false,
            "type" : "object"
          },
          "type" : "array"
        },
        "PromotionTemplate" : {
          "pattern" : null,
          "minLength" : null,
          "maxLength" : 40,
          "type" : "string"
        },
        "Id" : {
          "pattern" : null,
          "minLength" : null,
          "maxLength" : 40,
          "type" : "string"
        }
      },
      "additionalProperties" : false,
      "type" : "object"
    }

13. Test the API by making a REST call to the Promotion BO API endpoint and passing the required parameters.
    POST /services/apexrest/cgcloud/promotions/ingest
    
    {
      "workflow": "updateTacticComments", // Name of your workflow
      "salesOrg": "0001",
      "promotions": [
        {
          "Id": "a2VTC0000001lJR2AY",  // A promotion in the system
          "Tactics": [
            {
              "Id": "a36TC0000000XYfYAM", // It's tactics
              "MyComment": "Comment 1 - updated"
            },
            {
              "Id": "a36TC0000000XYgYAM",
              "MyComment": "Comment 2 - updated"
            }
          ]
        }
      ]
    }

14. Track the execution status from the “Business Object API Transaction Logs” Tab by referencing the request by the returned importId.

Coding Guidelines

• Avoid expensive operations (such as significant JSON serializations or deserializations) in the Business Rules code.
• Cache the SObject records from the database, as other rules might be impacted. (check SimplePromotionCoreBusinessRules.readSObjectById)
• Ensure that the Business Rules focus on a single job, to enable a modular and configurable approach.