Update the README; Renamed the Class TestDataSetup.cls as ExtededTestDataSetup for compatibility; Fix the issue that block resuing MasterQuote to generate Sub Quotes/Subscriptions.

Author: quantarick

QuoteSplit/README

@@ -31,10 +31,18 @@ INTRODUCTION
 
 This Z-Force Sample Code package provides a reference implementation that split single Quote(MasterQuote) into two Quotes(SubQuote) and sending to Z-Billing.
 
+USE CASES
+---------
+a. The customers have two categories of Rate Plans ("Regular" and "Power") that need to send to Z-Billing according to the categories but to track using one Quote on SFDC called MasterQuote. 
+b. Correspondingly to the two categories, there could be two SubQuotes. In this sample code, we can send two SubQuotes simultaneously to Z-Billing (only if there are two different categories of Rate Plans selected for the Quote), 
+   and there will be two Subscriptions generated after sending to Z-Billing. 
+c. The Subscription(s) will generated on single existing Billing Account;
+d. The Subscription Zuora ID(s) will be written back to the SubQuote(s) then roll up to the MasterQuote, among which, the "Regular" Subscription's ID will be stored in MasterQuote's zqu__ZuoraSubscriptionID__c, 
+   and the "Power" Subscription's ID will be stored in the MasterQuotes' Extended_Zuora_Subscription_ID__c.
+e. The SubQuote(s) will be deleted after subscribing, and only MasterQuote will be persisted.
 
 PRE-REQUISITES
 -------------
-
 1. This sample code package is an unmanaged package that depends on the following Z-Force managed packages: 
 - Z-Force 360 Version 2.3
 - Z-Force Quotes Version 5.5
@@ -65,17 +73,17 @@ ant deploy
 
 This will deploy the sample code unmanaged package into your Salesforce.com organization.  
 
-
 And the second approach is by installation:
 
 1. Install this sample code package using the following Force.com Installation URL: 
 
-https://login.salesforce.com/packaging/installPackage.apexp?p0=04tE0000000HPlS
+Z-Quotes Quote Split V 1.3
+https://login.salesforce.com/packaging/installPackage.apexp?p0=04tE0000000HQcY
 
 This will install sample code unmanaged package into your Salesforce.com organization.
 
 PACKAGE CONTENTS 
-================
+----------------
 
 Fields (3)
 Component Name                                               Parent Object                      Component Type                Description
@@ -88,7 +96,7 @@ Code (3)
 Component Name                                               Parent Object                       Component Type               Description
 ExtendedZQuoteUtil                                                                                Apex Class                  The reference implementation that split single Quote(MasterQuote) into two Quotes(SubQuote) and sending to Z-Billing.
 SendToZBillingPreviewController                                                                   Apex Class                  The entry page' controller which is to call ExtendedZQuoteUtil.sendToZBilling.
-TestDataSetup                                                                                     Apex Class                  Setup test data for apex unit test.
+ExtendedTestDataSetup                                                                             Apex Class                  Setup test data for apex unit test.
 
 Pages (1)
 Component Name                                               Parent Object                       Component Type               Description
@@ -98,3 +106,16 @@ SendToZBillingPreview
 Resources (1)
 Component Name                                               Parent Object                       Component Type               Description
 Send to Z-Billing (Quote Split)                                  Quote                             Button or Link             The link to SendToZBillingPreview page. 
+
+OPERATION MANUAL
+---------------
+1. Sync the product catalog from Z-Billing as usual, then check the Product Rate Plans, choose part of the records and set the Category__c field on the records. 
+   Currently we support two categories "Power" or "Regular";
+2. Create an Opportunity;
+3. On the Opportunity, create a New Subscription Quote as MasterQuote and select products, either from "Power" or "Regular" category, for that Quote, 
+   in another word, you can choose Product Rate Plans which belong to different Categories for the MasterQuote;
+4. In the Quote Detail page, click "Send to Z-Billing(Quote Split)" button to enter the SendToZBillingPreview page;
+5. In the SendToZBillingPreview, choose an existing Billing Account in Z-Billing(If there's no existing Billing Account, please prepare at least one in Z-Billing System).
+6. Click Button "Send to Z-Billing" to complete subscribe call. 
+7. After that, you can verify the result in both SFDC and Z-Billing. In SFDC, the Quote object's zqu__ZuoraSubscriptionID__c or Extended_Zuora_Subscription_ID__c (or Both) should be populated with the Subscription ID(s) of SubQuote(s).
+   And In Z-Billing, the corresponding Subscription record(s) should be generated already.

QuoteSplit/src/classes/TestDataSetup.cls renamed to QuoteSplit/src/classes/ExtendedTestDataSetup.cls

@@ -1,5 +1,5 @@
 @isTest
-public with sharing class TestDataSetup {
+public with sharing class ExtendedTestDataSetup {
 
   public static final String OPPORTUNITY_NAME = 'test opp';
   public static final Boolean DEFAULT_ALLOW_UPDATE_BILL_CYCLE_DAY = false;
@@ -159,7 +159,7 @@ public with sharing class TestDataSetup {
       try {
         insert zprod;
       } catch (Exception e) {
-        System.assert(false, 'TestDataSetup.prepareProductCatalog: Exception occured while inserting ZProduct__c. Exception Details: ' + e.getMessage());
+        System.assert(false, 'ExtendedTestDataSetup.prepareProductCatalog: Exception occured while inserting ZProduct__c. Exception Details: ' + e.getMessage());
       }
       System.assert(null != zprod.Id, 'Product record preparation failed when prepare for testing product catalog.');
 
@@ -183,7 +183,7 @@ public with sharing class TestDataSetup {
       try {
         insert p_rateplans;
       } catch (Exception e) {
-        System.assert(false, 'TestDataSetup.prepareProductCatalog: Exception occured while inserting ProductRatePlan__c records. Exception Details: ' + e.getMessage());
+        System.assert(false, 'ExtendedTestDataSetup.prepareProductCatalog: Exception occured while inserting ProductRatePlan__c records. Exception Details: ' + e.getMessage());
       }
       System.assert(p_rateplans.size() > 0, 'Product Rateplan records prepare failed when prepare for testing product catalog.');
       List < zqu__ProductRatePlanCharge__c > p_all_charges = new List < zqu__ProductRatePlanCharge__c > ();
@@ -194,7 +194,7 @@ public with sharing class TestDataSetup {
       try {
         insert p_all_charges;
       } catch (Exception e) {
-        System.assert(false, 'TestDataSetup.prepareProductCatalog: Exception occured while inserting ProductRatePlanCharge__c records. Exception Details: ' + e.getMessage());
+        System.assert(false, 'ExtendedTestDataSetup.prepareProductCatalog: Exception occured while inserting ProductRatePlanCharge__c records. Exception Details: ' + e.getMessage());
       }
       System.assert(p_all_charges.size() > 0, 'Product Rateplan charge records prepare failed when prepare for testing product catalog.');
       List < zqu__ProductRatePlanChargeTier__c > p_all_tiers = new List < zqu__ProductRatePlanChargeTier__c > ();
@@ -205,7 +205,7 @@ public with sharing class TestDataSetup {
       try {
         insert p_all_tiers;
       } catch (Exception e) {
-        System.assert(false, 'TestDataSetup.prepareProductCatalog: Exception occured while inserting ProductRatePlanChargeTier__c records. Exception Details: ' + e.getMessage());
+        System.assert(false, 'ExtendedTestDataSetup.prepareProductCatalog: Exception occured while inserting ProductRatePlanChargeTier__c records. Exception Details: ' + e.getMessage());
       }
       System.assert(p_all_tiers.size() > 0, 'Product Rateplan charge tier records prepare failed when prepare for testing product catalog.');
     }
@@ -296,7 +296,7 @@ public with sharing class TestDataSetup {
     try {
       insert acc;
     } catch (Exception e) {
-      System.assert(false, 'TestDataSetup.prepareTestQuote: Exception occured while inserting Account record. Exception Details: ' + e.getMessage());
+      System.assert(false, 'ExtendedTestDataSetup.prepareTestQuote: Exception occured while inserting Account record. Exception Details: ' + e.getMessage());
     }
     System.assert(null != acc.Id, 'Apex Test Failed to create Mockup account.');
 
@@ -307,7 +307,7 @@ public with sharing class TestDataSetup {
     try {
       insert billto;
     } catch (Exception e) {
-      System.assert(false, 'TestDataSetup.prepareTestQuote: Exception occured while inserting Bill To Contact record. Exception Details: ' + e.getMessage());
+      System.assert(false, 'ExtendedTestDataSetup.prepareTestQuote: Exception occured while inserting Bill To Contact record. Exception Details: ' + e.getMessage());
     }
     System.assert(null != billto.Id, 'Apex Test failed to create Mockup Bill To Contact.');
 
@@ -318,7 +318,7 @@ public with sharing class TestDataSetup {
     try {
       insert soldto;
     } catch (Exception e) {
-      System.assert(false, 'TestDataSetup.prepareTestQuote: Exception occured while inserting Sold To Contact record. Exception Details: ' + e.getMessage());
+      System.assert(false, 'ExtendedTestDataSetup.prepareTestQuote: Exception occured while inserting Sold To Contact record. Exception Details: ' + e.getMessage());
     }
     System.assert(null != soldto.Id, 'Apex Test failed to create Mockup Sold To Contact.');
 
@@ -330,7 +330,7 @@ public with sharing class TestDataSetup {
     try {
       insert opp;
     } catch (Exception e) {
-      System.assert(false, 'TestDataSetup.prepareTestQuote: Exception occured while inserting Opportunity record. Exception Details: ' + e.getMessage());
+      System.assert(false, 'ExtendedTestDataSetup.prepareTestQuote: Exception occured while inserting Opportunity record. Exception Details: ' + e.getMessage());
     }
     System.assert(null != opp.Id, 'The Insert Opportunity should not be null.');
     System.assert(null != opp.AccountId, 'The Insert Opportunity.AccountId should not be null.');
@@ -354,7 +354,7 @@ public with sharing class TestDataSetup {
     try {
       insert quote;
     } catch (Exception e) {
-      System.assert(false, 'TestDataSetup.prepareTestQuote: Exception occured while inserting Quote record. Exception Details: ' + e.getMessage());
+      System.assert(false, 'ExtendedTestDataSetup.prepareTestQuote: Exception occured while inserting Quote record. Exception Details: ' + e.getMessage());
     }
     System.assert(null != quote.Id, 'The Insert Quote should not be null.');
 
@@ -382,10 +382,10 @@ public with sharing class TestDataSetup {
         quoteCharges.add(quoteCharge);
       }
       try {
-	      insert quoteCharges;
-	    } catch (Exception e) {
-	      System.assert(false, 'TestDataSetup.prepareTestQuote: Exception occured while inserting QuoteCharge record. Exception Details: ' + e.getMessage());
-	    }
+        insert quoteCharges;
+      } catch (Exception e) {
+        System.assert(false, 'ExtendedTestDataSetup.prepareTestQuote: Exception occured while inserting QuoteCharge record. Exception Details: ' + e.getMessage());
+      }
     }
 
     return quote;

QuoteSplit/src/classes/TestDataSetup.cls-meta.xml renamed to QuoteSplit/src/classes/ExtendedTestDataSetup.cls-meta.xml

@@ -3,7 +3,7 @@
     <apiVersion>23.0</apiVersion>
     <packageVersions>
         <majorNumber>5</majorNumber>
-        <minorNumber>3</minorNumber>
+        <minorNumber>5</minorNumber>
         <namespace>zqu</namespace>
     </packageVersions>
     <status>Active</status>

QuoteSplit/src/classes/ExtendedZQuoteUtil.cls

@@ -1,5 +1,5 @@
 /**
- * Sample code of spliting single Quote(MasterQuote) into two Quotes(SubQuote) and sending to Z-Billing.
+ * Sample code of splitting single Quote(MasterQuote) into two Quotes(SubQuote) and sending to Z-Billing.
  * 
  * User case
  *    a. The customers have two categories of Rate Plans (e.g. Regular/Power) that need to send to Z-Billing according to the categories but track using one MasterQuote. 
@@ -39,8 +39,8 @@ global Class ExtendedZQuoteUtil {
 
     // Create two Quotes, one for "Regular" Quote, and another for "Power" Quote.
     String subscribeDate = String.valueOf(System.now());
-    final zqu__Quote__c regularQuote = generateSubQuote(masterQuote, '[Regular]', subscribeDate);
-    final zqu__Quote__c powerQuote = generateSubQuote(masterQuote, '[Power]', subscribeDate);
+    final zqu__Quote__c regularQuote = generateSubQuote(masterQuote, CATEGORY_REGULAR, subscribeDate);
+    final zqu__Quote__c powerQuote = generateSubQuote(masterQuote, CATEGORY_POWER, subscribeDate);
 
     // Split the MasterQuote as two SubQuotes.
     splitQuote(masterQuote, regularQuote, powerQuote);
@@ -93,13 +93,20 @@ global Class ExtendedZQuoteUtil {
   /**
    * Generate SubQuote.
    */
-  private static zqu__Quote__c generateSubQuote(zqu__Quote__c masterQuote, String namePrefix, String nameSurfix) {
+  private static zqu__Quote__c generateSubQuote(zqu__Quote__c masterQuote, String category, String timeStamp) {
     zqu__Quote__c subQuote = masterQuote.clone();
-    subQuote.Name = namePrefix + ' ' + masterQuote.Name + ' ' + nameSurfix;
-    // Set the look-up key to MasterQuote__c, if customer want to support sending SubQuotes seperately, 
-    // and update MasterQuote seperately, then the MasterQuote__c will be used.
-    subQuote.MasterQuote__c = masterQuote.id;
-    subQuote.zqu__Opportunity__c = masterQuote.zqu__Opportunity__c;
+    // Initialize the SubQuote.
+    {
+	    subQuote.Extended_Zuora_Subscription_ID__c = null;
+	    subQuote.zqu__ZuoraSubscriptionID__c = null;
+	    subQuote.Name = '[' + category + ']' + ' ' + masterQuote.Name + ' ' + timeStamp;
+	    subQUote.zqu__Description__c = subQuote.Name;
+	    
+	    // Set the look-up key to MasterQuote__c, if customer want to support sending SubQuotes seperately, 
+	    // and update MasterQuote seperately, then the MasterQuote__c will be used.
+	    subQuote.MasterQuote__c = masterQuote.id;
+	    subQuote.zqu__Opportunity__c = masterQuote.zqu__Opportunity__c;
+    }
     insert subQuote;
     return subQuote;
   }
@@ -170,7 +177,7 @@ global Class ExtendedZQuoteUtil {
    * Unit Test.
    */@isTest
   private static void splitQuoteTest() {
-    final zqu__Quote__c masterQuote = TestDataSetup.getQuote();
+    final zqu__Quote__c masterQuote = ExtendedTestDataSetup.getQuote();
 
     String subscribeDate = String.valueOf(System.now());
     final zqu__Quote__c regularQuote = ExtendedZQuoteUtil.generateSubQuote(masterQuote, '[Regular]', subscribeDate);
@@ -180,18 +187,18 @@ global Class ExtendedZQuoteUtil {
 
     final List < zqu__QuoteCharge__c > regularQuoteCharges = [SELECT zqu__Quote__c, zqu__ProductRatePlanName__c FROM zqu__QuoteCharge__c WHERE zqu__Quote__c = : regularQuote.id];
     for (zqu__QuoteCharge__c regularQuoteCharge: regularQuoteCharges) {
-      System.assertEquals(CATEGORY_REGULAR, TestDataSetup.PLAN_NAME_CATEGORY_MAPPING.get(regularQuoteCharge.zqu__ProductRatePlanName__c));
+      System.assertEquals(CATEGORY_REGULAR, ExtendedTestDataSetup.PLAN_NAME_CATEGORY_MAPPING.get(regularQuoteCharge.zqu__ProductRatePlanName__c));
     }
 
     final List < zqu__QuoteCharge__c > powerQuoteCharges = [SELECT zqu__Quote__c, zqu__ProductRatePlanName__c FROM zqu__QuoteCharge__c WHERE zqu__Quote__c = : powerQuote.id];
     for (zqu__QuoteCharge__c powerQuoteCharge: powerQuoteCharges) {
-      System.assertEquals(CATEGORY_POWER, TestDataSetup.PLAN_NAME_CATEGORY_MAPPING.get(powerQuoteCharge.zqu__ProductRatePlanName__c));
+      System.assertEquals(CATEGORY_POWER, ExtendedTestDataSetup.PLAN_NAME_CATEGORY_MAPPING.get(powerQuoteCharge.zqu__ProductRatePlanName__c));
     }
   }
 
   @isTest
   private static void doSendCodeCoverageTest() {
-    final zqu__Quote__c masterQuote = TestDataSetup.getQuote();
+    final zqu__Quote__c masterQuote = ExtendedTestDataSetup.getQuote();
 
     String subscribeDate = String.valueOf(System.now());
     final zqu__Quote__c regularQuote = generateSubQuote(masterQuote, '[Regular]', subscribeDate);

QuoteSplit/src/classes/SendToZBillingPreviewController.cls

@@ -116,7 +116,7 @@ public with sharing class SendToZBillingPreviewController {
   */
   @isTest
   private static void pageControllerCodeCaverageTest() {
-    final zqu__Quote__c masterQuote = TestDataSetup.getQuote();
+    final zqu__Quote__c masterQuote = ExtendedTestDataSetup.getQuote();
     SendToZBillingPreviewController pageController = new SendToZBillingPreviewController(new ApexPages.StandardController(masterQuote));
     pageController.doSend();
   }

QuoteSplit/src/package.xml

@@ -1,26 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Package xmlns="http://soap.sforce.com/2006/04/metadata">
     <fullName>Z-Quotes Quote Split</fullName>
-    <description>Sample code of spliting single Quote(MasterQuote) into two Quotes(SubQuote) and sending to Z-Billing.</description>
-    <types>
-        <members>ExtendedZQuoteUtil</members>
-        <members>SendToZBillingPreviewController</members>
-        <members>TestDataSetup</members>
-        <name>ApexClass</name>
-    </types>
-    <types>
-        <members>SendToZBillingPreview</members>
-        <name>ApexPage</name>
-    </types>
-    <types>
-        <members>zqu__ProductRatePlan__c.Category__c</members>
-        <members>zqu__Quote__c.Extended_Zuora_Subscription_ID__c</members>
-        <members>zqu__Quote__c.MasterQuote__c</members>
-        <name>CustomField</name>
-    </types>
-    <types>
-        <members>zqu__Quote__c.Send_to_Z_Billing_Quote_Split</members>
-        <name>WebLink</name>
-    </types>
+    <description>Sample code of splitting single Quote(MasterQuote) into two Quotes(SubQuote) and sending to Z-Billing.</description>
     <version>21.0</version>
 </Package>