PayloadKit

SupportApp by Root3

nl.root3.support

SupportApp by Root3 settings

macOS
macOS 11.0.1+

Configuration Keys (74)

KeyTypeTitle
PFC_SegmentedControl_0required
string
Title

Text shown in the top left corner when the app opens

Default: "Support"

stringTitle
Logo

Path to the logo shown in the top right corner when the app opens. Scales to 48 points maximum height

stringCustom Logo
LogoDarkMode

Path to the logo shown in the top right corner when the app opens for Dark Mode. Scales to 48 points maximum height

stringCustom Logo Dark Mode
NotificationIcon

Path to the notification icon

stringCustom Notification Icon
StatusBarIcon

Path to the status bar icon shown in the menu bar. Recommended: PNG, 16x16 points

stringCustom Status Bar Icon
StatusBarIconSFSymbol

Custom status bar icon using an SF Symbol. Ignored when StatusBarIcon is also set

stringCustom Status Bar Icon using SF Symbols
StatusBarIconNotifierEnabled

Shows a small notification badge in the Status Bar Icon when there is an Apple Software Update available or when the UptimeDaysLimit or PasswordExpiryLimit is reached

Default: false

booleanNotification badge in Status Bar Icon
CustomColor

HEX color in RGB format. Example: #8cc63f. Leave empty to use macOS Accent Color

stringCustom Color
CustomColorDarkMode

HEX color in RGB format for Dark Mode. Example: #8cc63f. CustomColor is used when CustomColorDarkMode is not specified

stringCustom Color Dark Mode
HideFirstRow

Hides the first row of configurable items.

Default: false

booleanHide First Row
HideSecondRow

Hides the second row of configurable items.

Default: false

booleanHide Second Row
ErrorMessage

Shown when clicking an action results in an error

Default: "Please contact IT"

stringCustom error message
ShowWelcomeScreen

A welcome screen and feature explanation to show when the app is first opened

Default: false

booleanWelcome Screen
FooterText

Shown at the bottom as footnote. Supports both text and Emoji. Markdown is supported for macOS Monterey and higher

stringFooter text
OpenAtLogin

Disabled 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 LaunchAgent

Default: true

booleanAutomatically Support (non-PKG) at login
InfoItemOne

Info item shown in the upper left corner

Default: "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)

stringInfo item 1st tile
InfoItemTwo

Info item shown in the upper right corner

Default: "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)

stringInfo item 2nd tile
InfoItemThree

Info item shown in the second row left

Default: "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)

stringInfo item 3rd tile
InfoItemFour

Info item shown in the second row right

Default: "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)

stringInfo item 4th tile
InfoItemFive

Info item shown in the third row left

Default: "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)

stringInfo item 5th tile
InfoItemSix

Info item shown in the third row right

Default: "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)

stringInfo item 6th tile
UptimeDaysLimit

Days of uptime after which a notification badge is shown

Default: 0

integerMaximum uptime in days
PasswordExpiryLimit

Days until password expiry after which a notification badge is shown

Default: 0

Range: 0 – —

integerMaximum password expiry in days
PasswordLabel

Alternative text label shown in the Password info item

Default: "Mac Password"

stringPassword item label
StorageLimit

Percentage of storage after which a notification badge is shown

Default: 0

integerMaximum used storage percentage
FirstRowTitleLeft

The text shown in the button label

Default: "Remote Support"

stringFirst Row Left: Title
FirstRowSubtitleLeft

Subtitle text will appear under title when the user hovers over the button. Ignored if left empty.

stringFirst Row Left: Subtitle
FirstRowTypeLeft

Type 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.

Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

stringFirst Row Left: Type
FirstRowLinkLeft

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

Depends on: FirstRowTypeLeft

Default: "com.apple.ScreenSharing"

stringFirst Row Left: Link
FirstRowSymbolLeft

The SF Symbol shown in the button

Default: "cursorarrow"

stringFirst Row Left: SF Symbol name
FirstRowTitleMiddle

The text shown in the button label

Default: "Company Store"

stringFirst Row Middle: Title
FirstRowSubtitleMiddle

Subtitle text will appear under title when the user hovers over the button. Ignored if left empty.

stringFirst Row Middle: Subtitle
FirstRowTypeMiddle

Type 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.

Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

stringFirst Row Middle: Type
FirstRowLinkMiddle

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

Depends on: FirstRowTypeRight

Default: "com.apple.ScreenSharing"

stringFirst Row Middle: Link
FirstRowSymbolMiddle

The SF Symbol shown in the button

Default: "cart.fill"

stringFirst Row Middle: SF Symbol name
FirstRowTitleRight

The text shown in the button label.

Default: "Company Store"

stringFirst Row Right: Title
FirstRowSubtitleRight

Subtitle text will appear under title when the user hovers over the button. Ignored if left empty.

stringFirst Row Right: Subtitle
FirstRowTypeRight

Type 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.

Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

stringFirst Row Right: Type
FirstRowLinkRight

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

Depends on: FirstRowTypeRight

Default: "com.apple.ScreenSharing"

stringFirst Row Right: Link
FirstRowSymbolRight

The SF Symbol shown in the button.

Default: "cart.fill"

stringFirst Row Right: SF Symbol name
SecondRowTitleLeft

The text shown in the button label.

Default: "Support Ticket"

stringSecond Row Left: Title
SecondRowSubtitleLeft

Subtitle text will replace the title when the user hovers over the button. Ignored if left empty.

stringSecond Row Left: Subtitle
SecondRowTypeLeft

Type 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.

Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

stringSecond Row Left: Type
SecondRowLinkLeft

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

Depends on: SecondRowTypeLeft

Default: "com.apple.ScreenSharing"

stringSecond Row Left: Link
SecondRowSymbolLeft

The SF Symbol shown in the button.

Default: "ticket"

stringSecond Row Left: SF Symbol name
SecondRowTitleMiddle

The text shown in the button label.

Default: "Email"

stringSecond Row Middle: Title
SecondRowSubtitleMiddle

Subtitle text will replace the title when the user hovers over the button. Ignored if left empty.

stringSecond Row Middle: Subtitle
SecondRowTypeMiddle

Type 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.

Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

stringSecond Row Middle: Type
SecondRowLinkMiddle

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

Depends on: SecondRowTypeMiddle

Default: "com.apple.ScreenSharing"

stringSecond Row Middle: Link
SecondRowSymbolMiddle

The SF Symbol shown in the button.

Default: "envelope"

stringSecond Row Middle: SF Symbol name
SecondRowTitleRight

The text shown in the button label.

Default: "Phone"

stringSecond Row Right: Title
SecondRowSubtitleRight

Subtitle text will replace the title when the user hovers over the button. Ignored if left empty.

stringSecond Row Right: Subtitle
SecondRowTypeRight

Type 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.

Range: App (App), URL (URL), User Command (Command), Privileged Script (PrivilegedScript), Command or Script (deprecated as of v2.6, use Privileged Script) (DistributedNotification)

stringSecond Row Right: Type
SecondRowLinkRight

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

Depends on: SecondRowTypeRight

Default: "com.apple.ScreenSharing"

stringSecond Row Right: Link
SecondRowSymbolRight

The SF Symbol shown in the button.

Default: "phone"

stringSecond Row Right: SF Symbol name
ExtensionTitleA

The text shown in the Extension.

stringExtension Title A
ExtensionSymbolA

The SF Symbol shown in the Extension.

stringExtension SF Symbol A
ExtensionTypeA

Type 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)

stringExtension Link Type A
ExtensionLinkA

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

stringExtension Link A
ExtensionTitleB

The text shown in the Extension.

stringExtension Title B
ExtensionSymbolB

The SF Symbol shown in the Extension.

stringExtension SF Symbol B
ExtensionTypeB

Type 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)

stringExtension Link Type B
ExtensionLinkB

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

stringExtension Link B
HideMajorUpdates

Ignore macOS major updates. This will prevent the menu bar icon and the macOS version info item from showing an available major update.

Default: false

booleanHide Major macOS Updates / Upgrades
UpdateText

Optional text to shown in the macOS Managed Updates popover to tell users about the updates

stringUpdate Text
HideFirstRowInfoItems

Hide the first row with Info Items

booleanHide first row Info Items
HideSecondRowInfoItems

Hide the second row with Info Items

booleanHide second row Info Items
HideThirdRowInfoItems

Hide the third row with Info Items

booleanHide third row Info Items
HideFirstRowButtons

Hide the first row with configurable items

booleanHide first row configurable buttons
HideSecondRowButtons

Hide the second row with configurable items

booleanHide second row configurable buttons
PasswordType

Password expiry information source: Apple (local account or AD), Jamf Connect or Kerberos SSO Extension

Range: Apple (Apple), Jamf Connect (JamfConnect), Kerberos SSO Extension (KerberosSSO), NoMAD (Nomad)

stringPassword type
OnAppearAction

Path to script script or command to be executed when the Support App is opened by clicking on the menu bar item.

stringOn Appear Script/Command
DisablePrivilegedHelperTool

Option to enable or disable the Privileged Helper Tool. Re-enabling requires the reinstallation of the Support App.

booleanEnable or Disable Privileged Helper Tool