Sandbox Branches
  • 3 Minutes to read
  • Contributors

    Sandbox Branches

      Article Summary

      What is a Branch?

      In Sandbox, a branch is a secluded space where created or modified artifacts such as apps, data tables, lookups, functions, etc., are parked temporarily, before being deployed to the concurrent stages (QA, UAT, or Live) from Dev stage.

      The Basic Sandbox and Advanced Sandbox both include a default branch known as General, where initially created or modified artifacts are temporarily stored by default, and ready for deployment. In the Advanced Sandbox, citizen developers have the ability to create up to 9 additional branches. These extra branches serve a purpose similar to the General branch, allowing users to manage and park their created or modified artifacts.

      Multiple Branches in Advance Sandbox

      In Advance Sandbox, having separate branches becomes especially useful for an organization which creates various artifacts and solutions. When multiple artifacts or solutions are created concurrently, by default they all end up in the General branch, leading to over accumulation of artifacts in one place and difficulties in identifying and deploying them to the next stage.

      To address this challenge, creating distinct branches for respective citizen developer (org. admin or workspace admin) proves beneficial. With up to 9 additional branches allowed to create (in addition to the default General branch), a citizen developer can manage their created artifact(s) or solution(s) in independent branches and deploy them. This organized approach facilitates easier segregation and deployment of artifacts, saving valuable time and effort.

      Let's understand how multiple branches work with an example:


      In an organizational setup, there is an organization administrator and two workspace administrators. When each of them creates their artifacts or solutions, these end up in the general branch, leading to confusion in identifying ownership. To prevent this, the Organization Admin advises the other two workspace admins to create separate branches for storing their artifacts and solutions in their respective branches. This ensures clarity and allows each admin to access their own artifacts without interfering with those of other users.

      How to create a Sandbox Branch?

      • Go to Admin menu -> More -> Branches.

      • Locate the Create Branch option at the top right corner and click on it.

      • A Create Branch pop-up will appear. Complete the necessary details and click Save.

      • Upon successful creation, a confirmation message will be displayed at the top center, indicating Branch Created Successfully.

      To store the created or modified artifact(s) in a newly created branch, you need to understand how to switch from the General branch to newly created branch.

      Upon the creation of a branch by a workspace admin, it retains its privacy and is not accessible to other workspace admins, until unless they add collaborators. Nevertheless, an organizational admin has the capability to access all branches generated by workspace admins. Furthermore, the organizational admin can switch to a branch created by a workspace admin and store artifacts in it.

      Switch among Sandbox Branches?

      To switch among the multiple branches, check out the below guidance .

      • Access the Admin Menu -> More -> Branches.

      • Upon reaching the Branches page, hover over the desired branch you wish to switch to and click on Switch.

      • A Switch Branch popup will appear, confirming your intent to switch branches. Click on Yes to proceed.

      • Notice the change in the top right corner, indicating the successfully switched branch and providing clarity about your current branch.

      How to delete a Sandbox Branch?


      To delete a Sandbox Branch, it is important to either deploy the artifacts within that branch to the Live stage or delete them.

      • Navigate to the branch list page and hover over the branch you wish to remove. Click on View Artifact Summary.

      • Access the Three Dot Menu and select Delete.

      • A Pop-up will appear, prompting you to enter the Branch Name. Provide the branch name and click on Delete.

      • Upon successful deletion, a confirmation message will display, indicating Branch Deleted Successfully.

      Was this article helpful?

      What's Next