Equisys technical notes

Technical guidance, explanations and fixes for our products

HOWTO: Configure the Zetafax API to work with a web-based application



ID: ZTN1740

This Zetafax technical note applies to:

  • Zetafax API – all versions


This technical note provides information on how to configure the Zetafax API so that it can be accessed from a web-based application.

More information

The Zetafax API needs to be hosted inside a COM+ package. To do this, please perform the following steps:

  • Ensure that the Zetafax Server is installed on a machine that your IIS server can access.
  • Ensure that your Zetafax Server is licensed to use the API.
  • You now need to install the Zetafax API onto your IIS machine.

There are two ways to accomplish this:

  1. The first method is to install the Zetafax Client and then run it once (connecting to your Zetafax Server). This will create the ZFCLIENT.INI file that API reads to determine which Zetafax Server to connect to. Please refer to the Zetafax help files for details on installing the Zetafax Client.
  2. The second method is to do the following:
      • Copy the Zfapi32.dll from the Zetafax Server < program files> \< common files> \Equisys\ folder on the Zetafax Server machine onto the IIS server in a folder of your choosing.
      • Register the API dll using regsvr32.exe
      • Ensure that you use the ZfAPI.SetZetafaxDirs method in your web application to tell the API where the Zetafax Server is located.
  • The Zetafax API is now ready to be configured for use with IIS. 
  • Logging on as an account with Local Administrator permissions on your IIS server, open Component Services. To do this:

                        Select Start à Programs à Administrative Tools à Component Services

  • Open the Component Services tree item and browse to the following area:

                        Computers à < computer_name> à COM+ Applications

  • Right-click on COM+ Applications and select New à Application.
  • The COM+ Application Install Wizard is displayed.
  • Select Next and then choose the ‘Create an empty application’ option.
  • Enter a name for your COM+ Application, such as Zetafax Web Components. Make sure that the Activation Type is set to Server Application.
  • Specify the user that the COM+ package will run as. This should be a named account that has read/write permissions to the Zetafax Server folders.
  • Select the CreatorOwner role and click Next.
  • Optionally, add any additional users that you need to and select Next.
  • Click Finish.
  • You now need to add the Zetafax API dll into the COM+ Application. To do this:
    • Find the newly created Zetafax COM+ Application in the left-hand tree structure of the Component Services window and expand it so the sub element called Components is visible.
    • Right-click on Components and select New à Component.
    • Click Next on the first screen of the wizard.
    • Select the ‘Import Components that are already registered’ option.
    • Select Zfapi32 from the list.
  • Your COM+ Application is now ready to be accessed from your web application.

Last updated: 2nd July 2009 (GR/MW)

Equisys Logo, Document Management and Expense Management for Business Central

Replaced by script