Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

An organization can configure an entity to use a specially designed form or specialized functionality. To implement this specialized behavior, a developer creates a .NET assembly that defines the entity's extended functionality. These assemblies are then stored in the Object Repository and are added to the entity on the Plug-Ins tab using the Plug Ins record. The entity uses the plugins specified on this tab to override standard functionality with the functionality specified in one or more plug-ins.

Plug In Types

The Entity Plug In Types service stores the list of available plug-in types. Plug-in types may be global or entity-specific. A developer can create additional Plug In Types as necessary. See Entity Plug In Types Form for information on this form.

The standard Aptify installation includes seven global types as well as a number of entity-specific types. This section describes the global types.

  • Viewer (1): This plug-in type corresponds to an alternate data form for the entity. In Aptify, entities with specialized viewer forms include Views, Entities, Archive Runs, Scheduled Tasks, and Base Fields.

  • Entity (2): This plug-in type indicates that the object implements specialized business logic for the entity. Typically, this plug applies to entities that require additional functionality beyond the standard implementation. For example, the Views, Entities, Archive Runs, Scheduled Tasks, and Base Fields entities all have an Entity plug-in.

  • Duplicate Check (3): This plug-in type corresponds to an object that implements entity-specific duplicate checking behavior.

  • Extension (4): This plug-in type corresponds to an object that implements an entity-specific right-click context menu.

  • Verification (5): This plug-in type corresponds to an object that implements entity-specific record verification behavior.

  • Find (6): This plug-in type corresponds to an object that implements an -entity-specific Find dialog.

  • Merge (7): This plug-in type corresponds to an object that implements -entity-specific record merging behavior.

  • Excel Integration (37): This plug-in type defines the Excel Export wizard for the entity and overrides the default Excel Integration logic specified in the Views entity (or the core Excel Integration component if a default integration plug-in is not specified in the Views entity). You can also define a default configuration for all views within Aptify using the Excel Integration Default plug-in type o f the Views entity. See the Excel Integration WizardExcel Integration Wizard section of the ReportingReporting chapter in the Aptify User Guide for more information.

  • Data Pack: This plug-in defines the Data Pack Wizard for the entity and overrides the default packing logic.

  • Data Unpack: This plug-in defines the data unpack Wizard and overrides the default unpacking logic.

Step-by-Step Instructions

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

...