Skip to content

jamJAR Preferences

macmule edited this page Nov 16, 2026 · 30 revisions

Introduction

With jamJAR 3.0+, there have been a number of changes to jamJAR's configuration, as such the below has sections for jamJAR < 3.0 and 3.0+.

Whilst the jamJAR < 3.0 preferences are listed below, the rest of the documentation has been updated with 3.0+ in mind.

jamJAR 3.0+

The jamJAR 3.0+ postflight stores it's configuration in the com.jamf.jamJAR preference domain.

This can be set via defaults, a plist or (strongly recommended) a profile.

This profile should be installed at the Computer level.

Within Jamf Pro, jamJAR can be configured via it's JSON schema via the: Application & Custom Settings Payload, but are detailed below for completeness sake, with the keys names, their defaults an descriptions as to what they do.

Defaults

Top-level keys
Key Type Default Description
use_notifier Boolean false When true, uses /Applications/Utilities/Notifier.app for all notifications. When false, uses Management Action.
message_title String jamJAR Title shown in all delivered notifications.
notifier_sender_id String com.jamfsoftware.selfservice Bundle ID used as the sender for Management Action notifications. Ignored when use_notifier is true.
Install Messages (dictionary key: Install Messages)
Key Type Default Description
notify_installed Boolean true Notify the user when an item has been installed.
installed_notification_type String banner Notifier only. alert or banner.
installed_message String %DISPLAYNAME% %DISPLAYVERSION% has been installed. Message body. Supports %DISPLAYNAME% and %DISPLAYVERSION% placeholders.
Pending Install Messages (dictionary key: Pending Install Messages)
Key Type Default Description
notify_pending_install Boolean true Notify the user when items are pending installation.
notify_pending_install_type String alert Notifier only. alert or banner.
pending_install_message String One or more items are pending installation. Click here for more information or log out and the pending items will be installed. Message body. Supports %DISPLAYPENDING% (pending item count).
pending_install_message_frequency String every_run every_run or on_change. on_change only notifies when the pending count changes.
pending_logout_install_button Boolean true Notifier only. Adds a logout button to the notification.
pending_logout_install_button_text String Logout Notifier only. Label for the logout button.
Pending Uninstall Messages (dictionary key: Pending Uninstall Messages)
Key Type Default Description
notify_pending_uninstall Boolean false Notify the user when items are pending uninstallation.
notify_pending_uninstall_type String alert Notifier only. alert or banner.
pending_uninstall_message String One or more items are pending uninstallation. Click here for more information or log out and the pending items will be uninstalled. Message body. Supports %DISPLAYPENDING%.
pending_uninstall_message_frequency String every_run every_run or on_change.
pending_logout_uninstall_button Boolean true Notifier only. Adds a logout button.
pending_logout_uninstall_button_text String Logout Notifier only. Label for the logout button.
Uninstall Messages (dictionary key: Uninstall Messages)
Key Type Default Description
notify_uninstalled Boolean false Notify the user when an item has been uninstalled.
uninstalled_notification_type String banner Notifier only. alert or banner.
uninstalled_message String %DISPLAYNAME% has been uninstalled. Message body. Supports %DISPLAYNAME%.
Up-to-date Messages (dictionary key: Up-to-date Messages)
Key Type Default Description
notify_up_to_date Boolean true Notify the user when a Self Service install is attempted but the latest version is already installed.
up_to_date_notification_type String banner Notifier only. alert or banner.
notify_up_to_date_message String The latest version of %DISPLAYNAME% is installed. Message body. Supports %DISPLAYNAME%.

Message placeholders

Placeholder Available in Replaced with
%DISPLAYNAME% installed, uninstalled, up-to-date messages The item's display name
%DISPLAYVERSION% installed message The item's version
%DISPLAYPENDING% pending install/uninstall messages Count of pending items

jamJAR < 3.0

The jamJAR postflight stores it's configuration in the uk.co.dataJAR.jamJAR preference domain.

This can be set via defaults, a plist or (strongly recommended) a profile.

This profile should be installed at the Computer level.

If any keys are not set, then the below defaults are used.

Defaults

<key>log_file_dir</key>
<string>/var/log/</string>
<key>log_file_name</key>
<string>jamJAR.log</string>
<key>no_msg_category</string>
<string>secret category</string>
<key>notifier_msg_installed</key>
<string>%s %s has been installed</string>
<key>notifier_msg_osupdatespending</key>
<string>macOS Updates available. Click here for more details</string>
<key>notifier_msg_nopending</key>
<string>No updates pending</string>
<key>notifier_msg_pending</key>
<string>Logout to complete pending updates</string>
<key>notifier_msg_title</key>
<string>jamJAR</string>
<key>notifier_msg_uptodate</key>
<string>Latest version of %s is installed.</string>
<key>notifier_path</key>
<string>/Library/Application Support/JAMF/bin/Management Action.app/Contents/MacOS/Management Action</string>
<key>notifier_sender_id</key>
<string>com.jamfsoftware.selfservice.mac</string>
<key>datajar_notifier</key>
<false/>
<key>datajar_notifier_always_pending_notify</key>
<true/>
<key>datajar_notifier_logout_button</key>
<string>Logout</string>
<key>delete_secure_auth</key>
<false/>

log_file_dir

This is the directory in which the log file is created, this is created via the jamJAR postflight after every run.

Prior to jamJAR 2.0: The log rotates at midnight & appends the date to the old file.

As of jamJAR 2.0+: The log rotates every 10MB, not archiving older versions.

Defaults to - string: /var/log

log_file_name

Requires jamJAR 2.0+

Name for the log file created in the dir specified in log_file_dir, .log is appended to the name.

Defaults to - string: jamJAR

notifier_msg_installed

The notification text to display when an item is installed, this requires 2 string placeholders (%s).

These are then passed the following:

  1. Item Name (i.e. Google Chrome).
  2. Item Version (i.e. 56.0.2924.87).

Defaults to - string: %s %s has been installed, where the first %s it the item name and the second %s the version.

notifier_msg_nopending

The notification text to display when all pending updates have been installed.

Defaults to - string: No updates pending

notifier_msg_osupdatespending

Requires jamJAR 2.0+

The notification text to display when macOS updates are pending.

This leverages Manual Apple Updates in Munki 5

Also requires that the datajar_notifier is set to True and is deployed to macOS clients and that Munki has InstallAppleSoftwareUpdates set to True

Example below shows this workflow with a re-branded Notifier and Munki via munki_rebrand

Defaults to - string: macOS Updates available. Click here for more details

notifier_msg_pending

The notification text to display when there are updates pending.

Currently blocking apps or apps requiring a restart action will all trigger this notification.

Defaults to - string: Logout to complete pending updates

notifier_msg_title

The notification text title.

Defaults to - string: jamJAR

notifier_msg_uptodate

The notification text to display when a jamJAR policy is initiated via Self Service & the title attempted to install is up-to-date.

This requires 1 string placeholders (%s), which defaults to Item Name (i.e. Google Chrome).

Defaults to - string: Latest version of %s is installed., where %s is the items name.

notifier_path

The path of the application sending the notifications.

If this is defined within jamJAR preferences but is missing, then no notifications are sent when a user is logged in. The only notifications will be from Munki status over the loginwindow.

Defaults to - string: /Library/Application Support/JAMF/bin/Management Action.app/Contents/MacOS/Management Action

notifier_sender_id

The bundle ID of the application that sent the notification, if using only terminal-notifier or Notifier, this should be /Applications/Managed Software Center.app (or whatever the path to MSC is, if using MSC).

Note, Jamf's Management Action doesn't use this.

Defaults to - string: com.jamfsoftware.selfservice

datajar_notifier

Boolean that determines if jamjar should use the datajar notifier for notifications.

With jamJAR 2.0+ this changes the notifications sent.

  • If any pending notification is to be sent for either macOS updates or other updates , a persistent Alert notification is sent.
  • Other notifications will be the banner, non-persistent notification.

(NOTE: If using Notifier you can set all notifications to Alert or Banner via a notifications configuration profile)

Defaults to - boolean: False

datajar_notifier_always_pending_notify

Requires jamJAR 2.1+ and datajar_notifier to be set to True

Set to False to have jamJAR only notify when more pending apple updates and installs are found than the prior run, where the default (True) notifies of pending apple updates and installs for every run.

Defaults to - boolean: True

datajar_notifier_logout_button

Requires jamJAR 2.0+ and datajar_notifier to be set to True

Sets the title for the logout button shown in the Alert notifications.

Defaults to - string: Logout

delete_secure_auth

Requires jamJAR 2.0+

If set to True, deletes the AdditionalHttpHeaders key in /private/var/root/Library/Preferences/ManagedInstalls.plist

Defaults to - boolean: False

Clone this wiki locally