Skip to main content
How to deploy GenAiPromptTemplate metadata

A walkthrough on how to deploy GenAiPromptTemplate metadata

Gareth Hefferon avatar
Written by Gareth Hefferon
Updated this week

Prerequisites

You must make sure to use at least API version 60 for the comparison.

The default comparison API version for most customers is Default (highest common version) which will take the version from your SFDX project JSON file from both source and target and it will use the lower of the two.

If you are using a VCS branch as a source or target then updating your SFDX project JSON file in your VCS branch to use at least API version (60) will allow the comparison to occur without manually changing the API version on your filter.


You can manually change the API version by editing your filter settings.

Either from the compare & deploy page by clicking the arrow on the comparison filter and selecting MANAGE CUSTOM FILTERS


Then selecting the API version to use from the drop down and clicking the Ok button



Or from the comparison screen by clicking on the cog in the upper left hand corner of the comparison


Then selecting the API version to use from the drop down and clicking the Update comparison button

or to keep this version going forward then Save filter (you can create a new filter or update your current filter).

What metadata is needed in the filter?

In your metadata filter you will only need to include GenAi prompt template. As long as all dependencies exist in the target org. (You don't need to worry about this if the target org is a VCS branch).

How to deploy through Gearset

To be able to deploy a GenAiPromptTemplate metadata type, you need to make sure that all dependencies exist on the target if they don't then you need to deploy them along side the GenAiPromptTemplate.

Example 1

Example 2

In Example 1 the GenAiPromptTemplate has a dependency on the Account Custom object and the AccountNumber CustomField.

In Example 2 the GenAiPromptTemplate has a dependency on an Apex class PersonalizedGuestExperiences

As you can see from the examples above these GenAiPromptTemplates can potentially have dependencies on a large amount of objects. We will be adding Problem Analyzers over time to help highlight any missing dependencies to light before a Validation or Deployment occurs.

Did this answer your question?