Installation Guide

Installing the API module

To install and configure the API, you must have administrative privileges on the local computer. Also, your account must belong to the securityadmin role on the SQL Server where your Alloy Navigator database is hosted.

NOTE: Typically, a single web server hosts all Alloy Navigator web applications. However, you can install the API module on a dedicated server computer, if needed.

To install the API module:

  1. Run the Alloy Navigator Enterprise 2024 Installer.

  2. By default, the installer extracts its installation files to the C:\AlloyNavigator-24.1.x.cd folder. If this folder does not exist, the installation wizard will create it.

    NOTE: If you want to change the destination folder, click Browse and make a new temporary folder for installation files.

    TIP: If you need to install Alloy Navigator components on multiple computers, you can copy this folder to a network share and then run the AlloyInstaller.exe file from there. If no longer needed, this folder and its content can be manually removed after the upgrade has finished.

    Click Extract. After the installation files are extracted, the Welcome page opens.

  3. On the Welcome page, click Advanced Installation.

  4. On the Advanced Installation page, select Install Alloy Navigator API.

    The installation wizard will automatically analyze your machine and test for prerequisites. If any of the tests fail, for example, if your computer has insufficient RAM size or hard drive space, or Microsoft .NET Framework 4.8 is missing, the wizard displays a warning message along with a hyperlink, which shows additional information about the encountered issue.

    • Information - Indicates missing software components that will be installed automatically.

    • Warning - Indicates missing software or partially met requirements that may result in the incorrect work or inoperability of the installed software.

    • Error - Indicates not met requirements that prevent the installation.

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

  5. Click Install to proceed with the installation after checking the prerequisites. The Setup Wizard starts.

  6. On the Welcome page of the Setup Wizard, click Next.

  7. On the End-User License Agreement page, review the license agreement and, if you agree, confirm the terms of the license agreement, and then click Next.

  8. On the Installation Folder page, click Next to install the API module to the default Alloy Navigator 2024 installation folder (\Program Files\Alloy Software\Alloy Navigator 2024\).

    TIP: 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 then click Next.

  9. On the Ready to install page, click Install to begin the installation. Click Back, if you need to review or change any of your settings.

  10. When the installation is complete, the Completed page opens.

    After the installation of the API module, you should configure it using the Web Configuration tool.

    If you want to launch the tool now, keep the Run the Web Configuration check box selected. If you want to configure the API module later, clear this check box.

    INFO: For details and instructions on configuring the API module, see Pre-Configuration Considerations and Configuring the API module.

    Click Finish to complete the installation process.