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


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. 

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. 


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

       Click here if installing Mac OS...

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

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


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. 


Launcher Settings

Each Launcher has its own settings. To access the settings on a Launcher, click Settings on the top right of any launcher window. 




The Settings popup window will appear, listing settings for the Launcher to use. There are some shared settings, such as those under the General tab. 

General Property Settings Tables

The following tables represent common property settings in the Designer Launcher, Vision Client Launcher and Perspective WorkstationThere are a few settings that are unique to each launcher application and are addressed on the specific application launcher page. 

General Property Settings 

General Settings - for the Design Launcher, Vision Client Launcher and Perspective Workstation
Property SettingDescriptionJSON Name
Default ApplicationWhen set, the Launcher will attempt to automatically launch the specified Application on Launcher startup. If left blank/null, an Application will not automatically start
default.application
Logging LevelLevel of logging that will be used for the launcher. Useful for our support team, but can be used to help troubleshoot problems with the launcher. 
logger.level
Multicast AddressThe address that will be used to listen for multicast broadcasts from Gateways.
multicast.address
Multicast PortThe port that will be used to listen for multicast broadcasts from Gateways.
multicast.receive.port
Auto Exit on LaunchAutomatically close the launcher window when an Application is started.
autoexit


Default Property Settings 

Default Settings - for the Designer Launcher and Vision Client Launcher
Property SettingDescriptionJSON Name
TimeoutMaximum number of seconds allowed for any Gateway communication. Any communication that exceeds this amount will cause the Launcher to abort and try again (if multiple retries are configured).
timeout
Retries

The number of times the Launcher will to attempt to contact a gateway when launching an application. 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 heap memory to be allocated to the application on startup.
init.heap
Max HeapMaximum amount of heap memory allocated to the application. 
max.heap
JVM ArgumentsArguments to append to client startup. These should start with a '-D'  and be separated by semi-colons. Mostly used by our support teams to aid with troubleshooting. 
jvm.arguments


Security Certificates

The launchers are able to trust certificates from each Gateway. Normally this is an automated process: if you launch an application from a host Gateway that requires the use of Security Certificates, the launcher will attempt to retrieve the certificate details, and ask you to trust the certificates. If you have certificates from the gateway, you can manually add them to to the launcher from the Trusted Certificates tab of the Launcher's settings by clicking the Add  icon.




When the launcher is aware of security certificates, you can use the Trusted Certificates screen to delete or export the certificates with the Delete  icon and click the Export icon, respectively

The directory where the Trusted Certificates are stored is under: 

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


Certificates Signed by a Certified Authority

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


Options Menu

There is a "three dot menu" on the applications in each of the launchers and Perspective Workstation. When you click on the three dots, a dropdown list appears. There are five options available.


Launcher Options Table

OptionDescription
ManageAllows you to configure/update property settings for your application.  These properties are unique to each launcher application.
Create ShortcutCreates a shortcut of the application and shows up as an icon on your desktop.
Add to FavoritesCreates a Favorite in your application and puts it under the Favorites tab located in the upper right corner. Your application is marked with a star icon denoting a Favorite.  
ExportExports the application launcher and configuration settings to a JSON file. It defaults to the application name and you provide the folder path.
DeleteDeletes/removes the application name from the launcher application. 

Note: To view the property settings under the Manage option, refer to the specific launcher application: Designer Launcher, Vision Client Launcher, and Perspective Workstation


Windows Silent Installations

The Designer Launcher, Vision Client Launcher and Perspective Workstation 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

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

Note: 

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



  • No labels