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:

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.
  • Recorder integration Web Service.
  • Coach Scheduler Windows Service.
  • Coach REST API (Docs and 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 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 with usage of required parameter DbPasswd. If omitted, user will be prompted to enter manually:
Coach-Install-Full -DbPasswd '$ecReT'

Full example with all parameters. Note that -SysPasswd is only needed for first-install of Coach.:

Coach-Install-Full -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.ps1 for property $dbInstanceName it is by default set to .\SQLEXPRESS.

Note

  • DbSrv parameter will always override config.ps1 property $dbInstanceName!
  • If you want to use general default value use config.ps1 property $dbInstanceName, if it is changeable use this DbSrv 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 $dbLoginName it is by default set to $null.

Note

  • DbUsr parameter will always override config.ps1 property $dbLoginName!
  • If you want to use general default value use config.ps1 property $dbLoginName, if it is changeable use this DbUsr 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!

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 $recorderIpAddress it is by default set to localhost.

Note

  • If RecorderIP parameter will always override config.ps1 property $recorderIpAddress!
  • If you want to use general default value use config.ps1 property $recorderIpAddress, if it is changeable use this RecorderIP 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.

App Installer

The Qualtrak Coach App Installer.

Description

The Qualtrak Coach App Installer installs:

  • Coach Web Application.
  • Recorder integration Web Service.
  • Coach REST API (Docs and 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

Install-CoachApp

Scheduler Installer

The Qualtrak Coach Scheduler Installer.

Description

The Qualtrak Coach Scheduler Installer installs:

  • Coach Scheduler Windows Service
  • Coach Scheduler Console app.

Usage

Note

Use config.scheduler.ps1 to set up Coach Scheduler Installer to meet desired needs.

  • Get Help for Qualtrak Coach Scheduler Installer Cmdlet Install-CoachScheduler

    Get-Help Install-CoachScheduler -Full Install-CoachScheduler -?

  • Run Install-CoachScheduler to install Coach. See “Examples” for more info or usage.

Examples

Install-CoachService

Database Installer

The Qualtrak Coach Database Installer.

Description

The Qualtrak Coach Database Installer installs:

  • Coach Database.

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 override config.db.ps1 property $dbInstanceName!
  • If you want to use general default value use config.db.ps1 property $dbInstanceName, if it is changeable use this DbSrv 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 $dbLoginName it is by default set to $null.

Note

  • DbUsr parameter will always override config.db.ps1 property $dbLoginName!
  • If you want to use general default value use config.db.ps1 property $dbLoginName, if it is changeable use this DbUsr 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!

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 $recorderIpAddress it is by default set to localhost.

Note

  • If RecorderIP parameter will always override config.ps1 property $recorderIpAddress!
  • If you want to use general default value use config.ps1 property $recorderIpAddress, if it is changeable use this RecorderIP Parameter.

Uninstaller

The Qualtrak Coach Uninstaller.

Description

The update to new release and full Coach Uninstaller:

  • Update to new release uninstaller removes only Coach files and binaries, needed to be cleaned up for newer release.
  • Full uninstaller removes Coach completely from the system.

Usage

  • Get Help for Qualtrak Coach Installer Cmdlet Coach-Uninstall
Get-Help Coach-Uninstall -Full
Coach-Uninstall -?
  • Run Uninstall-Coach to uninstall Coach. See “Examples” for more info or usage.

Examples

  • Minimal usage, used for update to new release version, removes files and Coach binaries, safe to use:
Coach-Uninstall
  • Minimal usage for full uninstall, used for complete remove of Coach from system, beware of losing data, unsafe to use.
Coach-Uninstall -Full -DbPasswd '$ecReT'
  • Full usage of uninstaller parameters, used for complete remove of Coach from system, beware of losing data, unsafe to use:
Coach-Uninstall -Full -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!

Full

  • The full unistall of Coach.

Warning

  • Beware,using this parameter will erase all your Coach data

Note

  • Removes Coach Scheduler Win Service.
  • Removes IIS Web applications.
  • Drops the Coach Database.
  • Remove all Coach files from disk.

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

  • Applicable only when Full parameter is used.
  • DbSrv parameter will always override config.ps1 property $dbInstanceName!
  • If you want to use general default value use config.ps1 property $dbInstanceName, if it is changeable use this DbSrv 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 $dbLoginName it is by default set to $null.

Note

  • Applicable only when Full parameter is used.
  • DbUsr parameter will always override config.ps1 property $dbLoginName!
  • If you want to use general default value use config.ps1 property $dbLoginName, if it is changeable use this DbUsr 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

  • Applicable only when Full parameter is used.
  • If not specified when Full parameter is used, 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]

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 in config.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 in config.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 quoted SHA1 string.

Default Value

Instead of default value don’t use this property in config.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 quoted AES string.

Default Value

Instead of default value don’t use this property in config.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 in config.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 in config.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 in config.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 in config.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 File sharing and Caching. Applicable only for Coach App Installer and its config file: config.app.ps1.

Those properties are included in config.app.ps1, but commented out by default.

To setup HA:

  • Fileshare: it is required to set values for File share Username, Password and Path. If not. it will not be applied!
  • Caching: it is required to set values for Caching Mode, IP and Port. If not, it will not be applied!

File share Username

The File share username used for Coach attachments folder on server.

Property Name

$fileShareUsername

Value

Single quoted string.

File share Password

The File share password used for Coach attachments folder on server.

Property Name

$fileSharePassword

Value

Single quoted string.

File share Path

The File share path used for Coach attachments folder on server.

Property Name

$fileSharePath

Value

Single quoted string.

Caching Mode

The ASP.NET caching mode, currently only supported is StateServer in future there will be support for SqlServer caching mode.

Property Name

$cachingMode

Value

Single quoted string. Currently only supported is StateServer.

Default Value

'StateServer'

Caching IP

The ASP.NET caching IP address.

Property Name

$cachingIp

Value

Single quoted string. Valid IP address or DNS name.

Caching Port

The ASP.NET caching IP address Port.

Property Name

$cachingPort

Value

Integer value. Greater than zero (0).

Default Value

42424

Indices and tables