{"id":6606,"date":"2018-09-14T16:14:23","date_gmt":"2018-09-14T20:14:23","guid":{"rendered":"https:\/\/www.jitendrazaa.com\/blog\/?p=6606"},"modified":"2018-11-19T21:37:41","modified_gmt":"2018-11-20T02:37:41","slug":"build-a-salesforce-dx-plugin-in-15-minutes-dreamforce-2018","status":"publish","type":"post","link":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/build-a-salesforce-dx-plugin-in-15-minutes-dreamforce-2018\/","title":{"rendered":"Build a Salesforce DX Plugin in 15 Min"},"content":{"rendered":"

Before deploying metadata in Sandbox of production, have you felt that how great it would be to generate configuration workbook ? Or compare sandboxes for difference ? Or check if fields are used on any page layouts or not ? Dear reader, you are in need of custom Salesforce DX<\/strong> plugin<\/strong>.<\/p>\n

You heard it right, Salesforce DX allows custom plugin development. So now question is, how do you connect to Salesforce Org ? Do you need to know about OAuth<\/a> or Single Sign On (SSO)<\/a> ?<\/p>\n

Complete source code is available on my Github repository here<\/a>.<\/p>\n

Prerequisite<\/strong><\/p>\n

    \n
  1. Nodejs Installed<\/li>\n
  2. Salesforce DX<\/a> Installed<\/li>\n<\/ol>\n

    First step is to install yarn using below command<\/p>\n

    \r\nsudo npm install -g yarn\r\n<\/pre>\n
    Next is to run below command, it will create a plugin Template for Salesforce DX which already has all boilerplate code to connect to Salesforce and query data.<\/p>\n
    \r\nsfdx plugins:generate \r\n<\/pre>\n
    Once plugin created, it’s time to link this plugin with Salesforce DX using below command<\/p>\n
    \r\nsfdx plugins:link foldername\r\n#If already in folder then folder name would be blank\r\nsfdx plugins:link \r\n<\/pre>\n
    Below is the structure of directory<\/p>\n
    \"Salesforce
    Salesforce DX Plugin Structure<\/figcaption><\/figure>\n
    As per above folder structure, I’m running command from DF18DEMO and src is immediate folder which contains plugin code, then below command would be used to link this code with Salesforce DX<\/p>\n
      \r\nsfdx plugins:link \r\n<\/pre>\n
    To run this plugin, we need to run command<\/p>\n
      \r\nsfdx hello:org -u jit11\r\n<\/pre>\n
    Above, jit11 is already approved org using command sfdx force:auth:web:login<\/p>\n
    Below image shows summary of commands and its results<\/p>\n
    \"Salesforce
    Salesforce DX Commands<\/figcaption><\/figure>\n
    Download code from here<\/a>\u00a0,\u00a0To run plugin which generates workbook. After downloading, run link command. Below are detail of various command parameters<\/p>\n
    \r\nUSAGE\r\n  $ sfdx DF18:fileoutput\r\n\r\nOPTIONS\r\n  -f, --force                                      example boolean flag\r\n\r\n  -m,                                              Comma separated list of objects to be exported. \r\n                                                   If blank then every object of Org would be exported\r\n\r\n  -p, --path                                       File Name with full Path to\r\n                                                   create Excel File\r\n\r\n  -u, --targetusername=targetusername              username or alias for the\r\n                                                   target org; overrides default\r\n                                                   target org\r\n\r\n  -v, --targetdevhubusername=targetdevhubusername  username or alias for the dev\r\n                                                   hub org; overrides default\r\n                                                   dev hub org\r\n\r\n  --apiversion=apiversion                          override the api version used\r\n                                                   for api requests made by this\r\n                                                   command\r\n\r\n  --json                                           format output as json\r\n\r\n  --loglevel=(trace|debug|info|warn|error|fatal)   logging level for this\r\n                                                   command invocation\r\n\r\nEXAMPLE\r\n  Example : sfdx DF18:fileoutput -u jit27 -m "Account,Lead,Opportunity"\r\nJitendras-MBP:sfdx-plugin jitendra.zaaibm.com$ sfdx DF18:fileoutput --help\r\nUSAGE\r\n  $ sfdx DF18:fileoutput\r\n\r\nOPTIONS\r\n  -f, --force                                      example boolean flag\r\n\r\n  -m,                                              Comma separated list of objects to be exported. \r\n                                                   If blank then every object of Org would be exported\r\n\r\n  -p, --path                                       File Name with full Path to\r\n                                                   create Excel File\r\n<\/pre>\n