{"id":6353,"date":"2017-11-12T22:59:28","date_gmt":"2017-11-12T22:59:28","guid":{"rendered":"http:\/\/www.jitendrazaa.com\/blog\/?p=6353"},"modified":"2017-12-12T23:33:36","modified_gmt":"2017-12-12T23:33:36","slug":"use-metadata-api-with-salesforce-dx","status":"publish","type":"post","link":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/use-metadata-api-with-salesforce-dx\/","title":{"rendered":"Use Metadata API with Salesforce DX"},"content":{"rendered":"

If you have existing VCS which stores metadata information about your Salesforce instance in old format, dependent on package.xml and you want to use\u00a0Salesforce DX<\/a>\u00a0<\/strong>then this blog post is for you. As you might already know,\u00a0Salesforce DX\u00a0<\/strong>does not need package.xml and can automatically detect changes in your Salesforce instance, therefore new Salesforce DX project format is different. In this blog post we will see, how Salesforce DX can be used without enabling Developer Hub<\/strong> and using Salesforce DX with normal Salesforce instances.<\/p>\n

There are two solution to this problem<\/p>\n

    \n
  1. Keep using old Project format and use\u00a0Metadata API\u00a0<\/strong>to retrieve and deploy<\/li>\n
  2. Convert old project format to\u00a0Salesforce DX\u00a0<\/strong>project Format<\/li>\n<\/ol>\n

    <\/p>\n

    First step is to authenticate your normal Salesforce org. For this, you don’t need to purchase license for Salesforce DX. You can refer this blog post for common Salesforce DX commands<\/a>. First command we would use is\u00a0login\u00a0<\/strong>command.<\/p>\n

    \r\nsfdx force:auth:web:login --setalias jzaa1\r\n<\/pre>\n
    Above command will open browser window to authenticate Salesforce instance. This authenticated Salesforce instance can be referred as jzaa1 in other Salesforce DX commands.<\/p>\n
    Use Salesforce DX with Metadata API to retrieve components<\/h5>\n
    Below command is used to retrieve component from Salesforce using metadata API by Salesforce DX<\/p>\n
    \r\nsfdx force:mdapi:retrieve -r .\/mdAPIZip -u jzaa1 -k src\/package.xml\r\n<\/pre>\n
    where<\/p>\n
      \n
    • -u : Which Salesforce Org to be used by Salesforce DX<\/li>\n
    • -r : Where zip file should be saved<\/li>\n
    • -k : List of components to be retrieved using package.xml<\/li>\n<\/ul>\n
      Use Salesforce DX with Metadata API to deploy components<\/h5>\n
      Below command can be used to deploy component in regular Salesforce instance where\u00a0Developer Hub\u00a0<\/strong>is not enabled using Metadata API and Salesforce DX<\/p>\n
      \r\nsfdx force:mdapi:deploy -c -f ..\/mdAPIZip\/unpackaged.zip -u jzaa1 -w 10\r\nor\r\nsfdx force:mdapi:deploy -c -d ..\/mdAPIZip\/unpackaged -u jzaa1 -w 10\r\n<\/pre>\n
      where<\/p>\n
        \n
      • -u : Which Salesforce Org to be used by Salesforce DX<\/li>\n
      • -f : Zip file location containing metadata and package.xml<\/li>\n
      • -c : Check only flag, Package would be validates only<\/li>\n
      • -w : Wait time in minute for operation to be completed<\/li>\n
      • -d : Folder location of non-zipped files, with package.xml in root<\/li>\n<\/ul>\n
        Convert old project structure to Salesforce DX format<\/h5>\n
        Lets see, how old project created using ANT Migration toolkit or Force.com IDE can be converted to Salesforce DX format<\/p>\n
        First we need to create a blank Salesforce DX project with the help of below command, where -n is name of Salesforce Dx project<\/p>\n
        \r\nsfdx force:project:create -n MdAPIDemo\r\n<\/pre>\n
        Now, navigate to MdAPIDemo folder<\/p>\n
        \r\ncd MdAPIDemo\r\n<\/pre>\n
        Its time to run last command<\/p>\n
        \r\nsfdx force:mdapi:convert -r ..\/mdAPIZip\/unpackaged\r\n<\/pre>\n
        Where<\/p>\n
          \n
        • -r : root directory, containing metadata API folder<\/li>\n<\/ul>\n