Plugin Processors

Plugin processors allow custom processing actions to be integrated into SOLO Server. Currently, SOLO Server supports custom order processing plugins which are called during checkout after standard order processing has completed, custom activation plugin processors which run during activation attempts, as well as custom daily processing plugins run by the daily processor.

Order Processing Plugins can be specified in three places:

• Cart Options - The plugin will be called for all orders.
• Distributor - The plugin will be called only for orders associated with the given distributor.
• Warehouse - The plugin will only be called if the order contains items associated with the given warehouse.

Activation Processing Plugins can be specified on the product option as follows:

• Activation Threshold Plugin - The plugin is run in place of the standard SOLO Server activation logic which determines if the activating computer matches a previously activated computer on the same license.
• Pre-Activation Plugin - The plugin is run prior to the standard SOLO Server activation logic to perform additional processing and verification of the activation. This type of plugin can prevent activation.
• Post-Activation Plugin - The plugin is run after the standard SOLO Server activation logic to perform additional processing.

Daily processing plugins are configured by setting the process type of a given daily process to Custom Plugin, and then selecting the appropriate plugin from the drop down which appears.

Depending on the plugin type, it may be necessary for an administrator to upload files to the PluginAssemblyPath specified in the web.config options and/or apply updates to the SOLO database.

To configure plugin processors, choose Admin / Plug-ins from the menu. This will display a list of existing plugins, with an option to view, edit, or delete for each plugin. To add a new plugin, click the Add New button. Note that if you delete a plugin, it will automatically be disassociated from any product options, distributors, warehouses, or cart options records it is tied to, and this action cannot be undone.

The plugin configuration fields are as follows:

Name

Friendly display name for the plugin. This will be displayed in the drop downs where plugins can be selected.

Type

The Plugin Type, which can be one of the following:

• .NET Assembly - Plugin logic is implemented in a .NET assembly file.
• Database Stored Procedure - Plugin logic is implemented in a SQL Server stored procedure. Note that only order processing plugins currently support this plugin type.

Assembly Path

Relative path to the plugin assembly from the root of the Plugin Assembly Path. Applicable only to .NET assembly plugin types.

Interface Name

The interface name to load from the plugin assembly. Applicable only to .NET assembly plugin types.

Stored Procedure Name

The name of the database stored procedure to call. Applicable only to database stored procedure plugin types.

Description

Extended description of the plugin.