Configuration
When the client launcher opens for the first time, you must select a Gateway on the Gateway Configuration screen. If your Gateways have multicast enabled, and multicast transmission is allowed on your network, you can see a list of Gateways under the Available Gateways tab. Select a Gateway from the list and click the Select Gateway button. The client launcher will attempt to connect to the Gateway that you selected.
If you do not see your Gateway, you can still manually enter Gateway address under the Manually Input Gateway tab. The format is " host:port":
Note: If you are using SSL, the Gateway address will need to specify both the
Ignition Gateway port and the SSL port using the format
host:port:port. See
Gateway Port Reference for more information.
//Examples
10.10.10.1:8088
//The following will connect to a Gateway running on the local machine
localhost:8088
//The following will connect to a Gateway using SSL
10.10.10.1:8088:8043
After you entered your address, click the Apply button. The client launcher will attempt to connect to the Gateway that you selected.
After you selected a Gateway, the client launcher will attempt to contact the Gateway and will update the Status field at the top of the screen. If there was an error while attempting to contact the Gateway, you can hold your mouse over the Status field to see what the error was. You can also check <user home folder>/.ignition/clientlauncher-data/clientlauncher.log for error information. Keep in mind that you cannot use a client launcher to connect to older Gateways. The minimum Gateway versions that can be used by client launchers are 7.5.11 for the 7.5 Ignition platform and 7.6.4 for the 7.6 Ignition platform. Any 7.7 or later Ignition platform can be used with the client launchers.
Temporary Configuration
The client launcher is typically used to open different projects residing on a single configured Gateway. However, you can also create temporary connections to other Gateways by checking the "Temporary Connection" checkbox on the Gateway Configuration screen. This prevents the selected Gateway from being saved in launch.xml, which may be helpful if you have already configured a default Gateway and you do not want to lose its connection settings. After the connection has been established and saved, the Projects screen will be shown for the temporary Gateway. You can then launch a project or the Designer as you normally would. If the "Create desktop icon" checkbox is checked for the launched project, the temporary Gateway network address is saved in the desktop shortcut.
The client launcher can be pre-configured locally and then deployed to remote client machines via a zip file. Using this capability allows a client launcher to immediately connect to a Gateway on the very first launch.
- First, you need to configure a client launcher on a local machine to point to a Gateway.
- Next, copy the <user home folder>/.ignition/clientlauncher-data folder next to the launcher executable.
- Zip everything together and distribute the zip to other machines.
- For Window and Linux machines, the launcher can use the clientlauncher-data/ folder that was placed next to the executable. For OSX machines, you need to copy the clientlauncher-data/ folder to the user's home directory and place the Client Launcher. app wherever convenient.
Redundancy
The client launcher can take advantage of a redundant Gateway setup. Whenever a connection is established with a master Gateway, the backup Gateway IP address is automatically stored in the client launcher configuration file. If the master Gateway cannot be contacted the next time the client launcher is run, an attempt is made to contact the backup Gateway. If the backup cannot be contacted, the client launcher switches between contacting the primary Gateway and the backup Gateway until one responds or the user closes the launcher.
2 Comments
Anonymous
Docs at https://support.inductiveautomation.com/usermanuals/ignition/index.html?native_client_launcher.htm have much more info.
Paul Scott
Thanks for pointing this out! It looks like that page was not migrated over to the new manual. I added the info from the old manual to this page.