Understanding Agentforce Metadata

When creating an agent in Agentforce, the metadata files generated depend on the builder used. The old builder generates Bot, BotVersion, and GenAIPlannerBundle metadata, while the new builder generates AiAuthoringBundle metadata.

The AiAuthoringBundle metadata is essentially the source code of the agent and may not be suitable for deployment to higher environments. However, when a version is committed, the necessary metadata files are created, which can be deployed without the AiAuthoringBundle.

Deploying Agentforce Agents with Ci-CD

To deploy Agentforce agents using a CI-CD system like GitHub, it is possible to deploy the AiAuthoringBundle and its dependencies, such as Flows and Apex. This approach allows for the deployment of the agent script to different environments.

The root cause of the issue is the lack of understanding of the metadata files generated by Agentforce and how to deploy them using a CI-CD system.

Best Practices for Deployment

To ensure successful deployment of Agentforce agents, it is essential to follow best practices, such as committing the necessary metadata files and deploying them to the target environment.

deploy-agent.sh

git add .
git commit -m "Deploy Agentforce agent"
git push origin main

Heads up: Make sure to update the deployment script to include the necessary metadata files and dependencies.

Checklist for Deployment

Pre-Deployment Checklist

• Commit the necessary metadata files, such as AiAuthoringBundle and dependencies.
• Update the deployment script to include the necessary metadata files and dependencies.
• Test the deployment script in a non-production environment.
• Verify the agent is working as expected after deployment.
• Monitor the agent for any issues or errors after deployment.

Frequently Asked Questions

What metadata files are generated by Agentforce?

The metadata files generated by Agentforce depend on the builder used, but may include Bot, BotVersion, GenAIPlannerBundle, GenAiFunction, GenAiPlugin, and AiAuthoringBundle.

Can I deploy the AiAuthoringBundle to higher environments?

It is not recommended to deploy the AiAuthoringBundle to higher environments, as it is essentially the source code of the agent.

What dependencies are required for deployment?

The dependencies required for deployment may include Flows and Apex.

How do I test the deployment script?

Test the deployment script in a non-production environment to ensure it is working as expected.