Merge pull request #142 from vlocityinc/next

v1.8 - New Minor Version - Enhancements for Delta Deploy and Error Messaging

Author: Adam Rutland

.gitignore

@@ -1,5 +1,6 @@
 build_*.properties
 dataPacksJobs/
+coverage/
 !dataPacksJobs/Example.yaml
 !dataPacksJobs/QueryDefinitions.yaml
 !dataPacksJobs/ReadMeExample.yaml
@@ -8,6 +9,7 @@ node_modules/
 vlocity-temp/
 example_vlocity_build/
 test/testJobRunning/
+.nyc_output/
 .vscode/
 .sfdx/
 .npmrc

DataPackSettings/latest/DataRaptor/Attribute-Assignment-Rule-Migration/Attribute-Assignment-Rule-Migration_Mappings.json

@@ -21,7 +21,7 @@
         "%vlocity_namespace%__FilterGroup__c": 2,
         "%vlocity_namespace%__FilterOperator__c": "=",
         "%vlocity_namespace%__FilterValue__c": "Id",
-        "%vlocity_namespace%__InterfaceFieldAPIName__c": "%vlocity_namespace%__AttributeId__c",
+        "%vlocity_namespace%__InterfaceFieldAPIName__c": "%vlocity_namespace%__AttributeCategoryId__c",
         "%vlocity_namespace%__InterfaceObjectLookupOrder__c": 1,
         "%vlocity_namespace%__InterfaceObjectName__c": "%vlocity_namespace%__AttributeAssignmentRule__c",
         "%vlocity_namespace%__MapId__c": "Attribute Assignment Rule Migration1",

DataPackSettings/latest/DataRaptor/OmniScript-Migration/OmniScript-Migration_Mappings.json

@@ -20,7 +20,7 @@
         "%vlocity_namespace%__DomainObjectFieldAPIName__c": "%vlocity_namespace%__OmniScript__c",
         "%vlocity_namespace%__FilterGroup__c": 2,
         "%vlocity_namespace%__FilterOperator__c": "=",
-        "%vlocity_namespace%__FilterValue__c": "'true'",
+        "%vlocity_namespace%__FilterValue__c": "'$Vlocity.TRUE'",
         "%vlocity_namespace%__InterfaceFieldAPIName__c": "%vlocity_namespace%__IsActive__c",
         "%vlocity_namespace%__InterfaceObjectLookupOrder__c": 1,
         "%vlocity_namespace%__InterfaceObjectName__c": "%vlocity_namespace%__OmniScript__c",
@@ -498,7 +498,7 @@
     },
     {
         "%vlocity_namespace%__ConfigurationAttribute__c": "Document",
-        "%vlocity_namespace%__ConfigurationCategory__c": "Sibling",
+        "%vlocity_namespace%__ConfigurationCategory__c": "Parent",
         "%vlocity_namespace%__ConfigurationProcess__c": "Export",
         "%vlocity_namespace%__ConfigurationType__c": "Relationship",
         "%vlocity_namespace%__ConfigurationValue__c": "%vlocity_namespace%__OmniScript__c:%vlocity_namespace%__Element__c:%vlocity_namespace%__PropertySet__c:documentNames",
@@ -654,6 +654,21 @@
         "VlocityDataPackType": "SObject",
         "VlocityRecordSObjectType": "%vlocity_namespace%__DRMapItem__c"
     },
+    {
+        "%vlocity_namespace%__ConfigurationAttribute__c": "VlocityUITemplate",
+        "%vlocity_namespace%__ConfigurationCategory__c": "Parent",
+        "%vlocity_namespace%__ConfigurationProcess__c": "Export",
+        "%vlocity_namespace%__ConfigurationType__c": "Relationship",
+        "%vlocity_namespace%__ConfigurationValue__c": "%vlocity_namespace%__OmniScript__c:%vlocity_namespace%__ElementTypeToHTMLTemplateList__c:ElementTypeToHTMLTemplateList",
+        "%vlocity_namespace%__DomainObjectAPIName__c": "Configuration",
+        "%vlocity_namespace%__DomainObjectCreationOrder__c": 0,
+        "%vlocity_namespace%__DomainObjectFieldAPIName__c": "Configuration",
+        "%vlocity_namespace%__InterfaceFieldAPIName__c": "Configuration",
+        "%vlocity_namespace%__MapId__c": "OmniScript Migration411",
+        "Name": "OmniScript Migration",
+        "VlocityDataPackType": "SObject",
+        "VlocityRecordSObjectType": "%vlocity_namespace%__DRMapItem__c"
+    },
     {
         "%vlocity_namespace%__ConfigurationAttribute__c": "VlocityUITemplate",
         "%vlocity_namespace%__ConfigurationCategory__c": "Parent",

README.md

@@ -3,9 +3,41 @@
 
 Vlocity Build is a command line tool to export and deploy Vlocity DataPacks in a source control friendly format through a YAML Manifest describing your project. Its primary goal is to enable Continuous Integration for Vlocity Metadata through source control. It is written as a Node.js Command Line Tool.
 
-# Recent Major Changes
+# Recent Features
+--------
+
+## v1.8 - Delta Deploys / Exports, Error Message Enhancements, Git Changes Based Deploys, and Auto Update Settings   
+### Delta Deploys / Exports
+Add `deltaCheck: true` to your job file to enable checking to see if there are changes to the the items you are about to deploy or export. This check will run much faster than the getDiffsAndDeploy check, but at this time 100% consistency is not gauranteed for all DataPack Types. The checks will error on the side of caution and run the deploy /export automatically for any DataPack Type that may have changes.
+
+### Error Message Enhancements
+Error messages have been improved to give more instrution on how to fix issues. An example change is as follows:
+
+##### Previous:
+`Error >> AttributeCategory/ATTRIBUTE_CATEGORY --- ATTRIBUTE_CATEGORY --- duplicate value found: <unknown> duplicates value on record with id: <unknown>`
+
+##### New:
+`Error >> AttributeCategory/ATTRIBUTE_CATEGORY -- DataPack >> ATTRIBUTE_CATEGORY -- Error Message --  duplicate field value found: 100 on the field: vlocity_cmt__DisplaySequence__c on record with id: a0K0b00000XabWUEAZ -- Change the vlocity_cmt__DisplaySequence__c field value of the vlocity_cmt__AttributeCategory__c on record with id: a0K0b00000XabWUEAZ in the target org to resolve the issue.`
+
+### Git Changes Based Deploys
+Add `gitCheck: true` to your job file to enable checking what the latest git hash was before deploying to the target org. With this setting *only* the DataPacks that have changed between the previous git hash and the latest git hash will be deployed to the org. 
+
+### Auto Update Settings
+Add `autoUpdateSettings: true` to your job file to enable checking that you have the latest DataPack settings before every export and deploy. This check is very fast and it is advised that this is enabled. 
+
+## v1.7
+### OmniScript and IntegrationProcedure
+The OmniScript and IntegrationProcedure DataPacks have been modified to remove the Order and Level. This means that merging changes for these objects is now much easier.
+
+### SFDX
+Authentication with Salesforce DX credentials is now possible. Use `-sfdx.username` to use a Salesforce DX Authorized Org for `vlocity` commands. Once you are passing this parameter you will not need a password or any other propertyfile information. The Salesforce DX Authorization from `sfdx force:org:display -u <username>` will handle all the information. Passing an alias will work as well.
+
+# Recent Data Model Changes
 --------
 
+## v1.8
+There were no data model changes for v1.8
+
 ## v1.7 - OmniScript and IntegrationProcedure
 The OmniScript and IntegrationProcedure DataPacks have been modified to remove the Order and Level fields which previously controlled how the OmniScript Elements were ordered in the UI. Now the Elements__c Array in the OmniScript `_DataPack.json` file is ordered in the display order of the UI.
 
@@ -28,16 +60,8 @@ If you have any issues with these changes you can install the previous version o
 npm install --global https://github.com/vlocityinc/vlocity_build#v1.5.7
 ```
 
-# Recent Features
---------
-
-## v1.7 - OmniScript and IntegrationProcedure
-The OmniScript and IntegrationProcedure DataPacks have been modified to remove the Order and Level. This means that merging changes for these objects is now much easier.
-
-## v1.7 - SFDX
-Authentication with Salesforce DX credentials is now possible. Use `-sfdx.username` to use a Salesforce DX Authorized Org for `vlocity` commands. Once you are passing this parameter you will not need a password or any other propertyfile information. The Salesforce DX Authorization from `sfdx force:org:display -u <username>` will handle all the information. Passing an alias will work as well.
-
-## Table of Contents
+# Table of Contents
+-----------
 * [Installation Instructions](#installation-instructions)
 * [Getting Started](#getting-started)
 * [Step by Step Guide](#step-by-step-guide)
@@ -57,6 +81,7 @@ Authentication with Salesforce DX credentials is now possible. Use `-sfdx.userna
 * [Advanced](#advanced)
   * [Matching Keys](#matching-keys)
 * [OmniOut](#omniout)
+* [Known Issues](#known-issues)
 
 # Installation Instructions
 -----------
@@ -71,7 +96,7 @@ This project requires Node Version 8+.
 Use `node -v` to find out which version you are on.
 
 ## Install Vlocity Build through NPM
-You can install this package linke any other Node Package! *Do not clone the repo!*
+You can install this package like any other Node Package! *Do not clone the repo!*
 ```bash
 npm install --global vlocity
 vlocity help
@@ -279,7 +304,7 @@ vlocity -propertyfile build_target.properties -job EPC.yaml packRetry # If any e
 ### New Sandbox Orgs
 If you have recently installed the Vlocity Managed Package or created a Sandbox Org that is not a Full Copy Sandbox and have done *no* development this Salesforce Org, you should run the following command to load all the default Vlocity Metadata:
 ```bash
-vlocity -propertyfile build_target.properties --nojob packUpdateSettings refreshVlocityBase
+vlocity -propertyfile build_target.properties --nojob packUpdateSettings installVlocityInitial
 ```
 This will install the Base UI Templates, CPQ Base Templates, EPC Default Objects and any other default data delivered through Vlocity DataPacks. This command should only be run if the Org was not previously used for Vlocity Development.
 
@@ -320,10 +345,8 @@ sfdx force:mdapi:deploy --deploydir managed_packages/vlocity_package --wait -1 -
 # Push Salesforce part of Project
 sfdx force:source:push --targetusername $SF_USERNAME
 
-# Refresh Vlocity Base - Installs all the Base DataPacks that can also be installed manually through 
-# the Vlocity Cards and Vlocity UI Templates Home Screens - 
-# Should only be run on newly created Orgs - Never in Production!
-# vlocity -sfdx.username $SF_USERNAME -job VlocityComponents.yaml refreshVlocityBase
+# Refresh Vlocity Base - Installs all the Vlocity Authored Vlocity Cards and Vlocity UI Templates
+vlocity -sfdx.username $SF_USERNAME -job VlocityComponents.yaml refreshVlocityBase
 
 # Update Settings
 vlocity -sfdx.username $SF_USERNAME -job VlocityComponents.yaml packUpdateSettings
@@ -337,7 +360,7 @@ The managed package in the example is installed through the Metadata API with `s
 
 ```xml
 <InstalledPackage xmlns="http://soap.sforce.com/2006/04/metadata">
-    <versionNumber>900.171.0</versionNumber>
+    <versionNumber>900.208.0</versionNumber>
 </InstalledPackage>
 ```
 
@@ -542,6 +565,7 @@ This will provide a list of files that are different locally than in the org. In
 `runApex`: Runs Anonymous Apex specified in the option -apex at the specified path or in the /apex folder  
 `packGetAllAvailableExports`: Get list of all DataPacks that can be exported  
 `refreshVlocityBase`: Deploy and Activate the Base Vlocity DataPacks included in the Managed Package  
+`installVlocityInitial`: Deploy and Activate the Base Vlocity DataPacks and Configuration DataPacks included in the Managed Package  
 
 ## Example Commands
 
@@ -650,6 +674,7 @@ The Job file additionally supports some Vlocity Build based options and the opti
 | json | Output the result of the Job as JSON Only. Used in CLI API applications | Boolean | false |
 | json-pretty | Output the result of the Job as more readable JSON Only. Used in CLI API applications | Boolean | false |
 | job | Path to job file | String | none |
+| key | DataPack Key to Export or Deploy | String | none |
 | manifest | JSON of VlocityDataPackKeys to be processed | JSON | none | 
 | simpleLogging | Remove the colors from console output. Good for Automation servers. | Boolean | false |
 | nojob | Run command without specifying a Job File. Will use all default settings | Boolean | false |
@@ -1207,3 +1232,9 @@ In order to Retrieve the OmniScripts that will be deployed as part of the OmniOu
 `vlocity -propertyfile <filepath> -job <filepath> runJavaScript -js omniOutRetrieve.js`
 
 This will export the retrieved files into the folder `OmniOut/scripts` in your Project.
+
+# Known Issues
+-----------
+
+* When Multi Currency is enabled, you can only deploy data exported from another Multi Currency Org or to deploy to another Multi Currency Org. Non Multi Currency to Multi Currency Export / Deploy will not work as expected.  
+* OmniScripts that are embedded in many other OmniScripts cannot be activated due to SOQL Query limits.

apex/RemoveOldAttributeAssignments.cls

@@ -1,4 +1,4 @@
-List<vlocity_namespace__AttributeAssignment__c> toDelete = new List<vlocity_namespace__AttributeAssignment__c>();
+Map<Id, vlocity_namespace__AttributeAssignment__c> toDelete = new Map<Id, vlocity_namespace__AttributeAssignment__c>();
 
 Set<Id> allIds = new Set<Id>();
 Set<Schema.SObjectType> types = new Set<Schema.SObjectType>();
@@ -16,14 +16,14 @@ for (vlocity_namespace__AttributeAssignment__c att : [ SELECT vlocity_namespace_
         }
         else 
         {
-           toDelete.add(att);
+           toDelete.put(att.Id, att);
         }
     }
     catch (Exception e)
     {
         System.debug(e);
 
-        toDelete.add(att);
+        toDelete.put(att.Id, att);
     }
 }
 
@@ -43,11 +43,11 @@ for (vlocity_namespace__AttributeAssignment__c att : [ SELECT vlocity_namespace_
 {
     if (!allFoundIds.contains((Id)att.vlocity_namespace__ObjectId__c))
     {
-        toDelete.add(att);
+        toDelete.put(att.Id, att);
         allDeletedIds.add(att.Id);
     }
 }
 
 delete [ SELECT Id FROM vlocity_namespace__OverrideDefinition__c WHERE vlocity_namespace__OverriddenAttributeAssignmentId__c in :allDeletedIds OR vlocity_namespace__OverridingAttributeAssignmentId__c in :allDeletedIds ];
 
-delete toDelete;
+delete toDelete.values();

codeship/encrypted_files/jwt.key

@@ -1,2 +1,2 @@
 codeship:v2
-p+hofCEUeihsEgzPEwKyg8Et66Us8m5UahR/dQNB09cdviLXVq2cQBP4S84//sQ7KwJo++0DfxJcMNr1Zv3UxVEGKaW70EzdkqLuwYk3PeziCUvOgelPQ2BbJ/V6vyaJkw0IpFOP1ifx0qbLdiogpTqtB9mzSqZDr63daRDzMJ5WPTRdYG77rx5E9DFqyWD7f9odJqU7s39QnXDpoqF27LzAZDXngenLQmbY8PWW7Kf+RKV/2ZBjuYIvE8qfLFd+XEvMaA8vJsWzyuC3JcmrZnyzC9azTrznEw0Q0IXJNPIJR5ccoKKo+97cOGDmY4d7ROCotoDFbZWtfkBlco71rUjIMbCmzyvs41/Ddn9viH6aN1WukURj603HxrCp0hEH3f9m3g==
+Q1MCEppg8jb0cRYltQw31QBtHOEL++m6bR8bxnP25B0I4X1xkPz3+NfUDVBib5hx6QN9XxFTMYYNpD3xRxp5jDKf+QlzZGKboPWRQqUwYsT3qiH4PEwlyyPvNBwZXxfouLkKTLL60TOIuCvnKe5D+s7geulqMVMN2pw/tSt9UrCLBPFieYO1V7rNZsBB1etuXMhdK+jCTirhfu3LBzPa5k6YFvp2YZybPT7G2+3KYghlEWkaHxfOvyxdG4TcQa3b+5WHgsWue8Ji8KNX7M5hnm7czkkO8JSrRRYfFJ/Ix08trmn16ffQMlDJ/tG3nrQfT5Q7jboHC1pPZbkwbRev9jZD4zGoXv0jU8zvmIoBPfd+V4f9CfK0/QLghcC4chkiQ+B49w==

codeship/encrypted_files/npmrc

@@ -4,10 +4,22 @@ set -e
 if [ $CI_BRANCH == "master" ]; then
     CURRENT_VERSION=`npm show vlocity version`
     npm version $CURRENT_VERSION --no-git-tag-version --allow-same-version
-    npm version patch --no-git-tag-version
+
+    if [[ $CI_COMMIT_MESSAGE == *"New Minor Version"* ]]; then
+        npm version minor --no-git-tag-version
+    else
+        npm version patch --no-git-tag-version
+    fi
 else 
     CURRENT_VERSION=`npm show vlocity@$CI_BRANCH version`
     npm version $CURRENT_VERSION --no-git-tag-version
+
+    echo $CI_COMMIT_MESSAGE
+
+    if [[ $CI_COMMIT_MESSAGE == *"New Minor Version"* ]]; then
+        npm version minor --no-git-tag-version
+    fi
+
     npm version prerelease --no-git-tag-version
 fi