Settings in settings.xml

Availability of the settings file is checked on BI server startup. The system searches for this file in the following folders:

Settings stored in the file are identical to those stored in the registry. The file stores these settings as an XML structure, where nodes' names correspond to the names of registry subsections, and attribute values correspond to parameter values.

Example of a settings file: settings_xml.zip.

All settings are specified within separate nodes <Key ...></Key>, which, in turn, are child nodes for the nodes <Configuration><Root>...</Root></Configuration>.

<Configuration>

  <Root>

    <Key ...>

    </Key>

    <Key ...>

    </Key>

  </Root>

</Configuration>

NOTE. To specify parameter values, use escaping of XML characters.

The System Section

The settings stored in the System registry key are stored in the file as child nodes of the <Key Name="System"> node. This node is the child one for the nodes <Key Name="PP"><BIS>...</BIS></Key>.

<...>

  <Key Name="PP">

    <BIS>

      <Key Name="System" GetStatusEnabled="true" >

        <Cert Alg="pro" Data="..." Id="SPCERT" Key="6E8E6325-496F-4177-BCEE-8A7859225C99" />

        <OAuth>

          <Key Name="Google"

            PPUserNameFormat="%s"

            ConsumerKey="214433571309-nl9btulcqc3u05d8128uaei3fjrdni8r.apps.googleusercontent.com"

            ConsumerSecret="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"

            AuthUrl="https://accounts.google.com/o/oauth2/auth/authorize?client_id=214433571309-nl9btulcqc3u05d8128uaei3fjrdni8r.apps.googleusercontent.com&amp;response_type=code&amp;access_type=offline&amp;scope=https%3A//www.googleapis.com/auth/userinfo.profile&amp;response_mode=query&amp;redirect_uri="

            Icon="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAB5SURBVDhPlZHJEQAhCASNy4CMx2hMxmBwPaBgxLXsJ9IyaKBHUKg5BiDmug47SnB6GeWwoLrtjVSSJ/TqIJVZODIF7r+2L4HzQBiXIWwDJOFCTTaCTEABl5Ynwh22m3hpMWCLo2D+QY35ET4wuMIXBo5lY6Jw5VEgatYLFxcSCQWXAAAAAElFTkSuQmCC"

            RequestTokenUrl="https://oauth2.googleapis.com/token"

            RequestCallbackParam="redirect_uri"

            UserDataUrl="https://www.googleapis.com/oauth2/v3/userinfo"

            UserIdAttr="given_name"

            UserNameAttr="name" />

        </OAuth>

        <Session KeyIncr="0" LockSession="-2" RWLockSlim="-2" LockAd="-2" Sampling="On" SamplingStr="IsOn" Cache="1" Statable="Never" StoreBins="3" StoreBinSize="2M" SysLogMb="FPRepository" TimeoutSec="-1" />

        <StateServer Type="Redis" Host="localhost" Port="-1" ExpireTime="3600" />

        <Pool MaxConnections="1" UserMaxConnections="0" Strategy="LRU" RetryCount = "20" RetryInterval = "2000">

          <Key Name="K1" Db="USER:FPRepository@FPServer" UserMaxConnections="1" />

        </Pool>

        <MbDefs AccessMode="1" />

        <Mbs>

          <Key Name="FPRepository" StatKeys="57637,150" />

        </Mbs>
       ...

      </Key>

    </BIS>

  </Key>

</...>

See settings description in the System Registry Settings section.

To work with directory services during setup of domain or integrated domain authentication, create the Ldap subsection in the System section. For details see the Working with Directory Services section.

NOTE. Working with directory services is can be set up only in settings.xml.

The Audit Section

The section with the Audit key contains credentials of service user of security subsystem. All parameters are specified in child elements of the <Key Name="Audit"> element, which in turn is a child of element of the <Root> element.

<...>

  <Key Name="Audit">

    <Key Name="Credentials">

      <Key Name="Item0" Realm="<...>" Crs="<...>" Crsa="<...>" />

      <...>

    </Key>

  </Key>

</...>

See settings description in the System Registry Settings section.

The Service Section

The section with the Service key contains settings for addressing a remote BI server. All parameters are specified in child elements of the <Key Name="Service"> element, which in turn is a child of element of the <Root> element.

<...>

  <Key Name="Service">

    <Epts>

      <Key Name="s0" address="http://localhost:9090/axis2/services/PP.SOM.Som" />

      <Key Name="s1" address="http://localhost:9091/axis2/services/PP.SOM.Som" />

      <Key Name="s2" address="http://localhost:9092/axis2/services/PP.SOM.Som" />

    </Epts>

    <Mbs>

      <Key Name="FPRepository1" endpoint="s0">

        <Cubes>

          <Key Name="k1" Keys="5" endpoint="s2" />

          <Key Name="k2" Keys="59,13837" endpoint="s0" />

        </Cubes>

        <UpdCache endpoint="s0" />

      </Key>

      <Key Name="FPRepository2" endpoint="s1">

        <Cubes>

          <Key Name="k1" Keys="18933,115978" endpoint="s1" />

        </Cubes>

        <UpdCache endpoint="s1" />

      </Key>

    </Mbs>

    ...

  </Key>

</...>

See settings description in the System Registry Settings section.

The InMem Section

The settings stored in the InMem registry key are stored in the file as child nodes of the <Key Name="InMem"> node. For details see the In-Memory Data Caching section.

<...>

  <Key Name="InMem">

    <Key Name="CacheType" Value="global" />

    <Key Name="DataDir" Value="C:\ProgramData\Foresight\Foresight Analytics Platform\inmem_data\" />

    <Key Name="MemLimitMb" Value="6000" />

  </Key>

</...>

See settings description in the System Registry Settings section.

The Dimensions Section

The settings stored in the Dimensions registry key are saved for the <Key Name="Dimensions"> node, which is a child element of the <Root> element. For details see the Working with Global Cache section.

<...>

  <Key Name="Dimensions" Cache="true" />

</...>

See settings description in the System Registry Settings section.

The License Section

The section with the License key contains licensing server connection settings in Linux OS. The License section is a child element of the <Root> element and contains a subsection with the Service key. For details see the Licensing Service and Features of Its Use section.

<...>

  <Key Name="License">

    <Key Name="Service" Active="True" Host="localhost" Port="8210"/>

  </Key>
</...>

NOTE. The License section is available for use only in settings.xml.

The SysLogServer Section

The section with the SysLogServer key contains syslog server connection settings for forwarding auditing event messages. The SysLogServer section is the child element of the <Root> element. For details see the Support of Work with Security Information and Event Management Systems section.

<...>

  <Key Name="SysLogServer" Active="true" Host="10.9.2.13" Port="514" Protocol="0" />

</...>

See description of settings in the System Registry Settings section.

Additional Subsections

<...>

  <Key Name="VirtualMemoryThreshold" Value="55" />

</...>

See settings description in the System Registry Settings section.

See also:

System Settings of Foresight Analytics Platform | System Registry Settings