Callum Hurry, Author at ProvenWorks

Blog

Using IndustryComplete

by Callum Hurry in IndustryComplete Support November 15, 2024

Overview

The IndustryComplete component allows users to:

Add industry codes to records.
Sort and delete existing industry codes to keep your records organized and relevant.

The component includes two main buttons as shown in the interface:

Add Industry Code Button – Allows you to search for, and add, a new industry code to the record.

Sort/Delete Industry Button – Enables you to alter the displayed order of existing industry codes or delete selected codes.

Step-by-Step Guide

1. Adding an Industry Code

Navigate to the record page where the IndustryComplete component is installed.
Click the ‘+' button to open the industry code selection window.
Search for and select the desired industry code from the list.
Confirm your selection by clicking ‘Add’ to add the code to the record.

2. Sorting Industry Codes

Click the ‘⇅' button to enable sorting.
Rearrange the industry codes in the desired order by dragging and dropping them.
Once satisfied, save the new order to reflect the updated sequence.

3. Deleting an Industry Code

To delete an industry code, first click the ⇅ button.
Select the dropdown button next to the code you want to remove.
Confirm the deletion to remove it from the list.

How to solve: ManagedImport failing to load / Refused to load frame

by Callum Hurry in Impowr Support September 27, 2024

You may see that the ManagedImport component fails to load, and a message is printed to the page’s log stating that it has refused to load a frame.

This can be resolved by heading to Setup > Trusted URLs, finding the entry for SimpleImport and enabling the ‘iframe-src’ directive.

Considerations when testing the Address Verification Flow Component (AVFC)

by Callum Hurry in AddressTools Support July 12, 2024

Note that when you use the ‘Run’ or ‘Debug’ options in Flow Builder, the country filter and icons will not function as expected. This is due to them being served from static resources in your org, which are not available in the Flow Builder’s ‘Run’ and ‘Debug’ contexts.

To test all the component behaviours, we recommend adding the Flow to a lightning page to test its functionality before rolling it out.

How To Use the Address Verification Flow Component (AVFC) Within an OmniScript

by Callum Hurry in AddressTools Support March 27, 2024

Overview

This article provides guidance on how to use the Address Verification Flow Component (AVFC) by ProvenWorks within an OmniScript.

How to include the Address Verification Flow Component in an OmniScript

Firstly, you will need to set up a development environment and link it to your Org. If you’re not familiar with this process, Salesforce have a great guide.

Open the command palette, and select SFDX: New Project, then SFDX: Create Lightning Web Component. We need this LWC to function as a wrapper around the Address Verification LWC, as we can’t directly implement a managed package within an OmniScript. Once the process has completed, navigate to force-app/main/default/lwc and find the newly created files for your LWC.

In the .js-meta.xml file, make sure isExposed is set to true, and runtimeNamespace is set to the namespace of the package containing your installation of OmniStudio. For example, here’s what ours looks like:

avfcWrapper.js-meta.xml

<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
  <apiVersion>59.0</apiVersion>
  <isExposed>true</isExposed>
  <runtimeNamespace>vlocity_cmt</runtimeNamespace>
</LightningComponentBundle>

Next, copy and paste the following into your .html file. This is a template that includes the Address Verification LWC, so feel free to remove any fields that you do not specifically need or instead, change the existing fields to meet your requirements. For a full list of attributes that can be used with the component, see here.

avfcWrapper.html

<template>
  <pw_avfc-address-verification-flow-base-component
    use-county="true"
    use-status="true"
    countries="GB,US,CA"
    origin="US"
    country=""
    state=""
    postalcode=""
    city=""
    street=""
    street2=""
    county=""
    status=""
    onaddresschange={changeHandler}>
  </pw_avfc-address-verification-flow-base-component>
</template>

Finally, we need to configure our LWC wrapper to listen to the events raised from the Address Verification component. This will allow us to read the address values from the component when the values change (i.e., a new verified address has been selected). I have given this method the name changeHandler in the above document, but you can use any name that you would like.

So that you can access the component’s values within the OmniScript, we must pass them to the OmniScript JSON Object. The event handler is passed the users input under the event.detail object, in easy-to-parse key-value pairs.

avfcWrapper.js

import { LightningElement } from 'lwc';
import { OmniscriptBaseMixin } from 'vlocity_cmt/omniscriptBaseMixin';
  
export default class avfcWrapper extends OmniscriptBaseMixin(LightningElement) {
    address = {};
    changeHandler(event) {
        this.address = event.detail["address"];
        this.omniApplyCallResp({"address": this.address});
    }
}

You can, if necessary for your use case, manipulate the data in this method before calling this.omniApplyCallResp(), as this is what adds it to the OmniStudio JSON Object.

Adding the LWC into the OmniScript Editor

Under the build tab, drag the Custom Lightning Web Component into the step, and inside that component’s properties, set the LWC Component Override field to the name of the wrapper LWC that you created earlier. Click activate version, followed by preview to see it in action.

To check everything is set up correctly, click over to the Data JSON tab inside OmniStudio. The user’s address data should be populated, as in the screenshot below:

This JSON object is accessible by other OmniScript elements, allowing you to manipulate or re-use the address inputs.

Address Verification Flow Component Available Parameters

by Callum Hurry in AddressTools Support

Value Parameters

street street2 city state postal-code country county status

Feature Parameters

inline-mode — Inline UI mode, more compact
use-county – Whether or not to use the county input
use-status – Whether or not to store a Verified/Not Verified attribute
use-second-street-line – Whether or not to use a 2nd line for the street input
return-company-in-street — Whether to return the company name registered at that address (if applicable)
disabled

Search Parameters

countries – A list of allowed countries
origin – The origin country of the request, will bias results towards the country the request originated from

Label Parameters – Customize labels for input fields

main-label search-label search-button-label manual-button-label street-label street2-label city-label state-label postal-code-label country-label county-label status-label

Styling Parameters

additional-styles – Custom CSS to add to the component

Event Parameters

onaddresschange — Function to call upon the user changing the data in any field

How to: Automatically Populate the Primary County Field based on the entered ZIP Code

by Callum Hurry in AddressTools Support January 16, 2024

Note: Functionality for populating regional data based on a country entry is only available for AddressTools Premium, if you are using AddressTools Free then you can trial our AddressTools Premium application to take advantage of this feature plus many more that it includes. This guide only applies to United States of America based addresses.

What Does This Guide Achieve?

After following this guide, you will have successfully configured a field that automatically populates with the appropriate Primary County corresponding to the ZIP code entered. This example will use the Account object.

Creating the Necessary Lookup Fields

To begin, you will need to create the three necessary lookup fields:

Country Lookup
State Lookup
ZIP Code Lookup

To achieve this, follow this guide, ensure that you use the address block which you intend to implement this functionality on.

After creating these fields, you will need to enable the lookup field population:

Go to App Launcher | AddressTools Administration.
Select Settings from the sidebar.
Click the pencil next to Enable Field Lookup Population.
Tick the Enable Field Lookup Population checkbox.
Click Save.

Adding the lookup fields to the Address Block

Navigate to AddressTools Administration Page | Address Blocks
Select the Down arrow next to the relevant address blocks and click Edit
Under the Lookup Fields section, select the fields that you just created and click Save

Creating a Formula Field to Display the County

Navigate to Setup | Object Manager | [Object you are using]
Select Fields & Relationships | New
Select Formula and then Next
Name the field and choose the Return Type as Text then click Next
Select Advanced Formula then Insert Field
Select [Object you are using] – [ZipCode Lookup field that you created in the previous step] – Primary County

Note: You will need to configure the Field-Level Security for this field and add it to your Page Layout to meet your desired criteria.

Now with the formula field created and on the page layout, when the record is saved with a valid USA based ZIP Code value, the value from the associated county record will now appear in the lookup field.

Contact Us

If you have any questions in relation to this article, contact us at: support@provenworks.com We will be happy to answer any questions or problems that you may have.

Level up your data with AddressTools 9.0 (Dec ’23)

by Callum Hurry in AddressTools News December 21, 2023

We’re constantly working to improve our solutions for you, and we’re excited to bring you a new release. Introducing AddressTools 9.0!

This latest version of AddressTools brings you UI updates to improve usability and solution quality of life, as well as improvements to our US address data.

Here are the key features of AddressTools 9.0 that we will cover in this article:

Improved UI for the address editor
Enhanced PowerSearch functionality
Helpful tooltips next to QuickComplete Country and Lookup ZIP
Scheduled Address Verification page is now known as Batch Address Verification
Improved US address data quality
Release notes
How to upgrade

So, let’s dive in!

Improved UI for the address editor

Verification-related functionality has been grouped at the top
Verify button is only enabled when needed
Updates to the PowerSearch component (more information in the next section)
Country appears first when State & Country pick lists are used

Benefit: Improved usability for a more efficient experience

We’ve made the address entry process in AddressTools more intuitive to improve your productivity. This includes grouping relevant fields within a section of the UI, keeping functionality together.

Enhanced PowerSearch functionality

Suggested addresses will show more applicable results
New country filter has been added to the PowerSearch bar to assist in finding exact addresses quicker

Benefit: Prioritise the country data you need and retrieve addresses faster

The PowerSearch functionality just got a huge upgrade helping organisations that work with international addresses. PowerSearch results will suggest a broader range of addresses. To manage this increased offering, we’ve added a dedicated country filter to assist in producing results within the selected country.

New tooltips for QuickComplete Country and Lookup ZIP

Benefit: increased clarity over functionality

Training users about every piece of functionality in Salesforce can be an endless process, and that can get harder when implementing additional functionality. To simplify this, we’ve added help text to the QuickComplete Country and Lookup ZIP links.

The Scheduled Address Verification page is now known as Batch Address Verification with a fresh new UI

Benefit: UI improvements providing a better quality of life for the user experience

The scheduled address verification tab has been renamed to Batch Address Verification to align closer to what the page allows you to do. With this change comes some quality of life and interface improvements focused on the user experience. The documentation has been updated to reflect the changes.

Improved US address data

Benefit: access even better address data for US addresses

You can expect improvements to our US address dataset, with even better quality.

Release Notes

To see the full list of enhancements and improvements, please refer to the Release Notes.

How do I upgrade?

To access these latest features, you will need to upgrade to AddressTools 9.0 by installing the latest package from the Salesforce AppExchange.

Upgrade now

Create a public prospectus request form with address verification using Salesforce Education Cloud

by Callum Hurry in Data Management September 1, 2023

This blog will take you through the key aspects of Education Cloud to provide you with more knowledge on what you can do with Salesforce Education Cloud, Digital Experiences and our Address Verification Flow Component. The second half of this article will walk you through a use case step-by-step that brings together all of this knowledge: creating a screen flow on a digital experience for prospective students to request a prospectus to be sent to their address.

What is Salesforce Education Cloud?

Education Cloud is a platform built on Salesforce CRM aimed at the education sector, from schools through to higher education institutions like universities and colleges. This cloud is aimed at keeping students, alumni and staff connected. According to Salesforce, Education Cloud is intended to “deliver the personalised engagements, proactive advice, and connected experiences students expect”. Education Cloud has a tonne of benefits, specific to the education industry it serves. This purpose-built platform enables educational organisations to better connect students, staff, schools, districts and universities, as well as providing a 360-degree holistic view of the education journey. 💡 Check out our blogpost: ‘What is Salesforce Education Cloud and what can you do with it?’ to learn more about the benefits and use cases of Education Cloud!

Education Cloud meets Digital Experiences

A Digital Experience, also known as a DX, is a digital interaction between the organisation offering the digital experience and other users (students, families, employees, or partners). Salesforce offers Digital Experiences through Experience Cloud, which enables you to build beautifully-branded external-facing sites that are connected to your CRM. Digital Experiences can provide educational institutions with better digital interactions for students and their families:

Improving the student experience and retention
Nurturing academic health with student-centric digital experiences,
Increasing prospective student engagement rates at the top of funnel.

Digital Experiences can really drive success for everyone involved!

Capturing accurate data for your Education Cloud

At ProvenWorks, we believe good data is the basis of success. Data is at the heart of all institutes and it’s critical that data is accurate at point of entry. With this goal in mind, we’ve developed solutions like AddressTools. Whether you’re sending out a prospectus or tracking term-time accommodation, capturing an accurate address is critical for your operations. When addresses are inaccurate or incomplete, 41% of deliveries are delayed, and 39% simply fail. For students, receiving critical post in good time can be the difference between smoothly enrolling into education or anxiously losing grip of future plans. For colleges and universities, tracking student addresses is important for sending mail to the correct address – whether a student is at their home or term-time address. Capturing accurate addresses is essential for education institutions, and what better way than by capturing addresses at point of entry with typeahead address?

Implementing typeahead address entry into an Education Cloud’s Digital Experience

We’ve established the need for capturing accurate data when utilising Education Cloud, so how can we improve this experience for capturing addresses? Using the Address Verification Flow Component by ProvenWorks, you can:

reduce data entry abandonment,
mitigate undelivered and returned mail,
minimise missed opportunities,
and improve staff productivity by allowing them to focus on what’s important.

So, let’s explore the use case of prospective students requesting a physical prospectus. We want to make this process as easy as possible and ensure that the data we collect is verified.

The use case: a prospective student requesting a prospectus

Let’s explore how we can build a form using a screen flow for prospective students to request a prospectus which will be made public on a Digital Experience. in the following steps, we will:

Create a Salesforce Flow to create a new Lead and upcoming Activity to send a prospectus.
Utilise the Address Verification Flow Component by ProvenWorks to provide typeahead address entry to the Flow Screen.
Deploy the Flow to a Digital Experience.

*Note, this guide will not cover the creation of a Digital Experience but will show how to place your Flow into the DX builder. Salesforce has extensive documentation on how to configure a Digital Experience available here: Experience Cloud (salesforce.com)

Before continuing

The following steps demonstrate the value of having both AddressTools Premium and the Address Verification Flow Component installed in your Education Cloud org. To follow along with the guide you will be required to install and complete the initial installation steps for both packages, including obtaining address verification credits from the ProvenWorks team. If you don’t yet have these packages installed, don’t fret! You can still read below to understand how to quickly implement typeahead address verification into your Flow Screen and then come back to explorw the managed packages after!

Steps: Flow Creation

Salesforce Setup | navigate to your Salesforce Flow
New Flow | Select Screen Flow | Click Create
Add New Resource | Variable
API Name we used ProspectiveLead
Data Type | Record
Object | Lead
Select Save

Add element

Click the Add element | Screen
Drag the following fields onto the Screen:

First Name
Last Name
Email
Optionally add any additional fields that you need to capture i.e. Mobile Number, but leave out the Address fields for now.

Navigate back to Components in the panel on the right of the Screen editor.
Add Address Verification by ProvenWorks into the Screen.
Click on the Address Verification by ProvenWorks component to open the component parameters on the right of the interface.
Scroll down the parameters and tick Manually assign variables
Assign the following Values:
City Value > {!ProspectiveLead.City}
Country Value > {!ProspectiveLead.Country}
Postal Code Value > {!ProspectiveLead.PostalCode}
State/Province Value > {!ProspectiveLead.MailingState}
Status Value > {!ProspectiveLead.pw_ccpro__AddressStatus__c}
Street Value > {!ProspectiveLead.Street}
Click Done

Create the Lead Record

Now that we’ve created a Flow Screen to capture the Lead’s information, we need to insert it to a new Lead record in Salesforce.

Add Element | Create records
Label | Create Prospective Lead
API Name will auto populate
Create a Record from These Values | Record | ProspectiveLead
Click Done

Create an Associated Task

Now that we’ve created a record for the Prospective Lead, we need to create an activity to send the prospectus to the lead.

Add Element | Create records
Object | Task
Label | Create Associated Task
API Name will autopolulate
New Resource | Formula | API Name TomorrowsDate
Data Type | Date/Time | Formula {!$Flow.CurrentDateTime+1} Done
Set Field Values for the Task: • ActivityDate < TomorrowsDate • Description < Send a prospectus • Status < Not Started • Subject < Send a prospectus • Type < Action Item • WhoId < ProspectiveLead>LeadID

Add a screen to notify the Prospect

It’s good practice to show a completion message after the flow has completed its processes. We’ll do this by adding another screen element at the end of the Flow. Add element

Click the Add element | Screen
Label | Lead Created Message
API Name will autopolulate
Drag display Text and display the message you desire.
Click Done

Save the Flow

The Flow now captures Lead information, saves it to a new Lead record, then creates a related task for your internal team to follow up on. Let’s save this Flow so we can use it in our Digital Experience.

Select Save
Provide a Flow Label to help you identify the Flow in the future, i.e. “Prospectus Request”
The Flow API Name will be auto populated, change this if required.
Click Save
Activate the Flow.

How to expose the Flow in a digital experience

Salesforce Setup | Open the Digital Experience where you want prospective students to request a prospectus from in the Experience Builder, then navigate to the page that you want to add the Flow to.
From the Components panel, drag the Flow component onto the page.
In the property editor, select the relevant Flow.
When you’re happy with the Digital Experience, press Publish.

Summary

We have now created a way for prospective students to easily request a prospectus via a Digital Experience, and most importantly to gather accurate address data in a fast an efficient manner.

AddressTools

AddressTools is our award-winning package for Salesforce to help you standardise, validate and verify your address data.

Find out more

How to: Provide access to our Address Verification Flow Component in a Digital Experience

by Callum Hurry in AddressTools Support August 3, 2023

Overview

With the Address Verification Flow Component now installed and in a Digital Experience, it is essential to provide access to CSP Trusted Sites to our component.

This article will explain what settings are required for users to be able to use AddressTools Verification Flow Component functionality.

Provide Access to our Component in Digital Experiences

Salesforce Setup | navigate to CSP Trusted Sites
Click Edit on https://addressvalidation.provenworks.com | Context "All"
Click on Save.

Back to the Address Verification Flow Component installation walkthrough

How to: deploy Address Verification Flow Component to users in your organization

by Callum Hurry in AddressTools Support

Overview

With Address Verification Flow Component now installed in your Org, it is essential to provide your users with the correct permissions to use the solution.

This article will explain what permissions are required for users to be able to use Address Verification Flow Component functionality.

It is recommended that a permission set is created for Address Verification Flow Component so that it can be applied to multiple users/profiles but these settings can be directly applied to the profiles.