How to install a Microsoft Dynamics AX hotfix

Microsoft releases hotfixes for Microsoft Dynamics AX in the following formats:

• Hotfixes are released as a compressed (.zip) file. The files that the .zip file contains replace existing files on the computer.
• Hotfixes are released as an .xpo file that contains code. The code is applied to existing objects, to database tables, or to both.
• Hotfixes for Microsoft Dynamics AX 4.0 are released as a DIS-layer file (AxDIS.aod).
• Hotfixes are released as a Microsoft Windows Installer update. These hotfixes contain a Setup.exe file.

General guidelines for hotfixes that replace files

Some Microsoft Dynamics AX hotfixes replace files on the computer. For instructions about how to install a hotfix that replaces files, carefully read the documentation that accompanies the hotfix download. The following are general recommendations for installing hotfixes that replace files:

• Before you copy the files that are included in the hotfix to your computer, use your ordinary backup processes to back up the server files that are affected by the hotfix.
• Test all hotfixes in a test environment to verify that your customizations are not adversely affected.
• Have all users log off the Microsoft Dynamics AX client application. Stop the Application Object Server (AOS) instance before you rename and then copy the hotfix files.
• When label files are included in the hotfix, copy all the included label files to the Microsoft Dynamics AX application folder. The label files will have the following file name extensions:
  • .ali
  • .acd
  • .alc
  By default, the application folder has the following path:
  root directory\Axapta Application\appl\Standard
  Note In the path, the root directory placeholder represents the hard disk drive and the main directory in which Microsoft Dynamics AX is installed.

Customized environments

If you customized your environment before you installed a hotfix, thoroughly review the Microsoft Knowledge Base article that documents the hotfix that you want to install. Any objects that are affected by the hotfix will be overwritten. This may cause customizations in those objects to be lost.

Database backups

If database tables are affected, create a full database backup before you apply the hotfix. For instructions about how to back up a database, see the Microsoft SQL Server documentation. Or, see the Oracle Database Server documentation.

Installation information

Hotfixes that are released as an .xpo file that contains code

Hotfixes that are released as an .xpo file contain code-level fixes that directly affect objects or database tables in Microsoft Dynamics AX.

Important Before you continue, examine each .xpo file for the objects or for the tables that will be changed. Note any customizations to your current environment that may be affected. We highly recommend that you apply all hotfixes in a test environment before you apply the hotfixes to your live system.

1. Log on to Microsoft Dynamics AX by using the Microsoft Dynamics AX Administrator account. Make sure that no other users are logged on to Microsoft Dynamics AX.
2. Open the Application Object Tree dialog box. To do this, use one of the following methods:
   • On the Standard toolbar, click Application Object Tree.
   • On the keyboard, press CTRL+D.
   • On the File menu, point to Open, and then click Application Object Tree.
3. In the Application Object Tree dialog box, click Import on the toolbar.
4. Click Browse, and then locate the .xpo file.
5. In the Open dialog box, click the .xpo file, and then click Open.
6. Click OK to complete the import process.
   
   Note You may have to complete a forward compile or a full Application Object Tree (AOT) compile process.

Hotfixes that are released as a DIS-layer file for Microsoft Dynamics AX 4.0 and for later versions

To install hotfixes that are released as a DIS-layer file, follow these steps:

1. Extract the files from the hotfix package.
2. Before you copy the files that are included in the hotfix to your computer, use your ordinary backup processes to back up the application folder and the server files that are affected by the hotfix.
3. Test the hotfix in a test environment. Then, schedule downtime when no other users are on the system.
4. Exit all the Microsoft Dynamics AX software clients. Then, shut down the Application Object Server instances that are connected to the production program file share.
5. Copy the AxDIS.aod file and the AxDISen-us.ald file into each application folder where the other .aod files exist. By default, this folder is in the following location:
   \application\appl\standard
   Note In this step, always use the copy function. Do not use the move function. When you move a file, the permissions of the source folder will be taken for this file. When you copy a file, it will take the permissions of the target folder.
6. Make a backup copy of the Axapd.aoi file by renaming the file. Or, delete the Axapd.aoi file in each application folder.
7. Restart the AOS instance. Review the Application log on the server that is running the AOS instance to make sure that the AOS instance is starting correctly. The AOS instance rebuilds the application object index. The Axapd.aoi file contains the application object index.
   
   Note Depending on the server hardware that you are using, the startup of the AOS instance may time out before the process is complete. This issue occurs because the process has insufficient time to rebuild the Axapd.aoi file.
   
   The AOS instance will remain in a starting status until the .aoi file is rebuilt. At that time, the AOS instance will have a "started" status. No additional steps are required. Wait, and then review the Application log for an indication that the AOS instance started.
8. Use the AOS instance to log on to a client computer by using the Microsoft Dynamics AX 4.0 Administrator account. Next, connect to this AOS instance by using the client software to verify that you can successfully connect. Finally, verify that the changes were detected by Microsoft Dynamics AX and that they are visible in the AOT.
9. If an upgrade checklist appears, complete the checklist to make sure that there will be no additional issues. If no upgrade checklist appears, the DIS layer is not recognized. If the DIS layer is not recognized, use one or more of the following methods:
   • Create a new application folder. Then, copy all the files from the existing application folder to the new application folder.
   • Change the AOS instance configuration to use the new application folder. To do this, follow these steps:
     1. Click Start, click Run, type Control Admintools, and then click OK.
     2. Double-click Microsoft Dynamics AX Configuration Utility.
     3. On the Application Object Server tab, select the new application folder that you created in the application instance list.
     4. Apply the configuration, and then restart the AOS instance.
     5. Repeat step 8.
10. After the checklist is completed, recompile the whole application.
11. If you are using multiple application folders and multiple AOS instances, stop all AOS instances, and then start all AOS instances.

Hotfixes that are released for Microsoft Dynamics AX 2009

To install hotfixes that are released as an application update for Microsoft Dynamics AX 2009, follow these steps:

1. Extract the files from the package.
2. Open the kbxxxxxx.txt file in the hotfix package to identify which objects will be patched when the hotfix is installed.
3. Exit all Microsoft Dynamics AX 2009 clients, and stop the AOS instance.
4. Back up the database.
5. Back up the application folder.
6. Restart the AOS instance, and then review the Application log on the server that is running the AOS service to make sure that the AOS instance is starting correctly. The AOS instance rebuilds the application object index. The Axapd.aoi file contains the application object index.
   
   Note Depending on the server hardware that you are using, the startup of the AOS instance may time out before the process is complete. This issue occurs because the process has insufficient time to rebuild the Axapd.aoi file before the AOS tries to use the file.
   
   The AOS instance remains in a starting status until the *.aoi file rebuild is complete. At that time, the AOS instance has a "started" status. No additional steps are required. Wait, and then review the Application log for an indication that the AOS instance starts.
7. Run the Axpatch.exe file for the application hotfix installation.
   1. Select the language in which to run the installation, and then click OK.
   2. When the installer wizard starts, click Next.
   3. Review the Microsoft Software License Terms, click to select the check box to accept the license terms if you agree, and then click Next.
   4. On the Select components page, the Application files option should be selected by default. Click Next.
   5. On the Select configuration page, indicate the correct configuration, and then click Next.
   6. On the Ready to apply hotfix page, click Install.
   7. When setup is complete, click Finish to exit the wizard.
8. From a client, verify that you can connect to the AOS instance as the Microsoft Dynamics AX administrator.
9. Validate the installation of the hotfix by opening the SysHotfixManifest class in the AOT and by checking that there is a method with a name that is the same as the article number of the installed hotfix.
10. Use the code upgrade tool (“Code comparison”) to compare the SYP or GLP change with any VAR or CUS layers. If customizations are present, partners’ or customers’ IT staff may be required to merge the hotfix into the customized system.

Hotfixes that are released as a Windows Installer update

Important The following actions must be performed:

• The ObjectServer kernel file must be installed on each AOS server.
• The Client kernel file must be installed on each client computer.
• The NetBusinessConnector kernel file and the ComBusinessConnector kernel file must be installed on every computer that is running the Microsoft Dynamics AX .NET Business Connector and the Microsoft Dynamics AX Com Business Connector.
• The ApplicationIntegrationServer kernel file is the BizTalk Adapter. Make sure that you install the ApplicationIntegrationServer kernel file together with the NetBusinessConnector kernel file when you update the BizTalk Adapter.

A Windows Installer update updates the following Microsoft Dynamics AX 4.0 client binary files:

• The .exe file
• The .dll files

These files are also known as the kernel files. To apply the Windows Installer update, follow these steps:

1. Extract the files from the hotfix. The extracted files may contain the following folders:
   • ApplicationIntegrationServer
   • Client
   • ComBusinessConnector
   • NETBusinessConnector
   • ObjectServer
2. Test the hotfix in a test environment. Then, schedule downtime.
3. Exit all the Microsoft Dynamics AX software clients. Then, shut down the AOS instances that are connected to the production program file share.
4. Back up the database, and then back up the application folder.
5. Run the Setup.exe file that is included in each folder in the hotfix.
6. Restart the AOS instance. Review the application event log on the server that is running the AOS service to make sure that the AOS instance is starting correctly. The AOS instance rebuilds the application object index. The Axapd.aoi file contains the application object index.
   
   Note Depending on the server hardware that you are using, the startup of the AOS instance may time out before the process is complete. This issue occurs because the process has insufficient time to rebuild the Axapd.aoi file.
7. Use the AOS instance to log on to a client by using the Microsoft Dynamics AX 4.0 Administrator account. Verify that you can successfully connect.

For more information, obtain the Microsoft Dynamics AX 2009 Patching white paper. To do this, visit the following websites:

PartnerSource
https://mbs.microsoft.com/partnersource/deployment/documentation/whitepapers/ax2009patching.htm?printpage=false

CustomerSource
https://mbs.microsoft.com/customersource/support/documentation/whitepapers/ax2009patching.htm?printpage=false