applications.json
Further information can be found in Configuring the Sidebar
The applications.json
file defines the contents of the sidebar in Hub. All Hub applications use the same instance of this file served from https://hub{env}.iqmetrix.net/applications.json
.
#
Typingsapplications
#
Defines all application entries.
Parameter | Description |
---|---|
id | The case-sensitive id of the application. Must match the applications hash key. |
title | The name of the application, shown in the sidebar. |
description | A brief summary of the application. |
href | The relative path to your application. v1 a path. Eg. /yourApp v2 and React a hash. Eg /#yourApp |
icon | The icon classes for the application. Usually from Font Awesome Eg. fa fa-user |
permissions | A case-sensitive list of permission names. |
assertionType | How to assert permissions . Default: "any" at least one permission granted. "all" all permissions granted. |
environmentToggleLevel | Limits the application entry to the given environment and below. Eg. If this is set to "rc" the application will show in "dev", "int", and "rc". |
featureToggles | A list of feature toggles required to show this application. |
version | The version of Hub the application is built in. Used by the shell when loading. Default: 1 React apps use 3 . |
#
GroupsApplications in the Hub sidebar are displayed as groups. What appears to be single application entries in the sidebar are groups with one application.
Parameter | Description |
---|---|
groupName | The name to display for iQmetrix users or when no domainRebrand is provided. |
domainRebrand | A hash of brands to the name to display for that brand. Eg. { "Cova": "Alternate Naming" } |
applications | An array of applications ids to display in the group. |
defaultApp | The application to open when the group is selected directly. |
icon | The icon classes for the group. |
path | |
disableToggle | Hides the group when true . Default: false |
useDefaultOrder | When true , Order applications in the group according to the order of applications . Default: false , applications are ordered alphabetically. |
applicationGroups
#
Defines the groupings of applications for users that do not have a parent entity of role Company
or MasterEntity
.
iQmetrix users will use these groups.
applicationGroupVariations
#
Defines the groupings of applications for users with a parent entity of role Company
or MasterEntity
.
Most end users fall under parent entities with the
Company
role.
settings
Application Group#
The settings application group is a special case. It is used both as a standard sidebar application group and by the settings app.
#
Releasing ChangesMerging a change will trigger a build and a release into
INT
automatically through Azure DevOps Pipeline.Further environments are manually triggered through the release pipeline and follow iQmetrix's Change Management Process.
Though we try to ensure that
applications.json
is always able to be promoted, it is still required that you ensure this prior to releasing beyondINT
by asking in #hub-developers
#
Sources- GitHub
- Live Versions
- Build Pipeline
- Release Pipeline