sgd

sfdc-generate-data-dictionary

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.

Showing:

Popularity

Downloads/wk

22

GitHub Stars

30

Maintenance

Last Commit

3mos ago

Contributors

4

Package

Dependencies

4

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

version

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.

Getting Started

Works in Unix like system. Windows is not tested.

Installing

npm install -g sfdc-generate-data-dictionary

Screenshots

Usage

Command Line

$ 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 [.]

Example

$ bin/cli -u "my.username@mydomain.com" -p "password" -l "https://test.salesforce.com" --sobjects "Account,Contact,Opportunity,Case" -c false

Module

  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);

Debugging

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.

Debug files location

For a local module:

CURRENT_DIR/node_modules/sfdc-generate-data-dictionary/files

Global module:

  • Mac: /usr/local/lib/node_modules/sfdc-generate-data-dictionary/files
  • Windows: %AppData%\npm\node_modules\sfdc-generate-data-dictionary\files

Built With

  • commander - The complete solution for node.js command-line interfaces, inspired by Ruby's commander.
  • bytes - Utility to parse a string bytes to bytes and vice-versa.
  • excel4node - Node module to allow for easy Excel file creation.
  • jsforce - Salesforce API Library for JavaScript applications (both on Node.js and web browser)

Versioning

SemVer is used for versioning.

Authors

License

This project is licensed under the MIT License - see the <LICENSE.md> file for details

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100