/optimize_sf_cmt

Script that helps you easily to find

Primary LanguagePython

Salesforce Custom Metadata Analyzer

This script is designed to analyze your Salesforce Custome Metadata. It retrieves metadata information, generates queries, executes them, and outputs field statistics either to a CSV file or as a Markdown table.

More information about the idea etc. can be found in my blog post about this topic.

Features

  • Fetch Metadata: Retrieve all Custom Metadata Types from a Salesforce organization.
  • Direct Input: Specify a list of Custom Metadata Types directly.
  • Output Options: Write results to a CSV file or print them as a Markdown table.
  • Field Analysis: Analyze field lengths and provide statistics on the fields.

Requirements

  • Salesforce CLI (sf) installed and configured.
  • Python 3.x with the subprocess, json, csv, and argparse modules.

Installation

  1. Clone this repository: 
    git clone https://github.com/yourusername/salesforce-metadata-analyzer.git

Usage

You can run the script with various command-line arguments to perform different tasks related to Salesforce metadata analysis. The best way to run it, is to copy the script into your sfdx folder. Since it uses the sf CLI without any additional parameters you have to have it in the same folder, or subfolders of your sfdx project. Usually, I have such scripts in the scripts folder of my sfdx project.

.
..
- config
- force-app
- scripts
  - analyze_cmt.py

Command-Line Arguments

  • -f: Fetch all objects from the org and filter for custom metadata types.
  • -l <list>: Specify a list of custom metadata types directly. You can provide multiple types separated by spaces.
  • -c: Write the results to a CSV file instead of printing to the console.
  • -o <filename>: Specify the name of the CSV file to write to. Defaults to output.csv.
  • -m: Print the results as a Markdown table.

Running the Script

To run the script, use the following command pattern:

python analyze_cmt.py [options]

Examples

python analyze_cmt.py -l MyCustomMetadataType1__mdt MyCustomMetadataType2__mdt
python analyze_cmt.py -f -m -c -o all_of_my_results.csv
python analyze_cmt.py -m -l My_Custom_Metadata_Type__mdt Yet_Another_Custom_Metdata_Type__mdt

Example Output

+-------------+------------------+---------+----------+--------+-------+------------+  
| Object      | Field            | Longest | Shortest | Length | Count | Type Info* |
+-------------+------------------+---------+----------+--------+-------+------------+
| Config__mdt | GroupLabel__c    | 49      | 31       | 255    | 36    |            |
| Config__mdt | Group__c         | 28      | 10       | 255    | 36    | Lookup     |
| Config__mdt | OptionLabel__c   | 54      | 0        | 255    | 36    |            |
| Config__mdt | OrderInGroup__c  | 2       | 1        | 18     | 36    |            |
| Config__mdt | Order__c         | 2       | 2        | 18     | 36    |            |
| Config__mdt | Configuration__c | 0       | 0        | 255    | 36    |            |
| …           | …                | …       | …        | …      | …     | …          |
+-------------+------------------+---------+----------+--------+-------+------------|