Important to note: GenAiPlanner components are available in API versions 60 to 63. In API version 64.0 and later, GenAiPlanner is deprecated and replaced entirely by GenAiPlannerBundle.
Gearset's Agentforce metadata deployment solution streamlines the process of deploying AI-powered configurations in Salesforce, including the Agent Planner metadata (GenAiPlanner & GenAiPlannerBundle).
Agentforce AI Agents engage customers autonomously across channels in natural language.
This guide will explain how to successfully deploy Agent Planner metadata with Gearset.
Prerequisites
Make sure to use at least API version 60 for the comparison. Read the prerequisite section of the How to deploy GenAi metadata guide to find out how to do this.
The Einstein bot and botVersion associated to the Agent that you want to deploy must exist on the target org — otherwise the agent will not be visible.
What metadata is needed in the filter?
You'll need to include Einstein bot, botVersion & GenAiPlanner (for API versions 60-63) or GenAiPlannerBundle (for API version 64 and above) in your metadata filter.
How to deploy GenAiPlannerBundle metadata with Gearset?
To deploy the GenAiPlannerBundle metadata type, you need to make sure that all the GenAiFunction and GenAiPlugin dependencies exist on the target environment. If they don't, then you'll need to deploy them alongside the GenAiPlannerBundle for the validation/deployment to be successful.
Note: If the GenAiPlanner is New (in the source), then the associated Einstein bot and botVersion will also need to be deployed to the target org. Otherwise the deployed GenAiPlanner will not be visible on the target org. It's recommended to always deploy any changes to the Einstein bot and botVersion alongside the GenAiPlanner (or alongside GenAiPlannerBundle if deploying via APi version 64 and above).
Example:
This GenAiPlannerBundle is dependent on the following GenAiFunction:
EmployeeCopilot_AnswerQuestionsWithKnowledge
It's also dependent on the following GenAiPlugins:
EmployeeCopilot_GeneralCRM
SvcCopilotTmpl_OrderInquiries
SvcCopilotTmpl_GeneralFAQ
Customer_Service_Assistant
If any of these GenAiFunctions or GenAiPlugins aren't already in the org, or being deployed to the org alongsidethe GenAiPlannerBundle, then the validation/deployment will fail.
We will be adding more problem analyzers over time to help highlight any missing GenAiFunction or GenAiPlugin dependencies before you validate or deploy your Agentforce agents.