If you have a comment on this topic, contact Aptify Documentation. If you want to return to the Aptify Community Site, please click here.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Once a developer has created the plug in, follow these steps to add the new plug-in to an entity:

 

These steps describe how to add a plug-in to an entity after a developer has created the .NET assembly; these steps do not describe how to write a plug-in. Aptify provides information on creating entity plug-ins in the Developers training course. Students in this course gain first-hand experience creating entity plug-ins in a test environment. Contact Aptify for more information. Additional developer information is also available in the Aptify Software Development Kit (SDK).

  1. Add the plug-in's object file to the Object Repository.
  • See Creating Object Repository Objects for more information on adding new items to the repository.
  1. If the plug-in provides functionality that is not already described by an existing plug-in type, create a new record in the Entity Plug In Types service as directed by the plug-in's developer.
  • In general, any new Entity Plug In Types records you create should be specific to a particular entity.
  1. Open the entity's record in the Entities service.
  2. Click the Plug-Ins tab.
  3. Open a new Plug Ins sub-type record.
  4. Select the Plug In Type from the drop-down list.
  • See Plug In Types for the list of global types.
  1. Enter the Object Repository location of the plug-in's object in the Object Name field.
  • Alternatively, you can click the plus (plus) icon to the right of the field to open the Select Object Repository Object dialog. You can use this dialog to browse for an existing object or to add a new object to the repository (if you have not done so already). See Creating Object Repository Objects for details.
  1. Enter the plug-in's .NET assembly name in the Assembly Name field.
  2. Enter the class within the .NET assembly that implements the plug-in's functionality in the Class Name field.

Plug Ins Record

  1. Click OK.
  2. Save and Close the Entities record.
  3. Close and reopen the Aptify client.
  4. Use the records in the entity to preform a test to confirm that the system successfully uses the functionality defined by the plug-in you added.

Sample Duplicate Check Objects
Aptify provides the compiled object and source code for two sample duplicate check objects: one for Persons and one for Companies. A developer can use these samples as a basis for writing his or her own duplicate check object for an entity. Note that these objects are provided as samples only since what may be considered a duplicate will vary from entity-to-entity and from organization-to-organization. Additional sample duplicate check objects are included with the sample application. See the Aptify Developer Guide for details.
The sample objects use the following logic to identify duplicates:

  • Sample Persons Duplicate Check Object (AptifyPersonDupeCheck.dll): When a user attempts to save a new Persons record, this sample object checks for existing Persons records that have the same First and Last Name. If any matches exist, Aptify identifies these records as potential duplicates.
  • Sample Companies Duplicate Check Object (AptifyCompanyDupeCheck.dll): When a user attempts to save a new Companies record, this sample object checks for existing Companies records that have the same exact Name. If any matches exist, Aptify identifies these records as potential duplicates.

By default, the Aptify installer adds these sample objects to the Aptify Object Repository, but the duplicate checking functionality is not enabled.
Follow these steps to turn on the sample duplicate check object for the Persons and/or Companies entity:

  1. Open the Entities record for Persons or Companies and click the Plug-Ins tab.

Entities Record

  1. Click the New icon in the sub-type toolbar to open a new Plug-Ins record.
  2. Select Duplicate Check from the Plug In Type drop-down menu.
  3. Enter the Object Repository location for the sample duplicate check object in the Object field.
  • For the Persons duplicate check object, enter CRM.AptifyPersonDupeCheck.
  • For the Companies duplicate check object, enter CRM.AptifyCompanyDupeCheck.
  1. Enter the object's Assembly Name in the field provided.
  • For the Persons duplicate check object, enter AptifyPersonDupeCheck.
  • For the Companies duplicate check object, enter AptifyCompanyDupeCheck.
  1. Enter the applicable Class Name in the field provided.
  • For the Persons duplicate check object, enter Aptify.Applications.CRM.PersonDupeCheck.
  • For the Companies duplicate check object, enter Aptify.Applications.CRM.CompanyDupeCheck.

Plug-Ins Record

  1. Click OK to save and close the Plug-Ins record.
  2. Save and close the Entities record.
  3. Close and reopen Aptify.
  4. Test the duplicate check object by attempting to save a new Persons or Companies record that has the same name as an existing record.

Duplicate Check -Message

  • No labels