Skip to main content
Version: 8.1

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 Settings 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. Refer to the list of additional launcher settings in the reference table below.

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 Settings Reference Table. However, the JSON file has the following setting that isn't available from the GUI:

  • lock.configuration: When 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 Table

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 startdefault.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
RetriesThe 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

    Trusted Certificates

    You can add security certificates to the launcher.

    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.

    Launcher 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 Table

    Setting NameDescriptionJSON Name
    Application NameThe 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 ModeControls the client mode. Available options are:
  • window: Launches the client in Windowed Mode
  • fullscreen: Launches the client in Fullscreen Mode
  • window.mode
    Screen IndexThe 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
    TimeoutThe 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
    RetriesHow 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. For example: 1024Mmax.heap
    Client Tag OverridesAllows 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.
    client.tag.overrides