Help center

Create a Metadata Filter

Overview 

Metadata Filters are like List Views for Metadata deployments. They provide a personalized view of metadata designed to help identify specific types of metadata components to load and compare values between the source and destination. They can be created and modified for specific types of changes and can increase the performance of loading the metadata by focusing on just a few metadata component types. For example, Prodly provides a Metadata Filter for “Objects, Flows and Workflow Rules” which would load and compare just these metadata component types, thus excluding large tables like Profiles or Email Templates.

View Available Metadata Filters

  1. Navigate to the Metadata Filters tab in App Navigator
  2. Change the list view to show all Metadata Filters. You should see the following Metadata Filters:
    1. Objects, Flows and Workflow Rules
    2. Object, Flows, Workflow Rules, Permission Sets, and Profiles
    3. Objects, Permission Sets, and Profiles
    4. All Major Metadata Types

Create a New Metadata Filter

  1. Click New.
  2. Add a descriptive Metadata Filter Name.
  3. Check the Active checkbox.
  4. Click Save.

Add Metadata Filter Rules to Filter Metadata Components

Metadata Filter rule logic applies “Or” conditions between different parent rules. For example, you might have one rule to include a Namespace and another rule to include all custom objects in the Org.

  1. Navigate to the Related tab on the Metadata Filters detail page.
  2. Click New to create a new Metadata Filter Rule.
  3. Set Action to Include or Exclude.
  4. Select a Filter Type.
  5. Add a Filter Value. Filter values will vary by the Component Type. See examples below.

Filter Value Examples 

Component Type 

This filter is used to select a metadata component type. For example, Custom Object, Flow, or Workflow Rules. To support all 3, one would create three rules in the Metadata Filter, one for each metadata component type.

Component Name

This filter is used to select a specific component to be included. For example, Account or Quote. To use this type, a parent Rule with a Namespace or Component Type is required. For example, one could create a parent rule to filter Component Type and Filter Value CustomObject and a child Metadata Filter Rule with a filter of Component Name and Filter Value SBQQ__Quote__c.

Namespace

This filter is used to narrow the components to just those in a specific application namespace. For example, a filter value of SBQQ would filter the metadata to just those components with this suffix.