BOARD Web - Application Settings

Document created by arocchietti Employee on Aug 4, 2017Last modified by davidegenini on Oct 7, 2019
Version 8Show Document
  • View in full screen mode

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 customized in the appSettings.config file located in "C:\Program Files (x86)\Board\Board WebApi Server\App_Data\Config" .

This article provides the developer with a description of every custom option configurable in this file:

Key nameFunction
hostHost and port of the web service. This setting is ignored if the site is published under IIS.
publicOriginFully qualified domain name of the host acting as Reverse Proxy. It is required only in case a Reverse Proxy is used.
boardEngineAddress of the BOARD Engine Server. When configured with SSL it must contain the fully qualified host name as defined in the certificate.
portTCP Port used by the BOARD Engine, the default value is 9700.
localAuthEnabledTo enable the button for username and password authentication on the login window. Accepted values: true or false.
winAuthEnabledTo enable the Windows authentication button on the login window. Accepted values: true or false.
anonymousAuthEnabledTo enable the anonymous authentication: all accesses will be mapped to the same BOARD user. Accepted values: true or false.
anonymousAuthUsername

BOARD user guaranteeing the anonymous authentication.

anonymousAuthPasswordPassword of the BOARD user guaranteeing the anonymous authentication.
useSSLTo enable SSL encryption between BOARD Web and BOARD Server. Mandatory if SSL is enabled on the BOARD Server. Accepted values: true or false.
headerTitleHiddenTo hide the screen title in page header. Accepted values: true or false.
chatEnabledTo enable the Chat. Accepted values: true or false.
presentationEnabledTo display the Presentations button in the top-left menu of the Web Client. Accepted values: true or false.
cognitiveSearchEnabledTo display the Cognitive Space button in the top-left menu of the Web Client. Accepted values: true or false.
cognitiveAnalysisEnabledTo display the Analysis feature in dataview and charts objects on BOARD Screens. Accepted values: true or false.
cognitiveCapsulesEnabledTo display the Capsules button in the top-left menu of the Web Client. Accepted values: true or false.
hideProcedureHasBeenTerminatedMailboxMessageTo display the error icon on procedure failures. Accepted values: true or false.
environmentTypeName given to the server to identify it while using the BOARD Transporter on the Web (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:

  1. Map every IP address to the hostname in the hosts file located in c:\Windows\System32\Drivers\etc
  2. 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:90/Callback.html,http://IP1:90/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

9 people found this helpful

Attachments

    Outcomes