Skip to content

Setup - Application Settings¶

This section summarizes the settings in the appsettings.json configuration files of the EnQualify back-office applications. Required and optional settings for each application are listed in separate tables.

EnQualify Web API¶

Required Settings¶

Setting	Description
`Application:Settings:Production`	Must be set to `true` for production environment.
`Application:Database:Connections:Default`	Database connection string.
`Application:ScheduledTasks:AssignAgent`	Set to `true` to run the AssignAgent task in this instance.
`Application:ScheduledTasks:ResizeVideo`	Set to `true` to run the ResizeVideo task in this instance.
`Application:ScheduledTasks:ArchiveVideo`	Set to `true` to run the ArchiveVideo task in this instance.
`Application:ScheduledTasks:ReportData`	Set to `true` to run the ReportData task in this instance.
`Application:ScheduledTasks:SignCalls`	Set to `true` to run the SignCalls task in this instance.
`Application:ScheduledTasks:DownloadVideo`	Set to `true` to run the DownloadVideo task in this instance.
`SeriLog:WriteTo:…(File)…Path`	Path and filename of the local log file.

Optional Settings¶

Setting	Description
`Application:Settings:CorsOrigins`	List of URLs for CORS configuration.
`Application:Settings:CustomerAppServiceBase`	Base URL of the customer's Integration API.
`Application:Settings:FileShare`	File share path for stored files (video files).
`Application:Settings:FileArchiveShare`	File archive share path for archived files (video files).
`Application:Settings:MediaServerFileShare`	File share path to download video files if MediaServer is used.
`Application:Settings:VideoFolder`	Used to change the default video folder name (`Video`).
`Application:Settings:FFmpegResourceUsage`	Amount of system resources that FFmpeg libraries will use during video resizing.
`Application:Settings:ADAuth`	Set to `true` to enable AD authentication.
`Application:Database:TimeFixMin`	Sets the difference between the database server's time and the local machine's time in minutes.
`Application:LDAP`	LDAP settings (if used).
`Application:Features:Test`	Enables test features.
`Application:Features:OpenAPI`	Enables Swagger OpenAPI UI.
`Application:Tokens:Auth`	Authentication token settings.
`Application:Tokens:Request`	Request signing settings.
`Application:Tokens:Verification`	Verification data encryption settings.
`Serilog:MinimumLevel`	Default minimum level for logging.
`Kestrel:…`	Used for additional http://ASP.NET Kestrel HTTP server settings including HTTPS and SSL certificate settings if the IIS in-process hosting model is not used.

EnQualify Web UI¶

Required Settings¶

Setting	Description
`Application:Settings:Production`	Must be set to `true` for production environment.
`Application:Settings:ServiceBase`	Internal URL of the Web API.
`Application:Settings:ServiceUser`, `ServiceKey`	EnQualify credentials for Web API access.
`Application:Settings:UIServiceBase`	External URL of the Web API.
`Application:Settings:AIServiceBase`	URL of the EnQualify AI Service App.
`Application:Settings:StunServerUrl`, `TurnServerUrl`, `TurnServerUser`, `TurnServerKey`	URL and credentials for EnQualify Communication Apps.
`SeriLog:WriteTo:…(File)…Path`	Path and filename of the local log file.

Optional Settings¶

Setting	Description
`Application:Settings:CorsOrigins`	List of URLs for CORS configuration.
`Application:Settings:CSPHeaders`	Sets header values to include Content Security Policy headers in web pages and enables `Enabled` value to `true`.
`Application:Settings:ADAuthServiceBase`	URL of the EnQualify ADAuth API if SSO is used with Windows Authentication.
`Application:Settings:CustomerAppServiceActive`	Set to `true` if customer integration services are used.
`Application:Settings:AIServiceBase2`	URL of the second EnQualify AI Service App.
`Application:Settings:StunServerUrl2`, `TurnServerUrl2`	URLs for the second EnQualify Communication Apps.
`Application:Settings:TurnOnly`	Set to `true` to force the use of Turn server in video relays.
`Application:Settings:MediaServer`	Set to `true` if MediaServer is used for video calls and recordings.
`Application:Features:Test`	Enables test features.
`Application:Features:OpenAPI`	Enables Swagger OpenAPI UI.
`Serilog:MinimumLevel`	Default minimum level for logging.
`Kestrel:…`	Additional http://ASP.NET Kestrel HTTP server settings including HTTPS and SSL certificate settings if the IIS in-process hosting model is not used.

EnQualify Mobile API¶

Required Settings¶

Setting	Description
`Application:Settings:Production`	Must be set to `true` for production environment.
`Application:Database:Connections:Default`	Database connection string.
`SeriLog:WriteTo:…(File)…Path`	Path and filename of the local log file.

Optional Settings¶

Setting	Description
`Application:Settings:CorsOrigins`	List of URLs for CORS configuration.
`Application:Settings:CustomerAppServiceBase`	Base URL of the customer's Integration API.
`Application:Settings:NotifyCustomerApp`	Set to `true` to inform the customer Integration API on call status changes.
`Application:Settings:CallBlockModuleOpen`	Set to `true` to enable call block lists.
`Application:Database:TimeFixMin`	Sets the difference between the database server's time and the local machine's time in minutes.
`Application:Features:Test`	Enables test features.
`Application:Features:OpenAPI`	Enables Swagger OpenAPI UI.
`Application:Tokens:Auth`	Authentication token settings.
`Application:Tokens:Request`	Request signing settings.
`Application:Tokens:Verification`	Verification data encryption settings.
`Serilog:MinimumLevel`	Default minimum level for logging.
`Kestrel:…`	Additional http://ASP.NET Kestrel HTTP server settings including HTTPS and SSL certificate settings if the IIS in-process hosting model is not used.

EnQualify Mobile API Proxy¶

Required Settings¶

Setting	Description
`Application:Settings:Production`	Must be set to `true` for production environment.
`Application:Settings:ServiceBase`	Internal URL of the Mobile API.
`SeriLog:WriteTo:…(File)…Path`	Path and filename of the local log file.

Optional Settings¶

Setting	Description
`Application:Settings:CorsOrigins`	List of URLs for CORS configuration.
`Application:Features:Test`	Enables test features.
`Application:Features:OpenAPI`	Enables Swagger OpenAPI UI.
`Application:Tokens:Auth`	Authentication token settings.
`Application:Tokens:Request`	Request signing settings.
`Serilog:MinimumLevel`	Default minimum level for logging.
`Kestrel:…`	Additional http://ASP.NET Kestrel HTTP server settings including HTTPS and SSL certificate settings if the IIS in-process hosting model is not used.

EnQualify Customer (Integration) API¶

Required Settings¶

Setting	Description
`Application:Settings:Production`	Must be set to `true` for production environment.
`Application:Database:Connections:Default`	Database connection string.
`Application:Integration:…`	Specific configuration settings for integration services and features.
`SeriLog:WriteTo:…(File)…Path`	Path and filename of the local log file.

Optional Settings¶

Setting	Description
`Application:Settings:CorsOrigins`	List of URLs for CORS configuration.
`Application:Database:TimeFixMin`	Sets the difference between the database server's time and the local machine's time in minutes.
`Application:Features:Test`	Enables test features.
`Application:Features:OpenAPI`	Enables Swagger OpenAPI UI.
`Application:Tokens:Auth`	Authentication token settings.
`Serilog:MinimumLevel`	Default minimum level for logging.
`Kestrel:…`	Additional http://ASP.NET Kestrel HTTP server settings including HTTPS and SSL certificate settings if the IIS in-process hosting model is not used.