Install and Configure the API Module 8

Updated in 8.5

IMPORTANT: If you are migrating from Alloy Navigator Express to the Alloy Navigator Suite of the same major version, perform the installation of the Alloy Navigator Suite components on a separate computer. These product versions are incompatible.

IMPORTANT: The API module was introduced in version 7.1. If you are upgrading form an earlier version, skip this step and install the API module later. For details, see Install and Configure the API Module.

Install the new version of the API module on the web server (IIS server) which currently hosts your production API module version, to a pilot web site. For details, see Pilot Web Site for New Web Services.

INFO: For the full list of preliminary considerations and preparations for the API module, see Installing and Configuring the API Module.

  1. Run the AlloyInstaller.exe file from the network share, where you saved extracted installation files earlier. Alternatively, you can run the Alloy Installer and extract its temporary files again.

  2. Click Advanced Installation. The Advanced Installation page appears.

  3. Click Install Alloy Navigator API 8.7.x.

    The installation wizard will automatically analyze your computer, and test for prerequisites. If any of the tests fail, the wizard displays a warning message along with a hyperlink, which shows additional information about the encountered issue.

    You can make the necessary changes and then recheck the prerequisites by clicking Recheck. To go back to the Advanced Installation page of the installation wizard, click Close.

  4. Click Install to proceed. The Setup Wizard starts.

  5. On the Welcome page, click Next. The End-User License Agreement page opens.

  6. Review and confirm the terms of the license agreement, then click Next. The Installation Folder page opens.

  7. Click Next to install the API module to the default Alloy Navigator 8 installation folder (\Program Files (x86)\Alloy Software\Alloy Navigator 8\). If you want to install the API module to a different folder, click Change, browse to choose the installation folder, click OK to return to the wizard page, and click Next.

    The Ready to install... page appears.

  8. Click Install to begin the installation. Click Back if you need to review or change any of the choices you made.

  9. On the Completed... page, keep the Run the Web Configuration check box selected.

    Click Finish to complete the installation process.

The Web Configuration tool for version 8 opens, and the Create Alloy Navigator API wizard starts.

Configure your pilot API module 8 using the configuration settings imported from your production API module version.

TIP: If you cleared the Run the Web Configuration check box when installing the API module version 8, you can launch the Web Configuration tool for version 8 when needed using the Alloy Control Pane or from the Start menu.

  1. On the Alloy Navigator API Creation Mode page, keep the Import Alloy Navigator API configuration settings option selected. Then specify the directory containing the production API module version. To help you identify this directory, the Web Configuration tool 8 displays a grayed-out identification icon next to its name.

    Click Next. This imports all configuration settings from your production API module to your pilot instance of the API module 8.

  2. On the Database page, specify the Database Access Key that the API module will use to connect to your pilot Alloy Navigator 8 database. Typically, this page will appear with all fields populated. However, you can import the key or fine-tune the database connection details, if needed.

    1. Click Import Key to import the Database Access Key.

      INFO: For details, see Importing the Database Access Key.

    2. Fine-tune the database connection details, if needed: in the SQL Server field, enter the network address of the SQL Server, which may differ from the SQL Server name specified in the Database Access Key. Click Next.

    3. On the Timezone page, specify the timezone of Alloy Navigator . The Web Configuration tool suggests the timezone of the IIS server where the API is installed. To change this setting, choose the timezone that you want from the Timezone list. For instructions, see Choosing Timezone.

    Click Next.

  3. Navigate to the Installation Type page. Specify where to install the API module. We recommend that you use a pilot web site.

    INFO: For details, see Pilot Web Site for New Web Services.

    Click Install into a virtual directory, then click Next.

  4. The Web Site page displays all web sites available on your IIS server. Select the pilot site that you created earlier (in our example, it is Alloy Navigator 8 Pilot Site), and click Next. The Virtual Directory page opens.

  5. Keep the default name for the virtual directory to create or type in a different name. Click Next.

  6. Navigate to the Ready to Apply Settings page opens.

  7. Click Apply to apply your settings. Click Previous if you need to make any changes. Wait for the Web Configuration tool to configure the portal.

    When completed, the Web Configuration tool shows the Apply Navigator API page with newly applied settings. Using the Configure buttons you can adjust any settings, if needed.