Generate data dictionary from a Salesforce Org. This tool can also generate a file that can be imported in Lucidchart to define entities and relationships.
Generate data dictionary from a Salesforce Org. This tool can also generate a file that can be imported in Lucidchart to define entities and relationships.
Works in Unix like system. Windows is not tested.
npm install -g sfdc-generate-data-dictionary
$ sgd -h
Usage: sgd [options]
Generate data dictionary from a Salesforce Org
Options:
-u, --username [username] salesforce username
-p, --password [password] salesforce password
-l, --loginUrl [loginUrl] salesforce login URL [https://login.salesforce.com]
-a, --apiVersion [apiVersion] salesforce API Version [48.0]
-c, --allCustomObjects [allCustomObjects] retrieve all custom objects [true]
-lc, --lucidchart [lucidchart] generate ERD file for Lucidchart [true]
-s, --sobjects [sobjects] sObjects to retrieve separated with commas
-D, --debug [debug] generate debug log file [false]
-d, --deleteFolders [deleteFolders] delete/clean temp folders [true]
-e, --excludeManagedPackage [excludeManagedPackage] exclude managed packaged [true]
-ht, --hideTechFields [hideTechFields] hide tech fields [false]
-tp, --techFieldPrefix [techFieldPrefix] Tech field prefix ['TECH_']
-o, --output [dir] salesforce data dictionary directory path [.]
$ sgd -u "[email protected]" -p "password" -l "https://test.salesforce.com" --sobjects "Account,Contact,Opportunity,Case" -c false
var sgd = require('sfdc-generate-data-dictionary');
sgd({
'username': '',
'password': options.password,
'loginUrl': options.loginUrl,
'projectName': '',
'allCustomObjects': true,
'debug': false,
'cleanFolders': true,
'output':'.'
}, console.log);
Since 1.0.3, you can now run the tool in debug mode to generate a file that contains information about each step during the process. Information contained in the debug files will be enriched following your feedback to have the most accurate information for debugging.
Please paste the content of this file in your issues to help analysis.
For a local module:
CURRENT_DIR/node_modules/sfdc-generate-data-dictionary/files
Global module:
SemVer is used for versioning.
This project is licensed under the MIT License - see the <LICENSE.md> file for details