Support Companion v1
SupportCompanion
Support Companion settings
macOS
Configuration Keys (33)
Showing 33 of 33 keys
| Key | Type | Description | Default | Range |
|---|---|---|---|---|
PFC_SegmentedControl_0stringrequired | string | — | Default: — | Range: — |
BrandNamestringBrand Name | string | Configures the name shown in the navigation menu. | Default: — | Range: — |
BrandColorstringBrand Color | string | Configures the brand color shown in the app, available colors are: Blue, Green, Red, Orange. Defaults to Blue if not configured. | Default: — | Range: Blue, Green, Red, Orange |
BrandLogostringBrand Logo | string | Configures the brand logo shown in the apps side menu. Specify a local path or Base64 string. | Default: — | Range: — |
SupportUrlstringSupport Page URL | string | Configures the URL to open when the user clicks on the Get Support button. | Default: — | Range: — |
ChangePasswordUrlstringChange Password URL | string | Configures the URL to open when the user clicks on the Change Password button. | Default: — | Range: — |
ChangePasswordModestringChange Password Mode | string | Configures the mode for the Change Password button, available modes are: local, SSOExtension, url. Defaults to local if not configured. | Default: — | Range: Local (local), SSO Extension (SSOExtension), URL (url) |
SupportEmailstringSupport Email | string | Configures the email address shown when the user clicks on the Support Info button. | Default: — | Range: — |
SupportPhonestringSupport Phone | string | Configures the phone number shown when the user clicks on the Support Info button. | Default: — | Range: — |
ShowMenuTogglebooleanShow Menu Toggle | boolean | Configures whether to show the menu toggle button in the apps side menu. | Default: false | Range: — |
HiddenWidgetsarrayHidden Widgets | array | Configures which widgets to hide, available widgets are: DeviceInfo, MunkiPendingApps, MunkiUpdates, IntunePendingApps, IntuneUpdates, Storage, MdmStatus, Actions, Battery, EvergreenInfo. | Default: — | Range: — |
| string | — | Default: — | Range: — | |
HiddenActionsarrayHidden Actions | array | Configures which actions to hide, available actions are: Support, ManagedSoftwareCenter, ChangePassword, Reboot, KillAgent, SoftwareUpdates, GatherLogs. | Default: — | Range: — |
| string | — | Default: — | Range: — | |
NotificationIntervalintegerNotification Interval | integer | Configures the interval for notifications in hours for Application Updates and Software Updates notifications. | Default: — | Range: 1 – 24 |
NotificationTitlestringNotification Title | string | Configures the title for notifications for notifications. Defaults to Support Companion if not configured. | Default: — | Range: — |
NotificationImagestringNotification Image | string | Configures an image to add to notifications. Local path should be specified. | Default: — | Range: — |
Software Update Notification Message | string | Configures the message for notifications for Software Updates notifications. Defaults to "You have software updates available. Take action now! \ud83c\udf89" if not configured. | Default: — | Range: — |
Software Update Notification Button Text | string | Configures the button text for notifications for Software Updates notifications. Defaults to "Details \ud83d\udc40" if not configured. | Default: — | Range: — |
App Update Notification Message | string | Configures the message for notifications for App Updates notifications. Defaults to "You have app updates available. Take action now! \ud83c\udf89" if not configured. | Default: — | Range: — |
App Update Notification Button Text | string | Configures the button text for notifications for App Updates notifications. Defaults to "Details \ud83d\udc40" if not configured. | Default: — | Range: — |
CustomColorsarrayCustom Colors | array | Configures custom colors for the app, should be specified in hex format, see example below. Do not use BrandColor in conjunction with this key. | Default: — | Range: — |
| dict | — | Default: — | Range: — | |
PrimaryColorstringPrimary Color | string | Configures the Primary Color for the app. | Default: — | Range: — |
AccentColorstringAccent Color | string | Configures the Accent Color for the app. | Default: — | Range: — |
IntuneModebooleanIntune Mode | boolean | Configures the app to use Intune for application information. Only supports PKG and DMG type apps, not LOB. | Default: false | Range: — |
SystemProfilerAppsbooleanSystem Profiler | boolean | Configures the app to list all applications installed under /Applications and their versions. Useful if Munki or Intune is not used. | Default: false | Range: — |
LogFoldersarrayLog Folders | array | Configures the log folders to gather logs from. Only used when gathering logs. Defaults to "/Library/Logs/Microsoft" if not configured. | Default: — | Range: — |
| string | — | Default: — | Range: — | |
ActionsarrayActions | array | Configures custom actions to add to the tray menu. See example below. | Default: — | Range: — |
| dict | — | Default: — | Range: — | |
NamestringName | string | Name of the action to show in the menu. | Default: — | Range: — |
CommandstringCommand | string | Command to run when to item is clicked. | Default: — | Range: — |
IconstringIcon | string | Icon to show in the Self Service page in the UI. | Default: — | Range: — |
ShowDesktopInfobooleanShow Desktop Info | boolean | Configures the desktop info widget. | Default: false | Range: — |
DesktopPositionstringDesktop Position | string | Configures the position of the desktop info. Defaults to TopRight. | Default: "TopRight" | Range: Top Left (TopLeft), Top Right (TopRight), Bottom Left (BottomLeft), Bottom Right (BottomRight) |
DesktopInfoLevelstringDesktop Info Level | string | Configures the level of information to show on the desktop. Defaults to Full. | Default: — | Range: Full, Minimal, Hardware, Custom |
Desktop Info Custom Items | array | If DesktopInfoLevel is set to Custom, use this array to determine which information to show. Available info are: HostName, Model, SerialNumber, Processor, IpAddress, MemSize, OsBuild, OsVersion, LastBootTime, StorageInfo, SupportPhone, SupportEmail, Separator. | Default: — | Range: — |
| string | — | Default: — | Range: — | |
Desktop Info Background Color | string | Configures the background color for the desktop info. Configure using Hex format. Defaults to Transparent | Default: — | Range: — |
Desktop Info Background Opacity | real | Configures the position of the desktop info. Defaults to 100%. | Default: 1 | Range: 10% (0.1), 20% (0.2), 30% (0.3), 40% (0.4), 50% (0.5), 60% (0.6), 70% (0.7), 80% (0.8), 90% (0.9), 100% (1) |
DesktopInfoColorHighlightbooleanDesktop Info Color Highlight | boolean | Configures whether to highlight the text in the desktop info. Defaults to true. | Default: true | Range: — |
DesktopInfoFontSizeintegerDesktop Info Font Size | integer | Configures the font size for the desktop info. Defaults to 17. | Default: 17 | Range: 8 – 24 |
CustomWidgetsPathstringCustom Widgets Path | string | Configures a path to a JSON file containing custom widgets to show on the Home view. | Default: — | Range: — |