To include a validated phone field in your Screen Flow simply click and drag the EDQ Phone Validation (Flows) component found under the Custom section of the Components panel into the required position on your screen.
You can select resources from the flow, such as variables or global constants, or you can manually enter a value.
Attribute |
Description |
|---|---|
| API Name | An API name can include underscores and alphanumeric characters without spaces. It must begin with a letter and can’t end with an underscore. It also can’t have two consecutive underscores. |
| Country Code | Can be used to optionally provide a default country code. It must be provided as a three-letter ISO code, e.g. GBR. Alternatively, if you want to inherit the default country country from the user's profile setting or LEDQ Settings Custom Metadata Type setting then set the value to [API Name].phoneCode, where [API Name] is the value set above. The user's profile setting will take precedent over that set in LEDQ Settings if both are present. |
| Disabled | Prevents the user from modifying or copying the value. Defaults to False and can be changed by using the appropriate GlobalConstant. |
| Existing Field API Name | Can be used in tandem with the Record Id below to optionally retrieve an existing EDQ Log entry so that the validated phone number and its status can be displayed when the component loads. This corresponds to the Salesforce API Name of the field the existing phone number is stored in. |
| Existing Record Id | Can be used in tandem with the Field API Name above to optionally retrieve an existing EDQ Log entry so that the validated phone number and its status can be displayed when the component loads. This corresponds to the Salesforce Record Id of the existing record containing the phone number. |
| Help Text | Give your users more context. The text you enter is available in an info bubble next to the component. |
| Label | User-friendly text that displays to the left of the component. |
| Phone Value | Can be used to optionally provide a default value. |
| Placeholder Text | The text that appears in the phone field when it's empty. Use placeholder text to give users a hint about what to enter in the field. |
| Required | Requires the user to enter a value. Defaults to True and can be changed by using the appropriate GlobalConstant. |
You may wish for the component to load already populated with existing data. This could be data that hasn't previously been validated using EDQ components or it may have already been validated and you want to show the existing validation status beside the field. You should therefore note how the behavior changes depending on which flow input variables are set.
Flow variables set |
Outcome |
|---|---|
| Country Code Phone Value |
|
| Existing Record Id Existing Field API Name |
|
| Existing Record Id Existing Field API Name Country Code Phone Value |
|
All attributes are available to store in flow variables, but usually you must store one of these attributes below. The values are assigned to the flow variables when the user navigates to the next screen.
Attribute |
Description |
|---|---|
| Phone Code | The international calling code of the country where the phone number is currently registered. |
| Phone Type | The type of the phone number. Possible values can be found in our Phone Validation API documentation. |
| Phone Value | The validated phone number. |
| Validation Input Key * | Used in the EDQ Save Transaction Log Apex Action if required. |
| Validation More Info * | Used in the EDQ Save Transaction Log Apex Action if required. |
| Validation Status * | Used in the EDQ Save Transaction Log Apex Action if required. |
| Validation Type * | Used in the EDQ Save Transaction Log Apex Action if required. |
* The four Validation attributes are all needed if you use the dedicated Apex Action we supply to create EDQ Log objects to store the validation status.
