Web Service view

Web Service view

This view displays a set of properties to configure web service settings.

Figure 331. Web Service view

You select this view by choosing Controller (System) Setup > Miscellaneous > Web Service from the main menu.

Property	Value	Description
Status	read-only	Reports the condition of the entity or process at last polling. {ok} indicates that the entity is licensed and polling successfully. {down} indicates that the last poll was unsuccessful, perhaps because of an incorrect property. {disabled} indicates that the Enable property is set to false. {fault} indicates another problem. Depending on conditions, multiple status flags may be set including {fault} and {disabled}, combined with {down}, {alarm}, {stale}, and {unackedAlarm}.
Fault Cause	read-only	Reports the reason why a network, component, or extension is in fault. Fault Cause is blank unless a fault exists.
Public Service Port
Http Port	number (defaults to 80	Defines the port that the HTTP service listens on.
Http enabled	`true` or `false`	Turns the processing of HTTP requests on (true) and off (false).
Https only	`true` (default) or `false`	`true` redirects any attempt to connect using a connection that is not secure (Http alone) to Https. `false`, does not redirect attempts to connect using Http alone.
Https Cert	text	Sets the certificates that the user wants to use. By default the certificate is set to `tridium`.
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	`true` or `false`	`true` shows exception stack traces in error responses when available. `false` disables exception stack traces in error responses.
Applet Module Caching Type	drop-down list; defaults to `Host`	Determines how a client using the applet caches modules. `Host` results in a folder and the downloading of installation modules to the module folder. This results in the creation of multiple folders of downloaded modules, that negatively affect platform memory usage. `User` results in one cache per host visited, (user)- one shared cache per user. This option results in the creation of a .sharedModuleCache folder. The system then downloads to a sub-folder at this location. This option minimizes the memory required when running in a controller.
Web Start Enabled	`true` or `false`	`true`, permits users to use the Java Web Start application, enabling a link on the login page for the user to download a `jnlp` file used to launch the application. `false` disables this feature.
Create Start Menu Shortcut	`true` or `false`	Enables (`true`) and disables (`false`) the creation of a shortcut in the user's Start Menu for opening the Web Start `jnlp` file. The system creates the shortcut when the user launches Web Start after setting this property to `true`.
Create Desktop Shortcut	`true` or `false`	Enables (`true`) and disables (`false`) the creation of a Web Start application shortcut on the desktop. The system creates the shortcut when the user launches Web Start after setting this property to `true`.