Roll Back a Deployed Visual Application

When you create a new version to update the live version of a deployed application, you republish the new version to make your changes live. If you want to revert these changes for any reason, you can roll back the application from the current live version to the previous deployed version.

Rollback is available when you've deployed a live version of your application more than once. For example, if you've deployed two versions of your visual application to https://host/something-else/live/index.html, you can roll back from the current live version to the previous deployed version (say, from version 1.0.2 to 1.0.1).

Deploying a new version of a live version (1.0.2 after 1.0.1) renders the previous live version obsolete. If you then decide to roll back from 1.0.2 to 1.0.1, the obsolete version (1.0.1) becomes the live version again. This reverts all your application's content, including any database schema changes.

Note:

When you roll back to a previous version, the data of the previous live application is restored only if the version being rolled back was deployed with the Use clean database option (specified in the deployment job of the pipeline used to package and deploy your changes to the environment's Visual Builder instance). Otherwise, the data from the version being rolled back is adjusted to the database schema of the previous version being restored.

Keep in mind that you can only roll back an application to its last published version. So if your application includes a 1.0 version that was previously deployed and is now obsolete, you can roll back from 1.0.2 to 1.0.1, but not subsequently from 1.0.1 to 1.0.

  • If your visual application was deployed to a Visual Builder instance in the same identity domain as your VB Studio instance, you can roll back the application's current live version to its previous deployed version from your environment's list of deployments:
    1. In the VB Studio left navigator, click Environments Environments.
    2. If necessary, select the environment where the visual application was deployed to, then click Deployments.
    3. Locate the deployed application you want to roll back. Take note of the live version shown in the Version column.
    4. From the application's Actions Three horizontal dots menu, select Rollback:

    5. When prompted, check the version to be rolled back and click Rollback. If, for example, version 1.0.2 was deployed over version 1.0.1, you'll be prompted to confirm the rollback from version 1.0.2 to 1.0.1.
  • If your visual application is deployed to a Visual Builder instance in a different identity domain (say, a production instance) or the instance was added to an environment through credentials, you'll need to add and configure steps in a build job to roll back the application's current live version to its previous deployed version:
    1. In the VB Studio left navigator, click Builds Builds.
    2. Click + Create Job. Give the job a new name and a description, select the build executor template, then click Create.
    3. On the Job Configuration page, click Steps.
    4. Click Add Step, select Visual Application, then select Rollback.

    5. In Instance, select the Visual Builder instance where the application was deployed to.
    6. In the Authorization section, Use OAuth is selected by default. You can also select Use Basic, but OAuth is the recommended authorization method. You should use Basic authentication only if you run into issues with setting up an OAuth connection.
      • With Use OAuth selected, the Authorization is required message indicates that this build step needs to be authorized, which you can do either by clicking Authorize or by running the build manually and entering the credentials when prompted. After authorization, the Authorization has been provided message shows.
      • With Use Basic selected, enter your Visual Builder instance credentials in Username and Password.
    7. In Application URL Root and Application Version, enter the visual application's root URL and its version. You can find this information from the Deployments tab of the environment where the visual application is deployed.

      Note:

      The version you specify to roll back must be the latest version of the application. If the version isn't the latest, you'll see an HTTPS status 400 error when you run the rollback job. So, if the latest version of the application is version 1.0.2, that is the version you specify to roll back, not version 1.0.1 or any other earlier version.
    8. Click Save.
    9. To run the build job, click Build Now.

    After you create and configure the build step, you may want to add it, in some combination, to the pipeline you created for the packaging and deployment steps for that production instance. By integrating these build steps in your deployment process, you'll ensure a more robust and error-free process when upgrades are done through deployment.