This document is intended to explain the various settings employed by the Manitou Web Client. Customers are not expected to modify these settings, but our support team members may find the need to adjust certain settings to accommodate requests from customers, to troubleshoot an issue, or to implement a new feature
API\web.config
The API\web.config is by default located in C:\inetpub\wwwroot\Manitou\api
ConnectionStrings section
EDIGIN:
The Edigin connection string is only used if you have SecurVoice.
<add name="Edigin" providerName="MySql.Data.MySqlClient" connectionString="server=[SECURVOICE_SERVERNAME]" />
LOGGER:
The Logger connection string is used for BoldNet logging.
NOTE: this is NOT the Manitou Logger. This is a separate database that gets written to when the client web.config has "ApiLogListener" listed as a "LogListeners" value.
<add connectionString="Data Source=[SQL_SERVER_NAME];Initial Catalog=ManitouClientLogs;User Id=[SQL_ADMIN_LOGIN];Password=[SQL_ADMIN_PASSWORD]" name="Logger" />
ASPNETDB:
The ASPNETDB connection string is used for validating the BoldNet users.
<add connectionString="Data Source=[SQL_SERVER_NAME];Initial Catalog=ASPNETDB;User Id=[SQL_ADMIN_LOGIN];Password=[SQL_ADMIN_PASSWORD]" name="AspNetDB" />
WEBPREFSDB:
The WEBPREFSDB connection string is used for BoldNet web preference storage.
<add connectionString="Data Source=[SQL_SERVER_NAME];Initial Catalog=WEBPREFSDB;User Id=[SQL_ADMIN_LOGIN];Password=[SQL_ADMIN_PASSWORD]" name="WebPrefsDB" />
AppSettings Section
WEBGATEWAY:
The WebGateway setting specifies the server name where the WebGateway Service is running.
<add key="WebGateway" value="[WEBGATEWAY_SERVERNAME]" />
SENTRY:
The Sentry setting specifies the server name where the Sentry Service is running.
<add key="Sentry" value="[SENTRY_SERVERNAME]" />
REPORT TEMPLATES:
The Report Templates setting specifies the path to the Reports folder on your IIS server.
Default value is C:\Inetpub\Wwwroot\Manitou\api\Reports.
<add key="ReportTemplates" value="C:\Inetpub\Wwwroot\Manitou\api\Reports" />
UPLOADS FOLDER:
The Uploads Folder setting specifies the path to your Uploads Folder on your IIS server. This folder will be used for uploading profile photos and for downloading reports through the web interface.
Default value is C:\Inetpub\Wwwroot\Manitou\UploadsFolder
<add key="UploadsFolder" value="C:\Inetpub\Wwwroot\Manitou\UploadsFolder" />
NOTIFYME CONFIG:
The NotifyMe Config setting specifies whether NotifyMe is setup or not on this system. The value is a binary 0 or 1 option.
The acceptable values are 0 or 1.
Default value is 0.
<add key="NotifyMeConfig" value="1" />
NEO INSTALLATION TYPE:
The Neo Installation Type setting determines whether the system will be a Manitou system, MDK, or a BoldNet system. This should be a single value based on the customer's need.
For the demonstration system, we do allow setting it Manitou & BoldNet by entering "Manitou.BoldNet" as the value. This is NEVER recommended in a customer environment.
<add key="NeoInstallationType" value="[Manitou_System_type]" />
DEFAULT USER:
<add key="DefaultUser" value="" />
DEFAULT PASSWORD:
<add key="DefaultUserPassword" value="" />
DEBUG:
The Debug setting is used to bypass the Local Utility Service check on demo and development systems.
The acceptable values are true|false.
Default value is false and should be set to false on customer systems.
<add key="Debug" value="true" />
LOG NOTIFICATIONS:
The Log Notifications setting designates whether notifications that are sent to users are also logged to a log file on the API server.
The acceptable values are true|false.
Default value is empty.
<add key="LogNotifications" value="true" />
LOG CONNECTION COUNTS:
The Log Connection Counts setting designates whether AppServer/WebGateway connection counts are written to a log file on the API server.
The acceptable values are true|false.
Default value is empty.
<add key="LogConnectionCounts" value="true" />
ERROR DETAILS:
The Error Details setting designates whether additional failure information is displayed to the end user. With this set to “False” the user would receive “An Error Has Occurred” instead of “Incorrect Username or Password”. The values are true|false.
<add key="ErrorDetails" value="true" />
LOG CONTROLLER CALL IN MS
The Log Controller Call In MS setting designates whether the API logs calls made to controllers that take more than the value in MS. The API logs this information to a log file on the API server. Setting it to 0 turns this feature off.
Default value is 0
<add key="LogControllerCallInMs" value="0" />
LOG MAKE CALL LOCK IN MS
The Log Make Call Lock In MS setting designates whether the API logs how long it took to get the lock to make an AppServer/WebGateway call. The API logs this information to a log file on the API server. Setting it to 0 turns this feature off.
Default value is 0
<add key="LogMakeCallLockInMs" value="0" />
LOG TOTAL CONNECTIONS
The Log Total Connections setting designates whether the API logs how many concurrent AppServer/WebGateway connections are active. The API logs this information to a log file on the API server. Setting it to false turns this feature off.
The acceptable values are True|False.
Default value is false
<add key="LogTotalConnections" value="false" />
LOG CREATING CONNECTION
The Log Creating Connection setting designates whether the API logs statistics when we need to create a new AppServer/WebGateway connection. The API logs this information to a log file on the API server. Setting it to false turns this feature off.
The acceptable values are true|false.
Default value is false
<add key="LogCreatingConnections" value="false" />
LOG DISCONNECTING CONNECTIONS
The Log Disconnecting Connections setting designates whether the API logs statistics when we disconnect from the AppServer/WebGateway connection. The API logs this information to a log file on the API server. Setting it to false turns this feature off.
The acceptable values are true|false.
Default value is false
<add key="LogDisconnectingConnections" value="false" />
CORS ORIGIN LIST
The CORS Origin List setting is a comma separated list of sites and it designates the web sites that are allowed access to the API other than the site that is hosting the API. Setting the value to "" means that only the site the API is hosted on is allowed to access data from the API. NOTE: CORS is only enforced by browsers. API developers can still get to the API even if their origin isn't in the list.
Default value is empty
<add key="CorsOriginList" value="" />
MANITOU\web.config
The Manitou\web.config is by default located at C:\inetpub\wwwroot\Manitou\manitou
AppSettings Section
WEBPAGES:ENABLED:
This setting should not be modified.
<add key="webpages:Enabled" value="false" />
WEBPAGES:VERSION:
This setting should not be modified.
<add key="webpages:Version" value="3.0.0.0" />
CLIENT VALIDATION ENABLED:
This setting should not be modified.
<add key="ClientValidationEnabled" value="true" />
UNOBTRUSIVE JAVASCRIPT ENABLED:
This setting should not be modified.
<add key="UnobtrusiveJavaScriptEnabled" value="true" />
TOKEN URL:
The Token URL setting specifies the path to our OAUTH token service. The domain section of this URL must match the domain section of the SSL certificate and the domain section of the URL specified in the browser address bar.
<add key="TokenUrl" value="https://[IIS_SERVER_NAME]/oauth/token" />
MANITOU API URL:
The API URL setting specifies the path to our Manitou API. The domain section of this URL must match the domain section of the SSL certificate and the domain section of the URL specified in the browser address bar.
<add key="ManitouApiUrl" value="https://[IIS_SERVER_NAME]/api" />
LOG LISTENERS:
The Log Listeners setting specifies the services monitored for the log.
Default values are ConsoleLogListener and ApiLogListener.
NOTE: you should only use ConsoleLogListener for a customer.
<add key="LogListeners" value="ConsoleLogListener,ApiLogListener" />
LOG LEVEL:
The Log Level setting specifies what level of logging to capture in the console.
LogLevel is like the Manitou log level. 5 is the highest and 1 is the lowest:
/** Manitou.Models.LogLevel */
export enum LogLevel {
error = 1,
warn = 2,
info = 3,
debug = 4,
debug2 = 5,
}
Default value is empty.
<add key="LogLevel" value="" />
LOG CATEGORIES FILTER:
The Log Categories Filter setting specifies which log categories will be displayed in the console. Multiple entries can be used by separating them with a comma. If the LogCategoriesFilter value is empty, then all categories will be output.
Default value is empty.
Acceptable values are Debugging, Translations, Exceptions, ApiSignalR, and LocalUtilityService.
<add key="LogCategoriesFilter" value="" />
LANGUAGE:
The Language setting determines which default language the browser should expect.
<add key="language" value="USENG" />
TIMEOUT:
The Timeout setting determines how long a user can remain logged into the Manitou Web Client or BoldNet Neo and be inactive before they are logged out.
<add key="Timeout" value="15" />
NEO INSTALLATION TYPE:
The Neo Installation Type setting determines whether the system will be a Manitou system or a BoldNet system. This should be a single value based on the customer's need. For the demonstration system, we do allow setting it for both by entering "Manitou,BoldNet" as the value. This is never recommended in a customer environment.
<add key="NeoInstallationType" value="[Manitou_System_type]" />
UTILITY SERVICE PORT:
The Utility Service Port specifies the port that the LUS (Local Utilty Service) will use for communication.
The normal value is 7020
<add key="UtilityServicePort" value="7020" />
VIDEO SERVICE PORTS:
The Video Service Ports specifies the port that the VCC (Video Control Center) will use for communication.
The normal value is 7022
<add key="VideoServicePorts" value="7022" />
CALL WATCHER SERVICE PORT:
The Call Watcher Service Port specifies the port that the Call Watcher Service will use for communication.
Default value is empty.
The normal value is 7023
<add key="CallWatcherServicePort" value="" />
DEBUG:
The Debug setting is used to bypass the Local Utility Service check on demo and development systems.
The acceptable values are true|false.
Default value is false.
<add key="Debug" value="true" />
ALLOW AD LOGIN:
The Allow AD Login setting enables the Active Directory Login feature and presents a new radio button option on the login page.
The acceptable values are true|false.
Default value is false.
<add key="AllowADLogin" value="false" />
DISABLED DIALOG ANIMATION:
The Disabled Dialog Animation setting disables the fade-in / fade-out animation which occurs when displaying pop-up dialogs. This can improve performance on some very slow systems.
The acceptable values are true|false.
Default value is empty.
<add key="DisableDialogAnimation" value="true" />
USERGROUPSETTINGS
<add key="UserGroupSettings" value="" />
Default value is empty.
Records are separated by a pipe. Fields in the record are separated by a comma.
Record format: UserGroupNumber,LandingPage,CanEditAlarmQueueHeaders,ShowWorkstationInActivityLog, LaunchVideoOncePerAlarm,ActivityLogView
UserGroupNumber:Acceptable values are the numeric representation of the chosen User Group.
LandingPage: The value should be the Path component of the URL.
• Example1: alarm/alarm-queue (this will open the alarm queue page when you log in)
• Example2: system-reports (this will open the System Reports page when you log in)
• Example2: customer/VIDEO/system/1/devices (this will open the "VIDEO" Customer > System > Devices page when you login)
CanEditAlarmQueueHeaders: default is false.
• 0=false
• 1=true
ShowWorkstationInActivityLog: default is false.
• 0=false
• 1=true
LaunchVideoOncePerAlarm default is false.
• 0=false
• 1=true
ActivityLogView default is false.
• 0=Standard
• 1=Report
• 2=Detail
• 4=Chronological
User Groups not defined here will go to the dashboard and can edit the alarm queue headers.
LandingPage default is Dashboard, CanEditAlarmQueueHeaders default is true (0=false,1=true)
Example: <add key="UserGroupSettings" value="1,alarm/alarm-queue,0,1|2,,1," />
An example explanation is in the table below:
OAUTH\web.config
The OAT\web.config is by default located at C:\inetpub\wwwroot\Manitou\oauth
ConnectionStrings section
ASPNET MEMBERSHIP:
The ASPNETDB connection string is used for validating the BoldNet users.
<add connectionString="Data Source=[SQL_SERVER_NAME];Initial Catalog=ASPNETDB;User Id=
[SQL_ADMIN_LOGIN];Password=[SQL_ADMIN_PASSWORD]" name="AspNetMembership" />
AppSettings Section
WEBGATEWAY:
The WebGateway setting specifies the server name where the WebGateway Service is running.
<add key="WebGateway" value="[WEBGATEWAY_SERVERNAME]" />
SENTRY:
The Sentry setting specifies the server name where the Sentry Service is running.
<add key="Sentry" value="[SENTRY_SERVERNAME]" />
DEBUG:
The Debug setting is used to bypass the Local Utility Service check on demo and development systems.
The acceptable values are True|False.
Default value is False.
<add key="Debug" value="true" />
