The Sample Import Filter

Writing a new import filter entails creating a 32-bit DLL that implements all of the predefined API functions, and then copying this DLL to the folder where SBCM is installed. This SDK has three major sections:

• Import Filters for the Microsoft Small Business Customer Manager — The document you are currently viewing. This document provides an overview of how the filters work.
  
  
• SBCM API and Data Structure Reference — The reference document for the API's and data structures used in this SDK.
  
  
• Release Criteria for Testing SBCM Filters — A list of guidelines to use when testing your SBCM filter.

To make the task of creating a new import filter easier, the SBCM Filter SDK includes a sample filter project created with Microsoft Visual C++ version 6.0. You can compile the sample project and run it within the SBCM environment to create simple hard-coded data. The sample illustrates the basic requirements of a filter; it does not perform any file input/output (I/O).

The sample project includes the following files (among others):

• Aaxyz.dll — The import filter DLL created from the sample project.
  
  
• Aaxyz.cpp — The richly commented C++ source file for the sample import filter.
  
  
• Aacommon.h — The richly commented header file containing definitions for the structures used by all import filters, including the sample filter.

The Aaxyz.cpp file contains an implementation of each API function that every import filter must support. By compiling the project and stepping through the code, you will learn the sequence in which the Import Wizard calls the API functions. Also, you can use Aaxyz.cpp as a template, studying and modifying it as necessary while you create your own import filter. Comments in the code identify areas where you will typically need to make modifications. For most import filters, these modifications include:

• Adding code for file I/O to retrieve data from your files.
  
  
• Adding code to handle conversion from your files' data types to the data types required by the structures.
  
  
• Adding code to properly map your accounts in a chart of accounts to the predefined account categories that the Import Wizard understands (SBFM functionality only).