You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-15Lines changed: 37 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,13 @@
3
3
4
4
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.
@@ -22,16 +22,17 @@ Vlocity Build is a command line tool to export and deploy Vlocity DataPacks in a
22
22
# Installation Instructions
23
23
-----------
24
24
25
-
## Install Node.js
26
-
Download and Install Node at:
27
-
https://nodejs.org/
25
+
## Install Node.js
26
+
Download and Install Node at:
28
27
29
-
This project requires Node Version 8+.
28
+
https://nodejs.org/
30
29
31
-
Use `node -v` to find out which version you are on.
30
+
This project requires Node Version 8+.
32
31
33
-
Inside the Git repository you have cloned run the following command:
34
-
```bash
32
+
Use `node -v` to find out which version you are on.
33
+
34
+
Inside the Git repository you have cloned run the following command:
35
+
```bash
35
36
npm install
36
37
npm link
37
38
vlocity help
@@ -43,8 +44,8 @@ This should show a list of all available commands confirming that the project ha
43
44
------------
44
45
To begin, create your own property files for your Source and Target Salesforce Orgs with the following:
45
46
```java
46
-
sf.username:<SalesforceUsername>
47
-
sf.password:<SalesforcePassword>
47
+
sf.username:<SalesforceUsername>
48
+
sf.password:<SalesforcePassword>
48
49
```
49
50
When you (or your CI/CD server) is behind a proxy you can specify the proxy URL with a Username and password by adding the below line to your property file:
50
51
```java
@@ -54,7 +55,7 @@ sf.httpProxy: http://[<Proxy server Username>:<Proxy server Password>@]<Proxy ho
54
55
It is best to not rely on a single build.properties file and instead use named properties files for each org like `build_source.properties` and `build_target.properties`
@@ -64,7 +65,7 @@ The propertyfile is used to provide the credentials of the org you will connect
64
65
## Job File
65
66
The Job File used to define the project location and the various settings for running a DataPacks Export / Deploy.
66
67
67
-
Step by Step Guide
68
+
# Step by Step Guide
68
69
------------
69
70
Once you have your `build_source.properties` file setup, you can get started with mirgation with the following:
70
71
@@ -442,6 +443,25 @@ manifest:
442
443
443
444
**Due to the limitation that not all DataPackTypes support the manifest format. It is best to use the Export by Queries syntax**
444
445
446
+
## Advanced: Export Individual SObject Records
447
+
You can export individual SObjects by using the VlocityDataPackType SObject. This will save each SObject as its own file.
448
+
449
+
```bash
450
+
vlocity packExport -type SObject -query 'SELECT Id from PricebookEntry WHERE Id in ('01u0a00000I4ON2AAN', '01u0a00000I4ON2AAN')"
451
+
```
452
+
453
+
This will export the PricebookEntries into a folder called SObject_PricebookEntry.
454
+
455
+
This method is also very good for adding Custom Settings to Version Control, however it requires creating Matching Key Records for your Custom Setting. See [Creating Custom Matching Keys] (#creating-custom-matching-keys) for more information on Matching Keys. You can specify a Custom Setting in your job file as follows:
456
+
457
+
```yaml
458
+
queries:
459
+
- VlocityDataPackType: SObject
460
+
query: Select Id from MyCustomSetting__c'
461
+
```
462
+
463
+
This will export the MyCustomSetting__c records into a folder called SObject_MyCustomSetting.
464
+
445
465
## BuildFile
446
466
This specifies a File to create from the DataPack Directory. It could then be uploaded through the DataPacks UI in a Salesforce Org.
447
467
```yaml
@@ -674,6 +694,8 @@ DataPacks uses a Custom Metadata Object called a Vlocity Matching Key to define
674
694
675
695
Create these keys if you want to support connections between SObject Id fields that are not already supported by DataPacks, or if you would like to change the Vlocity Default for any SObject. Matching Keys created outside the Managed Package will always override ones contained inside (Post Vlocity v15).
676
696
697
+
For Custom Settings `MatchingKeyFields__c` should always be `Name`.
0 commit comments