Input & Output

Update index for an Object

The doIndex(String objectPrefix) method triggers a complete indexing process for a specified Salesforce object, preparing its records for efficient Plauti Deduplicate operations. By generating a Search Index, this method optimizes the performance and accuracy of duplicate detection, matching, and filtering.

Method Signature

Method Name: doIndex

static Boolean doIndex(String objectPrefix)

Parameters

TypeVariableDescription
StringobjectPrefixThe object prefix that identifies a Salesforce object type (e.g. 003 for Contacts or 00Q for Leads). Ensure the object is configured in the DC Setup.

Output

The method returns a Boolean value indicating the result of the indexing process initiation.

  • true: The indexing process has successfully started.
  • false: The process failed to start (e.g., due to invalid input or configuration issues).

Apex Example

This snippet starts the indexing process for Lead records using dupcheck.dc3Api.doIndex(), logs whether the process was successfully initiated, and reports any failures.

// Define the object prefix for Lead
String objectPrefix = '00Q';

// Execute the indexing process
Boolean isIndexingStarted = dupcheck.dc3Api.doIndex(objectPrefix);

// Optionally log the result
if (isIndexingStarted) {
    System.debug('Indexing process successfully started for object prefix: ' + objectPrefix);
} else {
    System.debug('Failed to start the indexing process for object prefix: ' + objectPrefix);
}