Key Tabs in the XM Cloud Deploy App
Every day, while working on projects, I encounter questions about logs, the GraphQl playground, variables, and developer settings. Consequently, I decided to write a blog post navigating through these details. This way, when someone new comes on board, I can share this post to familiarize them with the important tabs on the platform.
Step 1 — To access the XM Cloud platform, log in at portal.sitecorecloud.io. Then, from the Quick Links section at the bottom, navigate to deploy.sitecorecloud.io
Step 2 — After clicking on the XM Cloud Deploy app, you will be directed to a screen displaying a list of projects. Select the project for which you need to view the details.
Step 3 — Once you click on your project, you will be taken to the Environment screen. From there, choose the specific environment for which you wish to view the required details.
Step 4 — On this screen, you will see several tabs that pertain to the specific environment you selected.
Let’s go over each tab displayed in the above screenshot and explore the details that each one contains.
Deployments
Under this tab, you can access the details of deployment, along with its associated steps. Each step provides an option to download logs, allowing you to review them in the event of a deployment failure. This helps in gaining a detailed understanding of the issues and pinpointing where things went wrong.
Including detailed screenshots will make the points mentioned above more easily understandable.
Sites
Under this option, you will find a list of sites associated with the environment you selected in the previous step. Clicking on a site link will directly take you to the page builder screen of XM Cloud. (pages.sitecorecloud.io)
Details
From developer perspective this tab is very important as it has lot of details which we require in .env file while configuring the project locally or wanted to connect to UAT and production environment
It includes a Context ID, Environment ID, and Hostname, as well as a GraphQl playground IDE. Additionally, there is an option to generate an API, which facilitates easier connectivity to the edge.
Logs
This tab contains all the logs associated with CM, and each sub-tab provides detailed information related to that specific log. Please refer to the screenshot provided for further details. When you expand the logs, you will find them organized by date, allowing you to download and review each log as needed.
Screen -1
Screen -2
Screen -3
Tip — When you need to investigate any user activity performed on a Sitecore Item, please review the logs it has INFO AUDIT which shows the detailed information about the activities performed by the user.
Variables
This tab contains the variables required by the XM Cloud platform. Whenever there is an update to the XM Cloud image, Sitecore recommends updating these variables. Therefore, this is the first place to go to add or modify the necessary variables.
Tip — If there is an update in the XM Cloud change logs that requires you to add a specific variable to your platform, please visit the variables tab.
Developer settings
This tab provides information about the environment variables specific to each site, tailored to the JSS version in the context of both Preview and Live environments.
Options
While navigating through each tab, you may have noticed a dropdown at the top with several options listed below. Please refer to the screenshot for further details.
Tip — When there is a need to restart the environment for any reason, please navigate to this location.
This blog post is useful for newcomers to the platform, those preparing for XM Cloud certification, and anyone needing a quick overview of the deploy app tabs for learning or interview preparation.
Stay tuned for more useful reads related to this platform.
Happy Sitecore XM Cloud Learning!
