Loading ...

Step-by-Step Guide: Using PatchTool in Acumatica ERP 25R1

29 August 2025

This guide walks you step by step through installing Acumatica ERP on disk C, checking for patches, applying a patch from a local archive, and rolling back a patch using the PatchTool command-line utility.

In this example, we will install Acumatica on the drive D: and all subsequent instructions will refer to paths based on this installation. However, you can install Acumatica on the C: or any other location—the exact path does not affect the procedure.

Step 1. Install Acumatica ERP

  1. Download the Acumatica ERP installer.

  2. Install the instance to:

D:\Work\AcumaticaInstances\25r1\25.101.0153\AcuSales25r1

  1. After installation, confirm that the instance is accessible in a browser.

All commands later will assume this path for the instance folder.

Step 2. Schedule System Lockout

Before applying a patch, the instance will restart. To avoid data loss:

  1. Sign in to Acumatica ERP.

  2. Open Apply Updates (SM203510).

  3. Click Schedule Lockout on the toolbar.

  4. Set:

    • Date and Time of lockout (current date/time for immediate lockout)

    • Reason

  5. Optional: clear Lock Out All Sites if you want to lock only this instance.

  6. Click OK.

Step 3. PatchTool General Information

PatchTool.exe is a command-line utility used to check for, apply, and roll back patches for your Acumatica ERP instance.

  • Default location:

%Program Files%\Acumatica ERP\Data\

 

  • In our example: the tool is located at

D:\Work\AcumaticaInstances\25r1\Demo\Data

Step 4. Open Command Prompt and Navigate to PatchTool

  1. Press Start → CMD → Right-click → Run as Administrator.

  2. Navigate to the PatchTool folder:

D:\Work\AcumaticaInstances\25r1\Demo\Data

Step 5. Check for Patches

To see if any patches are available from the Acumatica website you need to specify the path to your instance, as demonstrated in our example.

 

Note: This step requires internet access.

Step 6. Apply a Patch from Local Archive

Please note: the path to your Acumatica instance must not contain special characters such as period (.), comma (,), hyphen (-), equal sign (=), or similar and must not end with a forward slash (/). Failure to comply may lead to errors.

Option 1. Downloading a Patch from the Internet via PatchTool

If your computer has internet access, PatchTool can automatically download available patches. The command for this is:

Here, PatchTool checks the Acumatica website and, if a patch is found, downloads and applies it.

  • A backup is created automatically.

  • The Acumatica instance restarts.

Option 2. Local Patch (Without Internet)

If the server does not have internet access or you have already downloaded the patch:

  1. Contact Acumatica Support to obtain the patch as a .zip file (for example, patch2025p4.zip).

  2. Copy the file to the folder on the server where PatchTool is installed, for example:

During the patch process:

  • PatchTool creates a backup at:

D:\Work\AcumaticaInstances\25r1\25.101.0153\AcuSales25r1

  • Files in the instance folder are replaced with the new ones from the patch.

  • The Acumatica instance restarts automatically.

Step 7. Roll Back a Patch

If needed, you can roll back to the previous state:

 

Step 8. Summary of PatchTool Commands

Action

            CMD Command Example

Check for patch (internet)

PatchTool.exe check --path                      "D:\Work\AcumaticaInstances\25r1\Demo\AcuSales25r1"

Apply patch (local)

PatchTool.exe patch --path "D:\Work\AcumaticaInstances\25r1\Demo\AcuSales25r1" 

Roll back patch

PatchTool.exe rollback --path "D:\Work\AcumaticaInstances\25r1\Demo\AcuSales25r1"

Now you can:

  1. Lock out the system before applying updates.

  2. Check for available patches online.

  3. Download or apply a downloaded patch from a local archive.

  4. Roll back a patch if needed.

All steps are sequential and can be reproduced exactly following this guide.