DQ Email Capture - Install Guide

What is DQ Email Capture?

DQ Email Capture allows users to check an email address's validity, structure, and authenticity in real time when capturing data. 

Installation Guide

Note: The Base solution contains all the custom tables and Environment variables used by the DQ for Dynamics™ Capture & Cleanse tools and must be installed first.

Solution Install

2. Head over to the Power Apps Maker Portal

3. Select the Environment into which you will install the DQ Capture tool.

4. Now that you are in your desired environment, swap to the Solutions tab, and click the Import Solution button.

5. This will open up the Solution Import Wizard, and prompt you to select a ZIP file (Which you downloaded during step 1).

Note: The DQ for Dynamics - Base must be installed first.

6. Once you have selected the ZIP file you will be taken through the install wizard

7. The Next step of the Install wizard is the Environment Variable config, all of this can be edited later, so just click Import.

8. You will now see a notification at the top letting you know the status of the import

Once this has turned green you can repeat steps 5,6, and 7 for the DQ Email Capture solution.

9. If you now open the CRM you will now see that a new Model Driven app has been added.

From within this app you can edit all of the environment variables that you saw during the solution import on step 7

Form Setup Guide

This part of the guide will show you how to put the DQ Email Capture tool onto a form.

Note: for the guide, we will use the Account Table and the default Account form, the steps are the same for any table and form, so please use whichever table and form is appropriate for your CRM.

1. Open the Tables tab and then open the Account Table

2. Open the Forms section

3. Edit the Account form

4. Select the Field you want the control to appear on. For this example, we will use the Email field.

5. Please see the Control Properties section of this guide for descriptions of what each property is for.

6. Repeat steps 4 and 5 for all fields on the form that you want the control to appear on.

7. Click Save and publish

8. The control will now appear on the Form in the CRM.

Note: it may take a few page refreshes for it to show up.

Control Properties

Record ID

The field containing the Unique Identifier for the record. 

How to Populate: In the list of fields there will be a field with the name of the table, i.e. on the Account table there will be a field called "Account" This is the field which contains the ID for the Account record.

Invalid Result Behaviour

Defines how the control responds to an invalid result, the options are: 

• Take no action
• Displaying a Warning

• Preventing the user from saving the record

Triggered By Keys

Should the user be able to trigger the control using keys on the keyboard?

Options:

• None - No Keys will trigger the control, only clicking on the button will trigger it.
• Tab - Hitting Tab will trigger the control to process the phone.
• Enter - Hitting Enter will trigger the control to process the phone. 
• Tab & Enter - Either Tab or Enter will trigger the control to process the phone. 

Retry Period

How many days after completing an Authentication should the results be considered accurate? After this period the user will be able to process the Email Address again.

Note: This setting only applies to Authentication results, Both Validate and Format are static results, but an authentication will degrade over time, this is because once you have pinged the mailbox to confirm whether it is genuine or not that email could become inactive at any given time in the future, so the older the result is the lower the chance that is in still accurate.

Security Roles

Before a user can use the control there are a couple of permissions they will need.

1. Read access to Environment Variable Definitions
2. Read & Write Access to the tables included in the 'DQ for Dynamics - Base' solution

To make this easier the 'DQ for Dynamics - Base' solution includes 3 security roles:

• DQ for Dynamics - Base - Full
  • This role includes full access to all the necessary tables, (Create, Read, Write, Delete, Share, etc) and should ordinarily be reserved for privileged users.
• DQ for Dynamics - Base - Write
  • This role included Create, Read, & Write access to all the necessary tables allowing Users to both see results and contribute by writing back results from their usage of the controls.
• DQ for Dynamics - Base - Read
  • This role includes Read access to all the necessary tables and will let Users see the results from other Users, but will not let them store any results from using the controls themselves.

In most circumstances, you should give your users the DQ for Dynamics - Base - Write role.