Skip to main content

Configuration

The configuration is split into a number of sections and is stored in different files. There are settings for the MobileEngine, the Web Adapter and the application itself. The configuration files are XML files which means that the XML syntax must be adhered to when editing the files.

Configuration files for the Web layer

Configuration files for the application layer

Note: With a multiserver installation, you must always ensure that the Master service is the first service to be started when starting the Mobile Engine services. After startup, each slave registers itself with its master. If the master is restarted after the slave, the slaves are no longer registered and load distribution can no longer be performed.

Control and Behavior of the Session Timeout

Note:

  • In order to change the timeout property, you need to adjust all three timeout values because the timeout mechanisms work independently of each other. The smallest timeout value closes the connection to the server.

  • Please note that the value for the "user inactivity timeout" in the mobileenabler.cfg must not be lower than the other two timeout values. Otherwise, errors might occur when starting the application because sessions are still running on the server and ports are occupied.

Inactivity Timeout (mobileenabler.cfg)

The "user inactivity timeout" is responsible for terminating sessions that have not been closed, but which have received no user input within a specified period. This timeout is controlled using the "sessiontimeout" key in the file mobileengine.cfg. value is also specified in minutes, with the default being "20". Note that this value must not be lower than the value for the session timeout in the file web.config.

Session Timeout (web.config / IIS - Application settings)

CSP Mobile automatically terminates sessions when the app connected to a session is closed without the user having first explicitly logged out. Sessions such as these are referred to as "unused sessions" or "closed sessions", and the timeout mechanism is known as the "session timeout". This session timeout can be controlled using the "sessiontimeout" key in the file web.config. The value is specified in minutes, with the default being "20". The value can be reduced to a minimum of one minute ("1") in order to cause unused sessions to be terminated as soon as possible.

You should note that the risk of inadvertent termination increases if a lower value is set. Inadvertent terminations such as these can result from temporary network problems, insufficient bandwidth (with respect to the connection between the client computer and the IIS Web server) or from insufficient CPU power on the client computer when performing client-side calculations.

Idle Time-out (IIS - Advanced Settings)

The Idle Time-out defines the amount of time a worker process will remain idle before it shuts down. The Idle Time-out is specified in minutes, with the default being "20". The value can be adjusted using the IIS Manager.

  1. Open the Control Panel and choose System and Security > Administrative Tools.

  2. Select Application Pools > CubewareBI.

  3. Now call the Advanced Settings using the context menu or the Actions panel.

  4. Select the entry Idle Time-out (minutes) and adjust it as required.

IIS Advanced Settings

Using HTTPS

Communication between the app and the server can be handled over HTTPS, i.e. it can be encrypted.

The description below gives an example of how to set up SSL under IIS 8. If you are using a different version of IIS, refer to the online Help system for the relevant IIS version for information on how to set up SSL.

SSL Under IIS 8

  1. Open the Control Panel and choose Administrative Tools.
  2. Double-click Internet Information Services (IIS) Manager.
  3. Select the server and double-click Server Certificates.

    Server Certificates

  4. Create a self-signed certificate and give it a friendly name.

    Create self-signed certificate

  5. Select Default Web Site and add an SSL binding. Set the type to https, change the port if necessary and select the certificate you created.

    SSL binding configuration

  6. All Web sites below the Default Web Site can now be invoked over the configured secure connection.

Web Layer - Web.config

The web.config file is a default file of a web site in IIS. This file stores the settings for IIS and the virtual folder.

These settings can also be made in the IIS Manager.

  1. Open the Control Panel and choose System and Security > Administrative Tools.

  2. Double-click Internet Information Services (IIS) Manager.

  3. Expand the Default Web Site, select CubewareBI and check whether Feature View is set. If not, right-click CubewareBI and choose Switch to Feature View

  4. Now you can make the required settings in the Application Settings.

The file is located directly in the virtual folder of IIS. In a default installation this is C:\Inetpub\wwwroot\CubewareBI\Web.config.

Syntax example

<configuration>
...
<appSettings>
<add key="application" value="mobile"/>
...
</appSettings>
...
</configuration>

The following entries are relevant for the configuration:

Name

Default Value

Meaning

application

mobile

Specifies the application type for the server. Should not be changed.

config

mobileenabler.cfg

Specifies the configuration file that is used by the Web application.

server

localhost

Specifies the machine on which the Mobile Engine is running (application layer). The Web Adapter always connects to this machine.

port

4444

Specifies the port at which the Mobile Engine is accessible.

timeout

1200

Specifies the timeout in seconds for communication with the Mobile Engine. This value should not be too low, since heavy utilization of the Mobile Engine will lead to increased response times.

impersonate

0

Specifies whether the integrated security should be passed from IIS to the Mobile Engine. This setting is required for databases which require integrated security (e.g. Microsoft Analysis Services).

Caution: If the Mobile Engine is running on a machine other than IIS (multi-server), Impersonate can only be set to 1 if Windows authentication is activated in IIS.

sessiontimeout

20

Session timeout. Specifies the timeout in minutes after which a client is terminated automatically. This value is passed to IIS. In other words, the session management function of IIS takes care of the termination of the client. Refer also to the notes in the section Control and Behavior of the Session Timeout.

usekerberos

0

Specifies whether login should be performed using the Kerberos authentication mechanism or NTLM. 1 = Kerberos, 0 = NTLM

If the value for impersonate is set to 0, the usekerberos entry has no effect.

mobileprotocolversion

22

Forces a minimum version of the app. Should not be changed.

mobileminimumappversion

1.2

Name of the minimum version of the app (for information). The value should not be changed.

teamserver

localhost

CSP Server used. A CSP Server can also be set in the external settings of the mobile device. If no CSP Server is set in the mobile device, the specification made here is used.

whitelist

*

List of the repositories that can be used on mobile devices. The names of the repositories must be entered separated by semicolons.

Example:

Pantara AS;Pantara Mobile;Pantara Demo

Only the repositories "Pantara AS", "Pantara Mobile" and "Pantara Demo" can be selected on a mobile device. No other repositories can be selected.

* or empty means that all repositories can be selected.

Mobile Engine - mobileenabler.cfg

The Mobile Engine is configured in mobileenabler.cfg in the section <webruntime>.

In a standard installation, this file is located in the folder C:\ProgramData\Cubeware\CSP Mobile.

Syntax examples

<config>
<webruntime type="master"
maxworker="25"
workerswitch="3"
recycle="10"
port="4444"
portbase="4445"
watchdog="20"
sessiontimeout="20"
logging="max"
reservationtimeout="10"
assignment="load"
expiretime="60"
spn="HOST/MyServer.MyDomain.net">
</webruntime>
...
...
</config>

A Web runtime of the type "slave" always needs a <master> entry in order to identify the master:

<config>
<webruntime type="slave"
....
....>
<master ip="compname"
port="4444"/>
</webruntime>
...
...
</config>

The following entries are relevant for the configuration:

Name

Default Value

Meaning

maxworker

25

Specifies the maximum number of Worker processes that can be started on the machine.

workerswitch

3

Specifies how many clients a Worker process is able to serve concurrently. If this number is reached, a new Worker process is started. This specification is used for internal calculations regarding the utilization of the machine.

This value is very important as a Worker process is only permitted to use a maximum of 2 GB of memory. If a high value is selected for workerswitch, this may cause memory overflows. If a very low value is selected, it can lead to excessive task switching ("thrashing").

The setting should be selected in such a way that the normal memory requirements of a client multiplied by workerswitch are a maximum of 30% of the 2 GB limit (for systems with a 3 GB option, 3 GB).

The product of maxworker and workerswitch should give the number of clients for which the machine is set up. For calculation of the utilization of the machine, it can be assumed that this number corresponds to 100% utilization (for future load distribution mechanisms).

recycle

10

Specifies the number of served clients before the Worker process is restarted. When a Worker process reaches recycle number of clients (total since the process was started), no further clients are accepted. As soon as the last client in the process has terminated, the Worker process itself terminates. This mechanism is used to ensure that a Worker process does not occupy too many system resources.

port

4444

Specifies the port at which the clients communicate with the Mobile Engine.

The port can be freely selected, but should be greater than 5000.

Caution: If you change the port, check the specification for the portbase to prevent conflicts with the ports!

portbase

4445

Specifies the port number as of which ports are assigned for the Worker processes. One port number each is assigned to the Mobile Worker process and the Chart Worker process, starting at portbase. Each additional process i is assigned portbase + i. The port numbers of terminated Worker processes are recycled. It is important that the entire port range is free. The number of ports that can be occupied is portbase + maxworker * 2 + buffer.

portbase can be freely selected, but should be greater than 5000.

Caution: If you change the portbase, check the specification for the port to prevent conflicts with the ports!

watchdog

20

Specifies the interval for internal monitoring of the Worker processes. This specification is made in seconds.

sessiontimeout

20

User inactivity timeout. Specifies the "idle time" after which a client is terminated automatically. This specification is made in minutes.

Caution: This specification may collide with the session timeout in IIS (Web.config). Refer also to the notes in the section Control and Behavior of the Session Timeout.

logging

max

Specifies how many entries are created in the Event Viewer. The following values are permitted:

  • minimum or min: Only errors are output.
  • normal: Errors, warnings and important information is output.
  • maximum or max: All messages are output.

reservationtimeout

10

Specifies the time in seconds that the system will wait until a client has logged into the Mobile Worker.

assignment

load

Specifies the assignment strategy. The following values are permitted:

  • master: Assignment initially takes place to the master
  • slave: Assignment initially takes place to the slaves
  • load: Assignment is performed on a 50:50 basis

master/ip and master/port

Specifies the master for a Web runtime which is defined as type "slave". The IP address (or the NetBIOS name or the FQDN (Fully Qualified DNS Name)) and the port must be specified.

Was this article helpful?

We're sorry to hear that.