Installation Checklist

SmartIQ can be installed in a variety of deployment models from a single server to a server farm. A development environment can be set up on a single server with sufficient resources. Test and production environments may require a distributed architecture based on performance requirements. This document explains detailed steps to install SmartIQ for development, test and production purposes.

For detailed system requirements, refer to this document.

Installation Planning Checklist

Below is a checklist to help prepare for installation of the SmartIQ software. It is recommended that you review these items carefully to ensure you have everything in place and that the target environment is prepared according to the system requirements and recommendations.

Deployment Planning

• Determine the target environment type.

  • Development
  • Testing
  • Staging
  • Production
  • Other (e.g. Demo or PoC)

• Determine what deployment topology will be used for this deployment.

  • Single Server Deployment
  • Standard Two-Tier Deployment
  • Standard Scale-Out Deployment
  • Three-Tier Deployment
  • Other (e.g. Azure PaaS)

• Identify what server(s) you will need.

  • IIS Web Server(s)
  • SQL Server Database Server(s)
  • Reverse Proxy / Network Load Balancer

• Consider any network requirements that may apply.

  • DNS records
  • Firewall Exceptions
  • Proxy / Reverse Proxy / Network Load Balancer configuration
  • SSL Certificates
  • Active Directory users and groups if using Windows Authentication

• Define SmartIQ instances and naming.

  • SmartIQ instance names, e.g. ‘smartiqdev’ or ‘HRForms’.
  • Determine relevant target instance URL names for Manage and Produce sites. This will be useful when setting up IIS and also may be important for configuring DNS records, e.g. https://smartiqsvr.hostname.internal/dev/produce.
  • Determine the name of other components to be installed and configured, such as the database and database login names – it may be worthwhile developing a naming convention if one doesn’t already exist.

System Requirements

• Check the IIS web server(s) against the Web Server requirements discussed here
• Check the SQL Server database server(s) against the Database Server requirements discussed here

Server Access

• Ensure you have full administrator access to all IIS web servers and SQL Server database servers (access the server either physically or remotely, e.g. permission to allow Remote Desktop access.)
• Ensure you can access all SmartIQ installation media from the target servers. This may require access to an external drive, optical disc, website or FTP server, depending on where the installation media is available.
• If applicable, confirm that any security procedures are followed to ensure there is no possible breach in gaining access to the target environment.

Installation and Configuration

• Review the installation steps in this guide and ensure you have all the installation media required.
• Take note of web server and database server names. You will need these during the installation.
• If additional components, connectors or custom solutions are to be installed, ensure you have the installation media and any additional documentation ready.
• Make sure you have a valid SmartIQ license to be applied.

Installation Considerations

• For new installations, the Audit Log, Generation Log, and Workflow retention settings will be set to 1 year (or 365 days), and Event Log will be set to 90 days.
• Windows Offline App is now only available as appx.

Security Considerations

• The Encrypt Data option will always be on by default for all new installations. Once the Encrypt Data option has been enabled, it cannot be disabled. Upgrades will not modify this setting.

📘

Notes

This checklist may not cover all consideration needed for every installation, and equally, it may include items that are not relevant. Use this checklist as is or adapt it to your needs.