How to Add Docentric AX Models to TFS/Azure DevOps

Azure DevOps is a new name for TFS Online. In this manual we use the term TFS.

Learn which Docentric AX models are available and which models to install >>

Docentric AX SSRS Replicas and optional models Docentric AX Warehouse Labels and Docentric AX CBD Replicas are not covered by this manual but the approach of adding their artifacts to TFS is the same as for the typical models such as Docentric AX Extension and Docentric AX Emails; the Docentric AX model is specific because of the additional DLL files.

Clean installation: Add regular model artifacts to TFS

After you import these models using the script or the ModelUtil command line tool (see How to Install Docentric AX via Models) and then open Windows Explorer, you will notice in <ServiceNode>:\AOSService\PackagesLocalDirectory three new folders. These folders represent so called AX packages and in case of the Docentric AX product each of them contains exactly one model:

All artifacts from the marked folders on the image below should be added to TFS version control.

In each of the Descriptor folders you will find the single model descriptor file, whereas DocentricAX\Docentric AX, DocentricAXExtension\Docentric AX Extension, DocentricAXEmails\Docentric AX Emails contain all model’s source files. They are XML files and contain definitions of Docentric classes, forms, tables, etc. as well as extensions of the built-in D365FO artifacts. These artifacts should all be added to TFS version control.

 

The Docentric AX model ships with additional libraries (DLLs) installed in the DocentricAX\bin folder (Docentric.AX.dll and Docentric.AX.Services.Contracts.dll), which contain the document rendering engine and helper C# libraries. These DLL files will appear in the DocentricAX\bin folder after the Docentric AX model is installed and should also be added to TFS as described below.

Starting from Docentric AX v3.6.0, Docentric AX runs its third-party libraries in isolated application domains, so the model contains two DLLs, Docentric.AX.dll and Docentric.AX.Services.Contracts.dll. The second DLL holds the interfaces and data types that Docentric AX shares with the isolated application domains.
Before Docentric AX v3.6.0, there was only the single Docentric.AX.dll.

Clean installation: Add Docentric DLLs to TFS

Starting from version 3.6.0, the DocentricAX\bin folder contains two Docentric DLL files (Docentric.AX.dll and Docentric.AX.Services.Contracts.dll). Both DLLs should be added to TFS.

From the DocentricAX\bin folder, add to TFS only Docentric.AX.dll and Docentric.AX.Services.Contracts.dll. All other files, which will be created in this folder after the first build, including Dynamics.AX.DocentricAX.dll, are build artifacts and SHOULD NOT be added to TFS.

Upgrade installation: Commit changes to TFS

After you replace (upgrade) the Docentric AX models with scripts or manually, the model folders and descriptor files will be automatically updated. New files will be added and old ones removed, while the Docentric DLL files in the bin folder of the DocentricAX package will be updated.

When you check-in the upgraded version to TFS, there should be exactly the same files in repository as if you would install and check-in the new version on a clean environment. TFS does not automatically detect and include all upgrade changes for check-in. It requires some manual steps that can be error prone.

If you would like to check-in all the changes of the upgraded Docentric AX models, make sure that all these changes are listed in Team Explorer\Included Changes, before checking-in them to TFS. Updates are included automatically, while deleted files have to be manually promoted from Team Explorer\Excluded Changes > Detected. New files have to be added manually as well (Add Items to Folder).

After building Docentric AX models

After building Docentric AX core models, the bin folder will be created for the DocentricAXExtension and DocentricAXEmails packages, whereas the bin folder of the DocentricAX package is created immediately after the import of the Docentric AX model, and it contains the Docentric DLLs (Docentric.AX.dll and Docentric.AX.Services.Contracts.dll).

After the build, all bin folders will be filled with Microsoft DLLs and other files (build artifacts), so bear in mind that only the Docentric DLLs (Docentric.AX.dll and Docentric.AX.Services.Contracts.dll) should be put under TFS version control.

If you put any other files from the bin folder of the DocentricAX package under TFS, you will see the changed objects in Pending changes after each build.

See also

How to Unlock the Product >>
How to Install Docentric AX Designer >>
How to Set Up Docentric AX >>

IN THIS ARTICLE