Manage third-party models and runtime packages by using source control

Customers that work with solutions from third parties might receive different solution artifacts to use in their solution. Typically, these artifacts are distributed as code (in the form of models) or binaries (in the form of deployable packages). In some cases, third parties might provide some parts of their solution as code and other parts as a binary.

This article outlines a recommended strategy for managing, distributing, and deploying these third-party solutions.

Models from third parties

Any source code that is received from third parties must be compiled into a binary and included in a deployable package. Models should be installed on a development virtual machine (VM) and added to source control. From there, the build VM can pick up the source code, build it, and include it in a deployable package. Other developers can just synchronize the model from Microsoft Azure DevOps to their development VMs. They don't have to manually install it.

For information about how to install a model on a development VM, see Export and import models.

After you install the model, follow these steps to add the new model to source control.

1. In Microsoft Visual Studio, on the Dynamics 365 menu, click Model Management > Refresh Models.

2. Open Application Explorer by clicking View > Application Explorer.

3. Right-click the AOT root node, and then click Model view.

4. In the list of models, find the new model that you installed. Make a note of the name of the package that contains the model. The package name appears in parentheses after the model name. For example, in the following illustration, the Tax Books, Tax Engine Configuration, and Tax Engine Interface models all belong to the package that is named TaxEngine.

   

5. Open Source Control Explorer by clicking View > Other Windows > Source Control Explorer.

6. Navigate to the metadata folder that is mapped on this development VM, such as MyProject/Trunk/Main/Metadata.

7. In the metadata folder, find the folder for the package that contains the new model. Right-click the package folder, and then click Add Items to Folder.

8. In the Add to Source Control dialog box, select the Descriptor folder and the folder that has the name of the model. Some models may also contain referenced DLLs in the bin folder. If these exist you'll need to also include the approriate DLL files from the bin folder. Once all files have been selected, click Next.

9. Review the items that will be added, and then, when you're ready, click Finish.

10. Open the Pending Changes window from the Team Explorer pane or by clicking View > Other Windows > Pending Changes.

11. Review the changes, enter a check-in comment, and then click Check In.

Deployable packages from third parties

Deployable packages from third parties can be manually installed on a development VM, and the installed artifacts can then be added to source control. Then, by synchronizing their local workspace, other developers can receive the runtime package on their VMs without having to install the deployable package. The build process on the build VM will help guarantee that the runtime packages for any extensions or other dependencies are available on the build VM. In Platform update 6 and later, by default, these runtime packages will be included in the final deployable package that is created from the build VM. For more information, see the Deploying third-party code section later in this article.

For information about how to install a deployable package on a development VM, see Install deployable packages from the command line.

After you install the deployable package on a development VM, follow these steps to add the runtime package to source control.

1. Open Source Control Explorer by clicking View > Other Windows > Source Control Explorer.
2. Navigate to the metadata folder that is mapped on this development VM, such as MyProject/Trunk/Main/Metadata.
3. Right-click the Metadata folder, and then click Add Items to Folder.
4. In the Add to Source Control dialog box, double-click the folder that has the package name that you want to add to source control.
5. Select all the folders except XppMetadata and Descriptor, if they exist, and then click Next.
6. On the next page, on the Excluded items tab, select all files by clicking one of the files and then pressing Ctrl+A. At the bottom of the selection window, click Include item(s). When you're ready, click Finish.
7. Open the Pending Changes window from the Team Explorer pane or by clicking View > Other Windows > Pending Changes.
8. Review the changes, enter a check-in comment, and then click Check In.

Including source-controlled third-party packages

After checking in the package binaries into source control as described in the previous section, you include the binaries in deployable packages generated during build automation. There are two options:

• On a build virtual machine, the standard legacy pipeline will automatically find and include the binaries into the deployable package it generates.
• Using the new pipeline or using the new packaging task in the legacy pipeline, review the create deployable packages documentation. The documentation has examples for including source-controlled binaries in deployable packages.

Deploying third-party code

Because the models and runtime packages are in source control, other developers who use other development environments can just synchronize the models and packages to their workspace by using the Get latest feature of source control.

As of Platform update 4, the automated build process will also pick up the runtime packages. Therefore, dependencies in packages that are built will be resolved correctly. This feature is also available for Platform update 3 and Platform update 2 through a hotfix.

In Platform update 6, the build process will include this runtime package in the final deployable package. This allows customers to take the deployable package from the build and have one package to deploy to their environments. The one package includes both custom solutions and all the third party solutions.