MYOB Acumatica PatchTool: To Apply Patches

The following activity will walk you through the process of applying patches to an MYOB Acumatica application instance by using the PatchTool command-line utility.

Story

Suppose that you are the system administrator of the SweetLife Fruits & Jams company, and you need to apply patches to an MYOB Acumatica application instance.

Process Overview

In this activity, you will use PatchTool to check for available patches for your MYOB Acumatica instance. If new patches are found, PatchTool automatically downloads them and applies them to your instance.

System Preparation

Before you begin performing the step of this activity, you should do the following:

  1. Make sure that you’ve completed the Instance Deployment: To Deploy an Out-of-the-Box Instance prerequisite activity.
  2. Make sure that PatchTool has been installed on your computer.
  3. Either lock out the system (see Upgrading of MYOB Acumatica: To Schedule the System Lockout) or make sure that all users know about the restart so that they can save their work. This is necessary because applying or rolling back a patch replaces the files in the instance and restarts its website.

Step: Applying the Patch

To apply a patch to an MYOB Acumatica instance, do the following:

  1. On the Start menu, run a command-line utility installed on your computer as an administrator.
    Tip: You can use Command Prompt, the built-in command-line utility for Microsoft Windows.
  2. At the command prompt, enter a command to navigate to the folder where PatchTool is installed and PatchTool.exe is stored. 
    cd C:\Program Files\MYOB Acumatica\Data\
  3. At the command prompt, enter PatchTool.exe patch --path "path to the instance folder" to start the execution of the configuration file and the deployment of the instance. [path to the instance folder] is the path to the MYOB Acumatica application instance folder, which is specified in the following format.
    PatchTool.exe patch --path "C:\Program Files\MYOB Acumatica\AcumaticaS100"

PatchTool checks the MYOB website to see if any patches are available for the specified MYOB Acumatica instance:

  • When no patches are available, PatchTool returns No patches are available for download.
  • When a patch is available, PatchTool:
    • Creates the backup archive file in the instance's default backup folder:
      C:\Program Files\MYOB Acumatica\BackUp\Sites\AcumaticaS100\
    • Downloads the patch and replaces the files in the MYOB Acumatica application instance folder.
    • Restarts the instance.
    • Returns The patch with the <VERSION> P<X> version has been applied, where VERSION is a version number of the MYOB Acumatica application instance and X is the patch number.