Deployment guidelines for cash registers for France

Article
09/29/2023

Warning

You should only implement the steps that are described in this article if you are using Commerce version 10.0.28 or earlier. Starting with version 10.0.29, all required Commerce channel components for France are enabled out of the box. If you are using Commerce version 10.0.28 or earlier and are migrating to Commerce version 10.0.29 or later, you must follow the steps in Migrate to Commerce version 10.0.29 or later.

This article provides guidance about how to enable the cash register functionality for the Microsoft Dynamics 365 Commerce localization for France. The localization consists of several extensions of components. These extensions let you perform actions such as printing custom fields on receipts, registering additional audit events, sales transactions, and payment transactions in Point of Sale (POS), digitally signing sales transactions, and printing X and Z reports in local formats. For more information about the localization for France, see Cash register functionality for France. For more information about how to configure Commerce for France, see Set up Commerce for France.

Note

This version of the Commerce cash register functionality for France is based on the fiscal integration framework. For information about the legacy digital signing sample for France, see Deployment guidelines for cash registers for France (legacy). For guidelines about how to enable the fiscal integration functionality for France in existing environments that use the legacy digital signing sample, see Migrate from legacy Commerce functionality for France.

Development environment

Follow these steps to set up a development environment so that you can test and extend the localization functionality.

Enable Commerce runtime extension components

RegisterAuditEventFrance component

To enable the RegisterAuditEventFrance component, follow these steps.

Find the extension configuration file for the Commerce runtime (CRT):
- Retail Server: The file is named commerceruntime.ext.config and can be found in the bin\ext folder under the Microsoft Internet Information Services (IIS) Retail Server site location.
- Local CRT on Modern POS: The file is named CommerceRuntime.MPOSOffline.Ext.config and can be found under the local CRT client broker location.

<add source="assembly" value="Microsoft.Dynamics.Commerce.Runtime.RegisterAuditEventFrance" />

ReceiptsFrance component

To enable the ReceiptsFrance component, follow these steps.

Find the extension configuration file for CRT:
- Retail Server: The file is named commerceruntime.ext.config and can be found in the bin\ext folder under the IIS Retail Server site location.
- Local CRT on Modern POS: The file is named CommerceRuntime.MPOSOffline.Ext.config and can be found under the local CRT client broker location.
Register the CRT change in the extension configuration file, as shown in the following example.
```
<add source="assembly" value="Microsoft.Dynamics.Commerce.Runtime.ReceiptsFrance" />
```

XZReportsFrance component

To enable the XZReportsFrance component, follow these steps.

Find the extension configuration file for CRT:
- Retail Server: The file is named commerceruntime.ext.config and can be found in the bin\ext folder under the IIS Retail Server site location.
- Local CRT on Modern POS: The file is named CommerceRuntime.MPOSOffline.Ext.config and can be found under the local CRT client broker location.
Register the CRT change in the extension configuration file, as shown in the following example.
```
<add source="assembly" value="Microsoft.Dynamics.Commerce.Runtime.XZReportsFrance" />
```

RestrictingShiftDuration component

To enable the RestrictingShiftDuration component, follow these steps.

Find the extension configuration file for CRT:
- Retail Server: The file is named commerceruntime.ext.config and can be found in the bin\ext folder under the IIS Retail Server site location.
- Local CRT on Modern POS: The file is named CommerceRuntime.MPOSOffline.Ext.config and can be found under the local CRT client broker location.
Register the CRT change in the extension configuration file, as shown in the following example.
```
<add source="assembly" value="Microsoft.Dynamics.Commerce.Runtime.RestrictShiftDuration" />
```

Enable Modern POS extension components

To enable Modern POS extension components, follow these steps.

Open the solution at RetailSdk\POS\ModernPOS.sln, and ensure that it can be compiled without errors. Additionally, confirm that you can run Modern POS from Visual Studio by using the Run command.

Note

Modern POS must not be customized. You must enable User Account Control (UAC) and uninstall previously installed instances of Modern POS as required.
In the extensions.json file, add the following lines to enable the extensions that must be loaded.
```
{
    "extensionPackages": [
        {
            "baseUrl": "Microsoft/Receipts.FR"
        }, 
        {
            "baseUrl": "Microsoft/FifAuditEvent.FR"
        },
        {
            "baseUrl": "Microsoft/RestrictShiftDuration"
        }
    ]
}
```
Note

For more information, and for examples that show how to include source code folders and enable extensions to be loaded, see the instructions in the readme.md file in the Pos.Extensions project.
Rebuild the solution.
Run Modern POS in the debugger, and test the functionality.

Enable Cloud POS extension components

To enable Cloud POS extension components, follow these steps.

Open the solution at RetailSdk\POS\CloudPOS.sln, and ensure that it can be compiled without errors.
In the extensions.json file, add the following lines to enable the extensions that must be loaded.
```
{
    "extensionPackages": [
        {
            "baseUrl": "Microsoft/Receipts.FR"
        }, 
        {
            "baseUrl": "Microsoft/FifAuditEvent.FR"
        },
        {
            "baseUrl": "Microsoft/RestrictShiftDuration"
        }
    ]
}
```
Note

For more information, and for examples that show how to include source code folders and enable extensions to be loaded, see the instructions in the readme.md file in the Pos.Extensions project.
Rebuild the solution.
Run the solution by using the Run command, and then follow the steps in the Retail software development kit (SDK) handbook.

Production environment

To create deployable packages that contain Commerce components, and to apply those packages in a production environment, follow these steps.

In the commerceruntime.ext.config and CommerceRuntime.MPOSOffline.Ext.config package configuration files under the RetailSdk\Assets folder, add the following lines to the composition section.

<add source="assembly" value="Microsoft.Dynamics.Commerce.Runtime.ReceiptsFrance" />
<add source="assembly" value="Microsoft.Dynamics.Commerce.Runtime.RegisterAuditEventFrance" />
<add source="assembly" value="Microsoft.Dynamics.Commerce.Runtime.RestrictShiftDuration" />
<add source="assembly" value="Microsoft.Dynamics.Commerce.Runtime.XZReportsFrance" />

In the extensions.json file under the RetailSDK\POS\Extensions folder, add the following lines to enable the POS extension.

{
    "extensionPackages": [
        {
            "baseUrl": "Microsoft/Receipts.FR"
        }, 
        {
            "baseUrl": "Microsoft/FifAuditEvent.FR"
        },
        {
            "baseUrl": "Microsoft/RestrictShiftDuration"
        }
    ]
}

Open the MSBuild Command Prompt for Visual Studio utility, and run msbuild under the Retail SDK folder to create deployable packages.
Apply the packages via Microsoft Dynamics Lifecycle Services (LCS) or manually. For more information, see Create deployable packages.

Migrate to Commerce version 10.0.29 or later

The steps described in this section are required if you are using Commerce version 10.0.28 or earlier and are migrating to version 10.0.29 or later. You must follow the steps below to correctly update your Commerce environment.

Update Commerce headquarters.
Enable France-specific features in the Feature management workspace and distribute the changes to channels.
Update Commerce runtime, Cloud POS, and Modern POS, and exclude the following legacy France-specific extensions:
- Commerce runtime extensions in the commerceruntime.ext.config and CommerceRuntime.MPOSOffline.Ext.config files:
  - Microsoft.Dynamics.Commerce.Runtime.ReceiptsFrance
  - Microsoft.Dynamics.Commerce.Runtime.RegisterAuditEventFrance
  - Microsoft.Dynamics.Commerce.Runtime.RestrictShiftDuration
  - Microsoft.Dynamics.Commerce.Runtime.XZReportsFrance
- POS extensions in the extensions.json file:
  - Microsoft/Receipts.FR
  - Microsoft/FifAuditEvent.FR
  - Microsoft/RestrictShiftDuration