Edit

Create a Modern POS extension package

  • Article

Important

Support for the Retail SDK will end in October 2023. Please use or migrate to the Commerce SDK, which provides several benefits including a simplified development and update experience, and improved performance.

To create the extension installer for a Modern POS extension, follow these steps.

  1. In Microsoft Visual Studio 2017, create a new console application (.NET Core), and name it ModernPos.Installer.

  2. Edit the .proj file, and change the target framework to the .NET Framework version 4.6.1, as shown in the following XML.

    <Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <OutputType>Exe</OutputType>
        <TargetFramework>net461</TargetFramework>
    </PropertyGroup>
</Project>

  3. Delete the Program.cs file that was generated.

  4. Add a reference to the Microsoft.Dynamics.Commerce.Sdk.Installers.ModernPos NuGet Package:

    1. In Solution Explorer, select and hold (or right-click) the project, and then select Manage NuGet packages.
    2. In the NuGet Package Manager window, on the Browse tab, search for Microsoft.Dynamics.Commerce.Sdk.Installers.ModernPos.
    3. Select the package, and then select Install.
    4. Select the version that matches your go-live version.

  5. Add a reference to the Modern POS project that you created earlier:

    1. In Solution Explorer, select and hold (or right-click) the project, and then select Add > Reference.
    2. In Reference Manager, on the Projects tab on the left, select the Modern POS project that you created earlier.
    3. After the project is added as reference, edit the csproj file and add <ReferenceOutputAssembly>false</ReferenceOutputAssembly> for the reference added.

  6. For offline channel database extension script projects only: Add a reference from the Modern POS project to the channel database project:

    1. In Solution Explorer, select and hold (or right-click) the Modern POS project, and then select Add > Reference.
    2. In Reference Manager, on the Projects tab on the left, select the channel database extension project that you created earlier.

  7. Compile and build the project. The output of this project contains the Modern POS extension installer.

  8. To manually install the extension, open Windows PowerShell in administrator mode, go to the extension installer folder, and run the install command.

    PS C:\ModernPos.Installer\bin\Debug\net461> .\ModernPos.Installer.exe install

    To uninstall the extension, run the uninstall command.

    PS C:\ModernPos.Installer\bin\Debug\net461> .\ModernPos.Installer.exe uninstall

    Note

    Before you install the extension installer, install the sealed Modern POS.

  9. After you've finished installing the extension, close Modern POS if it's running. Then, to load the extension, open Modern POS by using the Install/Update Modern POS icon on the desktop. The extension's .appx file will be installed. The previous steps copy the .appx file and other files to the correct location.