Agent Guidance Core User Guide

Please email support@creovai.com for omissions or errors.
×
Menu

Agent Guidance Install Wizard

 
This article can be followed for a standard single server system. For more best practice regarding complex systems, please refer to Installing a Redundant Agent Guidance Solution. Details on how to obtain the Agent Guidance installer can found in the Agent Guidance Installer Files article.
 
1) Installer Route
Select "Add New Instance".
 
 
 
2) Prerequisite Check
The installer will check the server for required components. Any not present will be highlighted, and the Next button will be unavailable until the prerequisites are met. A refresh icon will appear next to any that have been flagged, and once installed the red flags can be cleared to enable you to proceed to the next step.
 
If all prerequisites are present, then the installer will skip over this page.
 
 
 
3) Instance Naming
Enter a name for your Agent Guidance website. This is what the website will be called in IIS, and the name of the instance's filesystem subfolder (see Step 9). As such, it should be unique within the webserver, but can be shared by instances on different webservers within the same System.
 
Note: when installing a System comprising multiple instances for purposes of resilience or scale, it may be desirable to name each instance within the System differently so as to be able to identify the site that a User is currently connected to via the About Section if needed. For example: AgentGuidance_Production_1
 
 
 
4) SQL Server Credentials
Enter the administrator credentials of the SQL server you wish to create the Agent Guidance database in. The username/password entered will need sufficient privileges to create databases, users and roles on the SQL server specified. These credentials are only used during the the system install, and are not carried through to the application.
 
 
 
5) Created Database Name
Specify the name of the Agent Guidance database. By default, this will match the name provided for the instance in Step 3.
 
Note: when installing a System comprising multiple instances for purposes of resilience or scale, it is generally desirable to name the System as the "generic" version of the variants used for the individual instances. For example: if the instances are AgentGuidance_Production_1 and AgentGuidance_Production_2, then name the System AgentGuidance_Production.
 
Note: when installing a new instance into an existing System, simply provide the same database name at this step. A number of the subsequent steps will then be skipped, as they have already been dictated by the original System's installation.
 
 
 
6) Licence Type
Agent Guidance may be licensed in one of two ways. You may have been provided with a Licence key (GUID), or a Licence file to upload. If you do not have a Licence, please contact your Agent Guidance vendor.
 
For further information on the Agent Guidance Licence file see the Agent Guidance Licensing Structure page.
 
 
 
7) System
Where you have more than one System associated with your Licence, you should choose the System you wish to install. Each System can have different licensable features, and you may have separate development and production environments on the same Licence.
 
A Agent Guidance System will not be listed as available for installation on a webserver that isn't defined for that System within the licence.
 
 
 
8) Local Install Location
Choose the location that the instance-specific folder for Agent Guidance will be created.
 
Note: the Agent Guidance instance will be installed in a subfolder of the specified location, named for the Agent Guidance instance name, and as such it's suggested to leave this as the default. So in this example, Agent Guidance would be installed to C:\Program Files\Creovai\AgentGuidance_Production\
 
 
 
9) Host Header and Port
The Host Header and Port that the Agent Guidance website will run under can be specified here.
 
Note: the site will be created with only an HTTP binding on the specified port. It is recommended that an HTTPS binding be set up after installation via IIS.
 
 
 
10) Authentication
Agent Guidance can be configured to run in Forms or Windows Authentication schemes. This cannot be simply changed at a later date.
 
Note: it is strongly recommended to use the default of Forms Authentication, as this supports both traditional username and password login as well as Single Sign On.
 
 
10a) Forms Authentication
Note: the SQL permission specified here will be used for operational access to the database by Agent Guidance, and can either specify a minimally-permissioned account, or provide new details for a user that will be automatically created by the installer with the minimum permissions.
 
 
 
10b) Windows Authentication
Note: all Agent Guidance users need to be a member of both Windows groups specified in this step, and a single group can be used for both items.
 
 
 
11) Cache Server
Configure the caching settings for Agent Guidance to use.
 
If making use of Redis Sentinel, then the Redis URL and Port should instead reflect the current Sentinel master, and the Sentinel Service Name should be populated. See the Redis Sentinel article for further information.
 
Note: please ensure that the specified database number for the connected Redis server isn't in use by any other Agent Guidance Systems or other applications. A common mistake is to use the same database number for both a production and development System, and this will cause errors within both Systems.
 
 
 
12) Localisation
The chosen localisation setting will affect the language used in Agent Guidance.
 
 
 
13) Summary
A summary of the planned install configuration is displayed for reference before finalising the install.
 
 
 
14) Installing
Once the Finish button has been clicked, it should typically take less than a minute to complete the installation.
 
 
 
15) Completion
When the installation has been completed, a logfile can be generated by clicking the Export Log button at the bottom-left of the window. The installation is now complete and the installer can be exited via the Close button.