Service Configuration View

The Services Configuration View is opened by clicking the Services Configuration button. It is used to manage settings for each of the site's web applications and web services. A list of the applications and services is displayed in a slide out pane. ClosedShow picture

To view the setting for a particular service click on its name. Many of the setting are read only as they are generated automatically by the WDC at the time of deployment and require re-deploying the web site for taking any change into account. These are displayed in the Information tile. Those settings that can be changed are displayed in the Settings tile. The following screen-shot of the settings for the GraphicalData service. ClosedShow picture

Using the Information tab can be useful for diagnostics, but changing settings affects the behavior of the corresponding service or web application and will anyway be replaced at the next re-deployment if changes were not done using the WDC itself. You should not change them if not recommended to.

Settings for the OAuth service

  • Access token lifetime - The access token is a short-lived token used when accessing the services. The default is 20 minutes.
  • Refresh token lifetime - The refresh token is a long-lived token used when renewing the expired access token. Range 0 to 2147483647 minutes. The default is 10080 minutes (7 days).
  • Property Server endpoint - Reserved.
  • Allow Remember me - If activated, users of WebVue and the WebScheduler web apps will be offered the Remember Me tick box on the login page. Depending on your IT policy, you may or may not want to offer users this opportunity leading to storage of user credentials in a cookie. In all cases, users should be recommended not to tick this box when connecting from a device shared with other users.
  • Perform a reverse DNS lookup to get the client host address - If activated the OAuth service attempts to get the client host address using the IP address.

Settings for the WebClient web app

  • Ignore certificate errors - If activated, a certificate will be accepted by the WebClient web app even if it is not trusted. You can activate it as a convenience on development and test machines if a self-signed certificate is in use. But it is recommended to use a valid certificate and disable this setting on web servers in production.
  • Use client host for redirect - Services perform several redirects to other services to handle Authentication. By default, the redirect URIs are generated by IIS based on the binding configuration. This leads to errors in case the IIS is behind a network device performing port translation. If enabled, the redirect URIs are generated based on the hostname that the clients sends in the Http request header. This setting must be enabled if a Gateway or a Router with Port Address Translation (PAT) is in place.
  • Enable PWA - If activated, allow installation of the WebClient (WebVue) as a PWA.

Settings for the WebScheduler web app

  • Ignore certificate errors - If activated, a certificate will be accepted by the WebScheduler web app even if it is not trusted. You can activate it as a convenience on development and test machines if a self-signed certificate is in use. But it is recommended to use a valid certificate and disable this setting on web servers in production.
  • Use client host for redirect - Services perform several redirects to other services to handle Authentication. By default, the redirect URIs are generated by IIS based on its own binding. This leads to errors in case the IIS is hidden behind a network device performing port translation. If enabled, the redirect URIs are generated by the Host that the clients sends in the HTTP Request header. This setting must be enabled if a Gateway or a Router with Port Address Translation is in place.
  • Hide schedule status columns - If activated, the timetable status columns are not displayed in the Overview page of the WebScheduler portal (columns Standard week is empty and Exception period is active).
  • Enable help - If not activated, the user access to the help from the run-time WebScheduler portal is prevented.

More settings are available, they are described in the topic WebScheduler Portal configuration.

Settings for the GraphicalData service

  • Connection timeout - The amount of time to leave the web socket connection open and waiting for a response before closing it and opening a new connection. Defaults to 110 sec.
  • Disconnect timeout - The amount of time to wait after a web socket connection is lost before raising the Disconnected event. Defaults to 30 sec.
  • Keep alive - The interval in seconds at which the Core back end is pinged by the GraphicalData service to keep the session alive. Minimum value is 5 sec, maximum is 60 sec, default is 10 sec.
  • Output buffer size for messages - Each time something changes in a mimic, a message is sent from the GraphicalData service to the client. This setting defines how many of these messages are buffered in case that there are more updates in a mimic than the client can handle. If the connection is slow, it can help to increase the value of this setting, but it will also increase the memory consumption on the server. The minimum value is 32, maximum is 65535, default is 100.
  • Show detailed error messages - If enabled, detailed traces are generated by the service for diagnostic purpose.
  • Cache lifetime for images - The amount of time in seconds that will be transmitted to the Web browser for handle the caching of images and audio file when using WebVue (max-age cache Http header). The default value is 0, it correspond to requesting web browsers to refresh their cache after 'age of the file/10'. For example, if an image file is 100 days old, the cache lifetime on the web browser side will be 10 days, after which it will ask the resource again to the web server. This setting does not apply to caching of JavaScript and Html files.
  • Property Server endpoint - Reserved.
  • Property Server callback port - The TCP port used by the Core back end to call the web server back to notify about data changes. This port must be open (incoming) on the IIS web server computer (default 8091).
  • Machine name - This setting is related to the communication layer used between the GraphicalData service and the Core back end. When the connection is established, the client (GraphicalData service) needs to tell the back end where it listens to the callbacks.

    By default, the hostname (or IP) from the first NIC is used, this setting overrides the default. It is necessary to customize the Machine name setting if you need to tightly control which network interface is used on the IIS Web server for callbacks from the Core back end, for example, if you use a VPN tunnel between the 2 machines.

Settings for the other services - SessionContext, RealTimeAlarm, RealTimeData, HistoricalData, ScheduleData, Geolocation, Tracking and Messaging

The other services have no setting other than reserved.

When the WDC detects that you select a certificate that cannot be validated (a self-signed cert for example), it automatically activates the Ignore certificate errors for WebVue and the WebScheduler. This is to make development and testing possible without a trusted certificate.

This setting is defined automatically by the WDC at the time of 1st deployment and when importing a deployment configuration.

It is important that you manually disable this setting from the Service configuration view if you replace an untrusted certificate by a trusted one on a web server.