Working with Projects | Online Help | Qntrl

Working with Projects

Step 1: Create a Project 

An admin or user with Manage Settings permission can create Projects.
 
To create a project (test environment):
  1. Navigate to   and select Projects under Advanced.
  2. Click New Project at the top-right corner.
  3. Enter the following details:
    1. Project name: Enter a unique name for the project.
    2. Description: Fill in a description of the project.
    3. Branch Name: (optional)
    4. Project owner: Select an owner for the project.
    5. Project members: Select the project members who can work on the project. (Users who have accepted the organization invite can only be added as Project owner or members). 
    6. Select Sandbox: You can either associate an existing Sandbox with the project or create a new Sandbox by clicking +New Sandbox.
  4. Click Create Project.
A project will be created with the sandbox that you've associated (if any). Access your sandbox to work with the project that you have created.

You can create a maximum of five sandboxes.

Create new sandbox 

You can create a sandbox individually without associating it with any project.
 
To create a new sandbox:
  1. Navigate to   and select Projects under Advanced .
  2. Click the Sandbox button at the top-right corner.
  3. Click Create New Sandbox.  
A new sandbox will be created without being associated with any project. While creating a new project, you can associate this existing sandbox with the project.


Switch Project

Only one project and sandbox can be associated at once. If you would like to use a sandbox for a different project that is already associated with a project, you can just switch the project using the Switch Project option.
 
To switch project:
  1. Navigate to   and select Projects under Advanced.
  2. Click the Sandbox button at the top-right corner.
  3. Click the drop-down arrow beside the Associated Project name in a Sandbox.
  4. Choose a project to switch to.
  5. Click Switch.  


When you switch a project, the current project data will be removed from the sandbox and the data from the newly selected project will be imported into the sandbox.
 
Switching projects can't be done when the sandbox is in development mode. Switch project or unassociate project is possible only when the sandbox is in Ready, Idle, or Failed mode.

Step 2: Access Sandbox 

Once the project is created and associated with a sandbox, the owner and members associated with the project can access the sandbox to develop and test their new processes.  You can associate new members with the project even after its creation. However, the project owner can't be changed.
 
To access Sandbox: 
  1. Click the Sandbox button at the top right.
  2. A list of all the sandboxes will be displayed. Click the Access Sandbox button.
  3. You'll be taken to the sandbox.




Users without settings permission will not be able to view the Access Sandbox button. Instead the users can access Sandbox through these steps: 
  1. Navigate to your profile at bottom left corner.
  2. Click My Organizations.
  3. Click the respective sandbox (Sandbox environment will be labelled as Sandbox). 

Sandbox Status

There are currently five statuses in Sandbox. To find the sandbox status:
  1. Navigate to   and select Projects under Advanced .
  2. Click the Sandbox button at the top band.
  3. All sandboxes will be listed here. You can find the sandbox status within each sandbox details view.


Below are the sandbox statuses:
  1. Import in progress : When a project is associated with a sandbox, the import of data starts and the sandbox status changes to Import in progress.
  2. Import failure : When a project data fails to get imported into the sandbox.
  3. Ready : When the import of project data is completed and it's ready for development.
  4. Development : When a developer makes changes in the sandbox, but it's not yet stored in the repository.
  5. Idle : When the developer has saved all the changes made in the Project to the repository and when there are no unsaved changes in the Project.

Step 3: Create new automations or update existing automations

A replica of your current production environment will be available for you to make changes. Developers or project members can create new automations such as a new orchestration, business rule, or server script, or update existing automations in the Sandbox environment.

Step 4:  View the changes made in the sandbox 

Once the changes are made in the sandbox, the project members can view the respective changes on clicking the Generate Change s button in the Unsaved Changes tab of the sandbox.



Upon clicking Generate Changes , a pop-up will appear with the sandbox logs as the system generates the changes. If all the logs are in completed status, you can close the pop-up and find the changes in the Unsaved Changes tab.
 
The  Unsaved Changes tab will list all the changes made in the respective sandbox. You'll also have the option to view board specific changes or view all the changes in the sandbox. The last modified developer will be captured for every change made in the sandbox.

Step 5:  Save to repository  (Save the changes)

Once the developer checks all the changes made in the sandbox, the changes can be saved in repository. To save the changes made, click Save to Repository . Upon doing so, you'll be prompted to enter a message. The message can be about the changes made in the Project for your reference. 



The message must contain 5 to 100 characters without any special characters.
 
Click Save to Repository . A pop-up will appear with the change logs. If all the logs are in completed status, click Close .
 
All the unsaved changes will now be saved in the repository and be listed under Saved Changes .
 

Step 6: Saved Changes

 You can find the message, who and when the changes were saved, status, differences and the number of changes made from the list view.
 
If you would like to deploy the changes to the production environment, click Send to Live Queue . Enter the message on the Message pop-up menu that appears on-screen and click Send to Live Queue .



The admin or any user with Manage Settings permission can make changes to the production environment directly while you are working in the sandbox. Ensure that your production and sandbox environment are in sync while trying to send the saved changes to live queue. When they are not in sync, you'll be prompted to sync your sandbox with the production environment.

Restrict users from making further changes in production environment 

In the production environment, you can enable read-only mode to prevent any user from making modifications.

Enable read-only mode

  1. Navigate to and select Preferences under Organization .
  2. Turn on Switch portal to read only mode under Manage Portal Mode .
Once done, your sandbox data will be added to Live Queue in production environment from where you can deploy or revert the changes.


Disable read-only mode

  1. Navigate to and select Preferences under Organization .
  2. Turn off Switch portal to read only mode under Manage Portal mode . 
Read/write mode will be turned on in the production environment. Your sandbox data can't be deployed to the production environment in this mode.


Step 7:  Deploy/ Revert the changes

List of all the changes waiting to be deployed will be under Live Queue . This Live Queue will be available under Projects. You can check the changes made in the Sandbox vs the production environment by clicking the View Differences button in Live Queue . Once done, you can click either Deploy or Remove .



  1. Deployment will be aborted if changes have been made in the production environment since the project was last synced with it. To deploy project changes in that scenario, the developer must first remove the project change from the deployment queue and sync the project with the current production environment. 
  2. Only last deployed changes can be reverted. Revert option is supported only for last deployed change. 

Deploying the changes will make the changes live in the production environment. To check if the deployment is successful, you can click View Logs . 

Step 8: Check the Deployment logs  

You can view a list of all the changes/ projects that were deployed to production environment. If there is an issue after deployment, you can revert the deployment from here by clicking the Revert Changes button. However, only the last deployment project will have the Revert Changes option.


After reverting the changes, you'll have to send the change to Live Queue once again from Sandbox to deploy it to the production environment. 


Further Reading 



    • Related Articles

    • Projects (Testing environment) - An Overview

      Early Access This feature is not enabled for all users. If you'd like to try it out, please email our support team for early access. Running a business can become complex as it grows. Bringing in new changes and enhancements is likely in any business ...

    • Step 1: Create Form

      Forms are used to capture requests from users that help you collect the data required to kickstart workflows and perform tasks in Qntrl. There are different departments in an organization providing different solutions. For instance, the finance team ...

    • Other actions in Projects

      Free up a sandbox You can unassociate a project from the sandbox when you want to free up a sandbox. To unassociate a sandbox: Navigate to and select Projects under Advanced. Click the Sandbox button at the top band. All sandboxes will be listed ...

    • Environment Scope for Parameters in Sandbox

      In the Sandbox module, you can assign dynamic values to parameters for different environments (e.g., development, testing, production), ensuring consistent configurations across multiple stages of the deployment process. These parameters can be ...

    • Implementation or Troubleshoot Access

      Access Privilege Implementation or Troubleshoot Access can be provided only by the Organization Owner. You can provide temporary access of your Qntrl account to our technical support team to help build workflows in your organization or troubleshoot ...

    You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.