Web Service view

This view displays a set of properties to configure web service settings.
Figure 343.   Web Service view
Image
You select this view by choosing Controller (System) Setup > Miscellaneous > Web Service from the main menu.

Properties

In addition to the standard properties (Status and Fault Cause), these properties support the Web Service.

Property Value Description
Public Server Port number (defaults to 80)
Specifies the HTTP client’s TCP port. The service listens on on this port for connections.
Http Enabled (general) true or false
Turns the processing of HTTP requests on (true) and off (false).
Public Server Port number (defaults to 443)
Specifies the HTTP client’s TCP port. The service listens on on this port for connections.
Https Enabled (general) true (default) or false
Turns the processing of HTTPS requests on (true) and off (false).
Https Only (general) true or false (default)
Configures the security of the connection.

true redirects any attempt to connect using a connection that is not secure (Http alone) to a secure Https connection.

false permits an Http connection.

Https Cert (general) drop-down list of server certificates; defaults to tridium
Specifies the alias of the host platform’s server certificate, which the client uses to validate server authenticity. The default identifies a self-signed certificate that is automatically created when you initially log on to the server. It cannot be deleted and should be used for recovery purposes. The default certificate is protected by the global certificate password. If other certificates are in the host platform’s key store, you can select them from the drop-down list.
X Frame Options drop-down list Prevents Cross-Frame Scripting (XFS) attacks. You choose whether or not a browser should be allowed to render a page in a <frame> or <iframe>, thus possibly allowing your content to be embedded into other sites.

Deny prevents any attempt to load the page in a frame. This option may negatively impact the display of information.

Sameorigin (default) loads the page in a frame as long as the site including it in a frame is the same as the one serving the page (same server).

If a page specifies Sameorigin, browsers will prevent framing only if the top-level origin FQDN (fully-qualified-domain-name) does not exactly match FQDN of the subframe page that demanded the Sameorigin restriction. This is considered a safe practice.

Any allows XFS and Cross-Site Scripting (XSS). This is the least safe choice.

Show Stack Trace (general) true or false
Controls if exception stack traces, when available, appear in error responses.

true shows exception stack traces in error responses when they are available.

false disables exception stack traces in error responses.

Web Launcher Module Caching Type (general) drop-down list; defaults to Host
Determines how a client using the Web Launcher caches modules.

Host results in a folder and the downloading of installation modules to the module folder (n4applet for N4, and wbapplet for AX). This results in the creation of multiple folders of downloaded modules, which negatively affects platform memory usage.

User results in the creation of a .sharedModuleCache folder (one cache per host visited; one shared cache per user). The system then downloads to a sub-folder at this location (n4applet for N4, and wbapplet for AX). This option minimizes the memory required when running in a controller.

Web Launcher Enabled true (default) or false Enables (true) and disables (false) the use of the Web Launcher.
Min Threads number (defaults to 4) Ensures that at least four threads process at a time.
Max Threads number
Tunes large networks (those with many station components) to process more than a single thread at a time. It is the only visible part of a shared thread-pool scheme for scaling large-jobs and allows the local station’s thread pool to grow uncapped.

Each thread uses one JDBC Connection to communicate with the database, so there are as many connections created as there are threads.

Normally you increase this value to between 20 and 50 to improve performance when handling large volumes of data.

Thread Idle Timeout hours minutes seconds (defaults to five hours) Configures the amount of idle time to elapse before a thread times out.