(r5) AppxHTMLClient546 < Main

Tags: view all tags
---+ APPX HTML Client 5.4.6 & Higher

_This page gives installation instructions and an overview of the Appx HTML client._

<br />%TOC%
---++ Overview

The Appx HTML client is designed to allow you to connect to an Appx server and run Appx applications using a browser, either on the desktop, a tablet or a smartphone. When running the client in a browser, no software is required on the desktop, tablet or smart phone. When the user logs on, the necessary code is downloaded to their device as required.

In this release, you can only run the applications, you cannot design them. Specifically, the ILF editor, old ILF Debugger and Image Editor are not supported. You may be able to work in Application Design so long as you avoid those.

The client will support SSL connections if your web server is configured appropriately. If not, the client will use its own built in AES encryption *but be aware that this is not sufficient to protect sensitive data*.

The Appx HTML client consists of two modules:
   * Web Server Files (webhost.zip). These are the javascript libraries and style sheets that make up the HTML client. This also contains the optional Local Connector for Windows, Mac and Linux clients. These must be installed in your web server's document directory.
   * APPX Server connector (serverConnector.zip). This is a javascript library that connects the client running in your browser to the actual Appx engine.
Note that Appx does not have to be running on the same server as your web server, and the APPX Server Connector does not have be on the same server as either Appx or your web server. This gives you maximum flexibility in configuring your installation.

Once the HTML client is working, you can connect to any Appx 5.4+ server, just as you can with the Appx Desktop Client. Due to the engine changes that were made in 5.4 to support the HTML client, you cannot connect to an earlier Appx engine.

We have tested the HTML client on current versions of IE, Chrome, Firefox and Safari.

*Prerequisites*

In addition to a 64 bit Operating System (Windows or Linux), the server that will run the APPX Server Connector requires some additional software:
   * The 'nodejs' package (<a href="https://nodejs.org/" target="_blank">https://nodejs.org/</a>).
   * The Mongo Database (<a href="https://www.mongodb.org/" target="_blank">https://www.mongodb.org/</a>).
See below for details on installing these packages.
---+++ Local Connector vs Web Browser

There are 2 ways the HTML client can interact with processes on the APPX Server (uploading/downloading/displaying files, invoking programs on the client).
---++++ Local Connector

The Local Connector is a small 'helper' program that allows you to upload/download and open files on the users desktop, similar to the way it can be done with the APPX Desktop Client. By default, the HTML client will check to see if the local connector program is running when the user logs in. If it is not running, it will offer to install it, and if the user cancels they will be nagged the next time they log in. If your application does not require the ability to upload/download/open files on the users device or invoke programs on the user's device you can turn this off (see Installation below).

The Local Connector is a 64 bit application that only runs on 64 bit Windows, OS/X or Linux based desktops or tablets.

There is a 'Connectivity' indicator in the lower right corner of the browser window with the words 'Remote' and 'Local'. If 'Local' is in green with a "+", it means the local connector is installed & running. Red means the connector is not installed. You can click the 'Local' sign to manually download and install the connector. If the 'Local' icon is blue, it means the requirement for a local connector has been turned off via metas["appx-local-required"]["value"] = "false"; in the your 'appx-client-settings.js' file (see below).
---++++ Web Browser

The other option is to use the Web Browser's built in ability to handle files. With this option, the APPX Server Connector stores the file in the Mongo database, then passes a URL to the Web Browser. The Web Browser will either display the file in a new tab if it knows how display that file type, or offer to save the file if it does not know how to display it. This is a better choice if you are planning to deploy your applications on non Windows tablets or smartphones.

The file only remains in the Mongo Database for 5 seconds after it is retrieved, so if the user refreshes that tab they will get error 404.

When uploading files, the web browser uploads the file into the Mongo database and returns a file path to your APPX process. You can use this path with .CLIENT UPLOAD FILE to transfer the file out of Mongo to the final destination. Note that using this method means you will not get the original path and file name as it existed on the user's computer. If you need this information, then you will have to use the Local Connector method. Files will stay in the Mongo database until the session ends, then they will be removed.

The Web Browser option does NOT allow you to invoke programs on the user's device (see <a href="Main.0LASubrClientLoadURL" target="_blank">.CLIENT LOAD URL</a>). If you need this capability, you will have to use the Local Connector option.

*NOTE: This option only works if you are connecting to an APPX server running Release 5.4.5 or higher.*
---+++ Differences between ADC and HTML Clients

The HTML client has a different presentation for most non-Appx elements such as Date Choosers, File Upload/download dialog boxes, Tables, etc. The goal of the HTML client was to replicate the presentation of your screens as accurately as possible as far as the Appx elements are concerned (i.e., the widgets and fields you use in the Image Editor). Since we use different 3rd party tools and runtimes for other elements, they will look different compared to the Appx Desktop Client.
---++ Requirements

You will need a web server, either Linux or Windows based (64 bit). If you are going to use the Apache web server and you want to use a forwarding proxy, it must be version 2.4 or higher. We have tested IIS on Win 7 with success, earlier versions of IIS have not been tested.

The web server does not have to be on the same server as Appx.

If you plan to use an SSL connection, your web server must be configured to accept both SSL and non-SSL connections. *Note: if you are trying to use SSL with the local connector running you will receive an error saying that part of your connection is not secure. The local connector does not have the functionality to talk to the browser using SSL. This is just an informational message.*

If you are going to run the APPX Server Connector on a Windows server, make sure all patches have been applied. In particular, <a href="https://support.microsoft.com/en-us/kb/2731284" target="_blank">https://support.microsoft.com/en-us/kb/2731284</a> will break tables if it is not applied
---++ Installation - Web Server Component

1) Extract the Web Server File (webhost.zip) into the document folder for your web server. Depending on your web site layout, you may want to put this in its own folder within the web server documents, i.e., /var/www/html/appx.

2) If this is a new installation, you *must* rename the appx-client-settingsTemplate.js file to appx-client-settings.js. This file is in the 'js' subdirectory. For example:
<pre>[root@localhost]# cd js
[root@localhost js]# mv appx-client-settingsTemplate.js appx-client-settings.js
</pre>

This file is where you will configure your site specific settings, similar to 'appx.env' in an APPX server installation.

3) If this is a new installation you *must* set the name of the host running the Appx Server Connector in the 'appx-client-settings.js' file you just renamed:

metas["appx-proxy-host"]["value"] = "localhost";

Change locahost to the name or IP address of the server running the Appx Server Connector. *Do _not_ use localhost unless you plan to run the HTML client on the same server as the Appx Server Connector, i.e., a testing/evaluation environment.*

You can also set any other meta tags that are unique to your installation. The 'appx-client-settings.js' file will never be replaced during an update, so the settings will remain until you change them. For example, you can set the name and login port of the APPX server, the default rows & columns, whether to use the Local Connector or not, etc. Consult the 'appx-client-settings.js' file for the full list of meta tags that can be set.
---++ Installation - APPX Server Connector Component

The APPX Server Connector is the software that connects the HTML clients and the APPX server. This can be installed on the same server as the web server, or the APPX Server, or a completely different machine. If you are not using tunnneling via the web server, then ports 3014/3015 (the default port) needs to be open between the server connector machine and your HTML clients.
---+++ Prerequisites

The server that will run the APPX Server Connector requires some additional software:

   * The 'nodejs' package (<a href="https://nodejs.org/" target="_blank">https://nodejs.org/</a>). <p>For rpm based Linux systems, you can install it via (as root):<br />curl --silent --location https://rpm.nodesource.com/setup | bash -yum install nodejs</p> <p>To install on Windows, go to https://nodejs.org and download the Windows installer (msi) file and simply run the installer.</p>

   * The Mongo Database (<a href="https://www.mongodb.org/" target="_blank">https://www.mongodb.org/</a>). Instructions for downloading and configuring the database can be found at <a href="https://docs.mongodb.org/manual/tutorial/" target="_blank">https://docs.mongodb.org/manual/tutorial/</a>
   * If the server is running Windows, you also need to install .NET Framework 3.5. Quick install instructions: <p>Press the Windows key on your keyboard, type Windows Features, and press Enter. This brings up the Turn Windows features on or off dialog box. ...<br />Select the .NET Framework 3.5 (includes .NET 2.0 and 3.0) check box, press OK, and reboot your computer if prompted.</p>

---+++ Installation

1) If you are upgrading from a prior release, you *must* uninstall the old Server Connector first by running 'appxConnector-uninstall.js'. You must do this *before* installing the new connector. This should be run as 'root' on Linux/Unix systems, and as an Administrator on Windows systems. To run the script, open a terminal or DOS window and navigate to the folder where you installed the Appx Server Connector, then invoke the script via 'node':
<pre>[root@localhost appxConnector]# node appxConnector-uninstall.js 
Using default mode: systemd
Uninstall complete.
The service exists: false
[root@localhost appxConnector]#</pre>

2) Extract the Appx Server Connector to a location of your choice. A folder in the /opt directory would be a good choice on a Linux server.

3) Run the appxConnector-install.js script. This should also be run as 'root' on Linux/Unix systems, or as an Administrator on Windows systems. This will check your system for the required modules. To run the script, open a terminal or DOS window and navigate to the folder where you installed the Appx Server Connector, then invoke the script via 'node':
<pre style="padding-left: 30px;">[root@localhost ~]# cd /opt/appxConnector<br />[root@localhost appxConnector]# node appxConnector-install.js  <br />Checking for required modules... <br />Module: crypto          - Installed. <br />Module: fs                 - Installed. <br />Module: hexy            - Installed.<br />Module: http             - Installed. <br />Module: https           - Installed. <br />Module: mongodb     - Installed. <br />Module: net              - Installed. <br />Module: node-cryptojs-aes    - Installed. <br />Module: string          - Missing, please run 'npm install string' to install. <br />Module: string_decoder      - Installed. <br />Module: url           - Installed. <br />Module: ws            - Installed. <br /><br />Missing modules. Please install required modules and run again.</pre>

Notice in this example the module 'string' is missing and the instructions on how to install it are displayed. If any modules are missing on your system, run the appropriate 'npm' command to install them, then re-run the install script. If all modules are present, the service will be created:
<pre style="padding-left: 30px;">[root@localhost appxConnector545]# node appxConnector-install.js</pre> <pre style="padding-left: 30px;">Checking for required modules...<br /> No arguments received, using default settings for install Module: crypto - Installed.<br /> Module: fs - Installed.<br /> Module: hexy - Installed.<br /> Module: http - Installed.<br /> Module: https - Installed.<br /> Module: mime - Installed.<br /> Module: mongodb - Installed.<br /> Module: net - Installed.<br /> Module: node-cryptojs-aes - Installed.<br /> Module: string - Installed.<br /> Module: string_decoder - Installed.<br /> Module: url - Installed.<br /> Module: ws - Installed.<br /> <br /> Using default mode: systemd<br /> Installing service on /etc/systemd/system/appxconnector.service<br /> Running systemctl daemon-reload...<br /> Installing appxConnector3014 service...<br /> Done... Waiting on service to start...<br /> Running systemctl start appxconnector...<br /> Service appxConnector3014 started<br /> Using default mode: systemd<br /> Installing service on /etc/systemd/system/appxmongoconnector.service<br /> Running systemctl daemon-reload...<br /> Installing appxMongoConnector3015 service...<br /> Done... Waiting on service to start...<br /> Running systemctl start appxmongoconnector...<br /> Service appxMongoConnector3015 started</pre>

4) Confirm the service is running. In Linux/Unix you can use 'ps -ef|grep appx', and in Windows you can use the 'Services' control panel.

Assuming the web server to which we installed the client is 192.168.0.15, and that we installed everything into an 'appx' folder on the web server, then we should be able to get a client login dialog box via:

http://192.168.0.15/appx/client.html

You must open ports 3014/3015 on the server running the APPX Server Connector for this connection to work. If you do not want to open any new ports on your firewall, see the section on 'Tunneling/Forwarding'. <b><br /></b>
---+++ Post Installation if upgrading an existing HTML client installation

If you are upgrading an existing HTML client installation, then you should check the following:
   * If you have customized 'client.html' you will have to re-do your customizations as it will be replaced when the new files are installed.
   * If you have created your own login page based on the standard 'client.html', compare your page and the standard 'client.html' for any changes that might be required.
---+++ Installing Multiple Server Connectors

You can install multple server connectors, each listening on different ports.

There are various reasons why you would want to do this:
   * You have development, model and production installations of APPX all on the same server. In this case, you would install a matching server connector in 3 different folders and configure each one to use a different set of ports. When a new release is available, you could install it in the test folder without affecting the model or production versions.
   * Load balancing. You could install multiple connectors as above and configure multiple ports and have different users connect on different ports by setting up different 'appx-client-settings.js' files on the web server. In this case, you would install the web server component multiple times into different folders then customize the 'appx-client-settings.js' file in each folder. For example, all users in a certain department use a settings file that uses ports 3014/3015, another department might use use a settings file that uses 3020/3021, etc. Each department woudl have it's own login page on the web server.

By default the installer will install a server connector on port 3014 and a mongo connector on port 3015. The installer accepts the following arguments:
<literal>node appxConnector-install [appx | mongo] [appxport] [mongoport]</literal>

Examples:
<pre>node appxConnector-install appx 3020</pre>

Installs a server connector listening on port 3020
<pre>node appxConnector-install mongo 3021</pre>

Installs a mongo connector listening on port 3021
<pre>node appxConnector-install 3020 3030</pre>

Installs a server connector on 3020 and a mongo connector on 3030.

You can then create different folders to contain the client.html pages using the different ports via setting "appx-proxy-port" and "appx-mongo-port" in each appx-client-settings.js file in each folder. If you are using port forwarding, then you'll have to create unique names and use those names instead (they all would use port 80).
---++ Local Connector or Web Browser Configuration

As mentioned above, you have a choice on how the HTML client should handle files sent to/from the browser.

By default, the HTML client will try to use the local connector. You can suppress the requirement for the Local Connector by uncommenting the following line in your appx-client-settings.js file:

//metas["appx-local-required"]["value"] = "false";

Remove the leading // to uncomment the line.

If you do not turn off the Local Connector requirement as above, then when the 'client.html' page is loaded it will check to see if the local connector is running on the users desktop. If not, they will get a dialog box offering to download the local connector. The actual installation of the local connector varies by the O/S on the user's desktop:
   * Windows: Once the download is complete, run the installer. The local connector will be installed, started and Windows will be configured to automatically start on a reboot. No further action is required.
   * Mac O/S: Once the download is complete, open the disk image and double click the installer. The local connector will be installed and started. The local connector will have to manually started after each login by opening a terminal window and entering the command "cd [[AppxLocalConnector]];open node-webkit.app". Alternatively, the user can add 'node-webkit.app' in their [[AppxLocalConnector]] folder to their Login Items in System Preferences.
   * Linux: Once the download is complete, open a terminal window and enter:
      * cd Downloads (or wherever the file was saved to)
      * sh LocalConnector _linux32.sh or sh LocalConnector _linux64.sh, depending on whether you have 32 or 64 bit Linux. The connector will be installed.
      * Start the connector running by:
         * cd $HOME/AppxLocalConnector
         * sh ./start-nw.sh
      * The user has to manually start the local connector every time they log in, or they can add the script to their programs that start automatically when they log in. The steps vary by Linux distribution, consult your documentation.
If you are going to use the Web Browser to handle files instead of the local connector, then turn off the requirement for a Local Connector as above, and uncomment the following line in your appx-client-settings.js file:

//metas["appx-upload-without-local"]["value"] = "true";

Remove the leading // to uncomment the line. The '+Local' connector icon will be blue in this case.

The Application Designer can also control this. Each file chooser widget can be individually set to not use the local connector by using the macro: @FULC=F, however setting "appx-upload-without-local" = true will override this, even if the macro specifies the local connector should be used (@FULC=T).
---++ Tunneling/Forwarding

If you do not want to open ports 3014/3015 and would rather use port 80, you can use forwarding instead. For example, to configure Apache 2.4 on Linux you would do the following:
   * <p>In /etc/httpd/conf.modules.d/00-proxy.conf, add (if not already loaded):<br /><br />LoadModule proxy_wstunnel_module modules/mod_proxy_wstunnel.so</p>
   * <p>Create the /etc/httpd/conf.d/appx.conf file with the following lines (or just add these to httpd.conf):<br /><br /></p> ProxyPass "/appxwss" "wss://localhost:3014"<br /> ProxyPassReverse "/appxwss" "wss://localhost:3014" <br />ProxyPass "/appxws" "ws://localhost:3014" <br />ProxyPassReverse "/appxws" "ws://localhost:3014" <br /><br />ProxyPass "/appxhttps" "https://localhost:3015"<br />ProxyPassReverse "/appxhttps" "https://localhost:3015"<br />ProxyPass "/appxhttp" "http://localhost:3015"<br />ProxyPassReverse "/appxhttp" "http://localhost:3015"
   * <p>Change the following in your appx-client-settings.js file:</p> <p>appx-proxy-host = hostname of httpd server (i.e., 192.168.1.11)<br />appx-proxy-port = “80"<br />appx-mongo-port = “80" <br />appx-proxy-path = /appxws/ <br /><br /></p>
   * <p>Restart your web server</p>
*NOTE:* If you are running selinux security on your server, you will have to configure it so that apache can initiate an outgoing network connections to the web socket server port. Use the following command:

# setsebool -P httpd_can_network_connect 1
---++ SSL

If you are running a secure web server (https), you can configure the Appx HTML client to use your SSL connection. Your web server must be configured to accept both SSL (https:) and non-SSL (http:) connections.

Change the following in your appx-client-settings.js file:

appx-proxy-host = hostname of httpd server (i.e., 192.168.1.11)<br />appx-proxy-port = “443" <br />appx-proxy-path = /appxwss/ <br />appx-encryption = “ssl”

Change your "appxConnector.js" as follows (this file is located on your APPX Server Connector server):

var sslEnabled = *true*;

For Unix/Linux hosts<br /> var sslPrivateKey = "<b>/etc/pki/tls/private/example.key</b>";<br /> var sslCertificate = "<b>/etc/pki/tls/certs/example.com.crt</b>";<br /> var sslCertAuthority = "<b>/etc/pki/tls/certs/gd_bundle.crt</b>";<br /> <br />For Windows hosts<br /> var sslPrivateKey = <b>"c:\\appx\\SSL\\example.key";</b><br /> var sslCertificate = <b>"c:\\appx\\SSL\\example.crt";</b><br /> var sslCertAuthority = *"c:\\appx\\SSL\\gd_bundle.crt"*

The SSL key values above are examples, you will need to change the file paths to point to your own SSL certificates.

Once you have made the above changes, restart the Server Connector and refresh the Appx Login page in your browser (if it was still loaded when you made these changes).

*NOTES:*
   * You still use 'http://' to connect to the client page. The client will switch to the SSL connection once the page is loaded.
   * If you are trying to use SSL with the local connector running you will receive an error saying that part of your connection is not secure. The local connector does not have the functionality to talk to the browser using SSL.
---++ Styles

Many aspects of the presentation of the Appx Client are controlled by the APPX.css style sheet in the 'css' folder. If you are familiar with working with style sheets, feel free to experiment with different settings, however those changes will be lost the next time the client is updated.

Instead, you can add a CUSTOM.css style sheet with your own settings. This should be located in the same folder as APPX.css and will override the standard settings in the HTML client. For example:

input {

background-color: pink;

}

.appxbox {

background-color: white;

}

This will set the background color of edittable fields to 'pink' and the default background color to 'white'.
---+++ Styles by website

It is possible to have different CUSTOM.css style sheets. Install the client web server files as normal, then follow these steps:

   * create sub folders for each of the different style sheets you want to use.
   * Edit your appx-client-settings.js file, changing 'appx-client-root' to point to the parent folder, i.e.:
      * metas["appx-client-root"]["value"] = "../";
   * Copy the appx-client-settings.js file to each js folder.
   * Create a 'css' folder in each subfolder, and put each unique CUSTOM.css file in that folder

---++ Anonymous Logins

Starting in Release 6.0, you can configure the client for anonymous logins. This is a login where the user is not presented with a login screen, but is taken directly to the startup process. Note that the user is not really 'anonymous', instead every user who connects via this method will have the same user credentials. You control which user credentials will be used by configuring the server connector.

This is configured in the server connector for better security. Your configuration file will probably include a valid user id/password for your server, so we don't want it in the web server folder.

The settings are in the 'appx-client-anonymousLogin.js' file in your server connector folder. The variables you can change are:

"appx-allow-noLogin" must be set to 'true'. If this is set to false, no matter what variables are provided the HTML Client will not allow anonymous logins.

"appx-allow-specific" can be set to 'true' or 'false'. If this is set to 'true', you can embed the process to run in the URL. If this is set to false, APPX will run the startup process for the specified anonymous user.

"appx-use-noLogin" can be set to 'true' or 'false'. If 'true' this tells the HTML Client that all logins are anonymous login. If 'false', then the login URL must include 'requireLogin=true' to request an anonymous login. The 'false' setting allows you to have both anonymous and normal logins.

"appx-use-specific" can be set to 'true' or 'false'. If "true" APPX will automatically run the process specified by the application related settings below. If 'false', the applications settings can be specified in the URL.

"appx-anon-user" should contain the login user ld

"appx-anon-pswd" should contain the password

"appx-anon-host" should contain the APPX host

"appx-anon-port" should contain the port number for the APPX host

"appx-application" should contain the 3 character APPX application id

"appx-database" should contain the 3 character Database Id to use

"appx-procType" should contain the APPX process type to run (MENU, INPUT, JOB, etc)

"appx-process" should contain the name of the APPX process to run

*URL String variables*

You can specify the following variables in the URL. These will override the settings in the 'appx-client-anonymousLogin.js' file.

requireLogin ---- true/false value: true = user is required to login, false = you are using anonymous login<br />specific ---- true/false value: true = you are logging user into a specific process, false = you are using normal login<br />user ---- Login Id<br />password ---- Password<br />host ---- Server<br />port ---- Port<br />application ---- application to run<br />database ---- database to use<br />procType ---- process type you are running<br />process ---- process to run<br /><br /><br /><b>Examples:</b>

Logging in as an anonymous user, using all the settings ithe 'appx-client-anonymousLogin.js' file:

http://&lt;html client server&gt;?requireLogin=false

Logging in as an anonymous user but overriding the startup process:

http://&lt;html client server&gt;?requireLogin=false&specific=true&application=DMO&database=DMO&procType=MENU&process=MAIN%20 MENU

This requires "appx-allow-specific" set to 'true'.

Logging in as a specific user:

http://&lt;html client server&gt;?requireLogin=false&specific=true&user=anon&password=password&host=&lt;host name&gt;&port=&lt;port number&gt;
---++ Troubleshooting
   * If you have created your own login page based on 'client.html', make sure you update it with any changes to the standard 'client.html' when upgrading the HTML client.
   * If the client login dialog box does not display, check your web server error logs for any error messages & correct as required.
   * If you are getting "[proxy:error] [pid xxxx] (13)Permission denied:" errors, you might have a selinux security issue that prevents apache from initiating any outgoing network connections to the web socket server port. In that case, try the following command:<br /># setsebool -P httpd_can_network_connect 1
   * Some browsers (like IE) will not run the client successfully if you double click the 'client.html' file. You should always access the web page via http://servername/client.html, even if the page is installed on your local system.
   * Check to make sure your Appx Server Connector is still running. If not, restart it.
   * If you can't display table data inside a browser and you are running Windows Server 2008R2, you might try installing this HOTFIX from Microsoft. Windows 2008R2 servers without that HOTFIX will sometimes zero-out the MongoDB data. https://support.microsoft.com/en-us/kb/2731284
   * If you're having trouble with Remote connections, <a href="HTMLClientRemoteTroubleshooting" target="_blank">this page</a> has some tips
   * If the client seems to hang while loading images or tables, that its a very good indicator that MongoDB server has stopped. If MongoDB server needs to be started or restarted then make sure you restart the appxConnector service after MongoDB is running.
   * Your mongodb driver may be out of date. Use 'npm install mongodb' as root/Administrator to make sure you have the latest version

---++ Comments

Read what other users have said about this page or add your own comments.
---

<br />%COMMENT%

-- Main.JeanNeron - 2017-11-14
Topic revision: r5 - 2018-04-27 - JeanNeron
~~Edit~~
~~Attach~~