Merge pull request #80 from yongbozuo/autoservicecreation

Add sample code for automated service document creation though invocable action

ServiceDocumentSampleComponents/.prettierignore → ServiceDocumentSamples/.prettierignore

@@ -7,4 +7,8 @@
 .sfdx
 .vscode
 
+# Ignore apex cls and apex trigger files:
+**/*.cls
+**/*.trigger
+
 coverage/

ServiceDocumentSampleComponents/README.md → ServiceDocumentSamples/README.md

@@ -1,6 +1,6 @@
-# Service Document Sample Components
+# Service Document Samples
 
-This project contains sample components can be used on the service document template. Through Salesforce DX project, these sample components can be pushed to your org and used on service document templates.
+This project contains sample codes for LWC components and Apex triggers which can be used on the service document template. Through Salesforce DX project, these sample components and triggers can be pushed to your org and used on service document templates.
 
 ## Salesforce DX Project: Next Steps
 

ServiceDocumentSamples/force-app/main/default/classes/FireCreateServiceDocumentInvocableAction.cls

@@ -0,0 +1,76 @@
+public with sharing class FireCreateServiceDocumentInvocableAction {
+  private static final String API_VERSION = 'v58.0';
+
+  private static final String CREATE_SERVICE_DOCUMENT_ACTION_PATH =
+    '/services/data/' +
+    API_VERSION +
+    '/actions/standard/createServiceDocument';
+
+  private static final String AUTHORIZATION_HEADER = 'Authorization';
+  private static final String AUTHORIZATION_BEARER_PREFIX = 'Bearer ';
+
+  private static final String CONTENT_TYPE_HEADER = 'Content-Type';
+  private static final String CONTENT_TYPE_JSON = 'application/json';
+
+  private static final String ACCEPT_HEADER = 'Accept';
+
+  /**
+   * recordId: recordId to generate service document for. WO/WOLI/SA id
+   * templateId: The ID of Service document template to generate document for. The ID starts with '0M0'
+   * locale: (Optional) Locale to generate the document in. Example valid formats: 'ru', 'ru_PL'
+   * title: (Optional) Used to name the document saved
+   */
+  @future(callout=true)
+  public static void TriggerCreateServiceDocumentInvocableAction(
+    String recordId,
+    String templateId,
+    String locale,
+    String title
+  ) {
+    // System.debug('Attempting to queue Create Service Document');
+    // System.debug('RecordId: ' + recordId);
+    // System.debug('TemplateId: ' + templateId);
+    // System.debug('Locale: ' + locale);
+    // System.debug('Title: ' + title);
+
+    String sessionId = UserInfo.getSessionId();
+
+    HttpRequest httpRequest = new HttpRequest();
+
+    httpRequest.setMethod('POST');
+    httpRequest.setEndpoint(
+      URL.getOrgDomainUrl().toExternalForm() +
+      CREATE_SERVICE_DOCUMENT_ACTION_PATH
+    );
+    httpRequest.setHeader(
+      AUTHORIZATION_HEADER,
+      AUTHORIZATION_BEARER_PREFIX + sessionId
+    );
+    httpRequest.setHeader(CONTENT_TYPE_HEADER, CONTENT_TYPE_JSON);
+    httpRequest.setHeader(ACCEPT_HEADER, CONTENT_TYPE_JSON);
+
+    JSONGenerator jg = JSON.createGenerator(false);
+    jg.writeStartObject();
+    jg.writeFieldName('inputs');
+    jg.writeStartArray();
+
+    jg.writeStartObject();
+    jg.writeObjectField('recordId', recordId);
+    jg.writeObjectField('templateId', templateId);
+    if (locale != null) {
+      jg.writeObjectField('locale', locale);
+    }
+    if (title != null) {
+      jg.writeObjectField('title', title);
+    }
+    jg.writeEndObject();
+    jg.writeEndArray();
+    jg.writeEndObject();
+
+    httpRequest.setBody(jg.getAsString());
+
+    Http http = new Http();
+    HttpResponse response = http.send(httpRequest);
+    System.debug(response.getBody());
+  }
+}

ServiceDocumentSamples/force-app/main/default/classes/FireCreateServiceDocumentInvocableAction.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>58.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

ServiceDocumentSamples/force-app/main/default/triggers/ServiceDocumentCreation.trigger

@@ -0,0 +1,201 @@
+trigger ServiceDocumentCreation on DocumentRecipient(after insert) {
+  //TODO:
+  //1. based on the number of signatures in your template, add the template id to a set below.
+  //2. if you have a template with more than 4 signatures
+  //   a. add another Set of templates following the pattern below.
+  //   b. add the corresponding branch in the if-else branch starting at line 56
+  //3. example: Set<String> SA_TEMPLATES_WITH_SIGNATURES_3 = new Set<String>{'0M0xx0000004CFUCA2'};
+  Set<String> WO_TEMPLATES_WITH_1_SIGNATURES = new Set<String>{ '' };
+  Set<String> WO_TEMPLATES_WITH_2_SIGNATURES = new Set<String>{ '' };
+  Set<String> WO_TEMPLATES_WITH_3_SIGNATURES = new Set<String>{ '' };
+  Set<String> WO_TEMPLATES_WITH_4_SIGNATURES = new Set<String>{ '' };
+
+  Set<String> WOLI_TEMPLATES_WITH_1_SIGNATURES = new Set<String>{ '' };
+  Set<String> WOLI_TEMPLATES_WITH_2_SIGNATURES = new Set<String>{ '' };
+  Set<String> WOLI_TEMPLATES_WITH_3_SIGNATURES = new Set<String>{ '' };
+  Set<String> WOLI_TEMPLATES_WITH_4_SIGNATURES = new Set<String>{ '' };
+
+  Set<String> SA_TEMPLATES_WITH_1_SIGNATURES = new Set<String>{ '' };
+  Set<String> SA_TEMPLATES_WITH_2_SIGNATURES = new Set<String>{ '' };
+  Set<String> SA_TEMPLATES_WITH_3_SIGNATURES = new Set<String>{ '' };
+  Set<String> SA_TEMPLATES_WITH_4_SIGNATURES = new Set<String>{ '' };
+
+  // TODO: Set threshold for when you want to fire the trigger for when a template not added to an above sets
+  // Eg: If you set this to 3, then if we cannot match the template being used, we'll automatically
+  //     fire the createServiceDocument invocable action when 3 signatures are collected
+  final Integer DEFAULT_NUM_SIGNATURES = 3;
+
+  for (DocumentRecipient dr : Trigger.new) {
+    ID documentId = dr.DocumentId;
+    if (documentId.getSobjectType() == Schema.ServiceReport.SObjectType) {
+      List<ServiceReport> serviceReports = [
+        SELECT Id, ParentId, DocumentTemplate
+        FROM ServiceReport
+        WHERE Id = :documentId
+      ];
+      String templateId = serviceReports.get(0).DocumentTemplate;
+      // System.debug('Service Report Identified: ' + documentId);
+      // System.debug('Template Id: ' + templateId);
+
+      ID baseRecordId = serviceReports.get(0).ParentId;
+      // System.debug('Base record Id: ' + baseRecordId);
+
+      //currently already collected signatures
+      List<DocumentRecipient> collectedSignaturesRelatedDRs = [
+        SELECT Id
+        FROM DocumentRecipient
+        WHERE DocumentId = :documentId
+      ];
+      // System.debug('Number of collected signatures related DocumentRecipients: ' + collectedSignaturesRelatedDRs.size());
+
+      // There is currently no way to retrieve the number of signatures
+      // on a template. Thus, for now we need to hardcode associations of
+      // template IDs and the number of signature records to collect before automatic
+      // invocation of PDFication.
+
+      // Below, we've provided an example organized by template entity, but more
+      // if conditions could be added within the switch blocks. If no specific template
+      // matches, we also have a default condition which will always submit the service
+      // document once DEFAULT_NUM_SIGNATURES document recipients have been collected.
+
+      // Work Order Templates
+      // The if-else branches can be combined by the number of signatures to reduce the number of branches,
+      // but, in that case, it will not be able to add debug information for each different entity
+      if (WO_TEMPLATES_WITH_1_SIGNATURES.contains(templateId)) {
+        // System.debug('Work Order Template block');
+        //only when all the signatures have been collected, then fire the trigger
+        if (collectedSignaturesRelatedDRs.size() == 1) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else if (WO_TEMPLATES_WITH_2_SIGNATURES.contains(templateId)) {
+        // System.debug('Work Order Template block');
+        if (collectedSignaturesRelatedDRs.size() == 2) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else if (WO_TEMPLATES_WITH_3_SIGNATURES.contains(templateId)) {
+        // System.debug('Work Order Template block');
+        if (collectedSignaturesRelatedDRs.size() == 3) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else if (WO_TEMPLATES_WITH_4_SIGNATURES.contains(templateId)) {
+        // System.debug('Work Order Template block');
+        if (collectedSignaturesRelatedDRs.size() == 4) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else if (WOLI_TEMPLATES_WITH_1_SIGNATURES.contains(templateId)) {
+        // Work Order Line Item Templates
+        // System.debug('Work Order Line Item Template block');
+        if (collectedSignaturesRelatedDRs.size() == 1) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else if (WOLI_TEMPLATES_WITH_2_SIGNATURES.contains(templateId)) {
+        // System.debug('Work Order Line Item Template block');
+        if (collectedSignaturesRelatedDRs.size() == 2) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else if (WOLI_TEMPLATES_WITH_3_SIGNATURES.contains(templateId)) {
+        // System.debug('Work Order Line Item Template block');
+        if (collectedSignaturesRelatedDRs.size() == 3) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else if (WOLI_TEMPLATES_WITH_4_SIGNATURES.contains(templateId)) {
+        // System.debug('Work Order Line Item Template block');
+        if (collectedSignaturesRelatedDRs.size() == 4) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else if (SA_TEMPLATES_WITH_1_SIGNATURES.contains(templateId)) {
+        // Service Appointment Templates
+        // System.debug('Service Appointment Template block');
+        if (collectedSignaturesRelatedDRs.size() == 1) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else if (SA_TEMPLATES_WITH_2_SIGNATURES.contains(templateId)) {
+        // System.debug('Service Appointment Template block');
+        if (collectedSignaturesRelatedDRs.size() == 2) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else if (SA_TEMPLATES_WITH_3_SIGNATURES.contains(templateId)) {
+        // System.debug('Service Appointment Template block');
+        if (collectedSignaturesRelatedDRs.size() == 3) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else if (SA_TEMPLATES_WITH_4_SIGNATURES.contains(templateId)) {
+        // System.debug('Service Appointment Template block');
+        if (collectedSignaturesRelatedDRs.size() == 4) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      } else {
+        // default case
+        // System.debug('Default block');
+        if (collectedSignaturesRelatedDRs.size() == DEFAULT_NUM_SIGNATURES) {
+          FireCreateServiceDocumentInvocableAction.TriggerCreateServiceDocumentInvocableAction(
+            baseRecordId,
+            templateId,
+            null,
+            null
+          );
+        }
+      }
+    }
+  }
+}

ServiceDocumentSamples/force-app/main/default/triggers/ServiceDocumentCreation.trigger-meta.xml

@@ -0,0 +1,5 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<ApexTrigger xmlns="http://soap.sforce.com/2006/04/metadata">
+  <apiVersion>58.0</apiVersion>
+  <status>Active</status>
+</ApexTrigger>

ServiceDocumentSampleComponents/package.json → ServiceDocumentSamples/package.json

@@ -4,12 +4,7 @@
   "version": "1.0.0",
   "description": "Salesforce App",
   "scripts": {
-    "lint": "eslint **/{aura,lwc}/**",
-    "test": "npm run test:unit",
-    "test:unit": "sfdx-lwc-jest",
-    "test:unit:watch": "sfdx-lwc-jest --watch",
-    "test:unit:debug": "sfdx-lwc-jest --debug",
-    "test:unit:coverage": "sfdx-lwc-jest --coverage",
+    "lint": "eslint **/lwc/**",
     "prettier": "prettier --write \"**/*.{cls,cmp,component,css,html,js,json,md,page,trigger,xml,yaml,yml}\"",
     "prettier:verify": "prettier --list-different \"**/*.{cls,cmp,component,css,html,js,json,md,page,trigger,xml,yaml,yml}\"",
     "precommit": "lint-staged"
@@ -26,7 +21,7 @@
     "eslint-plugin-jest": "^26.1.2",
     "husky": "^7.0.4",
     "prettier": "^2.6.0",
-    "prettier-plugin-apex": "^1.10.0"
+    "prettier-plugin-apex": "^1.8.0"
   },
   "lint-staged": {
     "**/*.{cls,cmp,component,css,html,js,json,md,page,trigger,xml,yaml,yml}": [