Jamf Setup Manager

Enables debug mode. See documentation for behavior changes.

The main title over the window. Supports substitutions. (v1.4+) When the title is empty or unset, the default message 'Welcome to Setup Manager' will be shown, unless the banner is set, then no title will be shown instead. This allows for a custom branded title and icon in the banner image.

Default: "Welcome to Setup Manager"

The icon shown at the top center of the window. There are many options to define icons, as described in the documentation. (v1.4+) When the icon is empty or unset, Setup Manager will show the Setup Manager app icon, unless the banner is set, then no icon will be shown instead. This allows for a custom branded icon and title in the banner image.

Default: "name:AppIcon"

The message shown below the title. Supports Markdown and substitutions.

Default: "Setup Manager is configuring your Mac…"

A banner image or color that covers the top of the Setup Manager window. See the documentation for dimensions. Supports both images (using the same sources as Icon) and colors.

When set, Setup Manager displays the image full screen as a background behind the main window. Supports images (using the same sources as Icon) and also colors from v1.4 on.

This value determines when Setup Manager should launch.

Default: "enrollment"

Range: Enrollment (enrollment), Login Window (loginwindow)

Sets the accent color for buttons, progress bar, SF Symbol icons, and other UI elements. Use this to match branding. Color is encoded as a six digit hex code, e.g. #FF0088.

Sets the action tile background color for all action tiles, unless the value is overridden by an individual action's tileColor key.

Changes the duration (in seconds) of the "final countdown" before the app automatically performs the finalAction. Set to -1 (or any negative number) to disable automated execution. This setting is ignored if finalAction is set to 'none'.

Default: 60

Sets the action and label for the button shown when Setup Manger has completed.

Default: "continue"

Range: Continue (continue), Restart (restart), Shut Down (shutdown), None (none)

Use this value to provide an estimate for the total size of all items that will be downloaded.

When using JSM with Jamf Pro, set this to $JSSID in a Jamf Pro configuration profile and Setup Manager will be aware of its computer's id in Jamf Pro.

Range: $JSSID

When using JSM with Jamf Pro, set this to $JSSID in a Jamf Pro configuration profile and Setup Manager will be aware of its computer's id in Jamf Pro. For similar effect with Jamf School, set this to %udid%.

Range: $JSSID (For Jamf Pro) ($JSSID), %udid% (For Jamf School) (%udid%)

Set this to $EMAIL in the configuration profile. This communicates the user who logged in to customized enrollment to Setup Manager. This can be used together with the userEntry.showForUserIDs key to control which users see the user entry UI.

Range: $EMAIL, $USERNAME

Set this to $EMAIL in the configuration profile. This communicates the user who logged in to customized enrollment to Setup Manager. This can be used together with the userEntry.showForUserIDs key to control which users see the user entry UI.

Range: $EMAIL, $USERNAME

Setup Manager will generate the computer name from this template and set it automatically. See the documentation for substitutions that can used in the template. (Setting this overrides the Computer Name field in user entry.)

When set, the "About this Mac" info window will show this value instead of the real serial number.

Hides the individual labels under each action's icon.

Controls whether the output of actions is written to the Setup Manager log file.

Default: "error"

Range: Always (always), Error (error), Never (never)

Custom message when Setup Manager workflow is complete. Supports Markdown and substitutions.

Custom message shown while Setup Manager is "Getting Ready…" Supports Markdown and substitutions.

Default: "Getting Ready…"

Set this key to false to suppress the network quality check.

Default: true

Suppresses display of the red 'DEBUG' label in debug mode.

When debug mode is enabled, you can set this to Jamf Pro or Jamf School. This allows you to do test runs on un-enrolled Macs.

Range: Jamf Pro, Jamf School

When you provide help, a help button (with a circled question mark) will be shown in the lower right corner (for left-to-right localizations). When you click on the help button a window with information will be shown.

When any of these are defined, Setup Manager will prompt for user data while the enrollment actions are running.

Describes the individual actions to be performed by Setup Manager. For each row, complete the Label, Icon, and then one of the following: Shell command, Jamf Pro Policy Trigger, Watch Path, Wait, Wait For User Entry, Jamf Pro Recon, or Installomator Label.

A full path to a script file which will be executed after Setup Manager has finished its workflow. This process runs independently of Setup Manager, so it can run installers or scripts that affect Setup Manager.

A custom Jamf Pro policy trigger which will be executed after Setup Manager has finished its workflow. This process runs independently of Setup Manager, so it can run installers or scripts that affect Setup Manager.

Provides a list of hosts to check connectivity to. These will be shown in the 'Connectivity' section in the network info pane. Be sure to read the documentation before configuring.

Suppress launch tracking by enabling this setting.

The title for the help message.

The help message. Supports Markdown.

The URL will be translated into a QR code and displayed next to the help message.

If computerNameTemplate is set, any data entry for computer name is ignored.

You can configure Setup Manager to only show the user entry section when specified users have authenticated in enrollment customization.

A pre-populated value for the User ID field.

A placeholder value for User ID. This is displayed in gray when no value has been entered.

Options displayed in a dropdown menu for User ID.

A regular expression used to validate the value of User ID.

A message displayed to the user when User ID fails to match the regular expression.

Override the default label for the User ID field.

Default: "User ID"

A pre-populated value for the Email field.

A placeholder value for Email. This is displayed in gray when no value has been entered.

Options displayed in a dropdown menu for Email.

A regular expression used to validate the value of Email.

A message displayed to the user when Email fails to match the regular expression.

Override the default label for the Email field.

Default: "Email"

A pre-populated value for the Account Name field.

A placeholder value for Account Name. This is displayed in gray when no value has been entered.

Options displayed in a dropdown menu for Account Name.

A regular expression used to validate the value of Account Name.

A message displayed to the user when Account Name fails to match the regular expression.

Override the default label for the Account Name field.

Default: "Account Name"

A pre-populated value for the Full Name field.

A placeholder value for Full Name. This is displayed in gray when no value has been entered.

Options displayed in a dropdown menu for Full Name.

A regular expression used to validate the value of Full Name.

A message displayed to the user when Full Name fails to match the regular expression.

Override the default label for the Full Name field.

Default: "Full Name"

A pre-populated value for the Position field.

A placeholder value for Position. This is displayed in gray when no value has been entered.

Options displayed in a dropdown menu for Position.

A regular expression used to validate the value of Position.

A message displayed to the user when Position fails to match the regular expression.

Override the default label for the Position field.

Default: "Position"

A pre-populated value for the Phone field.

A placeholder value for Phone. This is displayed in gray when no value has been entered.

Options displayed in a dropdown menu for Phone.

A regular expression used to validate the value of Phone.

A message displayed to the user when Phone fails to match the regular expression.

Override the default label for the Phone field.

Default: "Phone"

A pre-populated value for the Department field.

A placeholder value for Department. This is displayed in gray when no value has been entered.

Options displayed in a dropdown menu for Department.

A regular expression used to validate the value of Department.

A message displayed to the user when Department fails to match the regular expression.

Override the default label for the Department field.

Default: "Department"

A pre-populated value for the Building field.

A placeholder value for Building. This is displayed in gray when no value has been entered.

Options displayed in a dropdown menu for Building.

A regular expression used to validate the value of Building.

A message displayed to the user when Building fails to match the regular expression.

Override the default label for the Building field.

Default: "Building"

A pre-populated value for the Room field.

A placeholder value for Room. This is displayed in gray when no value has been entered.

Options displayed in a dropdown menu for Room.

A regular expression used to validate the value of Room.

A message displayed to the user when Room fails to match the regular expression.

Override the default label for the Room field.

Default: "Room"

A pre-populated value for the Asset Tag field.

A placeholder value for Asset Tag. This is displayed in gray when no value has been entered.

Options displayed in a dropdown menu for Asset Tag.

A regular expression used to validate the value of Asset Tag.

A message displayed to the user when Asset Tag fails to match the regular expression.

Override the default label for the Asset Tag field.

Default: "Asset Tag"

A pre-populated value for the Computer Name field.

A placeholder value for Computer Name. This is displayed in gray when no value has been entered.

Options displayed in a dropdown menu for Computer Name.

A regular expression used to validate the value of Computer Name.

A message displayed to the user when Computer Name fails to match the regular expression.

Override the default label for the Computer Name field.

Default: "Computer Name"

The label is used as the name of the action in display.

The icon shown for the action.

The background color of the action's tile.

The absolute path to the command or script that should be run for this action.

Range: Yes (true)

The absolute path to the command or script that should be run for this action.

This action will wait until a file at the given path exists or is removed.

The watchPath action will fail after this timeout.

Default: 600

Wait for a given time.

If Setup Manager reaches this action before the user entry has been completed, it will wait until the user entry is completed and the user has clicked 'Save.'

Range: Wait For User Entry ()

This will run a Jamf Inventory update.

Range: Jamf Pro Recon ()

The installomator label to run. Can also use Arguments.

Webhooks called when Setup Manager starts its workflow.

Webhooks called when Setup Manager finishes its workflow.

Enables webhook debug mode.

Kind of webhook

Default: "generic"

Range: Generic (generic), Microsoft Teams (teams), Slack (slack)

Webhook URL

Kind of webhook

Default: "generic"

Range: Generic (generic), Microsoft Teams (teams), Slack (slack)

Webhook URL

The host name, e.g. host.example.com (no url scheme) to test a connection to.

The port to test a connection to.

Default: 443

The connection protocol to test

Default: "tcp"

Range: TCP (tcp), UDP (udp)

A display label for the connection test.