Appendix A. File-AID/EX Application Programming Interface (API)

FacsAPI

FacsAPI lets users customize their own applications to make use of File-AID/EX Communication Manager and Execution Server functionality. Via the API, a user’s applications can access objects in the repository, execute Extract, Load, ConverterPro and Compare Specifications, and retrieve execution results. Users can develop applications in Java, C++, VB, or any Windows programming language that supports COM.

C++ Specific Information

Detailed C++ API documentation:

<FAEX_Install_Dir>\FACSAPI\CPP\Doc\index.html

C++ sample programs can be found in:

<FAEX_Install_Dir>\FACSAPI\CPP\Samples

To compile the C++ program add:

<FAEX_Install_Dir>\FACSAPI\CPP\Include

to the include path. Link your C++ program with facsAPI.dll, which can be found in the product install directory.

Java Specific Information

Detailed Java API documentation:

<FAEX_Install_Dir>\FACSAPI\Java\Doc\index.html

Java sample programs can be found in:

<FAEX_Install_Dir>\FACSAPI\Java\Samples

To use the File-AID/EX Java API, add FACSAPI.jar to the class path. FACSAPI.jar is located in the product install directory in the Dme folder.

VB Specific information

Detailed COM API documentation:

<FAEX_Install_Dir>\FACSAPI\VB\Doc\index.html

VB sample programs can be found in:

<FAEX_Install_Dir>\FACSAPI\VB\Samples

To call FACSAPI from the VB program, select References from the main menu in Visual Basic and select facsAPICom 1.0 Type Library.

The facsapiCom.dll can be found in the product installation directory.