How to retrieve or deploy Custom Metadata Records by ANT Migration Tool?

Question

How to retrieve or deploy Custom Metadata Records by ANT Migration Tool?

1. Is this possible?

I guess it should be possible if this is available for packages and changesets but can't find a way out to do this.

2. How to do this?

Found some article about this here:

https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_custommetadata.htm#meta_custommetadata

<types>
    <members>*</​members>
    <name>Custom​Metadata</name>
</types>

I see error

package.xml - Entity type: 'Custom​Metadata' is unknown

3. Does anyone knows how to overcome this error?

This should be working since version 31 but it is not working even in version 35.0

Answer 1

Gosh! This works: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_custommetadata.htm#meta_custommetadata

<types>
    <members>*</​members>
    <name>CustomMetadata</name>
</types>

I just had some invisible character ( &​#8203; Unicode Character 'ZERO WIDTH SPACE' (U+200B) http://www.fileformat.info/info/unicode/char/200b/index.htm ) copied from documentation between small 'm' and capitalised 'M':

<types>
    <members>*</​members>
    <name>Custom​Metadata</name>
</types>

Answer 2

Following are the steps to deploy custom metadata using force.com IDE

1)Make sure to download the latest force.com Migration tool from your salesforce instance

Setup | Tools

2)Drop the ant-salesforce jar into your lib of the ANT directory

sample path--C:\Program Files\apache-ant-1.9.0\lib

3)Use proper package XML as shown below

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
  <types>
    <members>*</members>
    <name>CustomMetadata</name>
  </types>
<version>35.0</version>
</Package>

4)Run the ant retrieve to fetch all custom metadata files

5)Change the build.properties username and password to point to right instance and run ant deploy command

Answer 3

Once you have Force.com Migration Tool set up, you can also choose to deploy individual CustomMetadata records using the following format:

<types>
    <members>MetadataObjectName.Record1Name</members>
    <members>MetadataObjectName.Record2Name</members>
    <name>CustomMetadata</name>
</types>

Answer 4

Following on some of the answers above, I created this script to bring down all custom metadata records into your repo and convert to DX. These data records can be deployed into orgs like any other metadata and are available for inclusion in source control.

I followed the advice found here: https://success.salesforce.com/issues_view?id=a1p3A000000mD2iQAE&title=sfdx-when-using-pull-command-on-custom-metadata-types-you-see-an-error-custom-metadata-type-__mdt-is-not-available-in-this-organization

# Pull down all custom metadata records for a Salesforce org and unpack them into the DX format
# Run from the root of your Salesforce DX project, the script assumes that your project is a git repo
#!/bin/bash

mkdir .tmp

echo '<?xml version="1.0" encoding="UTF-8"?><Package xmlns="http://soap.sforce.com/2006/04/metadata"><types><name>CustomMetadata</name><members>*</members></types><version>41.0</version></Package>' > .tmp/package.xml

echo 'Retrieving metadata from Salesforce...'
sfdx force:mdapi:retrieve --retrievetargetdir .tmp/ --wait 5 --unpackaged .tmp/package.xml

echo 'Unzipping package...'
cd .tmp
unzip unpackaged.zip

cd unpackaged/customMetadata

echo 'Renaming md files to md-meta.xml...'
for f in *.md; do 
    mv -- "$f" "${f%.md}.md-meta.xml"
done

echo 'Moving metadata records...'
mv *.xml ../../../force-app/main/default/customMetadata

echo 'Cleanup...'
cd ../../..

rm -rf .tmp

git status 

echo 'Done!'