Connecting Kajoo to Sitecore XM Cloud

This document will focus on integrating the Kajoo module with Sitecore Cloud XM, using the default git repository created when creating a new project in Cloud XM that can be found here GitHub - sitecorelabs/xmcloud-foundation-head.


Kajoo Plugin Integration

First download the Kajoo Plugin Code here from the following link.

https://kajoo.nyc3.digitaloceanspaces.com/Cloud/Kajoo Cloud Plugin.zip

After extracting the folders in the file the following item and folders should be visible.

Copy the items to the src folder in the Cloud Repository, if the renderinghost.module.json has been modified from the initial repository apply the Kajoo changes to your existing file or copy the modifications already made to the Kajoo JSON file.

Open the Repository in an IDE and include the files added in the App_config, App_Data, and Sitecore folders.

Add the files included in the bin folder as references to the Platform project.

Modify the xmcloud.build.json with the following transformation to update the web.config on build.

Check in all changes and Reference Files and deploy the changes to XM Cloud. After deployment navigate to the Kajoo Section through the ribbon from the Content Editor and follow the regular Kajoo documentation to register your instance.

Deployment

Environments in a Cloud XM project can be linked to a repository and a branch that deploys when a new commit is pushed or it can be deployed through powershell with the cloud deployment command Create an XM Cloud project using the Sitecore CLI.

For deployment with Windows PowerShell, open PowerShell and navigate to the repository’s folder. First run the following command to login into Sitecore cloud and authorize access:

dotnet sitecore cloud login

The customizations can then be deployed to Cloud XM. First you must find the environment ID that you wish to deploy to under the respective project.

Then follow up with the command after updating the environment id:

dotnet sitecore cloud deployment create --environment-id {your-enviroment-id} --upload

You can deploy the customizations to your Cloud XM environment tracking the progress in PowerShell or through the deployment URL provided.

Kajoo relies on the Import Service and the JSS Manifest API to deploy the components and templates generated in Kajoo into your XM Cloud.

Due to technical limitations in XM Cloud, the JSS import user does not have read and write permissions by default. Before deploying your Kajoo-generated JSS application into your Sitecore XM Cloud environment, you must configure the access permissions for the JSS import user.

For information on how to configure the access permissions to the JSS import user, please visit Sitecore’s official documentation at Walkthrough: Connecting a code-first JSS Next.js application to XM Cloud.