User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Skip to end of metadata
Go to start of metadata


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. 

Property Settings

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 Application

When 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

On this page ...


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

Launcher JSON Configuration Files

The settings for each launcher are stored into a configuration file. 

Linux/Mac
~/.ignition/clientlauncher-data

Windows 
C:\Users\username\.ignition\clientlauncher-data


On Window's systems, if the launcher was installed under "all users", then the configuration files are located in directories under:

C:\Users\username\AppData\Roaming\Inductive Automation\


In either case, each type of launcher gets its own JSON configuration file. Launcher and application settings can be modified directly from this configuration file. In addition, some administrative settings are only available in the JSON configuration file. Configuration changes must be made while the launcher is closed. Notable settings are listed below. 

SettingDescription
lock.configuration

Determines if users are able to make changes to the launcher from the GUI.

Set to true to disable the launcher's Settings menu, prevent users from managing any application from the GUI, and remove the ability to add new applications from the GUI. Defaults to false. 

version.updates.prompt

When a launcher attempts to launch an application, it checks the gateway version against the launcher's download version. If the launcher has not been updated within a set number of gateway updates versions (see version.updates.revision.diff ), the launcher will prompt the user to upgrade the launcher. 

Setting this setting to false will disable this update check. Disabling this setting is discouraged, as newer launchers could have beneficial features or security updates.  

version.updates.revision.diff
Dictates the number of revision differences before a launcher will prompt the user to upgrade. Defaults to 3, meaning 3 minor version updates (for example, 8.1.0 to 8.1.3 would trigger the update prompt, but 8.1.0 to 8.1.2 would not). 


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

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


  • No labels