BOARD WEB Api application settings

Document created by arocchietti Employee on Aug 4, 2017Last modified by arocchietti Employee on Aug 7, 2017
Version 2Show Document
  • View in full screen mode
On this article there is a complete overview of all settings for BOARD WEB Api application including hidden settings

 

Application setting are usually located under "C:\Program Files (x86)\Board\Board WebApi Server\App_Data\Config"  in the file named "appSettings.confing"

 

The default file settings is listed below:

 

<appSettings>
  <add key="host" value="http://*:80/" />  <!-- used only in self-hosted -->   
  <add key="boardEngine" value="localhost" />
  <add key="port" value="9700" />
  <add key="localAuthEnabled" value="true" />
  <add key="winAuthEnabled" value="true" />
  <add key="anonymousAuthEnabled" value="false" />
  <add key="anonymousAuthUsername" value="" />
  <add key="anonymousAuthPassword" value="" />
  <add key="useSSL" value="false" />
  <add key="headerTitleHidden" value="false" />
  <add key="chatEnabled" value="true" />
  <add key="presentationEnabled" value="true" />
  <add key="cognitiveSearchEnabled" value="true" />
  <add key="cognitiveAnalysisEnabled" value="true" />
  <add key="cognitiveCapsulesEnabled" value="true" />
</appSettings>

 

Key legend:

 

host : Host and port of the web service , this settings is not used if installed under Microsoft IIS.
boardEngine : Address of the BOARD Engine server, when configured with SSL must contain the fully qualified host name as defined in the certificate.
port : TCP Port used by the BOARD Engine, the default value is 9700
localAuthEnabled : If true, it enables username and password authentication.

WinAuthEnabled : If true, it enables Windows authentication.

anonymousAuthEnabled : If true, it enables anonymous user.

anonymousAuthUsername : anonymous user username as defined in BOARD user list.
anonymousAuthPassword : anonymous user password as defined in BOARD Username.

useSSL : If true, enable SSL encription between BOARD web engine and BOARD engine. To be enabled if on the BOARD Server have SSL enabled.

headerTitleHidden : If true hide the screen title in page header.
chatEnabled : Enable the Chat, the default value is set to true.

presentationEnabled : Enable presentation feature, the default value is set to true.
cognitiveSearchEnabled : Enable Cognitive Search feature, the default value is set to true.
cognitiveAnalysisEnabled : Enable Cognitive Analysis feature, the default value is set to true.
cognitiveCapsulesEnabled : Enable Cognitive Capsules, the default value is set to true.

 

 

Optional settings not included in the default installation:

 

<add key="acceptedRedirectUris" value="callbackpage.aspx,https://mysite.com/SitePages/callbackpage.aspx" />

Used for mashup. The value must be any page name or address allowed to receive the call back. All sites, pages listed here will be authorized to be used as a mashup

   

 

 

 

 

 

 

6 people found this helpful

Attachments

    Outcomes