How to Upgrade Docentric AX Models

To upgrade the product to a newer version, you will use the same Docentric AX models as for installation and which you can download from Docentric Download Center.

Download Docentric AX models >>
Read the complete Docentric AX change log >>

Upgrade Strategy

Upgrade Docentric AX when using TFS (Azure DevOps)

Upgrade Docentric AX models with scripts

To upgrade Docentric AX models you can use the scripts from the downloaded ZIP packages:

• DocentricAXInstallCoreModels.cmd, DocentricAXInstallSSRSReplicasModel.cmd and DocentricAXInstallCBDReplicasModel.cmd to replace the models,
• DocentricAXBuildAndSyncTool.cmd to build the models and synchronize the database.

Alternatively, you can follow the instructions below to complete the upgrade procedure step-by-step.

Upgrade Docentric AX models manually

Run Command Prompt as Administrator and navigate to the Bin directory of your Packages folder, typically C:\Packages\Bin or C:\AosService\PackagesLocalDirectory\Bin.

Execute the ModelUtil.exe command for replacement of Docentric AX models:

Example:

If you have Visual Studio open while replacing the models, you need to refresh them before you start the build:

Upgrade Docentric AX models on UDE environment

Before upgrading the Docentric AX installation, we should first check what Docentric AX models are installed on the UDE environment, to see which models we need to upgrade:
 

In this example we can see that the Docentric AX core models are installed (Docentric AX, Docentric AX Extension, Docentric AX Emails), as well as the optional models Docentric AX SSRS Replicas, Docentric AX CBD Replicas, and Docentric AX Warehouse Labels.

To upgrade Docentric AX models on a UDE environment, we first need to connect to the environment through Visual Studio:

1. Click on Tools > Connect to Dataverse:
   
2. Only check the Display list of available organizations checkbox and click Login:
   
3. Choose the environment you want to connect to:
   
4. Choose your solution, you can leave this on Default:
   
5. It takes a while for Visual Studio to connect to the environment, so wait until the Power Platform Explorer pops up and Visual Studio is in the Ready status (in the bottom left corner):
   

Next we need to find and delete the old Docentric AX models that are installed:

1. Click on Dynamics 365 > Configure Metadata (note that the Dynamics 365 menu item can also be hidden inside the Extensions menu item):
   
2. Here we can see the that the C:\CustomModels folder is set as the custom metadata directory:
   
3. Select the Docentric AX model folders that you want to upgrade and delete them from the disk:
   

Now we can install the the new version of the Docentric AX models that we want to upgrade:

1. Extract the downloaded Docentric AX .zip files into the same folder, in this example we will use the C:\temp directory:
    
2. Open up the Configure Metadata form and find where the local PackagesLocalDirectory folder is located:
   
3. Use the standard ModelUtil.exe tool (located in the PackagesLocalDirectory/bin directory, that we've found in the previous step) to install the new Docentric AX models that you want to upgrade:
   
   Example commands for different models:
   
   # Core models C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\DocentricAX\Docentric AX.axmodel" C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\DocentricAX\Docentric AX Extension.axmodel" C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\DocentricAX\Docentric AX Emails.axmodel" # Warehouse Labels model C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\DocentricAX\Docentric AX Warehouse Labels.axmodel" # SSRS Replicas model C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\Model - Docentric AX SSRS Replicas\Docentric AX SSRS Replicas.axmodel" # CBD Replicas model C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\Model - Docentric AX CBD Replicas\Docentric AX CBD Replicas.axmodel"

   1 2 3 4 5 6 7 8 9 10 11 12 13

   # Core models C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\DocentricAX\Docentric AX.axmodel" C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\DocentricAX\Docentric AX Extension.axmodel" C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\DocentricAX\Docentric AX Emails.axmodel" # Warehouse Labels model C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\DocentricAX\Docentric AX Warehouse Labels.axmodel" # SSRS Replicas model C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\Model - Docentric AX SSRS Replicas\Docentric AX SSRS Replicas.axmodel" # CBD Replicas model C:\Users\Admin\AppData\Local\Microsoft\Dynamics365\10.0.2345.190\PackagesLocalDirectory\bin\ModelUtil.exe -import -metadatastorepath="C:\CustomModels" -file="C:\temp\Model - Docentric AX CBD Replicas\Docentric AX CBD Replicas.axmodel"

Lastly we need to build the Docentric AX models, deploy the Docentric AX models to the UDE environment and synchronize the database:

1. Refresh the list of installed models by clicking on Dynamics 365 > Model Management > Refresh Models:
   
2. Click on Dynamics 365 > Build Models:
   
3. Select all the Docentric AX models and click on Build (make sure that you have the Build Labels parameter checked, otherwise the labels won't work):
   
   
4. Click on Dynamics 365 > Deploy > Deploy Models to Online Environment:
   
5. Check the Deploy and DBSync options for all the Docentric AX models and click on Deploy:
   

Once the deployment is complete, we can check the Docentric AX model versions on the UDE environment to make sure that the upgrade has been successful:

Troubleshooting

 

After that, retry to replace the Docentric AX models, by using the ModelUtil.exe tool as described above.

See also

Troubleshooting the Upgrade to 3.4.8 or Above >>
How to Commit Changes to TFS/DevOps After Upgrading Docentric AX Models >>
How to Install Docentric AX via Models >>
How to Set Up Docentric AX >>