Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Ignition features several launchable runtimes: Vision Clients, the Designer, and Perspective Sessions. To help with managing these separate systems, Ignition Gateways provide several "launcher" programs for each runtime. These launchers are the main means of launching an Ignition runtime application. For the purposes of clarify, the following are considered "Launchers":

  • Designer Launcher - launches the Designer against the configured Gateway. 
  • Vision Client Launcher - opens Vision Clients from an Ignition Gateway.
  • Perspective Workstationopens Perspective sessions from an Ignition Gateway, in a standalone desktop program. 

The application launchers and Perspective Workstation mentioned above, all download, install and configure their property settings in the same way. Some property settings are unique to a specific launcher application and will be detailed on that specific launcher application's page.

This page describes the download and installation process common to the launcher applications and Perspective Workstation, as well as the common property settings.  

What Is an Application?

To understand the purpose of a Launcher, we need to understand what an application is.  An Application is a configuration in a launcher which is associated with a project.

Below we see the Designer Launcher, which is the launcher for the Designer. The launcher has two Applications configured: one titled "Local Gateway", and the other titled "Production Gateway". Selecting either application and clicking "Open Designer" will launch the Designer for the gateway selected. 


The Vision Client Launcher and Perspective Workstation work under a similar pattern, except each application represents a project in a gateway. Multiple projects from a single gateway can be represented in a launcher. In the image below, there is a "Welcome Portal" application under the Production gateway, while the University gateway features two applications each leading to a different project. 


On_this_page



Launcher Download and Installation

This section demonstrates the common download and installation steps for all the launcher applications. Each launcher application has an install wizard that will guide you through the installation process. The installation steps are common for all the launchers with a few exceptions depending on the operating system you're using.

Note_friendly

Although you can run the Ignition Gateway and Perspective Sessions on ARM-based Desktops (such as a Raspberry Pi), the Designer, Vision Client, and Perspective Workstation cannot be run on ARM-based Linux machines. Instead, the Designer, Vision Client, or Perspective Workstation will need to be installed and run from an Intel-based machine.

For the sake of brevity, this section will focus on installing the Designer Launcher, but the steps for installing the Vision Client Launcher and Perspective Workstation are all very similar. 

  1. Go to the Home tab of the Gateway webpage. You will see buttons that lead to separate download pages for each of the launchers. Click the desired button and you'll be redirected. We'll click on Download Designer Launcher.



  2. Your web browser will detect the operating system, and suggest the appropriate download for the Download button. Press the button to download the installer for the launcher. 



  3. Locate the installer on your local system (web browser typically store downloaded files in a "Downloads" folder), and run it. 
  4. Work through the install wizard. There are only a handful of options in the installer: 

    • Whether or not to create a desktop icon

    • The installation directory for the launcher. 

      Expand
      titleClick here if installing on Windows....

      If this is a first time install, the Designer Launcher wizard has an additional step. It will prompt you to select the install mode. Installing locally installs the launcher in the user's AppData\Roaming folder whereas 'all users' installs it in Program Files. 

      Expand
      titleClick here if installing Mac OS...

      To install the Designer Launcher application, drag the Designer Launcher icon to the Applications folder.

      Note_friendly

      At this point, if you're presented with an error stating that the system is unable to open the installer, take a look at our Knowledge Base Article

      Expand
      titleClick here if installing Linux...

      Extract the contents of the 'tar.gz' file to your desired install location. 

      Navigate to your install folder, and click the 'designerlauncher.desktop' file. A message box may popup about the launcher application being an untrusted application. Click Trust and Launch.

  5. Once the installation process reaches its end, click  Finish .

  6. The Designer Launcher will open, allowing you to start adding applications. 

Upgrading Launchers

Whenever an Application is launched from a Launcher, the Launcher will check to see if it needs an update. If the Gateway containing launched application is several revisions ahead of the Launcher, the Launcher will provide a popup notifying you that an update is available. 

However manual upgrades can be performed. Simply download and run a new launcher installer from a more recent Ignition Gateway. During installation, simply set the installation directory to the same directory as the old launcher. 

Make this visible upon 8.1.21 release

Editor_notes
New_in
Version8.1.21


You can return the Vision Client Launcher, Perspective Workstation, and Designer Launcher versions using your operating system's terminal (PowerShell for Windows). The following table lists the commands for returning the version number by launcher:

LauncherOperating SystemCommand
Vision ClientWindows(Get-Item -Path 'C:\{Vision Client Launcher Installation Directory}\visionclientlauncher.exe').VersionInfo.ProductVersion
Vision ClientLinux
./visionclientlauncher.sh --version
Vision ClientmacOSdefaults read /{Vision Client Launcher File Path/Vision\ Client\ Launcher.app/Contents/Info CFBundleShortVersionString
Perspective WorkstationWindows(Get-Item -Path 'C:\{Perspective Workstation Installation Directory}\perspectiveworkstation.exe').VersionInfo.ProductVersion
Perspective WorkstationLinux
./perspectiveworkstation.sh --version
Perspective WorkstationmacOSdefaults read /{Perspective Workstation File Path/Perspective\ Workstation.app/Contents/Info CFBundleShortVersionString
DesignerWindows(Get-Item -Path 'C:\{Designer Launcher Installation Directory}\designerlauncher.exe').VersionInfo.ProductVersion
DesignerLinux
./designerlauncher.sh --version
DesignermacOSdefaults read /{Designer Launcher File Path/Designer\ Launcher.app/Contents/Info CFBundleShortVersionString




Adding Applications

The process for adding Applications/Designers to the Designer Launcher is very similar to adding Applications to the Vision Client Launcher and Perspective Workstation. This section demonstrates how to add new Applications.

The following Designer Launcher example is used to show how to add applications for the Designer and Vision Client Launchers and the Perspective Workstation.

  1. With the launcher open, click the  Add Designer  button.



  2. The launcher will browse and list all the available Gateways on your network. Select from any of the available gateways and press the  Add Designer  or Select Gateway button depending on which Launcher you are using. 



    If you don't see the Gateway you're looking for, but know the IP address, you can enter it manually. Click the  Manual  tab  and enter the   Gateway URL . It will inform you if you have a valid host name. If so, click  Add Designer or Select Gateway depending what launcher application you are are using. 


  3. If you're adding an Application to the Vision Client Launcher or Perspective Workstation, you'll have this extra step where you can select from any of the available projects on the Gateway. Select the desired projects, then click Add Application(s)



  4. Once added, the new Applications will appear on the starting screen of the Launcher. 


Windows Silent Installations

The Designer Launcher , Vision Client Launcher and Perspective Workstation  can be installed on Windows systems from command line without any user prompts.

Code Block
languagebash
# 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

# The following option installs silently without installing a desktop shortcut
C:\Users\user\Downloads\VisionClientLauncherSetup.exe /CURRENTUSER /VERYSILENT /MERGETASKS="!desktopicon"
Editor_notes

Commands above are taken from: https://jrsoftware.org/ishelp/index.php?topic=setupcmdline

Note_friendly

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:

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


Hosted Launcher Installers

Normally, each Ignition Gateway includes files for the various launchers. When you download a launcher from a Gateway, it simply streams its local launcher files. However, you can override this behavior, causing the Gateway to ignore it's local launcher files and instead download launchers from the internet. For more information, see the  Gateway Configuration File Reference page. 

If you simply wanted to download one of our hosted launchers, without modifying your Gateway's configuration file, you can download them directly from your web browser:

Code Block
https://files.inductiveautomation.com/launchers/VERSION/LAUNCHER

Where VERSION is the Ignition version (i.e., 8.1.0), and LAUNCHER is the name of the launcher. Launcher names are listed below. 

Linuxtar.gz
LauncherOperating SystemLauncher Name
Vision ClientWindows
visionclientlauncher.exe
Vision ClientWindowsvisionclientlauncher.msi
Vision ClientLinux
visionclientlauncher.tar.gz
Vision ClientmacOS
visionclientlauncher.dmg
Perspective WorkstationWindows
perspectiveworkstation.exe
Perspective WorkstationWindowsperspectiveworkstation.msi
Perspective WorkstationLinux
perspectiveworkstation.tar.gz
Perspective WorkstationmacOS
perspectiveworkstation.dmg
DesignerWindows
designerlauncher.exe
DesignerWindowsdesignerlauncher.msi
DesignermacOSLinux
designerlauncher.dmg
Editor_notes

Append to table above and make visible upon 8.1.21 release

LauncherOperating SystemLauncher NameVision ClientWindowsvisionclientlauncher.msiPerspective WorkstationWindowsperspectiveworkstation.msiDesignerWindowsdesignerlauncher.msi
tar.gz
DesignermacOS
designerlauncher.dmg


For example, the following would download an 8.1.0 version of Perspective Workstation for Windows:

Code Block
titleExample
https://files.inductiveautomation.com/launchers/8.1.0/perspectiveworkstation.exe


Custom Shortcuts

When a shortcut to an application is created, a launchable link is placed on the desktop of the user. This link uses the configuration of the application that is saved in the launcher. This ensures that updates to the launcher are respected even if the link was created before the changes. That being said, you can override the following settings for the shortcut itself:

  • "window.mode"
  • "timeout"
  • "screen"
  • "retries"
  • "init.heap"
  • "max.heap"
  • "fallback.application"
  • "custom.jre.path"

The values for these settings can be found elsewhere in this User Manual: general launchers settings are on the Launcher Settings page, while each of the three launcher pages list settings unique to particular launcher. 

Windows

  1. Create a shortcut.
  2. Right-click and select properties.
  3. Add additional arguments to the end of the Target field:

    Code Block
    ...application=test window.mode=fullscreen

Linux

  1. Create a shortcut.
  2. Right-click and select properties.
  3. Add additional arguments to the end of the command, but before the &”:

    Code Block
    ... -Dapplication=test -Dwindow.mode=fullscreen

Mac OS

  1. Create a shortcut.
  2. Right-click or CRTL-click and select Show package contents on the shortcut.
  3. Inside of Contents/Resources look for the file “launcher.properties”.
  4. Add additional arguments on their own lines as necessary.


Redirect Client Launch Cache

You can also redirect the cache directory that is used by the launcher. Typically the user’s cache is in their home directory in the “.ignition” directory. This holds all the resources that are required for launching a client as well as the resources for each launcher. Sometimes this is not desirable, for example in cases where you want a global cache that all users on a machine rely on or when you want the users client cache to reside in a different directory under AppData.

To change this directory, place a file named redirect.txt inside the .ignition directory in their user home directory. This file should have a single line in it which is an absolute path to the appropriate file.