PayloadKit

SupportApp by Root3

nl.root3.support

SupportApp by Root3 settings

macOS
macOS 11.0.1+

Configuration Keys (74)

Showing 74 of 74 keys

KeyTypeDescriptionDefaultRange
string—Default: —Range: —
Titlestring

Title

stringText shown in the top left corner when the app opensDefault: "Support"Range: —

Custom Logo Dark Mode

stringPath to the logo shown in the top right corner when the app opens for Dark Mode. Scales to 48 points maximum heightDefault: —Range: —

Custom Notification Icon

stringPath to the notification iconDefault: —Range: —

Custom Status Bar Icon

stringPath to the status bar icon shown in the menu bar. Recommended: PNG, 16x16 pointsDefault: —Range: —

Custom Status Bar Icon using SF Symbols

stringCustom status bar icon using an SF Symbol. Ignored when StatusBarIcon is also setDefault: —Range: —

Notification badge in Status Bar Icon

booleanShows a small notification badge in the Status Bar Icon when there is an Apple Software Update available or when the UptimeDaysLimit or PasswordExpiryLimit is reachedDefault: falseRange: —

Custom Color

stringHEX color in RGB format. Example: #8cc63f. Leave empty to use macOS Accent ColorDefault: —Range: —

Custom Color Dark Mode

stringHEX color in RGB format for Dark Mode. Example: #8cc63f. CustomColor is used when CustomColorDarkMode is not specifiedDefault: —Range: —

Hide First Row

booleanHides the first row of configurable items.Default: falseRange: —

Hide Second Row

booleanHides the second row of configurable items.Default: falseRange: —

Custom error message

stringShown when clicking an action results in an errorDefault: "Please contact IT"Range: —

Welcome Screen

booleanA welcome screen and feature explanation to show when the app is first openedDefault: falseRange: —

Footer text

stringShown at the bottom as footnote. Supports both text and Emoji. Markdown is supported for macOS Monterey and higherDefault: —Range: —

Automatically Support (non-PKG) at login

booleanDisabled by default. Launch Support (non-PKG) automatically at login and keep it open (macOS 13 and higher). This setting is ignored if a legacy LaunchAgent is installed/active. Keep disabled if you don't want to open Support at login or use your own LaunchAgentDefault: trueRange: —

Info item 1st tile

stringInfo item shown in the upper left cornerDefault: "ComputerName"Range: Computer Name (ComputerName), macOS Version (MacOSVersion), Network (Network), Password (Password), Storage (Storage), Uptime (Uptime), Extension A (ExtensionA), Extension B (ExtensionB), App Catalog (AppCatalog)

Info item 2nd tile

stringInfo item shown in the upper right cornerDefault: "MacOSVersion"Range: Computer Name (ComputerName), macOS Version (MacOSVersion), Network (Network), Password (Password), Storage (Storage), Uptime (Uptime), Extension A (ExtensionA), Extension B (ExtensionB), App Catalog (AppCatalog)

Info item 3rd tile

stringInfo item shown in the second row leftDefault: "Uptime"Range: Computer Name (ComputerName), macOS Version (MacOSVersion), Network (Network), Password (Password), Storage (Storage), Uptime (Uptime), Extension A (ExtensionA), Extension B (ExtensionB), App Catalog (AppCatalog)

Info item 4th tile

stringInfo item shown in the second row rightDefault: "Storage"Range: Computer Name (ComputerName), macOS Version (MacOSVersion), Network (Network), Password (Password), Storage (Storage), Uptime (Uptime), Extension A (ExtensionA), Extension B (ExtensionB), App Catalog (AppCatalog)

Info item 5th tile

stringInfo item shown in the third row leftDefault: "Storage"Range: Computer Name (ComputerName), macOS Version (MacOSVersion), Network (Network), Password (Password), Storage (Storage), Uptime (Uptime), Extension A (ExtensionA), Extension B (ExtensionB), App Catalog (AppCatalog)

Info item 6th tile

stringInfo item shown in the third row rightDefault: "Storage"Range: Computer Name (ComputerName), macOS Version (MacOSVersion), Network (Network), Password (Password), Storage (Storage), Uptime (Uptime), Extension A (ExtensionA), Extension B (ExtensionB), App Catalog (AppCatalog)

Maximum uptime in days

integerDays of uptime after which a notification badge is shownDefault: 0Range: —

Maximum password expiry in days

integerDays until password expiry after which a notification badge is shownDefault: 0Range: 0 – —

Password item label

stringAlternative text label shown in the Password info itemDefault: "Mac Password"Range: —

Maximum used storage percentage

integerPercentage of storage after which a notification badge is shownDefault: 0Range: —

First Row Left: Title

stringThe text shown in the button labelDefault: "Remote Support"Range: —

First Row Left: Subtitle

stringSubtitle text will appear under title when the user hovers over the button. Ignored if left empty.Default: —Range: —

First Row Left: Type

stringType of link the item should open. Can be anything like screen sharing tools, company stores, file servers or core applications in your organization. App by default.Default: —Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

First Row Left: Link

stringThe Bundle Identifier of the app, link, command or path to script

Depends on: FirstRowTypeLeft

Default: "com.apple.ScreenSharing"Range: —

First Row Left: SF Symbol name

stringThe SF Symbol shown in the buttonDefault: "cursorarrow"Range: —

First Row Middle: Title

stringThe text shown in the button labelDefault: "Company Store"Range: —

First Row Middle: Subtitle

stringSubtitle text will appear under title when the user hovers over the button. Ignored if left empty.Default: —Range: —

First Row Middle: Type

stringType of link the item should open. Can be anything like screen sharing tools, company stores, file servers or core applications in your organization. App by default.Default: —Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

First Row Middle: Link

stringThe Bundle Identifier of the app, link, command or path to script

Depends on: FirstRowTypeRight

Default: "com.apple.ScreenSharing"Range: —

First Row Middle: SF Symbol name

stringThe SF Symbol shown in the buttonDefault: "cart.fill"Range: —

First Row Right: Title

stringThe text shown in the button label.Default: "Company Store"Range: —

First Row Right: Subtitle

stringSubtitle text will appear under title when the user hovers over the button. Ignored if left empty.Default: —Range: —

First Row Right: Type

stringType of link the item should open. Can be anything like screen sharing tools, company stores, file servers or core applications in your organization. App by default.Default: —Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

First Row Right: Link

stringThe Bundle Identifier of the app, link, command or path to script

Depends on: FirstRowTypeRight

Default: "com.apple.ScreenSharing"Range: —

First Row Right: SF Symbol name

stringThe SF Symbol shown in the button.Default: "cart.fill"Range: —

Second Row Left: Title

stringThe text shown in the button label.Default: "Support Ticket"Range: —

Second Row Left: Subtitle

stringSubtitle text will replace the title when the user hovers over the button. Ignored if left empty.Default: —Range: —

Second Row Left: Type

stringType of link the item should open. Can be anything like screen sharing tools, company stores, file servers or core applications in your organization. URL by default.Default: —Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

Second Row Left: Link

stringThe Bundle Identifier of the app, link, command or path to script.

Depends on: SecondRowTypeLeft

Default: "com.apple.ScreenSharing"Range: —

Second Row Left: SF Symbol name

stringThe SF Symbol shown in the button.Default: "ticket"Range: —

Second Row Middle: Title

stringThe text shown in the button label.Default: "Email"Range: —

Second Row Middle: Subtitle

stringSubtitle text will replace the title when the user hovers over the button. Ignored if left empty.Default: —Range: —

Second Row Middle: Type

stringType of link the item should open. Can be anything like screen sharing tools, company stores, file servers or core applications in your organization. URL by default.Default: —Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

Second Row Middle: Link

stringThe Bundle Identifier of the app, link, command or path to script.

Depends on: SecondRowTypeMiddle

Default: "com.apple.ScreenSharing"Range: —

Second Row Middle: SF Symbol name

stringThe SF Symbol shown in the button.Default: "envelope"Range: —

Second Row Right: Title

stringThe text shown in the button label.Default: "Phone"Range: —

Second Row Right: Subtitle

stringSubtitle text will replace the title when the user hovers over the button. Ignored if left empty.Default: —Range: —

Second Row Right: Type

stringType of link the item should open. Can be anything like screen sharing tools, company stores, file servers or core applications in your organization. URL by default.Default: —Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

Second Row Right: Link

stringThe Bundle Identifier of the app, link, command or path to script.

Depends on: SecondRowTypeRight

Default: "com.apple.ScreenSharing"Range: —

Second Row Right: SF Symbol name

stringThe SF Symbol shown in the button.Default: "phone"Range: —

Extension Title A

stringThe text shown in the Extension.Default: —Range: —

Extension SF Symbol A

stringThe SF Symbol shown in the Extension.Default: —Range: —

Extension Link Type A

stringType of link the Extension should open.Default: "App"Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

Extension Link A

stringThe Bundle Identifier of the app, link, command or path to script.Default: —Range: —

Extension Title B

stringThe text shown in the Extension.Default: —Range: —

Extension SF Symbol B

stringThe SF Symbol shown in the Extension.Default: —Range: —

Extension Link Type B

stringType of link the Extension should openDefault: "App"Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

Extension Link B

stringThe Bundle Identifier of the app, link, command or path to script.Default: —Range: —

Hide Major macOS Updates / Upgrades

booleanIgnore macOS major updates. This will prevent the menu bar icon and the macOS version info item from showing an available major update.Default: falseRange: —

Update Text

stringOptional text to shown in the macOS Managed Updates popover to tell users about the updatesDefault: —Range: —

Hide first row Info Items

booleanHide the first row with Info ItemsDefault: —Range: —

Hide second row Info Items

booleanHide the second row with Info ItemsDefault: —Range: —

Hide third row Info Items

booleanHide the third row with Info ItemsDefault: —Range: —

Hide first row configurable buttons

booleanHide the first row with configurable itemsDefault: —Range: —

Hide second row configurable buttons

booleanHide the second row with configurable itemsDefault: —Range: —

Password type

stringPassword expiry information source: Apple (local account or AD), Jamf Connect or Kerberos SSO ExtensionDefault: —Range: Apple (Apple), Jamf Connect (JamfConnect), Kerberos SSO Extension (KerberosSSO), NoMAD (Nomad)

On Appear Script/Command

stringPath to script script or command to be executed when the Support App is opened by clicking on the menu bar item.Default: —Range: —

Enable or Disable Privileged Helper Tool

booleanOption to enable or disable the Privileged Helper Tool. Re-enabling requires the reinstallation of the Support App.Default: —Range: —