Creating custom Validation for Lead creation using Email and CustomCountry Code.

**lazovic** · 06-19-2023, 06:51 AM

Hi william34,

Since EspoCRM v7.5 it is possible to check for duplication and validation without changes or additions to the EspoCRM code. You can try using API Before-Save script: https://docs.espocrm.com/administrat...re-save-script.

**william34** · 06-19-2023, 10:43 PM

Hi @lazovic,
Thanks for the help,

I looked into the Api Before-Save Script. I tested the example code, it worked.
Based on that I came up with below formula. But it doesnt seem to be working.
It inserts everything regardless.

Don't know what is wrong though.

PHP Code:

if (entity\isNew() && !recordService\skipDuplicateCheck()) {
    
    $ids = list();
    
    
    $id = record\findOne('Lead', null, null,'emailAddress=' , emailAddress , 'customCountry=' , customCountry);
    if ($id) {
        $ids = array\push($ids, $id);
    }

    
    
    $ids = array\unique($ids);

    if (array\length($ids)) {
        recordService\throwDuplicateConflict($ids);
    }
}

**rabii** · 06-20-2023, 08:35 AM

hey william34

If you want both condition to applied at once try it like this, see code below:

PHP Code:


if (entity\isNew() && !recordService\skipDuplicateCheck()) {
    $id = record\findOne('Lead', null, null, 'emailAddress=', emailAddress, 'customCountry=', customCountry);

    if ($id) {
        recordService\throwDuplicateConflict($id);
    }
}

This should work for you.

**esforim** · 06-20-2023, 10:50 AM

Just adding keyword for future search:

duplicatecheck
duplicatechecker
duplicate check formula

**william34** · 06-20-2023, 12:01 PM

hi rabii,

I tried the formula.

Created new lead with name : sam , email : sam@gmail.com , customCountry : UK
And then tried to create same Lead with same email and country. It fails in this conditions

Same name , same email, same country : Not Allowed | Not Inserted ✅
diff name , same email, same country : Not Allowed | Inserted ❌
no name , same email, same country : Not Allowed | Inserted ❌
no name , same email, diff country : Allowed | Inserted ✅

created Lead
name = sam , email = info@gmail.com , country = UK

Testing Formula on ☝️ Created Lead
name = sam , email = info@gmail.com , country = UK : Expected behavior = Not Allowed | Record Not Inserted | Test Passed.
name = john , email = info@gmail.com , country = UK : Expected behavior = Not Allowed | Record Inserted | Test Failed.
name = '' , email = info@gmail.com , country = UK : Expected behavior = Not Allowed | Record Inserted | Test Failed.
name = '' , email = info@gmail.com , country = US: Expected behavior = Allowed | Record Inserted | Test Passed.

name = '' means left first name and last name blank

**rabii** · 06-20-2023, 12:09 PM

what do you mean by

Same name , same email, same country : Not Allowed | Not Inserted ✅
diff name , same email, same country : Not Allowed | Inserted ❌
no name , same email, same country : Not Allowed | Inserted ❌
no name , same email, diff country : Allowed | Inserted ✅

**rabii** · 06-20-2023, 12:52 PM

you should know that there is already a DuplicateWhereBuilder implemented in the crm by default for the Lead (which checks if the first or last name of the lead exist or if the emailaddress exist then the modal for duplicate check will popup) hence this checker exist it will be applied before the Befoe Save API and what you want to do is to add your code checker when the first one is triggered, meaning your code should be like below:

PHP Code:


if (entity\isNew() && recordService\skipDuplicateCheck()) {
    $id = record\findOne('Lead', null, null, 'emailAddress=', emailAddress, 'customCountry=', customCountry);

    if ($id) {
        recordService\throwDuplicateConflict($id);
    }
}

If this doesn't work i guess you will have to disable the default one hence that one checkes for the email so it will be triggered eveytime you create a lead with an email address that another has.

**rabii** · 06-21-2023, 08:11 AM

In this case you have to define your own duplicatewherecheck class, just follow the steps below:

1 - Create a the new duplicatewherebuilder under espo\Espo\Custom\Classes\DuplicateWhereBuilders (file should be named Lead.php) - make sure that the folders (Classes - DuplicateWhereBuilders exist otherwise create them under the path custom\Espo\Custom) - paste in the code below:

PHP Code:

<?php
namespace Espo\Custom\Classes\DuplicateWhereBuilders;

use Espo\Core\ORM\Entity as CoreEntity;

use Espo\Core\Duplicate\WhereBuilder;
use Espo\Core\Field\EmailAddressGroup;

use Espo\ORM\Entity;
use Espo\ORM\Query\Part\Condition as Cond;
use Espo\ORM\Query\Part\Where\OrGroup;
use Espo\ORM\Query\Part\WhereItem;

class Lead implements WhereBuilder
{
    /**
     * @param Entity $entity
     */
    public function build(Entity $entity): ?WhereItem
    {
        $orBuilder = OrGroup::createBuilder();

        $toCheck = false;

        if (
            (
                ($entity->get('emailAddress') || $entity->get('emailAddressData')) &&
                (
                    $entity->isNew() ||
                    $entity->isAttributeChanged('emailAddress') ||
                    $entity->isAttributeChanged('emailAddressData')
                )
            ) &&
            $entity->get('customCountry')
        ) {
            foreach ($this->getEmailAddressList($entity) as $emailAddress) {
                $orBuilder->add(
                    Cond::and(
                        Cond::equal(
                            Cond::column('emailAddress'),
                            $emailAddress
                        ),
                        Cond::equal(
                            Cond::column('customCountry'),
                            $entity->get('customCountry')
                        )
                    )
                );

                $toCheck = true;
            }
        }

        if (!$toCheck) {
            return null;
        }

        return $orBuilder->build();
    }

    /**
     * @return string[]
     */
    private function getEmailAddressList(CoreEntity $entity): array
    {
        if ($entity->get('emailAddressData')) {
            /** @var EmailAddressGroup $eaGroup */
            $eaGroup = $entity->getValueObject('emailAddress');

            return $eaGroup->getAddressList();
        }

        if ($entity->get('emailAddress')) {
            return [
                $entity->get('emailAddress')
            ];
        }

        return [];
    }
}

2 - now create the Lead.json file to map the custom class, create the file under custom\Espo\Custom\Resources\metadata\recordDefs\L ead.json (create those folder if they don't exist) and pase in the content below:

PHP Code:

{
    "duplicateWhereBuilderClassName": "Espo\\Custom\\Classes\\DuplicateWhereBuilders\\Lead"
}

That is it now whene a user create a Lead the system will check if any existing lead has the same email and customCountry if yes then it will show the modal with duplicate found message otherwise nothing will show up.

Hope this helps now, by the way if you use this code just remove the code from the formula hence you won't need it anymore.

Enjoy

Creating custom Validation for Lead creation using Email and CustomCountry Code.

Creating custom Validation for Lead creation using Email and CustomCountry Code.

Comment

Comment

Comment

Comment

Comment

Comment

Comment

Comment