Application Object Variables

Overview

This feature allows you to define reusable app or layout configurations as key-value pairs in the launcher.json file. Once defined, these variables can be referenced across multiple layout groups, eliminating the need to copy and paste configuration blocks.

User Guide

1. Use the applicationObjects block to create a key (e.g., chatApp) and store reusable app or layout configurations.

2. Use the appObjectKey field in layout groups (e.g., AssociateApps or ManagerApps) to reference the key. Please see sample configuration here.

3. Override the label field in layout groups to provide unique labels for each reference.

Feature Configuration

Defining Application Variables

Use the applicationObjects block in the launcher.json file to define reusable variables. Each variable is a key-value pair in the launcher.json file, where the key represents the variable name and the value contains the reusable app or layout configuration.

Using Chat App as an example: Specify its package name, label, description, etc.

"applicationObjects": {
   "chatApp": {
         "package": "com.bluefletch.staging.chat",
         "label": "Chat Label Will Be Overridden In Figure Below",
         "dateModified": "2024-10-03 10:10:10 UTC",
         "description": "describe the app here, reference info only for portal"
      }
}

Using Camera App as an example: Specify a label, URL, browser package, and browser-specific overrides.

"applicationObjects": {
  "cameraApp": {
   	"label": "Camera Test",
   	"url": "https://usefulangle.com/demos/352/camera-capture-photo.html",
   	"browser": "com.bluefletch.ems.staging.browser",
   	"browserOverrides": {
     	"showTitle": true,
     	"showUrl": true,
     	"fixOrientation": true,
     	"allowCameraAccess": true
     }
}

Configuring Layout Groups with Variables

Once application variables are specified, they can be referenced in layout groups using the appObjectKey field. This approach allows you to reuse the same configuration across multiple groups without duplicating the entire block.

Below is an example of using the chatApp application variable in the AssociateApps and ManagerApps layout groups:

"AssociateApps": [
  {
    "appObjectKey": "chatApp",
    "label": "Associate Chat"
  }
],
"ManagerApps": [
  {
    "appObjectKey": "chatApp",
    "label": "Manager Chat"
  }
]

Note: The chatApp variable is defined once in the applicationObjects block and reused in both the AssociateApps and ManagerApps layout groups. As shown above, the 'label' field is the only one that can be overridden.

Application Object Variables was introduced in Launcher v.4.2.144.