Adding the Notify Mechanism

Jamf Connect Login can include the Notify mechanism (formerly DEPNotify.app), which allows a progress bar, customized text, and images to display when deployed during automated device enrollment (formerly DEP). The Notify mechanism is configured by a script that writes commands to a control file.This script can then be specified with the ScriptPath preference key in a configuration profile deployed with Jamf Connect Login.

Note: The RunScript mechanism must also be enabled with the authchanger tool. For more information, see Adding the RunScript Mechanism.

Adding the Notify mechanism to Jamf Connect Login includes the following steps:

  1. Enable the Notify mechanism.

  2. Create a Notify script.

  3. Add the Notify script to your Jamf Connect Login configuration profile.

Step 1: Enabling Notify

The Notify mechanism is not included in the loginwindow application by default. Add the Notify mechanism to the loginwindow application by executing the following command:

/usr/local/bin/authchanger -reset -OIDC -preAuth JamfConnectLogin:Notify

Note: If Okta is your cloud identity provider (IdP) replace "-OIDC" with "-Okta".

Step 2: Creating a Notify Script

The Notify mechanism is controlled by a script that writes echo commands to a control file. By default, the control file is in the following location:

/var/tmp/depnotify.log

Notify Commands

The following commands may be used with the Notify mechanism.

General Commands

Command

Description

Image:

This command replaces the default Notify image with an image at a specified path. The image will automatically scale to the correct size.

Example: Command: Image: /tmp/logo.png

MainText:

This command changes the main text displayed to users.

Example: Command: MainText: Please wait while your new MacBook Pro is being set up.

MainTextImage:

This command replaces the main text with a custom icon at a specified path.

Example: Command: MainTextImage: /tmp/logo.png

MainTitle:

This command changes the main title displayed to users.

Example: Command: MainTitle: Welcome to yournew MacBook Pro!

Interactive Commands

Interactive commands are used to customize the user interaction during the Notify process.

Command

Description

Determinate:

This command sets the the progress bar to be "determinate", progress in steps, instead of displaying a spinning bar. You must specify the number of steps you want to use during the Notify process. Once set, every status update in your script will increment the bar by one stage.

Example: Command: Determinate: 5

DeterminateManual:

This command sets the progress bar to be determinate and progress manually rather than with stage commands. You must specify the number of steps you want during the Notify process. Once set, you must manually progress the status bar using the DeterminateManualStep: command.

Example: Command: DeterminateManual: 5

DeterminateManualStep:

When in DeterminateManual: mode, this command will advance the progress bar by one step or a specified interval. The example below moves the progress bar by two steps.

Example: Command: DeterminateManualStep: 2

DeterminateOff:

This command disables the determinate state for the progress bar. Steps that already occurred remain completed in the progress bar. This allows you to move between a determinate state and non-determinate state without losing your progress.

Example: Command: DeterminateOff:

DeterminateOffReset:

After turning off the determinate state of the progress bar, you must reset it to zero.

Example: Command: DeterminateOffReset:

Quit

This command quits the Notify process.

Example: Command: Quit

Note: A colon is not used with this command.

You can also specify a message to display to users.

Example: Command: Quit: Thanks for using this app.

Notify Status Updates

You can use echo Status: to update users on the Notify process. The following is an example of a status update:

echo Status: Installing Jamf >>/var/tmp/depnotify.log

Note: If the Determinate: command is used, the progress bar increments with each status update.

Step 3: Adding the Notify Script to Your Jamf Connect Login Configuration Profile

The Notify script must be specified in your Jamf Connect Login configuration profile and added to the Jamf Connect Login deployment package. Use the ScriptPath preference key to specify the path to your Notify script like the following example:

<key>ScriptPath</key>

<string>/usr/local/bin/JamfConnectNotify.sh</string>

Related Information

For related information, see the following sections in this guide:

For related information, see the Customizing the Jamf Connect Login package with Composer Knowledge Base article.

Copyright     Privacy Policy     Terms of Use     Security
© copyright 2002-2019 Jamf. All rights reserved.