What is manual metadata filtering?
Manual metadata filtering is an advanced feature in Gearset which allows you to edit the metadata filter used on your backup job.
Gearset currently selects the metadata filter based on the data filter you select when configuring your backup job's settings.
Any objects included in your data filter will also have their corresponding metadata backed up, along with any metadata objects with no data object equivalent. However, the metadata filter Gearset creates can sometimes lead to errors if we fetch an unsupported metadata object from Salesforce, resulting in your backup job failing.
In this case, you can also deselect only the metadata object from your backup. This is done through enabling manual metadata filtering for your team, then configuring your metadata filter manually using the backup job settings modal.
Note: Gearset does not recommend enabling this setting except for cases where you have been instructed to do so.
How to enable manual metadata filtering
On your Data management page under "Data backup and archiving settings", scroll down a bit and you'll find below toggle.
To configure manual metadata filtering for your team's backup jobs, you need to enable this setting for your Gearset team.
How to remove objects from your metadata filter
Once the manual metadata filtering team setting is enabled, you will find a new Metadata filtering tab in the Edit settings... modal for your job - this modal can be accessed directly from your Data backup jobs page.
You can "enable manual metadata filtering" individually for each of the CI jobs by selecting Edit and activating the toggle.
Once manual metadata filtering is enabled for a backup job, a list of all available metadata objects will be displayed in a similar format to all data objects in the Include data tab.
Here you are able to select and deselect metadata objects to be included in subsequent backup runs. Once objects are deselected (or selected) your edited filter can be saved by clicking Save on the modal.
To reset your metadata filter to its default value you can disable the toggle at the top of the Metadata filtering tab.
How to completely remove a metadata object from my backup job?
If you wish to completely remove a metadata object from your backup, you will need to deselect this metadata object in both the Include data and Metadata filtering tabs!
Important to note:
The improper use of this feature (Enable manual metadata filtering) can lead to incorrect configuration of your backup, which could result in objects not being backed up and failed restores.
Metadata objects should only be removed from the default filter - additional objects added to your backup are likely to cause it to fail.