Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


GLOSSARY


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL MANUAL VERSIONS

Ignition 8
Ignition 7.9
Ignition 7.8

Deprecated Pages

Skip to end of metadata
Go to start of metadata


The Vision Client Launcher opens Vision Clients from any Ignition Gateway. The launcher browses all Gateways for Vision projects that are available on your local network and remote locations. Once your Vision projects are added to the Vision Client Launcher, they will be displayed under My Applications and organized by Gateway.

This page will show you how to setup the launcher so both designers and users can launch Vision clients easily. 

What Is an Application?

For the purposes of the Vision Client Launcher, an Application is a configuration in the launcher, which is associated with a Vision Project. A Vision Project is an Ignition project that contains at least one Vision resource, such as a Window or a Template. 

The Vision Client Launcher can only launch applications. Thus, if a new project is created via the Designer, the Launcher will not be able to launch the project, until an Application has been configured in the Launcher. 

In the image below, we see two applications. One titled University, and the other titled Dashboard. Each application is a separate tile in the Launcher and contains unique settings and configurations. 


On this page ...

IULocgo


Vision Client Launcher



Download and Install

Best Practice

It's good practice to download and install the Vision Client Launcher every time you install a new release of Ignition. The Vision Client Launcher is a separate application and is not part of an Ignition release, so it's important not to have an outdated Vision Client Launcher shortcut residing on your desktop. Each time you install a new version of Ignition, download and install the Vision Client Launcher, then let the install process create a new desktop shortcut for you automatically.


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

The Vision Client Launcher can now be installed as an "all user" application on a Windows operating system providing launcher acess to all users on the same machine from a single installation. The first time the Designer Launcher is installed, you will be prompted to select your install mode: "Install for me only" or to "Install for all users." If the Vision Client Launcher was already installed, subsequent install attempts are treated as an upgrade and you will not be prompted to select the install mode. This new option will only appear on new launcher installations or after uninstalling a prior version of the installer.

Vision Client Launcher Destination Folder

When installing for "all users," the installer will be placed in the following folder: "%Ignition Installation Directory%\Program Files\Inductive Automation"
When installing for "me only," the installer will be found under the "\AppData\Roaming\Inductive Automation" folder. 



The Vision Client Launcher for Windows, Linux, and Mac OS are available on the Home tab of the Gateway Webpage. Use the following steps to do an install of the Vision Client Launcher.


 Click here to expand the example...


  1. From the Home tab on the Gateway Webpage, click on the Download Vision Client Launcher link. 





  2. Select the Download button for the platform you are running on: Windows, Mac, or Linux. This example demonstrates the installation steps for a Windows operating system. 




  3. Run the downloaded file (VisionClientLauncherSetup.exe) found on the lower-left of the window if using Chrome, or go to your Downloads folder and double-click the file to run it. 

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

  4. If this is the first time installing the Vision Client Launcher, you will be prompted to select an install mode. Select either "Install for me only," or "Install for all users."



  5. The Install Wizard will select a default destination location folder for the Vision Client application files. If you are "installing for me only", the destination folder will be different from the "all users" destination folder. You also have the option to select a different folder. Click Next.



  6. You'll notice that a desktop shortcut is checked and will be created so you don't have to run the Client Launcher each time you want to open a client. Click Next.



  7. The Ready to Install window will open. Click Install.



  8. When the Vision Client Launcher completes the install, click Finish.



  9. The Vision Client Launcher shortcut icon will be placed on your desktop and looks like the following.


  10. The Ignition Vision Client Launcher will open, but you most likely won't have any Applications (Vision Client configurations). The next step is to add Applications. Click Add Vision Client or Add Application(s). Both buttons will take you to the same window to browse for local and remote Gateways.


  11. The Vision Client Launcher window will refresh and show your local Gateway. It will also check for other Gateways on your network. Select a Gateway and click the Add a Selected Gateway button.


  12. If there is an issue automatically detecting your Ignition Gateway, you can manually add your Gateway. Click on the Manually Add Gateway button in the upper right corner.

  13. Enter the Gateway URL or IP address (i.e., localhost:8088), and click Add Gateway



  14. Once your Gateway is added, the Vision Client Launcher will automatically find all projects on the Gateway. However, this list of Applications will only contain projects that contain one or more Vision resources (such as a Vision Window). Additionally, projects configured as Inheritable will not appear (since Inheritable projects don't run as stand-alone applications). Select the Applications you would like to add, and click Add Applications.



  15. Back on the My Applications screen, you will see all of the Applications that have been added to the launcher, sorted by Gateway. 



  16. The Vision Client Launcher is installed and opens the same way you open any program. Launch the client by clicking the Launch Windowed button, or you can click the Expand icon and select Launch + Create Shortcut. The project shortcut will be placed on your desktop so you don't have to run the Vision Client Launcher each time you want to launch a project.




    The Vision Client Launcher notifies users if it detects that an updated version of the launcher is available from either the app or a shortcut. For a major Client Launcher upgrade, the application will start and offer an option to download a new version by providing a link to the gateway. For a minor upgrade, it allows the user to choose to upgrade at a later time and allows the application to start.

Windows Silent Installations

The Vision Client Launcher (and the Designer Launcher) can be installed on Windows systems from command Iine without any user prompts.

# Shows a simplified user interface
C:\Users\user\Downloads\VisionClientLauncherSetup.exe /CURRENTUSER /SILENT

# Shows no user interface at all. 
C:\Users\user\Downloads\VisionClientLauncherSetup.exe /CURRENTUSER /VERYSILENT

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

Version 8.0.10 introduced launcher installations for all users. Note that using ALLUSERS may trigger a check from User Account Controls, so you may need administrator access for the following command to offer a truly silent installation:

C:\Users\user\Downloads\VisionClientLauncherSetup.exe /ALLUSERS /VERYSILENT


Vision Client Launcher Settings

You have the option of customizing the Vision Client Launcher Settings. This can be accomplished with either the GUI or by modifying a file on the local file system. Regardless of method, both utilize the properties specified under the Vision Client Launcher Reference table

Launcher Settings

You can find the Settings  button in the upper right corner of the Vision Client Launcher.



You can choose to use the default settings or customize your client applications. There are three different Action buttons in Settings in the Vision Client Launcher. 

  • Export Launcher Config - Exports a configuration of the the Vision Client Launcher, as a JSON file (i.e., vision-client-launcher.json). Taking an export is useful in cases where you want multiple launcher instances to use the same settings. The content of the export file is based on the last saved configurations settings of the launcher. 
  • Import Launcher Config - Imports your launcher configurations from a Vision Client Launcher export file. 
  • Import Application Config -  Creates a new client application configuration from an export, adding a new application to the launcher. The import file is the same generated by an application export

 When finished updating any of the client launcher settings, click the Save Changes button.

Launcher Configuration Using JSON

In addition to using the GUI, these configurations changes can be made by modifying the vision-client-launcher.json file (created during installation of the launcher). The file is located at:

{user folder}\.ignition\clientlauncher-data\vision-client-launcher.json

The preferred method of configuration is with the GUI, but JSON modification is useful when attempting to load multiple application configurations simultaneously. 

A reference to the various properties that can be modified via JSON are listed in the Vision Client Launcher Reference table. However, the JSON file has a setting that isn't available from the GUI:

lock.configurationWhen set to true, the application list and individual application configurations cannot be modified. Effectively restricting the ability to add applications and edit the launcher's configurations.

Vision Client Launcher Settings Reference

Launcher Settings - Configurations for the Launcher
Property SettingDescriptionJSON Name
Default ApplicationWhen set, the Launcher will attempt to automatically launch the specified Application when running. If left blank/null, an Application will not automatically start
default.application
Logging LevelLevel of logging that will be used for the launcher: INFO, TRACE, DEBUG, WARN, and ERROR.
logger.level
Multicast AddressThe address that will be used to listen for multicast broadcasts from Gateways.
multicast.address
Multicast PortsThe port that will be used to listen for multicast broadcasts from Gateways.
multicast.receive.port
Auto Exit on LaunchAutomatically close the launcher window when a client is started.
autoexit
Application Defaults - Default Configurations for New Applications
Property SettingDescriptionJSON Name
TimeoutMaximum number of seconds allowed for any Gateway communication. Any communication that exceeds this amount will cause the client launcher to abort the communication and try again if configured.
timeout
Retries

The number of times a Client will to attempt to contact a gateway again if an error occurred during communication. Available values are:

  • -1 : Retry indefinitely, or until the launcher is manually closed.
  • 0 : Zero retries, or abort after the first failure.
  • 1 (or more): Determines the number of retries: i.e., a value of "5" means five retries.
retries
Initial HeapAmount of memory to be allocated at startup.
init.heap
Max HeapMaximum amount of memory allocation for heap size.
max.heap
JVMArguments to append to client startup. These should start with a '-D'  and be separated by semi-colons.
jvm.arguments
Client Tag OverridesClient Tags and their values that are set when the client launches.
client.tag.overrrides


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

Trusted Certificates

As of release 8.0.13 you can add security certificates to the launcher. To use this feature, you must have installed a launcher from a version 8.0.13+ Gateway.

While attempting to launch an application, the launcher will check against the application's host Gateway, and attempt to automatically download any required certificates. In addition, certificates can be manually added using the example below.

  1. Access Vision Client Launcher Settings by clicking Settings on the top right of the Vision Client Launcher window. 
  2. In the Trusted Certificates section, click the Add  icon.



  3. Navigate to the location of the certificate on your system and choose Open
  4. Information about the certificate is displayed. To view complete details, click the Expand  icon next to Details. If everything looks OK, click Trust Certificate.



  5. Once a certificate is imported, you can view its details by clicking the Information  icon.

Delete a Certificate

  1. To delete an imported certificate, access Vision Client Launcher Settings by clicking Settings on the top right of any Vision Client Launcher window. 
  2. In the Trusted Certificates section, select the certificate you want to delete. 
  3. Click the Delete  icon.
  4. You'll get a confirmation window. If the certificate is the correct one you want to delete, click the Delete button.

Export a Certificate

  1. To export an imported certificate, access Vision Client Launcher Settings by clicking Settings on the top right of any Vision Client Launcher window. 
  2. In the Trusted Certificates section, select the certificate you want to export. 
  3. Click the Export icon.
  4. Navigate to the location you want to save the certificate and click Save.


Application Settings

For each project application, you can update the default settings by clicking the More  icon (three vertical dots) next to the project name, and select Manage to open the Manage Project Settings window. The Export command exports the configuration settings to a .json file. The Delete command deletes the project application from the launcher. 



You can choose to use the default settings or customize your project client applications. There are three different Action buttons under Manage Project Settings in the Vision Client Launcher. 

  • Launch Application -  Launches the your application in the Vision Client Launcher.
  • Export Config - Exports your updates to the Vision Client Launcher file (i.e., vision-client-launcher.json). The resulting export file contains the last saved configuration of the application.
  • Create Desktop Shortcut -  Creates a shortcut to your application on your desktop, using the last saved application configuration.

 When finished updating any of the launcher settings, click the Save Changes button.


Application Property Reference

Setting NameDescriptionJSON Name

Application Name

The descriptive name of the application. This is independent of the project name that corresponds to a project on the gateway. Instead, this is the name of the application as it is defined in the Launcher.
application
ProjectThe Vision project that exists on the gateway that this application will load.
project
DescriptionAn optional brief note about the application. The description will appear in the Launcher. If left blank, a description will not appear.
description
Window Mode

Controls the client mode. Available options are:

  • window : Launches the client in Windowed Mode
  • fullscreen : Launches the client in Fullscreen Mode
window.mode

Screen Index

The screen index indicates which monitor to use.

screen
Image PathThis will allow the icon of the application to be set within the designer and it will be downloaded and displayed as the icon for the application as well as the shortcuts. If no path is set the default icon is used. If this is set to a different icon path, that icon will be used.
image.path
Fallback ApplicationThe name of the application to use if the number of retries has been exceeded. The fallback is only utilized if the Retries setting is greater than 0.
fallback.application

Timeout

The maximum number of seconds to allow for any gateway communication. Any communication that exceeds this amount will cause the Vision client launcher to abort the communication and try again if configured.

timeout
Retries

How many times to attempt to contact a gateway again if an error occurred during communication. Available values are:

  • -1 : Retry indefinitely, or until the launcher is manually closed.
  • 0 : Zero retries, or abort after the first failure.
  • 1 (or more): Determines the number of retries: i.e., a value of "5" means five retries. If the number of retries is exceeded, then the launcher will attempt to launch the Fallback Application.

If the number of retries is exceeded, then the Launcher will attempt to launch the Fallback Application

retries
Init HeapThe initial heap size (memory) for the client.
init.heap
Max HeapThe maximum heap size (memory) for the client
max.heap
Client Tag Overrides

Allows client tags to be overridden on the Vision Client. These are set using the table on the application configuration screen by adding rows with the names of the tags and the corresponding values.

When applying the overrides from command line, the tags must first be defined as launch parameters, then a value can be set on the parameters, as seen below in the Setting Client Tags section below.

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

Added support for Vision Client Tag overrides within folders and passing client tag overrides with spaces by using a '+' icon as an escape character. This happens automatically if you are configuring overrides in the Client Launcher. To learn more about how to configure Client Tag Overrides, refer to Overriding Vision Client Tags.

client.tag.overrides


Deploying Launchers

In some cases, it may be desirable to deploy a pre-configured Launcher to remote clients. Doing so bypasses the installation process on the remote machine. The process to do so is outlined below. The steps in this example are operating system dependent, as the launchers were designed to run on a single operating system. 

There are three key pieces to a configured launcher:

  • The launcher itself.
  • The JRE for the launcher. The "jre" directory should be in the same directory as the launcher. 
  • The configuration JSON file. The launcher always expects this file to be located at a certain directory, otherwise the launcher will create a new, blank, file. 

The steps below demonstrate how to configure a launcher, and then migrate each piece to a new file system into an appropriate location. 

Pre-Configure a Launcher

  1. Install a Vision Client Launcher somewhere on network. Take note of the Installation directory you use, as a later step will involve finding this directory. 
  2. Configure each application. Be mindful of the Gateway Address setting: the deployed launcher will need to be able find the gateway based on the address you enter.

At this point, we should have a single launcher configured with one or more applications. Next we can zip up the the launcher and its configuration files.

Create a ZIP

In these steps, we will create a single ZIP, containing all of the required files. 

  1. Navigate to the Launcher's installation directory. It should look similar to the image below:



  2. Copy all of the files shown in Step 1, and paste them into the Client Launcher Data directory. This is the same directory that the configuration JSON file is located. The path differs by Operating System, but should generally look like the following:

    C:\Users\userName\.ignition\clientlauncher-data\
    Linux
    /home/user/.ignition/clientlauncher-data/

    After pasting, the directory should look something like the following:



    We now have a single folder containing the launcher, a JRE, and the application configurations. 

  3. Navigate up a directory to the ".ignition" folder. You will see the folder we were just in: "clientlauncher-data"



  4. In this directory (the .ignition directory), create a new folder called .ignition. Note the leading period. In some operating systems you may have to attempt to rename with a trailing period as well:

    .ignition.




  5. Copy the clientlauncher-data folder into the new .ignition folder. Note that you want to copy, not move. Moving would make prior application configurations on the local system unavailable.
  6. Zip up the newer .ignition directory.



    We now have a ZIP we can deploy to a new system. 

Deploying the Launcher

  1. Take the ZIP, and move it to another computer. 
  2. Unzip the file at the user directory. The location of the directory is based on the local operating system.

    Windows
    C:\Users\userName
    Linux
    /home/user/
  3. The files should be unzipped. Navigate to the launcher at:

    {user folder}/.ignition/clientlauncher-data/visionclientlauncher
  4. Run the Launcher. It should contain all of the configured applications. 

  5. At this point, consider creating a shortcut to the launcher, and placing the shortcut at a more accessible location. Alternatively, the launcher can be accessed via command line/terminal, so you could automate client launchers in a number of ways.


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.


Command Line/Terminal

Clients can be launched from the Client Launcher via command/terminal. When called in this way, many of the application properties may be overridden for the one call. The overrides use the same property names as noted in the Application Property Reference, under the "JSON name" column.

Windows: 
"C:\ClientLauncher\visionclientlauncher.exe" application=myproject window.mode=window
 
Linux: 
./visionclientlauncher.sh application=myterminal window.mode=fullscreen screen=0 

There are a few important notes when using the Command Line/Terminal to launch a project from the Vision Client Launcher. 

  • The Vision Client Launcher must be installed and have an application added for the Command Line/Terminal commands to work.
  • The application argument requires the application name in the Launcher, not the project name. You can open the launcher to determine what the application name is. Adding new applications in the launcher uses the Project title by default.
  • Applications may contain spaces in their name. However, when launching from command/terminal, spaces should be escaped with %20. For example, if our application was named my project, then we could all it with the following:
"C:\ClientLauncher\visionclientlauncher.exe" application=my%20project


Command Line Arguments

ArgumentDescription
application
The name of the application to launch.
window.mode

Controls the client mode. Available options are:

  • window : Launches the client in Windowed Mode
  • fullscreen : Launches the client in Fullscreen Mode
screen

The screen index indicates which monitor to use.

fallback.application
The name of the application to use if the number of retries has been exceeded. The fallback is only utilized if the Retries setting is greater than 0.
timeout

The maximum number of seconds to allow for any gateway communication. Any communication that exceeds this amount will cause the Vision client launcher to abort the communication and try again if configured.

retries

How many times to attempt to contact a gateway again if an error occurred during communication. Available values are:

  • -1 : Retry indefinitely, or until the launcher is manually closed.
  • 0 : Zero retries, or abort after the first failure.
  • 1 (or more): Determines the number of retries: i.e., a value of "5" means five retries. If the number of retries is exceeded, then the launcher will attempt to launch the Fallback Application.

If the number of retries is exceeded, then the Launcher will attempt to launch the Fallback Application

init.heap
The initial heap size (memory) for the client.
max.heap
The maximum heap size (memory) for the client
-Djavaws.launchparams

Defines client tags that can be overwritten upon launch. The use of this argument alone only defines the client tags that will be overwritten. Setting a value on the tags can be done by an additional argument that utilizes the tag names delimited by a semicolon:

// Establishes the tag names
 -Djavaws.launchparams="Tag1;Tag2"

// Sets values on the tags
-Djavaws.launchparams.Tag1=10
-Djavaws.launchparams.Tag2=20

//An actual call would look like:
"C:\ClientLauncher\visionclientlauncher.exe" application=myproject -Djavaws.launchparams="Tag1;Tag2" -Djavaws.launchparam.Tag1=10 -Djavaws.launchparam.Tag2=20


Launchers and SSL

When SSL is enabled on a Gateway, the Vision Client Launcher can take advantage of the enhanced security features associated with SSL. 

Certificates Signed by a CA

When the Gateway's SSL certificates are signed by a recognized Certificate Authority, no additional configuration is required on the launcher.

Self-Signed Certificates

When using a self-signed SSL certificate, the certificates for the gateway must be locally accessible to the client launcher in the following directory:

{user folder}\.ignition\clientlauncher-data\certificates

When a certificate is placed in the directory above, the launcher will attempt to automatically add the certificate(s) to the local keystore upon application launch.


Troubleshooting

If the Vision Client Launcher fails to launch a client for some reason, the log file can be found at:

{user folder}\.ignition\clientlauncher-data\visionclientlauncher.log

This log contains any errors that occurred.



Related Topics ...
In This Section ...


  • No labels