This page lists the steps that you must follow to run the Rehearsal tool(dxrt) on your Windows system:

Procedure

  1. Navigate to the Delphix Downloads page in the browser.

  2. Log in using your username and password credentials.

  3. Navigate to the Delphix Product Release > Application Solutions > Salesforce > Delphix Rehearsal Tool.

  4. Currently, the Rehearsal tool(dxrt) is supported on the Mac, Red Hat, and Windows platforms. You can access the dxrt binaries for all the supported systems. Click on the Windows version dxrt-win10-vx.x.x.zip. This will direct you to the Delphix Product License and Services Agreement page.

  5. Accept the license agreement to start the download.

  6. After the download is complete, go to the Downloads directory, right-click on the downloaded file, and then click Extract All to extract the compressed (zipped) files.

  7. After the extraction is complete, open the Windows Powershell prompt.

  8. In the prompt, navigate to the directory where the files extracted in step 6 are present. You can use the cd {directory} command to move from one directory to another. For example, If your files have been extracted at C:\Users\Administrator\Downloads location, then you can use cd C:\Users\Administrator\Downloads command to move to the required directory.

  9. After navigating to the specified directory, you will find the dxrt-win10-vx.x.x directory. Enter this directory to proceed.

  10. Inside the dxrt-win10-vx.x.x directory, you will find the files dxrt.exe and README.md.

  11. Create the directory {Partition}:\var\delphix\sfdc\dxrt on the local disk corresponding to the partition where DxRT is being run. For instance, if you are running DxRT from any directory on partition C, the \var\delphix\sfdc\dxrt directory should be created within local disk C. Similarly, if you are running from partition D, the directory structure should be established on local disk D. You can create this directory using a graphical user interface (GUI).

  12. You can now execute the dxrt binary. There are two authentication modes for the dxrt binary: USERPASS and OAUTH. Each mode requires specific inputs, which are outlined in the next step.

  13. The dxrt binary accepts all passwords and tokens through either interactive input or via environment variables. Below are the inputs required for the authentication modes mentioned above:

    1. USERPASS:- Password & Security Token

    2. OAUTH:- Client Secret, Refresh Token & Access Token

  14. To perform a rehearsal operation using the dxrt binary, follow the steps outlined below:

    1. Using Authentication type USERPASS

      1. Using interactive mode ./dxrt.exe salesforce rehearse -u "<username>" -c <components_list> -o <salesforce_objects> -a "USERPASS" -it

      2. Using environment variables: You need to set these environment variables using the steps mentioned here. Once the environment variables are set, you can run the following command. 

        ./dxrt.exe salesforce rehearse -u "<username>" -c <components_list> -o <salesforce_objects> -a "USERPASS" -e "dxrt_password,dxrt_security_token

    2. Using Authentication type OAUTH

      1. Using interactive mode 

        ./dxrt.exe salesforce rehearse -ci "<client id>" -ur "<Salesforce instance's URL>" -c <component_list> -o "salesforce_objects" -a "OAUTH" -it

      2. Using Environment Variables: you need to set these environment variables using the steps mentioned here. 

        ./dxrt.exe salesforce rehearse -ci "<client id>" -ur "<Salesforce instance's URL>" -c <components_list> -o "salesforce_objects" -a "OAUTH"  -e "dxrt_client_secret,dxrt_refresh_token,dxrt_access_token"

  15. To perform a disable operation using the dxrt binary, follow the steps outlined below.

    1. Using the Authentication type OAUTH

      1. Using interactive mode 

        ./dxrt.exe salesforce disable -ci "<client id>" -ur "<Salesforce instance's URL>" -c <component_list> -o "salesforce_objects" -a "OAUTH" -it

      2. Using Environment Variables: you need to set these environment variables using the steps mentioned here. 

        ./dxrt.exe salesforce disable -ci "<client id>" -ur "<Salesforce instance's URL>" -c <components_list> -o "salesforce_objects" -a "OAUTH"  -e "dxrt_client_secret,dxrt_refresh_token,dxrt_access_token"

  16. Below is how we can run the dxrt binary enable operation. When running the enable operation with the dxrt binary, you must pass a retrieveResults zip file obtained during the disable process. From dxrt version 2025.1.1 the zip file is located in the \var\delphix\sfdc\dxrt\{domain_name} directory. For all other versions of dxrt between 1.x.x - 4.x.x, the zip file is located here:\var\delphix\sfdc\dxrt

    Below are the steps to execute the enable operation. For example \var\delphix\sfdc\dxrt\retrieveResults084840.zip.

    1. Using Authentication type USERPASS

      1. Using interactive mode 

        ./dxrt.exe salesforce enable -z "{path to retrieveResults zip file }" -u "<username>" -a "USERPASS" -it

      2. Using environment variables: you need to set these environment variables using the steps mentioned here. Once the environment variables are set, you can run the following command. 

        ./dxrt.exe salesforce enable -z "{path to retrieveResults zip file }" -u "<username>" -a "USERPASS" -e "dxrt_password,dxrt_security_token"

    2. Using Authentication type OAUTH

      1. Using interactive mode 

        ./dxrt.exe salesforce enable -z "{path to retrieveResults zip file}" -ci "<client id>" -ur "<Salesforce instance's URL>" -a "OAUTH" -it

      2. Using Environment Variables: you need to set these environment variables using the steps mentioned here. 

        ./dxrt.exe salesforce enable -z "{path to retrieveResults zip file }" -ci "<client id>" -ur "<Salesforce instance's URL>" -a "OAUTH"  -e "dxrt_client_secret,dxrt_refresh_token,dxrt_access_token"

For more information about the Rehearsal tool(dxrt), refer to this documentation.

Last updated
Oct 9, 2026