QEST Web API Installation Guide
- Mark Elkomos
Applies to QEST Web API
This article details the installation process for the QEST Web API product. This includes installation, configuration and solutions to common problems.
Contents
Overview
QEST Web API is a RESTful API for QESTNet which is hosted via Internet Information Services (IIS). A connection to an instance of the QESTNet service is required, through which it can connect to the QEST Platform database. In addition, for the QESTField Forms app to communicate with the QEST Web API, IIS and firewalls must be configured to permit this.
Installation guide
Prerequisites
The following must be present in the target environment to install the QEST Web API.
Machine
Windows Server 2008 R2, Windows 7 or later (64-bit).
Microsoft .NET Framework 4.6.2 or later. If required, this will be installed via the QEST Web API installer if the environment has internet access.
Internet Information Services 7.0 or later with default features plus ASP.NET v4.5.
Note: For the QESTField Forms mobile app to be able to communicate with the QEST Web API, IIS and any firewalls must be configured to all this.
Services
QESTNET v4.6 or higher, accessible via TCP or HTTP
Installation Files
Installer QESTWebAPI.Installer.Ma.Mi.B.R.exe where Ma, Mi, B and R are the major version, minor version, build and revision numbers. E.g. QESTWebAPI.Installer.4.6.2895.26827.exe
Installation Process
If Microsoft .NET Framework 4.6.2 requires installation, internet access is required during the QEST Web API installation process.
Run the provided installer.
If required, click on Options to change the installation options listed in the section below.
Agree to the terms and conditions and click Install. The installer will install and turn on any required Windows features before installing the QEST Web API.
Depending on the options set above, the QEST Platform website may need to be manually configured and/or started via the IIS Manager before the QEST Web API can be accessed.
QEST Web API is now installed and ready for use.
Installation Options
Setting | Description | Default |
|---|---|---|
Install location | Path to which the QEST Web API files will be installed (under sub-folder |
|
Configure QEST Platform website and QEST Web API application | If checked, the installer will automatically set up the IIS configuration for the QEST Platform website and QEST Web API application. Uncheck this option for systems which require manual configuration via the IIS Manager. | Checked |
Force start QEST Platform website | If checked, the installer will attempt to stop all websites running on the default port (80) so that the QEST Platform site can be started. | Unchecked |
Configuration guide
AppSettings.Config
AppSettings.Config is the only configuration file that requires user input prior to starting the web api.
<appSettings>
<add key="QESTNetAPIServiceUri" value="http://localhost:53535/" />
<add key="EnableSwagger" value="True" />
</appSettings>QESTNetAPIServiceUri: The Uri of the QESTNET service. Assuming QESTNET is installed on the same server as the web api, the default will be http://localhost:53535/
EnableSwagger: When set to "True", this will allow the swagger documentation to be visible via the web api. This can be accessed by going to the root uri of the web api and clicking on the Swagger link.
Troubleshooting guide
Installation
Unspecified Error
The following installation error ‘0x80072ee7 – Unspecified Error’, is most likely due to the installer being unable to download and install .Net Framework 4.6.2.
The issue can be confirmed by viewing the log file and looking for the following: Failed attempt to download URL: 'http://go.microsoft.com/fwlink/?LinkId=671728' to: 'C:\Windows\Temp{B321459C-617D-4C9F-8C70-15AEEE5945CF}\NetFx461Web'
Fix: To install the QEST Web API, download .NET Framework 4.6.2 and install it prior to installing the QEST Web API. The .NET Framework 4.6.2 Installer can be found here: https://www.microsoft.com/download/details.aspx?id=53344
Reporting Errors
If the information above has not resolved your issue, the Spectra QEST Service Desk procedure (Product Support Procedure Overview) should be followed to report the problem.
Configuration Changes
When changing the config files that are part of the installed QEST Platform IIS website, be sure to Stop and Start the QEST Platform site to reload the website with the changes. If you just click Restart the config changes will not be loaded.
Related content
Integrity | Curiosity | Empathy | Unity
The content of this page is confidential and for internal Spectra QEST use only. Do not share, duplicate or distribute without permission.