Restore bots from Git repository

You can restore all your bots and their dependent files from the Git repository to your server repository. This restore option is available only for On-Premises deployments and not supported on Cloud deployments.

Prerequisites

Ensure the following before you restore your bots from Git:

  • You must have a backup of the bots on Git.
  • You must have the AAE_Admin role assigned.

Keep the following considerations in mind while restoring bots from a Git repository:

  • You can restore either all or differential bots and files from the external Git repository. You cannot selectively restore specific bots or files from the external Git repository.
  • The Git restore process requires some downtime. When the restore process is running, the following public workspace operations are disabled:
    • Check-out
    • Clone
    • Run and schedule bots
    • Run bots with queue
    • Import and export bots
  • When the restore process is running, the check-in operation is not allowed from the private workspace. However, you can use the private workspace for the rest of the operations.
  • You can restore your bots to your empty or non-empty repository.
  • You cannot abort (cancel) an ongoing restore process.
The Git restore functionality is important in the following scenarios:
  • The server repository is corrupted and you are starting with a new server repository.
  • You want to restore bots to a different Git branch.

    For example, consider there are two branches of Git: Dev and Test integrated with Dev and Test Control Room. The Test branch can pull the contents from the Dev branch and you can restore bots from Git in the Test Control Room.

Procedure

  1. Log in to the Control Room as an admin user.
  2. On the left pane, click Automation.
    A list of available bots and forms is displayed.
  3. Click the Restore from Git option in the Public workspace.
    The Restore from Git dialog box appears, displaying a warning that all the public repository operations will be disabled during the Git restore process.
  4. If you have duplicate files in the Git repository, select to either Overwrite existing files or Skip existing files in the Git repository.
  5. Based on whether the repository is empty or non-empty, choose one of the following options:
    • To restore files to a repository that is not fully empty, enter your Git credentials for the associated repository.
      Note: You cannot use the existing Git configuration for a partially filled repository.
    • To restore files to a fully empty repository, you can choose the Git repository from which you want to restore your files.
    OptionAction
    Use existing git configuration settings Select this option to restore your data from the Git repository configured with the Control Room.
    Note: Ensure you connect your Control Room to the remote Git repository from Administration > Settings > Remote Git repository integration.
    Use manual settings Select this option to restore data from any other repository.
    1. Enter the HTTPS repository path including the username in the following format:

      https://<username>@bitbucket.org/companyname/product.git

    2. Enter the branch name.
    3. Enter your Git repository password or a generated Git token.
    4. Re-enter the password or Git token to confirm.
    Note: If you are using the same settings as the existing Git configuration, you will encounter an error. To use the same configuration, first remove the remote Git repository integration setting in Administration > Settings > Remote Git repository integration before providing the same in this manual settings option.
  6. Optional: Select the Connect to Git via proxy check box.
    1. Enter the proxy host name or IP address.
    2. Enter the port number.
    3. Optional: Select the authentication check box and enter the user name and password.
  7. Click Continue to proceed with the restore process.
    The system starts restoring the bots and the dependent files from Git. This process takes some time.
    After the restore process is completed successfully, you are automatically returned to the Automation page. The bots and the dependent files are restored in your new server repository, maintaining the original structure of the dependent files.

If the Git restore process fails after restoring some bots, you are redirected to the public workspace with the following options. Choose the required option to complete the restore process:

Option Action
Revert restoration bots This option clears all the bots that were restored.
Note: This option will delete the public bots that were restored from the Git repository.
Restart restoration The Git restore process restarts from where it ended.
Keep only the restored files This option retains whatever files were restored and will exit the restore process.