API System Requirements

Information

The information presented here applies to Issuetrak 10.0 through 11.1.

The Issuetrak API requires the Issuetrak application to be installed as the base application platform. In addition, the Microsoft .NET Framework 4.6.2 update must be installed on the application server.

The Issuetrak core product may be installed either on separate web and database servers or on a single server functioning as both web and database server. For a full listing of System Requirements for the Issuetrak product, please see the Issuetrak System Requirements.


Web Server Requirements

  • CPU Requirements:
    • Minimum Dual Core 1.8 GHz CPU
  • RAM Requirements:
    • Minimum 4 GB available RAM
  • Hard Disk Requirements:
    • Minimum 4 GB available hard disk space
  • Operating System Requirements:
    • Microsoft Windows Server 2008 R2 SP1, 2012 or 2012 R2, or 2016 (32-bit or 64-bit; Standard, Enterprise)
  • Web Server Requirements:
    • Microsoft Internet Information Services (IIS) version 7.5, 8.0, 8.5, or 10.0
    • Web Server (IIS) installed as a Role in Windows Server Manager with the following Role Services installed:
      • Common HTTP Features: Static Content
      • Application Development: ASP and ISAPI Extensions
      • Security: Request Filtering
      • Performance: Static Content Compression
  • Microsoft .NET Framework Requirements:
    • Microsoft .NET Framework 4.6.2
  • Other Requirements:
    • Up to Issuetrak 10.3.9: Microsoft Distributed Transaction Coordinator (MSDTC)

It is strongly recommended that all available service packs and security patches be applied to both the web server’s core operating system and the .NET Framework. The latest service packs and cumulative updates for Microsoft Windows Server products can be reviewed at the Microsoft TechNet Windows Server web page.

The API project must be configured to execute within a distinct application pool from the Issuetrak web application. Ensure that the .NET Framework branch selected for the application pool is a version 4 variant, and ensure that the “Managed pipeline mode” is set to “Integrated.”

API1.png
 

IIS REQUEST-FILTERING MODULES

Please note that certain IIS modules such as URLScan may interfere with HTTP request distribution to the API site endpoints. In particular, any modules that restrict or deny requests with the HTTP verbs GET, POST, PUT, and DELETE must be reconfigured to permit access for HTTP requests using those HTTP verbs for the API site.

SSL CONFIGURATION

It is strongly recommended that the hosting web server be configured with only HTTPS (Secure Hypertext Transport Protocol) bindings. This step requires the configuration of a Secure Socket Layer (SSL) certificate.

Implementing this recommendation will require the installation of an SSL certificate on the hosting web server. There are two typical scenarios for installing an SSL certificate within IIS. The first scenario involves creating a self-hosted certificate, a certificate type that is submitted to a Certificate Authority (CA) that is a server under the control of the hosting organization. The second scenario involves requesting a third-party certificate, a certificate issued by an external CA. Examples of certificate vendors that issue third-party certificates include (but are not limited to):

The following Microsoft knowledgebase articles provide step-by-step instructions for requesting a certificate, installing the certificate within IIS, and setting the HTTPS binding for a site so that only SSL connections are permitted.

In addition, the application pool identity that is assigned to the Issuetrak API application pool must have read and write permissions on the folder used to store Issuetrak attachments. The following Microsoft IIS article provides detailed information on not only configuring IIS Application Pool Identities but also configuring the security for resources such as files and folders.

Database Server Requirements

  • CPU Requirements:
    • Minimum Dual Core 1.8 GHz CPU
  • RAM Requirements:
    • Minimum 4 GB available RAM
  • Hard Disk Requirements:
    • Minimum 4 GB available hard disk space
  • Operating System Requirements:
    • Microsoft Windows Server 2008 R2 SP1, 2012 or 2012 R2, or 2016 (32-bit or 64-bit; Standard, Enterprise)
  • Database Server Requirements:
    • Microsoft SQL Server 2012 or later (32-bit or 64-bit in either Standard, Enterprise, or Business Intelligence Edition)
    • Full-Text Search feature must be installed
  • Settings:
    • Access to “C:/Program Files (x86)” or “C:/Program Files” directory.
    • Region and Language Settings should have the current locale set to “English (United States)”
    • TCP/IP and/or Named Pipes protocols enabled in SQL Server
  • Microsoft .NET Framework Requirements:
    • Microsoft .NET Framework 4.6.2 (or greater)
  • Other Requirements:
    • Up to Issuetrak 10.3.9: Microsoft Distributed Transaction Coordinator (MSDTC)

It is strongly recommended that all available service packs and security patches be applied to both the database server’s core operating system and the database server software itself. In addition, the database compatibility level must be set to a minimum level of 100 (Microsoft SQL Server 2012).

The latest service packs and cumulative updates for Microsoft SQL Server can be reviewed at the Microsoft TechNet Update Center for Microsoft SQL Server.