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 an Ignition Gateway. Once your Vision projects are added to the Vision Client Launcher, they will be displayed under My Applications and organized by Gateway.

The Vision Client Launcher is available on the Home tab of the Gateway Webpage. More information on installing any of the Launchers can be found on the Launchers and Workstation page. This page describes the unique Vision Client Launcher settings, deploying the launcher and Command Line Arguments. 


On this page ...

IULocgo


Launching a Client


Vision Client Launcher Settings

Settings for the entire Launcher can be found on the Launchers and Workstation page. 


Vision Client Application Settings

This section details settings for applications in the Vision Client Launcher. To access the settings, click on the "three menu dots" on the My Applications window and select the Manage option.  The General tab will open. The table below shows the General settings that can be applied to each designer.

Vision Client Launcher Application Settings

Setting Name

Description

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.
Gateway AddressThe address to the Gateway in the format http[s]://host:port
DescriptionAn optional description for the application that will be listed on the Application in the launcher. Defaults to the Project's description. 
Vision Client ProjectThe name of the project containing Vision resources that the Application will attempt to launch. 
Fallback ApplicationThe name of the application (configured in the same launcher) to use if the number of retries has been exceeded. The fallback is only utilized if the Retries setting is greater than 0.
Image Path

This 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.  The image path notation is a filepath on the local system. 

Window Mode

Controls the client mode. Available options are:

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

Screen Index

The screen index indicates which monitor to use.

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 HeapThe initial heap memory size  for the client.
Max HeapThe maximum heap memory size for the client
JVM ArgumentsArguments to append to client startup. These should start with a '-D'  and be separated by semi-colons.

Vision Client Tag Override Settings

Click on the Client Tag Overrides tab to create or update any Tags.  The table below shows the Client Tag Override setting that can be applied to each designer.

SettingDescription
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.

Vision Client Tag overrides within folders and passing client tag overrides are supported 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.

For additional application settings, refer to the Launchers and Workstation page. 


Deploying Vision Client 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. 

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:

    Windows

    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 Vision 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 Table, 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

Argument

Description

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

config.json

Allows you to point the launcher to a launcher configuration file from command line. Doing so will start running an instance of the launcher using the configurations in the file as temporary overrides. The argument expects a path to a JSON export file, specifically the same file that created by the that's created by the Export Launcher Config button under the launcher's  Settings menu. 

"C:\ClientLauncher\visionclientlauncher.exe" config.json="C:\Users\MyUser\Desktop\vision-client-launcher.json"


  • No labels