Welcome to Qualtrak Coach Installer documentation!¶
Note
Qualtrak Coach Installer is written in Powershell and uses Powershell to
manage instalation. Apart from Powershell, for manipulating SQL Server
database is used SQL Server command line utility sqlcmd
.
Contents:
Fresh Install¶
Important
Before installing Qualtrak Coach Installer please make sure that system requirements are met and server is configured for Coach.
Checklist¶
- Check validity of values in <installer folder>\config.ps1. If in doubt check Config file properties.
- If your SQL Server instance is different than
.\SQLEXPRESS
make sure to enter proper one for property$global:dbInstanceName
inconfig.ps1
. - Make sure that SQL Server user is
sa
or any user with SQL Server system role. Only needed for fresh install.
Note
Currently fresh install requires SQL Server system role for creating Database and SQL User for Coach. If this is a problem ask DB admin to create new user with SQL system role, that can be removed after first install.
Currently installer only support Database users with SQL Authorization. SQL Server Windows Authentication is not supported.
Important
For Coach IntegrationSDK install partners, please before running install make sure to overwrite 02_partner_integrationsdk.sql
with your own Coach integration T-SQL file in <installer folder>\db.
If the Recorder IP address used during the Integration Testing is different for this deployment then please open up the T-SQL script (02_partner_integrationsdk.sql
) received from the Integration Tool and change the Recorder IP address there.
Pre-Install¶
- Download installer.
- Unblock installer zip file (by right click > Properties > Unblock).
- Extract installer zip.
- Open Powershell console as Administrator.
cd
into extracted installer folder.- Run installer setup by:
.\InstallerSetup.ps1
Installation¶
- Run Full Qualtrak Coach Installer
DbPaswd
andSysPasswd
are required. If not entered installer will prompt for entering them.
Install-CoachFull -DbPasswd '<db user password>' -SysPasswd '<coach system administrator password>'
Note
Coach System Administrator is role used to create Tenants and shold be used only for that. Do not add this Coach System Administrator to any Tenant organization hierarchy.
Post Install¶
After successful installation sign in into Coach first time, use this values in login page:
- Tenant Code:
1000
- Username:
sys.admin
- Password: password entered for Coach System Administrator on first install (installer switch
SysPasswd
, if used or when prompted).
Note
Coach System Administrator username is by default set to sys.admin
. If there is need for other username please use config property $sysAdminUsername
in <installer folder>\config.ps1 to set desired username for Coach System Administrator user.
Update Coach Install¶
Checklist¶
- Check validity of values in <installer folder>\config.ps1. If in doubt check Config file properties.
- If your SQL Server instance is different than
.\SQLEXPRESS
make sure to enter proper one for property$global:dbInstanceName
inconfig.ps1
.
Note
Currently if sa
or SQL server system user is not avaialble. It is possible to use Coach SQL server user AspireUser
created on fresh install, it has a default password set to password
.
If this is a security issue ask DB admin to create new password for user AspireUser
and use it in install.
Currently installer only support Database users with SQL Authorization. SQL Server Windows Authentication is not supported.
Important
For Coach IntegrationSDK install partners, please before running install make sure to overwrite 02_partner_integrationsdk.sql
with your own Coach integration T-SQL file in <installer folder>\db. Make sure that you use script file with Recorder IP adress set for this deployment.
Pre-Install¶
- Download installer.
- Unblock installer zip file (by right click > Properties > Unblock) .
- Extract installer zip.
- Open Powershell console as Administrator.
cd
into extracted installer folder.- Run installer setup by:
.\InstallerSetup.ps1
Installation¶
- Run Full Qualtrak Coach Installer
DbPaswd
is required. If not entered installer will prompt for entering SQL server user password.
Install-CoachFull -DbPasswd '<db user password>'
Post Install¶
After successful installation sign in into Coach first time, use this values in login page:
- Tenant Code:
1000
- Username:
sys.admin
- Password: password entered for Coach System Administrator on first install (installer switch
SysPasswd
, if used or when prompted).
Getting started¶
Note
Powershell 3 or above is required for running Qualtrak Coach Installer.
Main Usage Requirement¶
- Open Powershell console as Administrator!
- Unblock Qualtrak Coach Installer zip file and extract it.
cd
to extracted Qualtrak Coach Installer folder.- Run Qualtrak Coach Installer setup by:
.\InstallerSetup.ps1
Full Installer¶
The Qualtrak Coach Full Installer.
Description¶
The Qualtrak Coach Installer installs:
- Coach Web Application.
- Data Connector integration.
- IntelliSearch Windows Services (Producer and Consumer).
- TLM (Tenant and Licensing management & real-time Monitoring) Web App and Windows Service.
- Akka Coach Seed Windows Service
- Coach REST API (C# Wrapper)[Optional].
Warning
Please make sure to backup all your data before running Qualtrak Coach Installer to make sure of no data loss!
Usage¶
Note
Use config.ps1
to set up Coach Full Installer to meet desired needs.
Get Help for Qualtrak Coach Installer Cmdlet
Install-CoachFull
Get-Help Install-CoachFull -Full Install-CoachFull -?
Run
Install-CoachFull
to install Coach. See “Examples” for more info or usage.
Examples¶
Note
- See more info about
Install-CoachFull
parameters in “Parameters” section. - Please use single quotes (‘’) around parameter values, double quotes (“”) values evaluate as Powershell statement, so it can have undesired effect!
Minimal command with usage of required parameter
DbPasswd
. If omitted, user will be prompted to enter manually:Install-CoachFull -DbPasswd '$ecReT'
Full example with all parameters. Note that -SysPasswd
is only needed for first-install of Coach.:
Install-CoachFull -DbSrv 'srv\ins' -DbUsr 'admin' -DbPasswd '$ecReT' -RecorderIP '10.0.0.1' -SysPasswd 'P@$$w0rd' -HA -StartingPort 9000
Parameters¶
Note
- Please use single quotes (‘’) around parameter values, double quotes (“”) values evaluate as Powershell statement, so it can have undesired effect!
- If
AspireUser
(Coach database User) is used asDbUsr
parameter or$global:dbLoginName
property is set inconfig.ps1
then in Coach database connection stringDbPasswd
parameter value will be used, overriding default Coach database connection string password value.
DbSrv¶
- Specifies the SQL Server database serverinstance.
- General default value can be changed in
config.ps1
for property$dbInstanceName
it is by default set to.\SQLEXPRESS
.
Note
DbSrv
parameter will always overrideconfig.ps1
property$global:dbInstanceName
!- If you want to use general default value use
config.ps1
property$global:dbInstanceName
, if it is changeable use thisDbSrv
Parameter.
DbUsr¶
- Specifies the SQL Server database serverinstance user login name.
- This value is not persisted or saved in any way, it is only for lifetime of installation session. Unless user used is
AspireUser
which is Coach database user used in connection string. - General default value can be changed in
config.ps1
for property$global:dbLoginName
it is by default set to$null
.
Note
DbUsr
parameter will always overrideconfig.ps1
property$global:dbLoginName
!- If you want to use general default value use
config.ps1
property$global:dbLoginName
, if it is changeable use thisDbUsr
Parameter.
DbPasswd¶
- Specifies the SQL Server database serverinstance password.
- This value is not persisted or saved in any way, it is only for lifetime of installation session. Unless
DbUsr
parameter value isAspireUser
which is default Coach database user used in connection string. ThenDbPasswd
value will override default password for Cocah database connection string. - Required.
Note
- If not specified will stop script and wait for
DbPasswd
enter manually in prompt! - If
DbPasswd
value is whitespace it will terminate the script!
RecorderIP¶
- Specifies the Recorder IP address with any valid IP Address or DNS name.
- General default value can be changed in
config.ps1
for property$global:recorderIpAddress
it is by default set tolocalhost
.
Note
- If
RecorderIP
parameter will always overrideconfig.ps1
propertyglobal:$recorderIpAddress
! - If you want to use general default value use
config.ps1
property$global:recorderIpAddress
, if it is changeable use thisRecorderIP
Parameter.
SysPasswd¶
- Specifies the Coach System Administrator password.
- It is required on Coach first-install.
Note
- If not specified on Coach first-install it will stop script and wait for
SysPasswd
enter manually in prompt! - If
SysPasswd
value is empty or whitespace it will terminate the script! - If used on Coach release update will display warning, because in that case
SysPasswd
will be completely ignored by install.
HA¶
- Tells to installer that this is HA installation and sometimes in combination with
StartingPort
when there is need for sliding number for ports in HA. - If used then will set installer to be in a HA mode, if not it will do normal Single Server install.
StartingPort¶
- Only usable with
HA
switch and in HA mode. - Specifies the starting port and it can be used to set sliding ports when multiple installers used in multiple VM’s.
- Sliding port means each HA VM’s with Coach components needs unique port number(s).
- Default value can be changed in
config.ps1
for property$global:startingPort
it is by default set to9000
.
Note
- If
StartingPort
parameter will always overrideconfig.ps1
property$global:startingPort
! - If you want to use general default value use
config.ps1
property$global:startingPort
, if it is changeable use thisStartingPort
Parameter.
App Installer¶
The Qualtrak Coach App Installer.
Description¶
The Qualtrak Coach App Installer installs:
- Coach Web Application.
- DataConnector integration Web API/Service.
- IntelliSearch [Optional].
- Coach REST API (C# Wrapper)[Optional].
Usage¶
Note
Use config.app.ps1
to set up Coach App Installer to meet desired needs.
Get Help for Qualtrak Coach App Installer Cmdlet
Install-CoachApp
Get-Help Install-CoachApp -Full Install-CoachApp -?
Run
Install-CoachApp
to install Coach. See “Examples” for more info or usage.
Examples¶
Note
- See more info about
Install-CoachApp
parameters in “Parameters” section. - Please use single quotes (‘’) around parameter values, double quotes (“”) values evaluate as Powershell statement, so it can have undesired effect!
Minimal command usage:
Install-CoachApp
Full command usage:
Install-CoachApp -IntelliSearch All -HA -StartingPort 9000
Parameters¶
Note
Please use single quotes (‘’) around parameter values, double quotes (“”) values evaluate as Powershell statement, so it can have undesired effect!
IncludingTLMWeb¶
- If it is used during installation it will include TLM Web in installation, otherwise it will not.
IntelliSearch¶
- It can include IntelliSearch Windows Service(s).
All
it will install Producer and Consumer Windows Services, orProducer
orConsumer
by itself. - Valid options:
All
,Producer
,Consumer
. - Default value is
All
or not installing IntelliSearch.
HA¶
- Tells to installer that this is HA installation and sometimes in combination with
StartingPort
when there is need for sliding number for ports in HA. - If used then will set installer to be in a HA mode, if not it will do normal Single Server install.
StartingPort¶
- Only usable with
HA
switch and in HA mode. - Specifies the starting port and it can be used to set sliding ports when multiple installers used in multiple VM’s.
- Sliding port means each HA VM’s with Coach components needs unique port number(s).
- Default value can be changed in
config.app.ps1
for property$global:startingPort
it is by default set to9000
.
Note
- If
StartingPort
parameter will always overrideconfig.app.ps1
property$global:startingPort
! - If you want to use general default value use
config.app.ps1
property$global:startingPort
, if it is changeable use thisStartingPort
Parameter.
IntelliSearch Installer¶
The Qualtrak Coach IntelliSearch Installer.
Description¶
The Qualtrak Coach IntelliSearch Installer installs:
- IntelliSearch Producer Windows service.
- IntelliSearch Consumer Windows service.
IntelliSearch Producer¶
Creates and queues IntelliSearch jobs for all Coach Tenants Searches. IntelliSearch Producer is quick and low on consuming machine resources.
IntelliSearch Consumer¶
Executes queued jobs from IntelliSearch Producer and gets from DataConnector endpoint media for particular Search Criteria, gets randomized media for User and saves all media for that IntelliSearch job. Depending on numbers of Users for a particular IntelliSearch it can be time and machine resource consuming.
Usage¶
Note
Use config.intellisearch.ps1
to set up Coach IntelliSearch Installer to meet desired needs.
Get Help for Qualtrak Coach IntelliSearch Installer Cmdlet
Install-CoachIntelliSearch
Get-Help Install-CoachIntelliSearch -Full Install-CoachIntelliSearch -?
- Run
Install-CoachIntelliSearch
to install Coach IntelliSearch. See “Examples” for more info or usage.
Examples¶
Note
- See more info about
Coach-Install-Full
parameters in “Parameters” section. - Please use single quotes (‘’) around parameter values, double quotes (“”) values evaluate as Powershell statement, so it can have undesired effect!
Minimal command usage. It will install both IntelliSearch Windows services (Producer and Consumer):
Install-CoachIntelliSearch
Full command usage:
Install-CoachIntelliSearch -Install Consumer -HA -StartingPort 9000
Parameters¶
Note
Please use single quotes (‘’) around parameter values, double quotes (“”) values evaluate as Powershell statement, so it can have undesired effect!
Install¶
- Installs one or both IntelliSearch Windows service(s).
- Valid options:
All
,Producer
,Consumer
. - Default value is
All
or installing both IntelliSearch Windows services. So it can be used just asInstall-CoachIntelliSearch
without any parameter.
HA¶
- Tells to installer that this is HA installation and sometimes in combination with
StartingPort
when there is need for sliding number for ports in HA. - If used then will set installer to be in a HA mode, if not it will do normal Single Server install.
StartingPort¶
- Only usable with
HA
switch and in HA mode. - Specifies the starting port and it can be used to set sliding ports when multiple installers used in multiple VM’s.
- Sliding port means each HA VM’s with Coach components needs unique port number(s).
- Default value can be changed in
config.intellisearch.ps1
for property$global:startingPort
it is by default set to9000
.
Note
- If
StartingPort
parameter will always overrideconfig.intellisearch.ps1
property$global:startingPort
! - If you want to use general default value use
config.intellisearch.ps1
property$global:startingPort
, if it is changeable use thisStartingPort
Parameter.
TLM Installer¶
The Qualtrak Coach TLM Installer.
Description¶
The Qualtrak Coach TLM (Tenant and Licensing management & real-time Monitoring) Installer installs:
- TLM Windows Service.
- TLM Web Application.
- Akka Coach Seed Windows Service [Optional].
- Coach REST API (C# Wrapper)[Optional].
Usage¶
Note
Use config.tlm.ps1
to set up Coach TLM Installer to meet desired needs.
Get Help for Qualtrak Coach TLM Installer Cmdlet
Install-CoachTLM
Get-Help Install-CoachTLM -Full Install-CoachTLM -?
Run
Install-CoachTLM
to install Coach. See “Examples” for more info or usage.
Examples¶
Note
- See more info about
Install-CoachTLM
parameters in “Parameters” section. - Please use single quotes (‘’) around parameter values, double quotes (“”) values evaluate as Powershell statement, so it can have undesired effect!
Minimal command usage:
Install-CoachTLM
Full command usage:
Install-CoachTLM -IncludingSeed -HA -StartingPort 9000
Parameters¶
Note
Please use single quotes (‘’) around parameter values, double quotes (“”) values evaluate as Powershell statement, so it can have undesired effect!
IncludingSeed¶
- If it is used during installation it will include Akka Coach Seed Windows Service in installation, otherwise it will not.
HA¶
- Tells to installer that this is HA installation and sometimes in combination with
StartingPort
when there is need for sliding number for ports in HA. - If used then will set installer to be in a HA mode, if not it will do normal Single Server install.
StartingPort¶
- Only usable with
HA
switch and in HA mode. - Specifies the starting port and it can be used to set sliding ports when multiple installers used in multiple VM’s.
- Sliding port means each HA VM’s with Coach components needs unique port number(s).
- Default value can be changed in
config.app.ps1
for property$global:startingPort
it is by default set to9000
.
Note
- If
StartingPort
parameter will always overrideconfig.tlm.ps1
property$global:startingPort
! - If you want to use general default value use
config.tlm.ps1
property$global:startingPort
, if it is changeable use thisStartingPort
Parameter.
Database Installer¶
The Qualtrak Coach Database Installer.
Usage¶
Note
Use config.db.ps1
to set up Coach Database Installer to meet desired needs.
Get Help for Qualtrak Coach Databse Installer Cmdlet
Install-CoachDb
Get-Help Install-CoachDb -Full Install-CoachDb -?
- Run
Install-CoachDb
to install Coach. See “Examples” for more info or usage.
Examples¶
Note
- See more info about
Install-CoachDb
parameters in “Parameters” section. - Please use single quotes (‘’) around parameter values, double quotes (“”) values evaluate as Powershell statement, so it can have undesired effect!
Minimal command with usage of required parameter
DbPasswd
. If omitted, user will be prompted to enter manually:Install-CoachDb -DbPasswd '$ecReT'
Full example with all parameters. Note that
-SysPasswd
is only needed for first-install of Coach:Install-CoachDb -DbSrv 'srv\ins' -DbUsr 'admin' -DbPasswd '$ecReT' -RecorderIP '10.0.0.1' -SysPasswd 'P@$$w0rd'
Parameters¶
Note
Please use single quotes (‘’) around parameter values, double quotes (“”) values evaluate as Powershell statement, so it can have undesired effect!
DbSrv¶
- Specifies the SQL Server database serverinstance.
- General default value can be changed in
config.db.ps1
for property$dbInstanceName
it is by default set to.\SQLEXPRESS
.
Note
DbSrv
parameter will always overrideconfig.db.ps1
property$dbInstanceName
!- If you want to use general default value use
config.db.ps1
property$dbInstanceName
, if it is changeable use thisDbSrv
Parameter.
DbUsr¶
- Specifies the SQL Server database serverinstance user login name.
- This value is not persisted or saved in any way, it is only for lifetime of installation session.
- General default value can be changed in
config.db.ps1
for property$dbLoginName
it is by default set to$null
.
Note
DbUsr
parameter will always overrideconfig.db.ps1
property$dbLoginName
!- If you want to use general default value use
config.db.ps1
property$dbLoginName
, if it is changeable use thisDbUsr
Parameter.
DbPasswd¶
- Specifies the SQL Server database serverinstance password.
- This value is not persisted or saved in any way, it is only for lifetime of installation session.
- Required.
Note
- If not specified will stop script and wait for
DbPasswd
enter manually in prompt! - If
DbPasswd
value is whitespace it will terminate the script!
Uninstaller¶
Partial Uninstall¶
The Qualtrak Coach partial uninstall.
Description¶
On each update for new release partial uninstall is used to remove only Coach files and binaries, needed to be cleaned up for newer release files and binaries.
Each installer [Full
, App
, Db
, IntelliSearch
, TLM
] can be uninstalled with partial uninstaller.
Usage¶
Get Help for Qualtrak Coach Installer Cmdlet
Coach-Uninstall
Get-Help Coach-Uninstall -Full Coach-Uninstall -?
Run
Uninstall-Coach
to update and partially uninstall Coach. See “Examples” for more info or usage.
Examples¶
Note
- See more info about
Coach-Uninstall
parameters in “Parameters” section. - Please use single quotes (‘’) around parameter values, double quotes (“”) values evaluate as Powershell statement, so it can have undesired effect!
Minimal usage, it will uninstall Qualtrak Coach Full installer files:
Coach-Uninstall # same as it was used: Uninstall-Coach -Installer Full
Full usage for uninstall particular Qualtrak Coach installer with all supported installers:
Uninstall-Coach -Installer Full Uninstall-Coach -Installer App Uninstall-Coach -Installer IntelliSearch Uninstall-Coach -Installer TLM
Parameters¶
Note
- Please use single quotes (‘’) around parameter values, double quotes (“”) values evalute as Powershell statement, so it can have undesired effect!
Installer¶
- Set of Qualtrak Coach supported installers that can be uninstalled for speceific installer.
- All except Coach
Db
installer have their equivalent uninstaller. - Valid options:
Full
,App
,IntelliSearch
,TLM
. - Default value is
Full
. So it can be used just asUninstall-Coach
without any parameter.
Full Uninstall¶
The Qualtrak Coach full uninstall.
Description¶
The uninstaller removes Coach completely from the system.
Warning
Beware with this command all data will be lost files, binaries, uploaded files and Coach database.
Note
Full installer removes:
- Coach Windows Services.
- Coach IIS Web applications.
- Drops Coach database, and database User Login used for Coach (AspireUser
).
- All Coach files from disk.
Usage¶
Get Help for Qualtrak Coach Installer Cmdlet
Uninstall-CoachAll
Get-Help Uninstall-CoachAll -Full Uninstall-CoachAll -?
Run
Uninstall-CoachAll
to fully uninstall Coach. See “Examples” for more info or usage.
Examples¶
Minimal usage, used for complete remove of Coach from system, with minimal (required) parameters:
Uninstall-CoachAll -DbPasswd '$ecReT'
Full usage of uninstaller parameters, used for complete remove of Coach from system with all parameters:
Uninstall-CoachAll -DbSrv 'srv\ins' -DbUsr 'admin' -DbPasswd '$ecReT'
Parameters¶
Note
- Please use single quotes (‘’) around parameter values, double quotes (“”) values evalute as Powershell statement, so it can have undesired effect!
DbSrv¶
- Specifies the SQL Server database serverinstance.
- General default value can be changed in
config.ps1
for property$global:dbInstanceName
it is by default set to.\SQLEXPRESS
.
Note
DbSrv
parameter will always overrideconfig.ps1
propertyglobal:$dbInstanceName
!- If you want to use general default value use
config.ps1
propertyglobal:$dbInstanceName
, if it is changeable use thisDbSrv
Parameter.
DbUsr¶
- Specifies the SQL Server database serverinstance user login name.
- This value is not persisted or saved in any way, it is only for lifetime of installation session.
- General default value can be changed in
config.ps1
for property$global:dbLoginName
it is by default set to$null
.
Note
DbUsr
parameter will always overrideconfig.ps1
property$global:dbLoginName
!- If you want to use general default value use
config.ps1
property$global:dbLoginName
, if it is changeable use thisDbUsr
Parameter.
DbPasswd¶
- Specifies the SQL Server database serverinstance password.
- This value is not persisted or saved in any way, it is only for lifetime of installation session.
- Required when parameter
Full
is used.
Note
- If not specified it will stop script and wait for
DbPasswd
enter manually in prompt! - If
DbPasswd
value is whitespace it will terminate the script!
Config file properties¶
The Coach Installer now has a config.ps1
file that can be customized to meet the needs of Qualtrak partners for easier and
efficient Coach install process.
The properties in the config.ps1
file should only be used where needed. Where they are not used, they will be ignored during the install.
Microsoft Powershell coding notation is used for editing the config.ps1
script file.
General¶
General Coach Installer properties.
Install Path¶
The install path for Coach Installer. Some development work outstanding so please do not change Default Value!
Property Name
$installPath
Value
Single quoted string with standard Windows path notation e.g.c:\
.
Default Value
Depending on system type:
'C:\Program Files'
[x86]'C:\Program Files (x86)'
[x64]
Log Level¶
Sets logging level for a Coach logging.
Property Name
$logLevel
Value
Single quoted string. Possible values:'Error'
,'Information'
,'Debug'
,'Verbose'
.
Default Value
'Error'
SSL¶
Whether SSL should be enabled or not.
Property Name
$isSSL
Value
Boolean value:$true
or$false
.
Default Value
$true
Coach System Administrator Username¶
Sets the Coach System Administrator username. This is only required for a first-time installation. Where Coach is being upgraded the System Admininstrator Username value will be ignored.
Property Name
$sysAdminUsername
Value
Single quoted string.
Default Value
'sys.admin'
Scheduler Trigger Time¶
The time of day that the Coach Scheduler Service will run. Accepts 24 hour clock time.
Property Name
$schedulerTriggerTime
Value
Single quoted string that represents time form'00:00'
to'23:59'
. Please make sure to use leading zero time format e.g.01:30
!
Default Value
'02:00'
Install Instrumentation¶
Whether Coach Instrumentation will be installed.
Don’t use Coach Instrumentation property in config.ps1
, if it is not needed!
Property Name
$installInstrumentation
Value
Boolean value:$true
or$false
.
Default Value
Instead of default value don’t use this property inconfig.ps1
!
IIS¶
Internet Information Services (IIS) specific properties.
Application Pool Name¶
The name of IIS Application Pool that Coach will be added to.
Property Name
$appPoolName
Value
Single quoted string.
Default Value
'ASP.NET 4.0'
IIS Web Site Name¶
The IIS Web Site Name that Coach Web Application will be part of.
Property Name
$iisWebSiteName
Value
Single quoted string.
Default Value
'Default Web Site'
Web Application Name¶
The Coach Web Application Name, that will be then used for main Coach URL, e.g. if name is set to “test”, URL will be: https://example.com/test
.
This can be left as Default Value Coach
but can be modified to fit with branding requirements.
Property Name
$appName
Value
Single quoted string.
Default Value
Coach
Database¶
The Coach SQL Server Database properties.
Database Instance Name¶
The SQL Server Database Instance or Server name for where Coach database will be installed.
Use this property if the Instance name is not changing, but if the Instance name does need to be changed then use Qualtrak Coach Installer parameter -DbSrv
with instance/server name.
Property Name:
$dbInstanceName
Value
Single quoted string. Any valid SQL Server named instance or server name.
Default Value
.\SQLEXPRESS
Database Login Name (User)¶
The SQL Server Database Login name (Db User) needed for Coach database and scripts to run and install properly. The Login name must have sysadmin
role in SQL Server Server Roles.
Use this property if the same login name is used for all deployments, otherwise use Qualtrak Coach Installer parameter -DbUsr
with login name.
This value is only persisted here in config.ps1
as it is only needed for installation session.
If persisting to config.ps1
is a problem then use Qualtrak Coach Installer parameter -DbUsr
instead.
Property Name
$dbLoginName
Value
Single quoted string.
Default Value
sa
web.config¶
The ASP.NET web.config
properties currently for <appSettings>
, <machineKey>
and <authentication>
.
Authentication Route¶
Used to mark that Coach integration Authentication Route will be through a URL query string.
It will add to the Coach web.config
in <appSettings>
element new setting with key AuthenticationRoute
with value url
.
Don’t use Authentication Route property in config.ps1
, if it is not needed!
Property Name
$authenticationRoute
Value
Single quoted string.
Default Value
Instead of default value don’t use this property inconfig.ps1
!
Machine Validation Key¶
Sets the custom Machine Validation SHA1
Key to Coach web.config
<machineKey>
element.
Don’t use Machine Validation Key property in config.ps1
, if it is not needed!
Property Name
$machineValidationKey
Value
Single quotedSHA1
string.
Default Value
Instead of default value don’t use this property inconfig.ps1
!
Machine Decription Key¶
Sets the custom Machine Decryption AES
Key to Coach web.config
<machineKey>
element.
Don’t use Machine Validation Key property in config.ps1
, if it is not needed!
Property Name
$machineDecryptionKey
Value
Single quotedAES
string.
Default Value
Instead of default value don’t use this property inconfig.ps1
!
Authentication Forms Name¶
Sets the custom Forms Name attribute to Coach web.config
<forms>
element.
Don’t use Authentication Forms Name property in config.ps1
, if it is not needed!
Property Name
$formsName
Value
Single quoted string.
Default Value
Instead of default value don’t use this property inconfig.ps1
!
Authentication Forms Domain¶
Sets the custom Forms Domain attribute to Coach web.config
<forms>
element.
Don’t use Authentication Forms Domain property in config.ps1
, if it is not needed!
Property Name
$formsDomain
Value
Single quoted string.
Default Value
Instead of default value don’t use this property inconfig.ps1
!
Windows Authentication¶
Enables Windows Authentication in Coach.
If Windows Authentication is not needed don’t include any of its properties in config.ps1
.
Windows Authentication¶
Enables Windows Authentication in Coach. This also requires the Active Directory Group Name property to be set.
Don’t use Windows Authentication property in config.ps1
, if it is not needed!
Property Name
$isWindowsAuth
Value
Boolean value:$true
or$false
.
Default Value
Instead of default value don’t use this property inconfig.ps1
!
Active Directory Group Name¶
Sets the custom Active Directory group name.
Don’t use Active Directory Group Name property in config.ps1
, if it is not needed!
Property Name
$activeDirectoryGroupName
Value
Single quoted string.
Default Value
Instead of default value don’t use this property inconfig.ps1
!
Recorder¶
Recorder specific properties for IP address and database connection details.
Recorder IP Address¶
The IP address of the Recorder that Coach will integrate with.
Use this property if the same Recorder IP address is used for all deployments. If not, then use Qualtrak Coach Installer parameter -RecorderIP
with valid IP address.
Property Name
$recorderIpAddress
Value
Single quoted string as valid IP address.
Default Value
localhost
Recorder Database Instance Name¶
The Database instance name that the Recorder uses for persisting recordings.
Property Name
$dbRecorderInstance
Value
Single quoted string.
Default Value
'.\SQLEXPRESS'
Recorder Database Login Name¶
The Database login (user) name that the Recorder uses for persisting recordings.
Property Name
$dbRecorderLoginName
Value
Single quoted string.
Recorder Database Login Password¶
The Database login (user) password that the Recorder uses for persisting recordings.
Property Name
$dbRecorderPasswd
Value
Single quoted string.
HA (High Availability)¶
HA specific properties currently for ASP.NET Identity/Shared Folder, ASP.NET Session State and Database.
Note
HA properties are included in all config files, except config.db.ps1
, but commented out by default.
Note
To setup HA:
- ASP.NET Identity and Shared Folder: it is required to set values for File share Username, Password and Path. If not. it will not be applied!
- ASP.NET Session State: State Server: it is required to set values for Session State mode (as StateServer), IP address and port. If not, it will not be applied!
- ASP.NET Session State: SQL Server: it is required to set values for Session State mode (as ‘SQLServer’), SQL Server IP address and SQL Server Failover Partner IP address.
- Datbase: it is required to set values for SQL Server IP address and SQL Server Failover Partner IP address.
ASP.NET Session State¶
Session State Mode¶
The ASP.NET session state mode, supported is both StateServer
and SqlServer
ASP.NET Session State mode.
Property Name
$sessionStateMode
Value
Single quoted string. Supported values:'StateServer
,'SqlServer'
.
Default Value
'SQLServer'
ASP.NET Session State: State Server¶
Session State IP address¶
The ASP.NET Session State Server IP address.
Property Name
$sessionStateIP
Value
Single quoted string. Valid IP address or DNS name.
Session State Port¶
The ASP.NET Session State IP address Port.
Property Name
$sessionStatePort
Value
Integer value. Greater than zero (0).
Default Value
42424
Database & ASP.NET Session State: SQL Server¶
SQL Server IP address¶
The SQL Server IP address.
Property Name
$sqlServerIP
Value
Single quoted string. Valid IP address or DNS name.
SQL Server Catalog (Db)¶
The SQL Server Catalog/Db if session state for Sql Server should be different from default Coach Db. Use this property option when Session State for Sql Server should have different DB than default Coach Db.
Property Name
$sqlServerCatalog
Value
Single quoted string.
SQL Server User ID (Login)¶
The SQL Server Userd ID (Sql Server login) for given Catalog/Db if session state for Sql Server should be different from default Coach Db. Use this property option when Session State for Sql Server should have different DB than default Coach Db.
Property Name
$sqlServerUserID
Value
Single quoted string.
SQL Server Password¶
The SQL Server Userd ID (Sql Server login) password for given Catalog/Db if session state for Sql Server should be different from default Coach Db. Use this property option when Session State for Sql Server should have different DB than default Coach Db.
Property Name
$sqlServerPassword
Value
Single quoted string.
SQL Server Failover Partner IP address¶
The SQL Server Failover Partner IP address.
Property Name
$sqlServerFailoverPartnerIP
Value
Single quoted string. Valid IP address or DNS name.
TLM (Tenant and Licensing management & real-time Monitoring)¶
TLM (Coach Tenant and License Management) properties that will set up the URI of TLM.
Note
Available in config.ps1
and in config.tlm.ps1
.
TLM IP address¶
TLM (Tenant and Licensing management & real-time Monitoring) IP address.
Port for IP address is set from property StartingPort
and it is usually one number higher
StartingPort
, e.g. if StartingPort
is 9000
the TLM IP address port will be 9001
.
Property Name
$tlmIp
Value
Single quoted string. Valid IP address or DNS name.
Default Value
'127.0.0.1'
Akka Coach Seed¶
Akka Coach seed specific properties. Where seed node list is used in all Coach Akka Win Services.
Available in all configs except config.db.ps1
, for seed nodes list and starting port,
and Public IP address available only in HA installation.
Seed Public IP address¶
Coach Akka Seed IP address. Only applicable for HA installations.
Port is used from property StartingPort
but it is only used when it is a HA installation.
For non-HA installation port 0
is used.
Property Name
$seedPublicHostname
Value
Single quoted string. Valid IP address or DNS name.
Starting Port¶
Port for Coach Akka Seed IP address and TLM IP address.
In non-HA installation used only for TLM IP address port, in HA installation can be
used with installer switch -StartingPort
to apply sliding ports on multiple VM’s
since port must be unique on multiple VM’s for same Seed Public IP address.
Property Name
$global:startingPort
Value
Integer value. Greater than zero (0).
Default Value
9000
Seed Nodes list¶
List of multiple Coach Akka seed nodes.
Property Name
$seedNodes
Value
Powrshell array@()
of single quoted string and comma separated. [IP|DNS]:Port format.
Default Value
@('127.0.0.1:9001')