How to Upgrade Docentric AX Framework

The goal of this tutorial is to guide you through the installation of an updated version of Docentric AX Framework.

The latest version or a hotfix you can find in Docentric Download Center.
Before installation check the version of Docentric AX Framework you have currently installed. This is the same version as the version of the installed DocentricAX model (in case that you installed Docentric AX Framework via model).

You can upgrade Docentric AX Framework in two ways:

(I) By reimporting the DocentricAX model that is bound to the ISV, VAR or CUS layer.
You will choose this option if you initially have installed Docentric AX Framework via model.

Do not delete the DocentricAX model, and then reimport it. Instead, import the model over the existing model. Before you import the model, it is recommended to back up the databases of your system.

1. Import the DocentricAX model from the downloaded package. The model is located here: "\DocentricAX\DocentricAX_NewArtifacts_AX2012_R2_R3_Models\DocentricAX_<layer>.axmodel".

Command in MS Dynamics AX 2012 Management Shell for importing the model:

If you use, e.g. DocentricAX_VAR.axmodel, and if the Docentric AX artifacts from the model, specifically the VS projects, were compiled in the same layer (i.e. VAR layer) with the current model other than the DocentricAX model, you will get a conflict when you try to reimport the model. To resolve the conflict open the Docentric_NewArtifacts shared project and move two VS projects to the DocentricAX model (see the pictures below). Close AX client and reimport the model.


2. AOS restart.

3. If it is specified in the new version release (and usually, this is NOT the case), import the Docentric_ChangedArtifacts project from the SharedProject_Docentric_ChangedArtifacts_AX2012_Rx_CUx.xpo file from the downloaded package. See how >>

4. Check labels.
New labels are being automatically imported as a part of the model. Still, if you are using a different language than EN-US, e.g. NL (the Dutch language), you will have to rename the label file (AxDOCen-us.ald) from the downloaded package to AxDOCnl.ald and import it afterwards. This way the language of your enviroment will be simulated, and you can translate the labels later. Labels which are not translated to your language (e.g. Dutch) will appear in the English language. Instructions on how to do it you can find here.

If you already translated Docentric labels to your language (e.g. NL), you will need to update the label file (e.g. AxDOCnl.ald) used for your language manually. In the version release notes (a txt file located in the downloaded package) you will find the information which labels are added for the new Docentric AX version, so you can append (copy) these labels and their translation in the English language from the AxDOCen-us.ald file to the label file for your language that you already use (e.g. AxDOCnl.ald). Afterwards you can start with translation of these new labels to your language.

5. Synchronize tables.
Open the Docentric_NewArtifacts (shared) project. Synchronize all tables from this project.

6. Full compile. Full CIL. AOS restart.

(II) By reimporting the Docentric AX Framework artifacts via XPO files.
You will choose this option if you initially have installed Docentric AX Framework via XPO files.

Before you upgrade Docentric AX Framework, back up the databases of your system.

Open the AX client in the layer which is appropriate for your scenario and follow the installation instruction from here.
Usually only the Docentric_NewArtifacts project and labels should be reimported.
In the end of the procedure perform the full compile, full CIL, synchronize tables from the Docentric_NewArtifacts project and restart the AOS service.

See also

How to Upgrade Docentric AX Template Designer >>
How to Upgrade Docentric Server >>