Configure the Apache Server Application Programming Interface for a Library - Author-it On-Premises - Author-it

Author-it Development Documentation

  • To Configure a Library for the Server Application Programming Server:

  1. Configure the Apache Server Application Programming Interface installation.

  2. Select Libraries in the left pane.

  3. Choose Add Library. In the Add New Library window select the database type, either SQL Server or Jet. The window displays the options for the library type; complete the options required to link to the library (refer to the following option descriptions for more information). Choose Add to save the settings to the library list.

  4. Save the changes to this screen.

    Note: You must click Save to save the settings to the configuration files. The tool does not automatically save your changes when you click Close.

The Author-it API Server Library options

This section describes the library settings used by the API Server Configuration Tool.

SQL Server options:

  • Alias: provide a user-friendly name for the library database. The alias can be a shortened and easy to remember version of the database name, and is used to log in to the library. (For example, Acme when the full database name is Acme Production Library.)

  • Server: provide the server name where the library database is stored.

  • Database: provide the full name for the library database.

  • Login method: check the Trusted Connection check box to use Windows authentication, or provide user credentials for the database login.

Jet options:

  • Alias: provide a user-friendly name for the library database. The alias can be a shortened and easy to remember version of the database name, and is used to log in to the library. (For example, Acme when the full database name is Acme Production Library.)

  • Path: browse to the Jet database .adl file.

    Note: While the API Server Configuration Tool supports configuring a Jet library for access by the Apache Server Application Programming Interface we recommend using only SQL Server hosted libraries with the Server Application Programming Server.

After you initially install and configure the Server Application Programming Server you may need to modify the settings.

  • To Reopen Existing Settings in the API Server Configuration Tool:

  1. Open the API Server Configuration Tool.

  2. Select API Server in the left pane. In the API Server screen click Configure Author-it API Server Installation then browse to the Author-it API Server install folder. After selecting the install folder, the screens in the configuration tool update and display the existing settings.