Note: This is currently a Pilot feature. If you would like to enable suggestions, you can do so in Feature access page (access to this page is available to Team Owners only).
This Pilot feature is available to all teams with any level of Compare and deploy license.
Gearset suggestions takes a number of problem analyzer fixes and brings them into a new tab in the comparison screen, making it quicker and easier to find the changes you may have missed that could impact your deployment.
Not only does this let you access these fixes earlier in your workflow, with the full context and visualizers offered by the comparison view, it also allows you to find dependencies of dependencies, which is a limitation of the current problem analyzers.
Overview of the suggestions tab layout
Standard view
To find Gearset suggestions click the "Suggestions" tab in the sidebar.
The grid view will show a list of all items Gearset suggests you add to your deployment.
If you have an item selected, a banner will display why Gearset is suggesting you add the selected item.
This button will update the suggested item list, pulling in any suggested items for the item(s) you have selected whilst in the suggestions tab or, if the comparison was still loading before entering the tab, will let you update the suggestions based on any new metadata types that have loaded in.
Collapsed view
When working in the collapsed view you can update the suggestions by clicking the suggestions tab (the light bulb icon) again.
All other behavior is the same as in the standard view.
A simple workflow using Compare and Deploy suggestions
To get started with suggestions, open any standard comparison and select an item you would like to deploy without adding its dependencies. In this case I am deploying a layout.
After selecting my layout (1), I will move to the Suggestions tab (2), to see what other metadata items Gearset suggests to include.
Here we can see Gearset suggesting three custom fields to include in my deployment.
Upon selecting an item, a blue banner will show why Gearset is suggesting it.
In this case, I will select all three custom fields as I know they are needed for this layout.
I will then press "Update Suggestions", which will look at the items I have just added and look for any further suggestions based on the new selections.
In my case I can now see the permissions for each of the custom fields I added previously.
I will once again select all the permissions and update the suggestions.
I can now see there are no more suggested items and can continue on with my workflow as normal, either checking what items are selected or click next to continue with my deployment, or go back to the comparison tab to add further items.
Problem analyzers included in Gearset suggestions
Currently, we are including a number of problem analyzers that add additional items to your comparison. We are looking to support more in future updates.
Below is the current list of problem analyzer fixes that will be shown in the suggestions tab:
Problem analyzer name | Reason |
Missing dependency | Some items reference components that aren't in the target. |
Changed dependency | Some items depend on the settings for other items. |
Record type missing updated picklist values | Some record types reference picklist values that will not be available on the target after the deployment. |
Update Permissions For New Components | New items found with permissions that are not included in the deployment |
FAQ
Are suggestions replacing the problem analyzer?
Suggestions do not replace any of the current problem analyzers. This means, you may see an item suggestion that you decide not to include, and then see it again on the problem analyzer screen.
Will suggestions find dependencies for metadata items not in my metadata filter?
No, just like with the problem analyzer, we only query the metadata types that are part of your current comparison. You will need to add all required metadata types before suggestions can find any missing dependencies.
Have any feedback? Please reach out in the in-app chat and let us know what you think!