Creating a Dupe Check Class

The following steps provide an overview of how to write a duplicate check object for Aptify:

1. Open a new Class Library project in Visual Studio.
2. Configure the Properties for the project.
   • When assigning an assembly name for this object, use this format: [EntityName]DupeCheck (remove spaces in the entity name). For example: VehicleModelsDupeCheck (or SampleVehicleModelsDupeCheck, as shown below).
   • Specify a root namespace for your project. For example: Aptify.SampleApplication.MotorLoaner, as shown below.
     
     
3. Click the References tab in the Properties page and add a reference to the following Aptify objects:
   • AptifyApplication
   • AptifyAttributeManagement
   • AptifyExceptionManagement
   • AptifyGenericDataServices
   • AptifyGenericEntityBase

   • IAptifyDataServices

     References to the following Microsoft Objects should already exist in the project: System, System.Data, and System.Xml. You can find the Aptify objects in your Aptify Windows application's C:\Program Files\Aptify 5.5 directory.

4. Open the class file.
5. Add Option Explicit On and Option Strict On at the top of the class file (as described in Use Option Explicit and Option Strict.
6. Import the following namespaces into the class:
   • Aptify.Framework.BusinessLogic.GenericEntity
   • Aptify.Framework.DataServices
   • Aptify.Framework.Application
      
7. Define the name for your class (typically this is Public Class [Object Name]).
8. Add Implements IAptifyDuplicateCheck below the class name to specify that this class will implement that interface to create a duplicate check object.
   
   
9. Write a function to implement the CheckForDuplicate method for your object.
   • As described previously, Aptify recommends that you write a stored procedure to check for matching records and add this stored procedure to the database. The stored procedure should receive its input parameters from your CheckForDuplicate function.
   • See About the Sample Application Duplicate Check Objects, the sample application source code, and Use Stored Procedures to Retrieve Database Values for more information and examples.
10. If you are planning to use the standard Duplicate Check dialog box, configure the DuplicateMessageObject Property to Return Nothing.
    • See the sample applicable source code for examples.
11. Build, test, and sign the assembly. See Best Practices When Writing Code for Aptify for details.
    • See Adding a Duplicate Check Plug-In Object to an Entities Record for instructions on how to add the object to the Aptify system.

Related topics

• Page:
  About the Baseline Persons and Companies Sample Duplicate Objects
• Page:
  About the Customers Entity Duplicate Check Object
• Page:
  About the Sample Application Duplicate Check Objects
• Page:
  About the Vehicle Models Entity Duplication Check Object
• Page:
  Adding a Duplicate Check Plug-In Object to an Entities Record
• Page:
  Adding Plug-Ins to an Entity
• Page:
  Addressing Absolute Duplicate Records
• Page:
  Addressing Absolute Duplicate Records
• Page:
  Addressing Potential Duplicate Records
• Page:
  Addressing Potential Duplicate Records
• Page:
  Bypassing the Duplicate Check Process
• Page:
  Creating a Dupe Check Class
• Page:
  Developing Duplicate Check Objects
• Page:
  Enabling the Duplicate Record Check for a Service
• Page:
  Enabling the Duplicate Record Check for a Service