DQE One Package — Webservices Settings

Support DQE
Support DQE
  • Updated

This guide walks through the configuration of DQE One webservices in a Microsoft Dynamics 365 or Power Apps environment. Each webservice (Addresses, Emails, Phones, B2B) requires two levels of configuration: application-level settings (done once) and form-level settings (done per entity — Account, Contact, Lead).

1. Prerequisites

Before configuring any webservice, make sure the following are in place:

1.1 Package and Roles

  • The DQE One application is installed in the target Dynamics Sales or Power Apps environment. Refer to the DQE One Package Setup documentation if not done.
  • Users have been assigned the correct roles (DQE – Data Administrator and/or DQE – User) in the admin center.

1.2 Create the DQE Metadata Record

This record connects the application to the DQE webservice server. Without it, no webservice will function.

  1. In the DQE Unify application, go to DQE Metadata and click New.

  2. In the API URL address field, enter the DQE server URL:

    <URL provided by your DQE project manager>
  3. Click Save & Close.

1.3 Activate the Licence and Subscribed Products

This step defines which webservices are enabled for the customer based on their contract.

  1. In the DQE Unify application, go to DQE DataQ Settings and click New.
  2. Enter the DQE licence key provided by the DQE project manager in the DQE Licence field.
  3. Set each product the customer has subscribed to to Yes. Only activate what is in the customer's contract.
  4. Click Save & Close.

Each activated webservice must then be configured individually, both in the application settings and in the form of each entity where it will be used.

2. Addresses

The address webservice provides real-time address autocomplete and validation as users type in address fields. It can be activated on the Account, Contact and Lead entities.

2.1 Application Settings

  1. In DQE DataQ Settings, verify that Enable address autocomplete is set to Yes, then go to Address Setup.
  2. Configure the options:
    • Autofill address complement — enable to recover additional data such as building name.
    • Geolocation — enable only if subscribed.
    • Entities and address blocks — select which entities (Account, Contact, Lead) and which address block (Address 1, Address 2…) the webservice should be active on.
  3. Click Save & Close.

Note: The default country setting does not block international address validation. It simply pre-selects a country in the search field. A DQE Country table is installed automatically with the package.

2.2 Form Configuration

Three fields must be configured per entity: Street, City and Postal Code. Each field needs a DQE custom control added to it, with the related fields mapped so they update together when a suggestion is selected.

For each field below, the process is the same: open the form, select the field, add the component, map the related fields, then save and publish.

Street Field — AddressFieldControl

  1. In the form editor, select the Street 1 field and click + Components.
  2. Select AddressFieldControl.
  3. Map: City, Postal Code, Country Code.

City Field — CityFieldControl

  1. Select the City field and click + Components.
  2. Select CityFieldControl.
  3. Map: Postal Code, Country Code.

Postal Code Field — PostalcodeFieldControl

  1. Select the Zip/Postal Code field and click + Components.
  2. Select PostalcodeFieldControl.
  3. Map: City, Country Code.
  4. Click Save & Publish.

Repeat this configuration for each entity (Account, Contact, Lead) where the webservice must be active.

2.3 Expected Results

  • Typing an address: suggestions appear as the user types in the Street field.
  • Typing a postal code: suggestions are filtered by matching cities and streets.
  • Selecting a suggestion automatically fills in the City and Postal Code fields.

3. Emails

The email webservice validates email addresses in real time and can suggest email corrections based on the contact's first and last name. Available on Account, Contact and Lead.

3.1 Application Settings

  1. In DQE DataQ Settings, verify that Enable email is set to Yes, then go to Email Setup.
  2. Configure the options:
    • List of values — fill in if not done during installation (return codes displayed to the user).
    • Name-based suggestions — enable to suggest email addresses based on the contact's first and last name.
    • Store return code — optionally map the validation result to a custom field on the entity.
    • Entities — select which entities the email webservice should be active on.

3.2 Form Configuration

  1. In the form editor, select the Email field and click + Components.
  2. Select EmailFieldTextControl.
  3. Map: First Name / Account Name, Last Name (used for name-based suggestions).
  4. Click Save and Publish.

Repeat for each entity where the webservice must be active.

3.3 Expected Results

  • After the user enters an email, a validation indicator is displayed next to the field.
  • If First Name and Last Name are filled in, the webservice suggests likely email addresses and common domain names.

4. Phones

The phone webservice validates phone numbers in real time and formats them according to the selected country. Available on Account, Contact and Lead.

4.1 Application Settings

  1. In DQE DataQ Settings, verify that Enable phone is set to Yes, then go to Phone Setup.
  2. Configure the options:
    • List of values — fill in if not done during installation.
    • Store return code — optionally map the validation result to a custom field.
    • Types and Geolocation — configure if applicable and subscribed.
    • Entities — select which entities the phone webservice should be active on.

Note: The default country does not restrict international phone validation. It only pre-selects a country dial code.

4.2 Form Configuration

  1. In the form editor, select the Main Phone field and click + Components.
  2. Select PhonefieldControl.
  3. Map Country Code to the field storing the country, used to determine the dial code.
  4. Click Save and Publish.

Repeat for each entity where the webservice must be active.

4.3 Expected Results

After the user enters a phone number, a validation indicator is displayed and the number is reformatted according to the country's standard.

5. B2B

The B2B webservice provides company autocomplete from the French SIRENE database (INSEE). When a user types a company name or SIRET number, the webservice suggests matching companies and automatically fills in company data fields. Available on the Account entity only.

5.1 Configure the Field Mapping — DQE B2B Settings

Before configuring the form, you must define which SIRENE data fields map to which Dynamics fields on the Account entity. This is done in DQE B2B Settings → DQE Setup.

  • The screen shows the full list of available SIRENE data fields on the left and your Dynamics fields on the right.
  • Use the green buttons to add multiple target fields for a single SIRENE property.
  • Use the trash buttons to remove extra rows.
  • Click Initialize Default Records to pre-populate a standard mapping. This is safe to click multiple times: it only creates records that do not already exist and will not overwrite your changes. This button replaces the former Power Automate flow B2B Setup.

5.2 Form Configuration — Simple Method

This method is recommended for standard use cases.

  1. In Power Apps, go to Tables, select the Account table, then open Forms. Click on the form you want to configure, go to Events and add the following library and function:
    • Library: dqe_/shared/B2BAutoCompletion.js
    • Function: DQE.Shared.B2BAutoCompletion.AddAutoCompleteOnOutputChange
    • Check Pass execution context as first parameter.
    • In the parameters, add the field's logical name in double quotes, a comma, then true or false depending on whether the field should fire the OnChange event when autocomplete fills it.
  2. Switch to the Classic form editor. Double-click on the company name or SIRET field, go to Controls and add:
    • Account Autocompletion by Name — for the company name field.
    • Account Autocompletion by SIRET — for the company number field.
    • Enable each control for Web, Phone and Tablet.
  3. Click Publish.

5.3 Form Configuration — Integrator Method

Use this method if you need to handle autocompletion logic programmatically, for example for custom business rules or conditional field updates.

Add the library dqe_/shared/B2BAutoCompletion.js to the form, then use the two available functions:

  • DQE.Shared.B2BAutoCompletion.ProcessAutocompleteData(formContext, data, triggerOnChange) — applies the same autocompletion field-filling logic as the standard DQE form. Call this when the custom control fires its OutputChange event.
  • DQE.Shared.B2BAutoCompletion.AddAutoCompleteOnOutputChange(formContext, fieldLogicalName, triggerOnChange) — registers autocompletion on a specific field. Useful to attach the behavior without writing the event listener manually.

Each custom control exposes two output properties:

  • outputdata — the company data returned by the webservice.
  • outputtrigger — equals "autocomplete" when the output was triggered by a suggestion selection, rather than a manual change.

Microsoft reference: addOnOutputChange — Power Apps client API

5.4 Customizing the Suggestion Dropdown Columns (Integrator Only)

By default, the Autocomplete by Name control shows a standard set of columns in the suggestion dropdown. You can override this by setting a Columns parameter on the control, directly in the form's XML.

Example configuration showing company name, postal code, SIRET and a reference field:

[
  {"label": "Company",  "propertyName": "CompanyName",   "minWidth": 150, "maxWidth": 250},
  {"label": "Zip Code", "propertyName": "ZIP_Code",      "minWidth": 150, "maxWidth": 250},
  {"label": "SIRET",    "propertyName": "CompanyNumber", "minWidth": 150, "maxWidth": 250},
  {"label": "Ref",      "propertyName": "Ref",           "minWidth": 150, "maxWidth": 250}
]

To apply this configuration:

  1. Export the solution containing the form as a ZIP file.
  2. Unzip and open the form's XML file.
  3. Locate the custom control definition and add the Columns parameter with the desired JSON.
  4. Rezip the solution and reimport it into the environment.

A form XML editor plugin from XrmToolBox can simplify steps 2–3.

Full list of available properties for column customization: CompanyName, CompanyNumber, ZIP_Code, CompanyAddress1, CompanyAddress2, CompanyAddress3, Locality, Phone, Email, Activity1, Activity2, StaffCount, TurnOver, LegalStructureCode, LegalStructureLabel, IncorporationDate, DissolutionDate, Country, CompanyStatus, MainCompanyFlag, Ref.

5.5 Expected Results

  1. The user opens an Account record and clicks New.
  2. As they type the company name or SIRET number, a dropdown appears with matching companies from the SIRENE database.
  3. The user selects a company. The mapped fields, such as address, SIRET and legal form, are automatically filled in.
  4. The user clicks Save and Close. If Dynamics detects a potential duplicate, a native duplicate detection pop-up appears.

Important: Selecting a country before searching is mandatory.

Related to

Was this article helpful?

0 out of 0 found this helpful