Skip to end of metadata
Go to start of metadata

 

General

Component Palette Icon:


IULocgo


Web Browser

Description

The Web Browser component in Designer allows you to embed a full web browser inside of an Ignition Client. This component becomes available in Designer after you download the Web Browser module from the Inductive Automation's website. The Web Browser module installs the same way as any other modules. Once this component is added onto a window, it will behave just like any other web browser when it is inside a Client.

Client machines need to meet the following minimum requirements to use this component. The component may not work properly if the requirements are not met.

Operating System Requirements

Windows

  • Microsoft Windows XP (SP2), 7, 8, Vista, Server 2003 (SP1), Server 2008/2012, 32-bit and 64-bit.
    • Windows version 8 and 8.1 require Java 6 update 38 or greater
  • Oracle (Sun) JRE 1.6.x and higher, 32-bit and 64-bit.

Linux

  • Ubuntu 12.04+, Debian 7.7, RedHat Enterprise Linux 7, openSUSE 13.1, Fedora 20, 32-bit and 64-bit
  • Oracle (Sun) JRE 1.6.x and higher, 32-bit and 64-bit.

    Required Linux Libraries

    Missing Libraries: 32-bit Ubuntu 12.04

    Some 32-bit Linux distros are missing a needed library for running the Web Browser: libXss.so.1

    Steps that fixed it in Ubuntu 12.04:

    sudo apt-get update
    sudo apt-get upgrade
    sudo apt-get install ia32-libs-multiarch

    Missing Libraries: Ubuntu 17.04

    Ubuntu 17.04 is missing a library that is required for the component to run. Running the following command can resolve the issue:

    sudo apt-get install libgconf-2-4

    Mac OS X

    • Mac OS X 10.7.x - 10.10.x (Intel)
    • Apple or Oracle (Sun) JRE 1.6.x and higher, 32-bit and 64-bit.


This feature is new in Ignition version 7.9.8
Click here to check out the other new features

As of 7.9.8, the underlying JxBrowser was updated and now has a new set of system requirements. If your Web Browser used to work, but does not meet the requirements of the newer versions, it is possible to install an older Web Browser module on a newer Ignition Gateway.

Windows

  • Microsoft Windows 7, 8, 8.1, 10, Server 2008 R2, Server 2012, Server 2016, 32-bit and 64-bit.
    • Windows version 8 and 8.1 require Java 6 update 38 or greater
  • Oracle (Sun) JRE 1.6.x and higher or IBM JRE 1.7.x and higher, 32-bit and 64-bit.

Linux

  • Ubuntu 14.04+, 17.04 Desktop, Debian 8+, RedHat Enterprise Linux 7, openSUSE 13.3+, Fedora 24+, 64-bit only
  • Oracle (Sun) JRE 1.6.x and higher or IBM JRE 1.7.x and higher, 32-bit and 64-bit.

Required Linux Libraries

Missing Libraries: Ubuntu 17.04

Ubuntu 17.04 is missing a library that is required for the component to run. Running the following command can resolve the issue:

sudo apt-get install libgconf-2-4

Mac OS X

  • Mac OS X 10.9.x - 10.13.x (Intel)
  • Apple or Oracle (Sun) JRE 1.6.x and higher, 32-bit and 64-bit.

The Web Browser Component will only support the following video codecs: Opus, Theora, Vorbis, VP8, VP9, and WAV.

The underlying browser component is available in scripting through the getBrowser() method. Documentation on the browser component is available at the JxBrowser Programmer’s Guide. The Inductive Automation support team is unable to provide detailed advice on scripting with this component. Furthermore, they are unable to provide troubleshooting beyond the basic functionality of the module.


Hardware Notes

ARM

Currently, the jxBrowser does not support the ARM architecture, thus the component will not work properly when used in conjunction with the ARM architecture.

Properties
Properties
NameDescriptionProperty TypeScriptingCategory
BorderThe border surrounding this component. NOTE that the border is unaffected by rotation.Border.borderCommon
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
FTP Proxy PortFTP Proxy Port sets the proxy port for FTP connections. This setting is only used when Use Proxies is checked.int.ftpProxyPortData
FTP Proxy ServerFTP Proxy Server sets the proxy server for FTP connections. This setting is only used when Use Proxies is checked. Can be emptyString.ftpProxyServerData
HTTP Proxy PortHTTP Proxy Port sets the proxy port for HTTP connections. This setting is only used when Use Proxies is checked.int.httpProxyPortData
HTTP Proxy ServerHTTP Proxy Server sets the proxy server for HTTP connections. This setting is only used when Use Proxies is checked. Can be emptyString.httpProxyServerData
HTTPS Proxy PortHTTPS Proxy Port sets the proxy port for HTTPS connections. This setting is only used when Use Proxies is checked.int.httpsProxyPortData
HTTPS Proxy ServerHTTPS Proxy Server sets the proxy server for HTTPS connections. This setting is only used when Use Proxies is checked. Can be emptyString.httpsProxyServerData
ModeData source for browser. Mode controls whether Starting URL or Starting HTML will be used.int.modeData
NameThe name of this component.String.nameCommon
Popups AllowedThis flag is used to allow popups in the web page displayed.boolean.popupsAllowedBehavior
Proxy ExceptionsA comma delimited list of rules for websites that will bypass the proxy servers. An example sting would be "*foo.com,<local>,127.0.1". This setting is only used when Use Proxies is checked.String.proxyExceptionsData
Proxy PasswordThe password to use for proxy authentication. This setting is only used when Use Proxies and Use Proxy Authentication are checked.String.proxyPasswordData
Proxy UsernameThe username to use for proxy authentication. This setting is only used when Use Proxies and Use Proxy Authentication are checked.String.proxyUsernameData
Show Navigation ButtonsShow the navigation buttons at the top of the frame.boolean.showNavigationBehavior
Starting HTML

The initial HTML displayed when the Mode is set to HTML.

Starting HTML is

<html><body>&nbsp;</body></html>

by default, which gives a blank page.

String.startingHtmlData
Starting URLThe initial URL displayed when the Mode is set to URL. Starting URL is blank by default.String.startingUrlData
Use Proxies If checked, the Web Browser will try to use the proxy settings.boolean.useProxiesData
Use Proxy AuthenticationIf checked, the browser will use the username and password for proxy authentication. This setting is only used when Use Proxies is checked.boolean.useProxyAuthenticationData
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Zoom LevelThe zoom level the web page is displayed in. 0.0 is normal, positive numbers zoom in, negative numbers zoom out.double.zoomLevelBehavior
Scripting
Scripting Functions
 .getBrowser()

 

  • Description

This function will return the underlying browser object. See JxBrowser Programmer’s Guide for more information.

  • Parameters

none 

  •  Return

Object - The Browser Object

  • Scope

Client

Extension Functions

This component does not have extension functions associated with it.

Event Handlers
 propertyChange
 propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.sourceThe component that fired this event.
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyNameThe name of the property that changed. NOTE: remember to always filter out these events for the property that you are looking for! Components often have many properties that change.
Examples

There are no examples associated with this component.

  • No labels

2 Comments

  1. Anonymous

    What is the source module for the Web Browser component?  I remember reading in the old docs how to script to it and the documentation on the open source project it is built on, but I cannot find it anywhere in the new docs...

    1. It is the only thing in the "Web Browser" module