Scanning Service Installation

1. Click next.

1. Accept the End-User License Agreement.
   
   
   
2. Click next.

The Typical and Complete options install the scanning service, the UI and the API on a single device (POC and basic estate scenario). More complex set-ups will separate the other components from the Scan Engine.
This document will identify how to install the scanning service, UI and API onto a single device.

1. Click Typical button to give to start install.

1. Option 1: Provide the name of a local database to be used by the Scan Engine.

This example uses:

• A DB on the same machine as the Scan Engine. If this is the first installation, the specified DB will be created. Subsequent installation will re-use the existing DB.
  
• The current identity of the logged in user to create and populate the scan database. The user specified must have appropriate DB permissions.

1. Option 2: Select a remote database to be created and used by the Scan Engine.

This example uses:

• A DB on different machine as the Scan Engine. If this is the first installation, the specified DB will be created. Subsequent installations will re-use the existing DB.
  
• The DB specific user to create and populate the scan database. The user must have appropriate DB permissions.

Server\instance: Define the server/instance on which the new database is installed.
If the server is located on the machine then the server value can be omitted or replaced with localhost; otherwise, the server name of the machine that is hosting the SQL Server Instance must be provided.

Database name: Define the database name that is to be created. For example: iQuateSE.

Authentication type: Select Windows or SQL Server authentication.

• Windows authentication uses a domain defined user name that is provided with access to the DB.
  
• SQL Server authentication uses a SQL Server defined local user

Username: Enter the username to access the database. This identifies the user that accesses the DB to create the required DB and save scanned information.

Password: Specify the password to access the database.

Test (Button): Test the login details for the database.

1. Test the connection.
   
   
   
2. Click OK to close the test window.
   
   
   
3. Click Next.

1. Confirm that the pre-requisites for the install have passed and correct any failed tests.
   
   
   
2. Click View Details is you wish to see the criteria that were checked or if a failure occurs.
   
   
   
3. Click next.

1. Select the Create a new key option
   
   
   
2. Click next.

• This encryption key is a customer specific key used to control access to credentials used within the scanning server. This key should be retained for future use. The iQSonar Scan Engine security documentation provides additional information about this feature.
  
• The generated key will be displayed at the end of the install process.
  
• You need to define the connection details for the Web Interface components.

1. Select your Scan Engine UI virtual directory. This will modify the URL used to access the user interface.
   
   
   
2. Enable Active Directory account login if required active directory user login is required for the UI.

1. Click the check box if the scan engine service and UI are to be started following the installation.
   
   If you want to install additional 3^rd party libraries then uncheck the Start iQSonar Scan Engine Service option.
   See Section 5 for additional details.

1. Click install.
   The summary of the details of the install are displayed.

1. Click Finish.
   The Scan Engine Service and UI will be launched at the completion of the installation (unless this option was previously unchecked).

1. Remember the encryption key that is generated when the 'Create new key' is selected in the encryption key section of the installation process.

This customer encryption key is used to control access to credentials used within the scanning engine. This key should be retained for future use. See the Security documentation for additional information. NOTE: Make a backup of this file. If it is not saved at this point, it could be lost permanently.

At this point, the iQSonar Scan Engine should be installed and running. In the event that the scan engine service fails to start, the most likely problem is that the server hosting the service does not trust the Authenticode certificates used by iQuate to sign the code. Appendix B lists the steps necessary to address this issue.