Board Web: Application Settings
Functionality
The Application Settings of the BOARD Web API Server are responsible of the following options:
- Web Server connection
- Authentication methods permitted
- Anonymous authentication activation
- Web menu display
- Chat activation
Default Settings
These settings can be customised.
File location: "C:\Program Files (x86)\Board\Board WebApi Server\App_Data\Config" .
File name: “appSettings.config”
This article provides the developer with a description of every custom option configurable in this file:
Key name | Function |
|---|---|
host | Host and port of the web service. This setting is ignored if the site is published under IIS. Value is “http://*:80/”, in the browser enter “localhost” (default value of the “boardEngine” parameter) and add the port number “:80” at the end, and press enter to access the locally installed instance of Board. Updating the “80” in the parameter value will allow you decide what port number is used I the URL. |
publicOrigin | Fully qualified domain name of the host acting as Reverse Proxy. It is required only in case a Reverse Proxy is used. |
boardEngine | Address of the BOARD Engine Server. When configured with SSL it must contain the fully qualified host name as defined in the certificate. Value is “localhost”, in the browser enter “localhost” and add the port number “:80” (default value of the “host” parameter) at the end per the host value (see above), and press enter to access the locally installed instance of Board. Updating the “localhost” in the parameter value will allow you decide what domain name is used I the URL. |
port | TCP (transmission control protocol) Port used by the BOARD Engine. The default value is “9700”. This value needs to match the “baseport” parameter in the BOARD Engine server config XML file to allow communication. |
localAuthEnabled | To enable the button for username and password authentication to appear on the login window. Accepted values: true or false. Local authentication set up will be required to use the enabled feature. There is no default if the value is absent, please ensure this is populated with an accepted value. |
winAuthEnabled | To enable the Windows authentication button to appear on the login window. Accepted values: true or false. Windows authentication set up will be required to use the enabled feature. There is no default if the value is absent, please ensure this is populated with an accepted value. |
anonymousAuthEnabled | To enable the anonymous authentication: all accesses will be mapped to the same BOARD user. Accepted values: true or false. There is no default if the value is absent, please ensure this is populated with an accepted value. |
anonymousAuthUsername | The BOARD user name required for the anonymous authentication. |
anonymousAuthPassword | The BOARD password required for the anonymous authentication. |
useSSL | To enable SSL encryption between BOARD Web and BOARD Engine. Mandatory if SSL is enabled on the BOARD Engine. Accepted values: true or false. There is no default if the value is absent, please ensure this is populated with an accepted value. |
headerTitleHidden | To hide the screen title in page header. Accepted values: true or false. There is no default if the value is absent, please ensure this is populated with an accepted value. |
chatEnabled | To enable the Chat. Accepted values: true or false. There is no default if the value is absent, please ensure this is populated with an accepted value. |
presentationEnabled | To display the Presentations button in the top-left menu of the Web Client. Accepted values: true or false. There is no default if the value is absent, please ensure this is populated with an accepted value. |
cognitiveSearchEnabled | To display the Cognitive Space button in the top-left menu of the Web Client. Accepted values: true or false. There is no default if the value is absent, please ensure this is populated with an accepted value. |
cognitiveAnalysisEnabled | To display the Analysis feature in dataview and charts objects on BOARD Screens. Accepted values: true or false. There is no default if the value is absent, please ensure this is populated with an accepted value. |
cognitiveCapsulesEnabled | To display the Capsules button in the top-left menu of the Web Client. Accepted values: true or false. There is no default if the value is absent, please ensure this is populated with an accepted value. |
hideProcedureHasBeenTerminatedMailboxMessage | To display the error icon on procedure failures. Accepted values: true or false. There is no default if the value is absent, please ensure this is populated with an accepted value. |
environmentType | Name given to the server to identify it while using the BOARD Transporter on the Web (feature inherited from Board 10.5). |
Optional Settings
If the machine hosting the Board Web API Server is mapped to multiple IP addresses, there are two potential solutions:
- Hostname based
- Redirect based
Hostname Based
In such a case, the developer would need to:
- Map every IP address to the hostname in the hosts file located in c:WindowsSystem32Driversetc
- Specify the hostname in the key host of the appSettings.config of Board
Redirect based
This option relies on an additional tag available on the appSettings.config, called acceptedRedirectUris. This tag redirects every authentication call to the IP addresses or hostnames defined in the tag itself (e.g. IP1 and IP2). The call must be redirect to the pages Callback.html and SilentRefreshFrame.html for every address separated by comma. An example of the syntax is shown below:
<add key="acceptedRedirectUris" value="http://IP1:80/Callback.html,http://IP1:80/SilentRefreshFrame.html,http://IP2:80/Callback.html,http://IP2:80/SilentRefreshFrame.html" />
This tag must be specified in a mashup configuration. The value must be any page name or address allows to receive the call back. All sites and pages listed here will be authorized to be used as mashup. A guide about the mashup is provided here: Howto: Embed a report on other sites