Skip to main content
All CollectionsCompare and deploy metadataMetadata filters
Manage custom filters in Compare and deploy
Manage custom filters in Compare and deploy

Guidance on how to manage your custom created filters in our 'Compare and deploy' UI

Mateusz Kochanowicz avatar
Written by Mateusz Kochanowicz
Updated over 2 months ago

We've upgraded our existing comparison filter in several ways to improve the usability and feature set.

Accessing the metadata comparison filter

The fastest and easiest way to open the new comparison filter is to simply click on the cog icon shortcut from the new sidebar when in Comparison filter mode:

You can also access managing your custom filters via the comparison filter dropdown:

Building a new comparison filter

Building a completely new filter is easy. Simply:

  • Select the None (0) option which will clear any existing metadata type selections.

  • Pick and choose the metadata type(s) you want to add to your filter

  • Choose if you want to always include any items for a type to be included in future comparisons, or specify specific named items based on the current items found between the two orgs

  • Add any custom rules using regex or specific object names that will also be applied as part of your filter

  • If you wish to save your current selects and rules as a permanent filter for future use, click Save filter... to give it a name and save the configuration.

    Note: you can also apply a filter to your current comparison without saving it for permanent use.

  • Once you select Save filter..., leave the default option to Save your changes as new filter ticked.

  • Then choose a 'Name' to your filter, and decide if you'd like to Share filter with team. Once done, select Save filter.


    ​Note: Shared filters can be used by anyone in your Gearset team. They can only be edited by the person who created the filter, or a team owner.

Below is quick video to demonstrate the process of creating a new filter.

Updating an existing filter using manage custom filters

To edit a pre-existing filter via the manage custom filters panel:

  • Open the Manage custom filters settings

  • Choose your comparison filter from the drop-down

  • Add/remove types or specify rules and items that you wish to change for your current filter

  • To apply the filter without making permanent changes to it, simply click Update comparison filter.
    ​Note: This will update the filter only for the comparison you're running.

  • To save the changes and update the existing filter, click Save filter... and choose the applicable option: Update the filter with any changes you have made.

Below is a quick video to demonstrate the process of updating an existing filter (to which we've added a new metadata type named Apex test suite).

Updating metadata types on a filter selected for already run comparison

If you need to quickly add new metadata type(s) to your current view from the comparison results, you can also simply use the +COMPARE shortcut from the list of types in the sidebar to add it to an already selected filter.

To permanently save the change, you can do that via the manage custom filters panel.

On below video we're showing how to add a new metadata type (e.g. Custom object) to already selected custom filter on a comparison that was run.
​

Note: This would update the filter only for the comparison you're running.

Did this answer your question?