diff --git a/ConfigurationProfile.md b/ConfigurationProfile.md index 92405e6..72b8fc4 100644 --- a/ConfigurationProfile.md +++ b/ConfigurationProfile.md @@ -1,6 +1,6 @@ # Configuration Profile format -The project includes a [custom profile plist](sample-com.jamf.setupmanager.plist) for Jamf Pro and [an example configuration profile](sample-jamfschool.mobileconfig) for Jamf School. +The project includes a [custom profile plist](sample-com.jamf.setupmanager.plist) for Jamf Pro and [an example configuration profile](sample-jamfschool.mobileconfig) for Jamf School. ## Top-level keys @@ -10,8 +10,7 @@ The project includes a [custom profile plist](sample-com.jamf.setupmanager.plist When this is set to `true` any steps that actually change software on the disk will not be performed. -These behaviors change in debug mode: - +These behaviors change in debug mode: - checks for the existence of the Jamf binary and keychain are skipped - Jamf Setup manager will accept enrollmentActions from a non-managed preference file - `policy`, `recon`, and `shell` actions that require root are replaced with a 10 second delay (and will always complete successfully) @@ -21,13 +20,13 @@ When in debug mode, you have to set the `simulateMDM` preference key to `Jamf Pr #### `title` -(String, default: `Welcome to Setup Manager`, localized) +(String, default: `Welcome to Setup Manager`, localized, substitutions) The main title over the window. Example: -```xml +``` title Welcome to your new Mac! ``` @@ -40,22 +39,37 @@ The icon shown at the top center of the window. There are many options to define #### `message` -(String, default: `Setup Manager is configuring your Mac…`, localized) +(String, default: `Setup Manager is configuring your Mac…`, localized, substitutions) The message shown below the title. Example: -```xml +``` message Please wait a few moments while we install essential software… ``` +The message can use [substitutions](#substitutions). + +Example: + +``` +message +Preparing your new %model%. Please be patient. +``` + #### `background` (String, optional, localized) -When this key is set, Setup Manager treats it as an image/[icon source](#icon-sources) and displays the image in a screen covering background. +When this key is set, Setup Manager treats it as an image/[icon source](#icon-source) and displays the image in a screen covering background. + +#### `runAt` + +(String, optional, deafult; `enrollment`) + +This value determines when Setup Manager should launch. There are two values: `enrollment` (default) and `loginwindow`. When set to `enrollment` Setup Manager will launch immediately when the pkg is installed. This is the setting to use for automated device enrollment (without AutoAdvance) and user-initiated enrollment. When the `runAt` value is set to `loginwindow` Setup Manager will launch when the login window is shown. This is useful for fully automated enrollments with AutoAdvance. A setting of `loginwindow` will only with enrollment setups that eventually end on the login window (i.e. a user has to be created automatically or the device is bound to a directory). #### `enrollmentActions` @@ -89,12 +103,12 @@ This key changes the duration (in seconds) of the "final countdown" before the a Examples: -```xml +``` finalCountdown 30 ``` -```xml +``` finalCountdown -1 ``` @@ -107,7 +121,7 @@ This key sets the action and label for the button shown when Setup Manger has co Example: -```xml +``` finalAction shutdown ``` @@ -118,22 +132,24 @@ Example: This key determines whether both the 'Shutdown' and 'Continue' are shown or just the button set in the `finalAction` key. +**Warning:** this key will be removed in a future version of Setup Manager + Example: -```xml +``` showBothButtons ``` #### `totalDownloadBytes` -(Integer, optional, default: 1000000000 or 1GB, v0.8) +(Integer, opitonal, default: 1000000000 or 1GB, v0.8) Use this value to provide an estimate for the total size of all items that will be downloaded. Setup Manager will display and estimated download time for this sum in the "About this Mac..." popup window. Example: -```xml +``` totalDownloadBytes 4500000000 ``` @@ -146,7 +162,7 @@ Set this to `$JSSID` in the configuration profile and Setup Manager will be awar Example: -```xml +``` jssID $JSSID ``` @@ -159,39 +175,27 @@ Set this to `$EMAIL` in the configuration profile. This communicates the user wh Example: -```xml +``` userID $EMAIL ``` #### `computerNameTemplate` -(String, Jamf Pro only) +(String, Jamf Pro only, substitutions) When this key is set, Setup Manager will generate the computer name from this template and set it. When this key is present, a `computerName` dict or string in `userEntry` will be ignored. -The template uses tokens, which begin and end with `%` character. The tokens will be replaced with data from the device or from user entry. For example, in the template `Mac-%serial%` the `%serial%` token will be replaced with the computer's serial number. (A double `%%` will be substituted with a single `%`, in case you need to represent this symbol in the computer name.) - -The following tokens are available: - -- `serial`: the computer's serial number -- `udid`: the computer's provisioning udid -- `model`: the computer's model name, e.g. `MacBook Air` or `Mac mini` -- `model-short`: the first word of `model` (no spaces), i.e. `MacBook`, `Mac` or `iMac` -- these values from user entry: `email`, `assetTag`, `building`, `department`, `room` - -If the value for a token cannot be retrieved or is empty, it will be substituted with `%%%` (three percentage signs). - -You can add a `:n` (where `n` is an integer number) to a token. This will substitute only the first `n` characters of the string. For example `%serial:5%` will be substituted with the first 5 characters of the serial number. When `n` is negative, it will substitute the _last_ `n` characters. For example, `%udid:-8%` will substitute the last eight characters of the udid. +The template uses substitution tokens, which begin and end with `%` character which will be substituted with data at run time. See [Substitutions](#substitutions) for details. Example: -```xml +``` computerNameTemplate -Mac-%serial:-6% +Mac-%serial:=6% ``` -This will set the computer name to `Mac-ABC123` where `ABC123` is the last six characters of the serial number +This will set the computer name to `Mac-DEF456` where `DEF456` are the center six characters of the serial number #### `overrideSerialNumber` @@ -207,10 +211,10 @@ Hides the individual labels under each action's icon. Example: -```xml +``` hideActionLabels -``` +``` #### `hideDebugLabel` @@ -220,18 +224,19 @@ When set, suppresses display of the red 'DEBUG' label in debug mode. Useful for Example: -```xml +``` hideDebugLabel ``` + ## Actions All actions should have these keys: #### `label` -(String, required, localized) +(String, required, localized, substitutions) The label is used as the name of the action in display. @@ -265,7 +270,7 @@ When this key is set to `true` Setup Manager will only run this when itself is r Example: -```xml +``` label Set Time Zone @@ -295,7 +300,7 @@ This will run the jamf policy or polices with the given trigger name. This is th Example: -```xml +``` label BBEdit @@ -328,7 +333,7 @@ The action will fail after this timeout. Example: -```xml +``` label Jamf Protect @@ -337,7 +342,7 @@ Example: watchPath /Applications/JamfProtect.app wait - 300 + 300 ``` @@ -353,7 +358,7 @@ Wait for a given time. Use this to let the system catch up with previous install Example: -```xml +``` label Waiting… @@ -362,6 +367,29 @@ Example: ``` +### Wait for User Entry + +#### `waitForUserEntry` + +(String, value is ignored) + +When 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.' + +When the user entry is saved, this action will set the computer name, according to the `computerNameTemplate` or what was entered by the user and run a recon/Update Inventory which submits the user data. + +This action allows for "two phase" installation workflows where the policies in the second phase are scoped to data from the user entry. After this action, smart groups in Jamf Pro should reflect the data entered and you can use scoping in subsequent policies to choose which policies should or should not run on this device. + +Regardless of whether there is a `waitForUserEntry` action or not, Setup Manager will submit the user data and run a recon/Update Inventory after all actions are finished. + +```xml + + label + Wait for User Entry + waitForUserEntry + + +``` + ### Jamf Inventory Update (recon) #### `recon` @@ -374,7 +402,7 @@ You should usually not need to add a recon step. By default Setup Manager will a Example: -```xml +``` recon @@ -383,9 +411,9 @@ Example: ### Installomator -This will run Installomator to install a given label. +This will run [Installomator](https://github.com/Installomator/Installomator) to install a given label. -Note: by default, Setup manager will add `NOTIFY=silent` to the arguments to suppress notifications. You can override this in the `arguments`. +Note: by default, Setup manager will add `NOTIFY=silent` to the arguments to suppress notfications. You can override this in the `arguments`. #### `installomator` @@ -401,7 +429,7 @@ List of additional arguments passed into Installomator. Example: -```xml +``` label Google Chrome @@ -412,6 +440,7 @@ Example: ``` + ## Icon Sources Icons can be defined in several ways in Setup Manager. These different approaches for the top-level `icon` and `background` key, as well as the `icon` key in an action. @@ -420,7 +449,7 @@ Icons can be defined in several ways in Setup Manager. These different approache When the icon source string starts with `http` or `https`, Setup Manager will attempt to download a file from that URL and interpret it as an image file. It will show a spinning progress view while downloading. -```xml +``` icon https://example.com/path/to/icon.png ``` @@ -429,36 +458,36 @@ When the icon source string starts with `http` or `https`, Setup Manager will at When the icon source is an absolute file path, Setup Manager will attempt to read that file as an image file and display it. -```xml +``` icon /Library/Organization/image.png ``` -### Application +### Application: When the icon source is an absolute file path that ends in `.app`, Setup Manager will get the icon from that app. -```xml +``` icon /System/Applications/App Store.app ``` -### Name +### Name: When the icon source starts with `name:`, Setup Manager will get the icon with that name. Two names are useful: `AppIcon` gets Setup Manager's app icon and `NSComputer` will get an icon representing the current hardware. -```xml +``` icon name:AppIcon ``` -### SF Symbols +### SF Symbols: -When the icon source starts with `symbol:`, Setup Manager will create the icon using that symbols name. You can look up symbol names using the [SF Symbols app](https://developer.apple.com/sf-symbols/). +When the icon source starts with `symbol:`, Setup Manager will create the icon using that symbols name. You can look up symbol names using the [SF Symbols](https://developer.apple.com/sf-symbols/) app. Note that the availability of SF Symbols will vary with the OS version and that some SF Symbols may look different in different localizations. -```xml +``` icon symbol:clock ``` @@ -476,6 +505,10 @@ You can enable user entry for the following keys: Any of the fields will only be shown when its key exists. If you were to create an empty `userEntry` dict, you get an empty user input screen with a 'Save' button - not a good user experience. +### User Data file + +Data from user entry is written, together with some other data to a file when Setup Manager reaches a `waitForUserEntry` action and again when it finishes. The file is stored at `/private/var/db/SetupManagerUserData.txt`. [More details.](Extras.md#user-data-file) + #### `default` (String, localized) @@ -484,7 +517,7 @@ You provide a default value in two ways: Example: -```xml +``` computerName Mac-12345 ``` @@ -495,25 +528,16 @@ When you want to configure other options of the field, you need to use the `dict Example: -```xml +``` computerName default ABC12345 + validation + [A-Z]{3}\d{5} ``` -With the second, longer form you can have different default values per [localization](#localization). - -```xml -computerName - - default - Device-12345 - default.de - Gerät-12345 - -``` #### `placeholder` @@ -521,7 +545,7 @@ With the second, longer form you can have different default values per [localiza This will show the string value given as a greyed out placeholder in the empty text field. -```xml +``` assetTag placeholder @@ -537,7 +561,7 @@ Note: a `default` value will prevent the placeholder from appearing, unless the This will show a popup list of preset options: -```xml +``` department options @@ -570,7 +594,7 @@ Detailed description of the regular expression syntax: [NSRegularExpression](htt Example: -```xml +``` userID placeholder @@ -586,7 +610,7 @@ Example: The default validation message will show the regular expression the value is not matching. This is suitable for debugging but not at all user friendly. You really should provide a localized message explaining how the value can conform. -```xml +``` assetTag placeholder @@ -594,13 +618,16 @@ The default validation message will show the regular expression the value is not validation [A-Z]{3}\d{5} validationMessage - Asset Tag needs to be of format 'ABC12345' - validationMessage.de - Etikett Nummer muss im Format 'ABC12345' sein - validationMessage.fr - L'étiquette d'actif doit être au format 'ABC12345' - validationMessage.nl - Asset Tag moet het formaat 'ABC12345' hebben + + en + Asset Tag needs to be of format 'ABC12345' + de + Etikett Nummer muss im Format 'ABC12345' sein + fr + L'étiquette d'actif doit être au format 'ABC12345' + nl + Asset Tag moet het formaat 'ABC12345' hebben + ``` @@ -616,7 +643,7 @@ For this, you need to setup the top-level `userID` to receive the `$EMAIL` varia Example: -```xml +``` userEntry showForUserIDs @@ -649,7 +676,7 @@ When you provide a top-level `help` key with a dictionary a help button (with a (String, optional, localized) -#### `url` +#### `url`: (String, optional, localized) @@ -657,7 +684,7 @@ The contents of the `url` key will be translated into a QR code and displayed ne Example: -```xml +``` help message @@ -673,22 +700,36 @@ Example: The app will pick up the user choice of the UI language for the interface elements. Right now it supports English, French, German, Italian, Spanish, and Dutch. The app will fall back to English for other language choices. -You can provide localizations for the texts given in the configuration profile. You can do so by adding the two-letter language abbreviation (e.g. `de`, `fr`, or `nl`) to the key, separated with a `.` (dot or period character). The value of the key without a "language extension" is used for English and as a fallback value for other languages. +You can provide localizations for the texts given in the configuration profile. -Example: +**Note:** the method for providing localized texts in the configuration profile changed in version 1.1. The previous method will continue to work for the time being. Going forward, it is _strongly_ recommended to change to the new dictionary-based solution. -```xml +To provide a set of localizations for a value in the profile, change its type from `string` to `dict`. Inside the `dict`, provide a value for each localization for each localization with the language code as key. + +For example, this unlocalized key-value pair + +``` title Welcome! -title.de -Willkommen! -title.fr -Bienvenu! -title.nl -Welkom! +``` + +is localized like this: + +``` +title + + en + Welcome! + de + Willkommen! + fr + Bienvenu! + nl + Welkom! + ``` -If you do not provide or have deleted a `title.de` key and value, the app will choose the value of the `title` key even when in the German setting. +When there is no value for the localization, the app will fall back to the value of the `en` key. The following keys can be localized: @@ -699,26 +740,61 @@ The following keys can be localized: - `icon` - `background` -### Action keys +### Actions - `label` - `icon` -### User Entry keys +### User Entry - `default` - `placeholder` - `validationMessage` +### Help + +- `title` +- `message` +- `url` + Use these two-letter codes for these languages: | Language | two-letter code | -| ------------------ | --------------- | -| Dutch (Nederlands) | nl | +|--------------------|-----------------| | English | en (default) | +| Dutch (Nederlands) | nl | | French | fr | | German | de | | Italian | it | | Norwegian | nb | | Spanish | es | | Swedish | sv | + +## Substitution + +Certain keys, such as `computerNameTemplate` can use tokens, which begin and end with `%` character. The tokens will be substituted with data from the device or from user entry. For example, in the template `Mac-%serial%` the `%serial%` token will be replaced with the computer's serial number. (A double `%%` will be substituted with a single `%`, in case you need to represent this symbol in the computer name.) + +The following tokens are available: + +- `serial`: the computer's serial number +- `udid`: the computer's provisioning udid +- `model`: the computer's model name, e.g. `MacBook Air` or `Mac mini` +- `model-short`: the first word of `model` (no spaces), i.e. `MacBook`, `Mac` or `iMac` +- these values from user entry, _after_ user entry has completed + - `email` + - `assetTag` + - `building` + - `department` + - `room` + +If the value for a token cannot be retrieved or is empty, it will be substituted with `%%%` (three percentage signs). + +You can add a `:n` (where `n` is an integer number) to a token. This will substitute only the first `n` characters of the string. For example `%serial:5%` will be substituted with the first 5 characters of the serial number. When `n` is negative, it will substitute the _last_ `n` characters. For example, `%udid:-8%` will substitute the last eight characters of the udid. When you use `:=n` the _center_ `n` characters will be picked. + +These keys can use substitutions: + +- `title` +- `message` +- `computerNameTemplate` +- actions: `label` + diff --git a/Docs/Extras.md b/Docs/Extras.md new file mode 100644 index 0000000..33bb1f6 --- /dev/null +++ b/Docs/Extras.md @@ -0,0 +1,80 @@ +# Extras and Notes + +## Custom JSON Schema for Jamf Pro + +- create a new profile +- go to ‘Application & Custom Settings’ +- select ‘Jamf Applications’ +- click the ‘+ Add’ button +- in the ‘Jamf Application Domain’ popup select ‘com.jamf.setupmanager’ +- for the version select the version of Setup Manager you are using +- for the ‘Variant’, select ‘Setup Manager.json’ +- fill in your fields! + +Note that the custom schema can become confused when you switch between enrollment action types and you will need to clean up extra empty fields. + +## Quit + +The command-Q keyboard short cut to quit the app is disabled. You can use shift-control-command-E instead. This should only be used when debugging as it may leave the client in an undetermined state when installations are aborted. + +## Logging + +Setup Manager logs to `/Library/Logs/Setup Manager.log`. While Setup Manager is running you can open a log window with command-L. + +## Debug mode + +When you set the `DEBUG` key to `true` in the profile or locally with the `defaults` command Setup Manager will not perform any tasks that actually perform installations or otherwise change the system. + +You will also be able launch the app as the user, by double-clicking the app in `/Applications/Utilities`. This is useful to test the look and feel of your custom icons, text and localization. When you use this to create screen shots for documentation, also note the `overrideSerialNumber` and `hideDebugLabel` keys. + +## Flag file + +Setup Manager creates a flag file at `/private/var/db/.JamfSetupEnrollmentDone` when it finishes. If this file exists when Setup Manager launches, the app will terminate immediately and without taking any action. You can use this flag file in an extension attribute in Jamf to determine whether the enrollment steps were performed. (Setup Manager does not care if the actions were performed successfully.) + +When `DEBUG` is set to `true` in the defaults/configuration profile, the flag file is ignored at launch, but may still be created when done. + +In Jamf Pro, you can create an Extension Attribute named "Setup Manager Done" with the script code: + +```sh +if [ -f "/private/var/db/.JamfSetupEnrollmentDone" ]; then + echo "done" +else + echo "incomplete" +fi +``` + +And then create a Smart Group named "Setup Manager Done" with the criteria `"Setup Manager Done" is "done"`. This can be very useful for scoping and limitations. + +## User Data file + +The data from user entry is written to a file when Setup Manager reaches a `waitForUserEntry` step and again when it finishes. The file is stored at `/private/var/db/SetupManagerUserData.txt`. When `DEBUG` is enabled, the file will be written to `/Users/Shared/`. + +The file is plain text with the following format: + +``` +start: 2024-08-14T13:52:56Z +userID: a.b@example.com +department: Sales +building: Example +room: ABC123 +assetTag: XYZ888 +computerName: MacBook-M7WGMK +submit: 2024-08-14T13:54:37Z +duration: 101 +``` + +Start time (`start`) and finish/submission time (`submit`) are given in ISO8601 format, universal time (UTC). + +Fields that were not set in user entry will not be shown at all. You can use this file in scripts or extension attributes. The easiest way would be to parse it with `awk`, e.g. + +``` +duration=$(awk -F ': ' '/duration: / {print $2}' /private/var/db/SetupManagerUserData.txt) +``` + +## Final action and shutdown + +When the app is not running as root (for testing or from Xcode) or when the `DEBUG` preference is set, shutdown will merely quit. + +## "About This Mac…" window + +When you hold the option key when clicking on "About This Mac…" you will see more information. diff --git a/Docs/FAQ.md b/Docs/FAQ.md new file mode 100644 index 0000000..956bc1c --- /dev/null +++ b/Docs/FAQ.md @@ -0,0 +1,35 @@ +# Frequently Asked Questions + +## Is there are custom JSON Schema for Jamf Pro? + +[Yes.](Extras.md#custom-json-schema-for-jamf-pro) + +## Can you block the user desktop with user initiated enrollment? + +Yes, use the top-level `background` key and point it to a local image file or a http URL to an image file. If you don't want custom branding, you can set `background` to `/System/Library/CoreServices/DefaultDesktop.heic` for the default image. + +## Setup Manager is not launching after enrollment + +There can be many causes for this. A few common causes are: + +- Jamf Pro: check that Setup Manager is added to your prestage and the package does not have the label "Availability pending" in Settings> Packages +- Jamf Pro: do not install JamfConnect.pkg in prestage when you want to use Setup Manager. Install JamfConnect with Setup Manager instead +- you need at least one of the 'Setup Assistant Options' in the prestage to be set to _not_ skip. Location Services or 'Choose your Look' are common choices, that you generally want to leave up the user anyway. Otherwise Setup Assistant may quit before Setup Manager can launch and do its actions. + +## Does Setup Manager require Jamf Connect + +No. + +Setup Manager will run fine without Jamf Connect. You can even build 'single-touch' style workflows with Setup Manager withough Jamf Connect. Some features, such as pre-assigning a device to a specific user require Jamf Connect, though. + +## How can I use the icon for an app before the app is installed? + +- preinstall icon files with a custom package installer in prestage. Set the priority of the media/branding package lower than that for Setup Manager, or give the branding/media package a name that is alphabetically earlier than Setup Manager, so it installs before Setup Manager +- use http(s) urls to the image files + - you can host them on a web server/service that you have control over + - you can add the icon as an icon for a self service policy in Jamf and then copy the url to the icon once uploaded + + +## What is happening during the "Getting Ready" steps? + +During the "Getting Ready" phase, Setup Manager is waiting for the Jamf Pro configuration to be complete, and runs a recon, so that policies during the enrollment phase can already be scoped. You cannot change the steps in this phase. You can see the details and possibly failures in the Setup Manager log. diff --git a/Docs/JamfPro-QuickStart.md b/Docs/JamfPro-QuickStart.md new file mode 100644 index 0000000..b17b92b --- /dev/null +++ b/Docs/JamfPro-QuickStart.md @@ -0,0 +1,71 @@ +# Jamf Pro: Setup Manager Quick Start + +## Upload Setup Manager package + +Download the latest version of the Setup Manager installation pkg from the [releases page](https://github.com/Jamf-Concepts/Setup-Manager/releases/latest). + +In the Jamf Pro web interface, go to Settings > Packages. Create a new package and upload the Setup Manager installer pkg file to Jamf Pro. Save the package. + +_Note:_ when the package is marked as 'pending' it will not work in prestage deployment. Wait with testing deployments until the 'pending' flag has disappeared. + +## Prepare a Jamf Pro policy for use with Setup Manager + +Setup Manager can trigger policies in Jamf Pro. By triggering a sequence of Jamf Pro policies all the required software and configurations will be installed on the device. + +## Create the Setup Manager configuration profile + + - Go to Computers > create a new profile + - Name the profile 'Setup Manager' + - assign a category, ensure the Level is set to 'Computer Level' + - in payload sidebar select 'Application & Custom Settings', then select 'Jamf Applications' + - click the '+ Add' button + - for the 'Jamf Application Domain' choose `com.jamf.setupmanager` + - for the version select the version of Setup Manager you are using + - for the 'Variant', select `Setup Manager.json` + +### Profile values + - for the Icon Source, enter `name:NSComputer`. This is a special value that tells Setup Manager to use an image of the computer it is running on. There are many other options you can use as an icon source [documented here](../ConfigurationProfile.md#icon-source). + - for the Title, enter `Welcome to Setup Manager!` + - for the Message, enter `Please be patient while we set up your new Mac…` + +### Enrollment + - under Enrollment Actions, click on 'Add Item' + - for item 1, from the 'Select Action Type' popup, choose "Installomator" + - for 'Action Label,' enter `Google Chrome` + - for 'Action Icon Source,' enter `symbol:network` + - for 'Installomator Label' enter `googlechromepkg` + - click 'Add Item' + - for item 2, from the 'Select Action Type' popup, choose "Shell Command" + - under 'Command Arguments', click 'Add argument', enter `-setTimeZone` + - click 'Add argument' again and enter your time zone in the format `Europe/Amsterdam` (the 'TZ identifier' [from this list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)) + - for 'Action Label,' enter `Set Time Zone` + - for 'Action Icon Source,' enter `symbol:clock` + - for 'Requires Root' select `true` + - for 'Shell Command Path' enter `/usr/sbin/systemsetup` + +You can add more actions here. There are more types of actions available, you can use a 'Jamf Policy Trigger' action to run a policy with a custom trigger. You can also use a 'Watch Path' action to wait for an app to be installed from the Mac App Store or Jamf App Installers. + +## Scoping and Prestage + +- Scope the configuration profile to the computers you want to run Setup Manager on +- create a new Prestage or duplicate an existing one +- Add the Setup Manager pkg and the configuration profile to the Prestage +- if you have JamfConnect.pkg in the Prestage, remove it. You can later add an action to install JamfConnect using Setup Manager. +- ensure that 'Automatically advance through Setup Assitant' is _disabled_ +- Have at least one option _disabled_ (so that _is_ displayed) +- ensure your test Mac(s) is (are) assigned to the Prestage + +## Wipe the Test Mac + +- on the test mac, choose 'Erase all Contents and Settings' in the Settings app or wipe the Mac using the 'Wipe Computer' remote management command in Jamf Pro +- click through the initial enrollment dialogs. After you approve the enrollment in your MDM, Setup Manger should appear and perform the actions you configured +- while the installations are progressing, click on "About this Mac…" for information, click again while holding down the option key for even more information +- hit command-L for a log window. You can also find this log info later at `/Library/Logs/Setup Manager.log` + +## Next Steps + +- add more actions to Setup Manager, you can use more Jamf Pro policies, Installomator labels, or shell actions +- add a computer name template key to the profile to automate computer naming +- add a `help` section to let the user know what is going on +- ideally automated deployments shouldn't require manual entry, but if necessary, you can configure a user entry section in the profile + diff --git a/Docs/JamfPro-TwoPhase.md b/Docs/JamfPro-TwoPhase.md new file mode 100644 index 0000000..d5d2364 --- /dev/null +++ b/Docs/JamfPro-TwoPhase.md @@ -0,0 +1,60 @@ +# Jamf Pro: extra installations based on user data entry + +In this simple example workflow, we run certain Jamf Pro policies depending on the department. This example can be expanded to other user entry data fields. + +- create Setup Manager configuration profile + - create a `userEntry` key with a list of options for the department: + +```xml +userEntry + + department + + options + + Sales + Development + IT + Marketing + + + +``` + +Note that you need to have the matching departments in Jamf Pro. + +- add the `enrollmentActions` that should run on all computers first +- then add a `waitForUserEntry` action: + +```xml + + label + Submit entries + waitForUserEntry + + +``` + +When Setup Manager reaches this action it will wait for the user data entry to be complete if it isn't already. Then Setup Manager will submit the data from the user entry to Jamf Pro and run a recon, so you can use the data for scoping subsequent policies. + +Setup Manager also saves the data from user entry in a plain text file which you can use in policy scripts after the `waitForUserEntry` action. [See details here.](Extras.md#user-data-file) + +- Insert this action + +``` xml + + icon + symbol:plus.app + label + Extra Apps for %department% + + policy + install_extra_apps + +``` + +- for the policies you want run/install depending on the user entry: + - give the policy a custom trigger matching the trigger in 'Extra Apps' action: `install_extra_apps` + - scope the policy to the department(s) that should receive the installations + - repeat for every extra installation that depends on the user entry + diff --git a/JamfProConnect-SingleTouch.md b/Docs/JamfProConnect-SingleTouch.md similarity index 100% rename from JamfProConnect-SingleTouch.md rename to Docs/JamfProConnect-SingleTouch.md diff --git a/Docs/JamfSchool-Setup.md b/Docs/JamfSchool-Setup.md new file mode 100644 index 0000000..9f8b96d --- /dev/null +++ b/Docs/JamfSchool-Setup.md @@ -0,0 +1,166 @@ +# Installation and Configuration: Jamf School + +## Selecting Deployment Method + +Jamf Setup Manager can be deployed to run at two different points during a device deployment. Right after enrollment (the default) and at login window. You must select which method is appropriate for your deployment before configuring the Jamf Setup Manager Workflow in Jamf School + +### At Enrollment (Default) + +Jamf Setup Managers default deployment action is to run at `Setup Assistant`. + +Setup Manager will appear and during `Setup Assistant` allowing the user to continue to configure `Setup Assistant` after Setup Manager has completed its tasks. + +_**This method is recomended for 1:1 environments**_ + +Example +> You deploy 1:1 MacBooks, want to ensure that critical software installed prior to the user working on the device but also require the user to configure TouchID and create a user account during the onboarding. + +> The user will connect the MacBook to the network and enroll into MDM. After a short delay Setup Manger will run and complete its tasks and install critical software + +> Once complete the user will be released back to Setup Assistant where they will be able to use the Setup Assistant panes to configure TouchID and create a user + + + +With this default method you will require an Automated Device Enrollment Profile configured with + +- At least one setup assistant pane configured +- *“Wait for the configuration to be applied before continuing the Setup Assistant”* box checked +- An admin account should be configured as required +- Other ADE profile setting should be set as required +- _**Do Not**_ select `Auto Advance` + +> If the user skips through all of the Setup Assistant panes before Setup Manager launches or Auto Advance is selected. and the device lands on the login screen, Setup Manager will not launch + + +### At Login Window + +Jamf Setup Manager can be configured to run at `Login Window`. + +Setup Manager will appear once the device has ran through `Setup Assistant` and is waiting at the login screen and run through its tasks. Releasing back to the login window once complete. + +_**This method is recommended for lab environment**_ + +Example +> You are deploying a lab of iMacs ready for the new academic year. You wish to connect iMacs to the network with ethernet, power on and leave the devices to enroll and build while you complete other tasks. + +> After configuring an ADE profile with Auto Advance an iMac will enroll into Jamf School and move through Setup Assistant without any user interaction. Once at the login Window Setup Manager will run and complete its tasks. + +> Once Setup Manager is complete the build is complete + + +To run Setup Manager at `Login Window` you will require + +1. A Setup Manager Profile with the key `runAt` and `String Value` of `loginwindow` +2. An Automated Device Enrollment Profile configured with + +- An admin account +- `Auto Advance` configured +- Other ADE profile setting should be set as required + + +--- + +## Jamf Setup Manager Workflow Requirements + +In order to configure the workflow in Jamf School you will need + +- A Jamf Setup Manager Configuration Profile (customized for your deployment, example profile below) uploaded to Jamf School +- Jamf Setup Manager package installer (available from Jamf Concepts) uploaded to Jamf School +- An Automated Device Enrollment Profile with the correct settings for your chosen deployment method (`default` or `LoginWindow`) + + +--- + +**Step 1: Configuration Profile** +Create a Payload-less Profile for Smart Group Targeting + +- Navigate to profiles and create a new macOS Profile +- Name it *“Jamf Setup Manager Installed”* +- Do not scope the profile and do not configure any payloads. Simply save the profile + +--- + +**Step 2: Smart Group for Setup Manger Config Profile** +Create a Smart Group to target your required Macs + +- Navigate to `Devices → Device Groups` and create a new group. Ensure you select `Smart Group` +- Name the Group *“Jamf Setup Manager Profile”* skip all other panes until members +- In members select `Automated Device Enrollment Profile` `equals` and then select the ADE profile that you created as part of the requirements step. This will target any and all devices that enrol using that ADE profile + +> If you only want to select a subset of macOS devices, for example Lab Mac devices and not 1:1 devices, configure this group to target additional critera the desired devices in your environment will have + +- `Save` Scope +- Next in the `Profiles` tab add the Jamf Setup Manager Configuration Profile that you uploaded to Jamf School + +--- + +**Step 3: Smart Group to install Setup Manager** +Create a Smart Group to target devices with Jamf Setup Manager Profile Installed to deploy the Setup Manager pkg + +- Navigate to `Devices` → `Device Groups` and create a new group. Ensure you select `Smart Group` +- Name the Group *“Install Jamf Setup Manager”*, skip all other panes until members +- In members select `Managed Profile (Installed)` `equals` and then select the Jamf Setup Manager Configuration Profile that you uploaded to Jamf School +- `Save` Scope +- Next in the `Apps` tab add the Jamf Setup Manager pkg and in the `Profiles` tab select the *“Jamf Setup Manager Installed”* profile you created in Step 1 + + +> If you named your profile in step 1 something different, be sure to select that profile in this step + +--- + +**Step 4: Smart Group for all other apps and configurations** +Create a Smart Group to target devices with the “Jamf Setup Manager Installed” profile installed and deploy the rest of the profile and apps + +- Navigate to `Devices` → `Device Groups` and create a new group. Ensure you select `Smart Group` +- Name the group *“macOS Management & Apps”*, skip all other panes until members +In members select `Managed Profile (Installed)` `equals` and then select *"Jamf Setup Manager Installed"* profile that you created in Step 1 + +> If you named your profile in step 1 something different, be sure to select that profile in this step + +- Next in the `Apps` tab add any apps or packages that will not be installed via Installomator as part of the Jamf Setup Workflow and in the `Profiles` tab any any and all config needed to manage your Macs +- If you install packages or App Store apps through Jamf School, and you want to report on them as part of the Jamf Setup Manager workflow be sure to add `Watchpaths` for the apps / content into the Jamf `Setup Manager Configuration Profile` before uploading to Jamf School + +--- + +### Workflow + +These chained amart group actions then perform the following flow + +- Scope the Jamf Setup Manager Config profiles to all macOS devices enrolled with a given ADE profile +- Once the Profile is reported as installed by Jamf School, it will then install the Jamf Setup Manager pkg (since we 100% know the config profile is on the device before the pkg, we know it’ll be configured in the correct manner) and the *“Jamf Setup Manager Installed”* profile +- Only when the device reports back that it has *“Jamf Setup Manager Installed”* profile will it move into the next smart group where it will receive the `commands` to install further apps / packages and the rest of the configuration profiles. + + +With this flow we are controlling, the best we can, that the first thing the device does is install Jamf Setup Manager and the required config. This is rather than having Jamf Setup Manager queued further down a list of apps that are installing. + +> You can view the device activity log in the Jamf School console to ensure that the InstallEnterpriseApp command for Setup Manager is received before other app commands, for testing and troubleshooting. + + +--- + +### Workflow Considerations and Warnings + +The Jamf Setup Manager workflow for Jamf School has been designed to take advantage of profile installation reporting in smart groups and in part to tackle the fact that Jamf School does not have a concept of *“Pre-Stage Packages”*. As such the workflow relies on chaining together smart groups where membership of one group is dependent on an action of the previous step. + +Example +> You can view the device activity log in the Jamf School console to ensure that the InstallEnterpriseApp command for Setup Manager is received before other app commands, for testing and troubleshooting. +> +If an admin to accidentally unscoped the *“Jamf Setup Manager Installed”* profile from a device it would then fall out of scope of the *“macOS Management & Apps”* group, as its membership criteria requires the *“Jamf Setup Manager Installed”* profile to be installed on the device. + +> Since the *“macOS Management & Apps”* group is where all of the management and App Store apps are scoped removal from this group means the device has the profiles and App Store apps removed, resulting in a device in an unexpected state. + +Therefore it is essential that the device maintains this chained smart group flow throughout its deployment. + +Should you need to `update`, `amend` or `edit` the `Jamf Setup Manager Configuration Profile` that controls Setup Manager, you will need to do this locally and then re-upload to Jamf School. + +For best results we recommend the following workflow + +- Navigate to the current profile in Jamf School in the `Profiles` -> `Configuration Profiles` menu +- Click the `pencil icon` to edit +- Click `replace profile` +- Drag local updated profile to the revealed box or click on the box to navigate to the profile +- Click `save` + +Following this workflow keeps the name of the profile in Jamf School the same as the previous version and there is no need to edit / add a different or new profile the the scope in `Step 2` or change the criteria for the name of the installed profile in `Step 3` + +Should you want to keep different versions of the Jamf Setup Manager Configuration Profile in Jamf School in order to switch between different Setup Manager actions please ensure that you update the profile in `Step 2` and `Step 3` to match the desired Jamf Setup Manager Configuration Profile prior to deploying devices. Failure to do this could result in the breaking of the smart group chain required for Jamf School resulting in devices in an unexpected state (ie not with the desired configurations and/or apps) diff --git a/sample-com.jamf.setupmanager.plist b/Examples/sample-com.jamf.setupmanager.plist similarity index 59% rename from sample-com.jamf.setupmanager.plist rename to Examples/sample-com.jamf.setupmanager.plist index 937adcc..5290a04 100644 --- a/sample-com.jamf.setupmanager.plist +++ b/Examples/sample-com.jamf.setupmanager.plist @@ -13,17 +13,20 @@ icon symbol:clock label - Set Time Zone - label.de - Zeitzone setzen - label.es - Establecer zona horaria - label.fr - Définir le fuseau horaire - label.it - Imposta il fuso orario - label.nl - Tijdzone instellen + + de + Zeitzone setzen + en + Set Time Zone + es + Establecer zona horaria + fr + Définir le fuseau horaire + it + Imposta il fuso orario + nl + Tijdzone instellen + requiresRoot shell @@ -71,29 +74,35 @@ jssID $JSSID message - Please be patient while Setup Manager configures your new Mac. - message.de - Bitte etwas Geduld während Setup Manager deinen neuen Mac konfiguriert. - message.es - Por favor espere mientras Setup Manager configura tu nuevo Mac. - message.fr - Veuillez être patient pendant que Setup Manager configure votre nouveau Mac. - message.it - Sii paziente mentre Setup Manager configura il tuo nuovo Mac. - message.nl - Even geduld terwijl Setup Manager je nieuwe Mac configureert. + + de + Bitte etwas Geduld während Setup Manager deinen neuen Mac konfiguriert. + en + Please be patient while Setup Manager configures your new Mac. + es + Por favor espere mientras Setup Manager configura tu nuevo Mac. + fr + Veuillez être patient pendant que Setup Manager configure votre nouveau Mac. + it + Sii paziente mentre Setup Manager configura il tuo nuovo Mac. + nl + Even geduld terwijl Setup Manager je nieuwe Mac configureert. + title - Welcome! - title.de - Willkommen! - title.es - ¡Bienvenido! - title.fr - Bienvenu! - title.it - Benvenuto! - title.nl - Welcom! + + de + Willkommen! + en + Welcome! + es + ¡Bienvenido! + fr + Bienvenu! + it + Benvenuto! + nl + Welcom! + userEntry assetTag @@ -115,11 +124,14 @@ userID placeholder - first.last@example.com - placeholder.de - vorname.nachname@example.com - placeholder.nl - voornaam.achternaam@example.com + + de + vorname.nachname@example.com + en + first.last@example.com + nl + voornaam.achternaam@example.com + diff --git a/sample-jamfschool.mobileconfig b/Examples/sample-jamfschool.mobileconfig similarity index 71% rename from sample-jamfschool.mobileconfig rename to Examples/sample-jamfschool.mobileconfig index bd76911..fd86db1 100644 --- a/sample-jamfschool.mobileconfig +++ b/Examples/sample-jamfschool.mobileconfig @@ -25,13 +25,16 @@ icon symbol:clock label - Set Time Zone - label.de - Zeitzone setzen - label.fr - Définir le fuseau horaire - label.nl - Tijdzone instellen + + de + Zeitzone setzen + en + Set Time Zone + fr + Définir le fuseau horaire + nl + Tijdzone instellen + requiresRoot shell @@ -46,13 +49,16 @@ icon symbol:cpu label - Install Rosetta - label.de - Rosetta installieren - label.fr - Installer Rosetta - label.nl - Rosetta installeren + + de + Rosetta installieren + en + Install Rosetta + fr + Installer Rosetta + nl + Rosetta installeren + requiresRoot shell @@ -78,21 +84,27 @@ icon name:AppIcon message - Setup Manager is configuring your Mac… - message.de - Setup Manager konfiguriert deinen Mac… - message.fr - Setup Manager configure votre Mac… - message.nl - Setup Manager configureert je Mac… + + de + Setup Manager konfiguriert deinen Mac… + en + Setup Manager is configuring your Mac… + fr + Setup Manager configure votre Mac… + nl + Setup Manager configureert je Mac… + title - Welcome! - title.de - Willkommen! - title.fr - Bienvenu! - title.nl - Welkom! + + de + Willkommen! + en + Welcome! + fr + Bienvenu! + nl + Welkom! + diff --git a/uninstall.sh b/Examples/uninstall.sh similarity index 100% rename from uninstall.sh rename to Examples/uninstall.sh diff --git a/Images/setup-manager-progress-screenshot.png b/Images/setup-manager-progress-screenshot.png index bb8f949..84e1e32 100644 Binary files a/Images/setup-manager-progress-screenshot.png and b/Images/setup-manager-progress-screenshot.png differ diff --git a/README.md b/README.md index 9d29738..bf3c384 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ Updates will be published in the '[Releases](https://github.com/jamf-concepts/se There is also a [`#jamf-setup-manager`](https://macadmins.slack.com/archives/C078DDLKRDW) channel on the [MacAdmins Slack](https://macadmins.org). +![setup manager progress dialog](Images/setup-manager-progress-screenshot.png) + ## What it does There are many enrollment progress tools available for Mac admins, each with their own strengths. Jamf Setup Manager approaches the problem from the perspective of an IT service provider. @@ -28,70 +30,40 @@ Setup Manager provides: - zero-touch (user-driven) - single-touch (tech-driven) - user initiated enrollment + - handsfree deployment with auto advance - customized branding - localized interface and custom text - support for Jamf Pro and Jamf School -![setup manager progress dialog](Images/setup-manager-progress-screenshot.png) - ## Installation and Configuration -### Jamf Pro - -1. Upload the Setup Manager installer pkg file to Jamf Pro -2. Create a custom configuration profile with the preference domain `com.jamf.setupmanager`. See documentation for the profile contents [here](ConfigurationProfile.md). -3. Scope the configuration profile to the computers -4. Add the pkg and the configuration profile to the Prestage - -Setup Manager can be used for various zero-touch and tech-driven single-touch deployments with Jamf Pro and (optionally) Jamf Connect. One single-touch workflow with Jamf Connect where the tech can re-assign the Mac to a different end user [is described here](JamfProConnect-SingleTouch.md). - -### Jamf School - -[Setup with Jamf School](Setup-JamfSchool.md) +- Jamf Pro + - [JamfPro-Quick Start](Docs/JamfPro-QuickStart.md) + - zero-touch and user-initiated deployments (forthcoming) + - [extra installations based on user data entry](Docs/JamfPro-TwoPhase.md) + - [Single-touch workflow with user re-assignment using Jamf Connect](Docs/JamfProConnect-SingleTouch.md) + - handsfree deployment with auto advance and Setup Manager at login window (forthcoming) +- [Jamf School](Docs/JamfSchool-Setup.md) +- [Extras and Notes](Extras.md) +- [Frequently Asked Questions](FAQ.md) ## Configuration Profile The structure of the configuration profile [is documented here](ConfigurationProfile.md). -## Notes - -### Requirements +## Requirements Setup Manager requires macOS 12.0.0 or higher. It will work only with Jamf Pro or Jamf School. -### Known Issues +## Known Issues -- Setup Manager will **_not_** launch with Auto-Advance enabled -- Setup Manager may **_not_** launch or launch and quit quickly when you disable _all_ Setup Assistant screens -- Policies that are triggered by `enrollmentComplete` may disrupt Setup Manager running from Prestage/Automated Device Enrollment. To avoid this, disable or unscope policies triggered by `enrollmentComplete` on devices using Setup Manager. -- In some deployments, Setup Manager attempts to start while Jamf is still installing. Try adding a 30-60 second `wait` action as the first action. We are working on a solution. -- SVG and PDF files don't work with download URLs. workaround: convert files to PNG or use local SVG or PDf files instead. +- Setup Manager will **_not_** launch at enrollment with Auto-Advance enabled, use the option to run at login window +- Setup Manager may **_not_** launch or launch and quit quickly when you disable _all_ Setup Assistant screens, leave at least one Setup Assistant option enabled +- When you install **_Jamf Connect_** during the Prestage together with Setup Manager, you may see Setup Assistant for some time before Setup Manager launches or Setup Manager may not launch at all. Remove Jamf Connect from the Prestage and install it with Setup Manager policy or installomator action. +- Policies that are triggered by `enrollmentComplete` may disrupt Setup Manager running from Prestage/Automated Device Enrollment. Disable or unscope policies triggered by `enrollmentComplete` on devices using Setup Manager. +- In some deployments, Setup Manager attempts to start while Jamf Pro is still installing. Try adding a 30-60 second `wait` action as the first action. We are working on a solution. - With Jamf School, there will a few seconds after the remote management dialog where Setup Assistant shows before Setup Manager launches. With the Jamf School enrollment architecture, this is unavoidable. -### Quit - -The command-Q keyboard short cut to quit the app is disabled. You can use shift-control-command-E instead. This should only be used when debugging as it may leave the client in an undetermined state when installations are aborted. - -### Logging - -Setup Manager logs to `/Library/Logs/Setup Manager.log`. - -While it is running you can open a log window with command-L. - -### Flag file - -Setup Manager creates a flag file at `/private/var/db/.JamfSetupEnrollmentDone` when it finishes. If this file exists when Setup Manager launches, the app will terminate immediately and without taking any action. You can use this flag file in an extension attribute in Jamf to determine whether the enrollment steps were performed. (Setup Manager does not care if the actions were performed successfully.) - -When DEBUG is set to YES in the defaults/configuration profile, the flag file is ignored at launch, but still created when done. - -### Final action and shutdown - -When the app is not running as root (for testing or from Xcode) or when the `DEBUG` preference is set, shutdown will merely quit. - -### "About This Mac…" window - -When you hold the option key when clicking on "About This Mac…" you will see more information. - --- -Please report issues, feature requests, and feedback (positive and negative) [as an issue.](https://github.com/Jamf-Concepts/setup-manager/issues) +Please report issues, feature requests, and feedback (positive and negative) [as an issue.](https://github.com/Jamf-Concepts/Setup-Manager/issues) diff --git a/Setup-JamfSchool.md b/Setup-JamfSchool.md deleted file mode 100644 index b52e6ca..0000000 --- a/Setup-JamfSchool.md +++ /dev/null @@ -1,80 +0,0 @@ -# Setup with Jamf School - -## Setting Jamf Setup Manager Workflow in Jamf School - -In order to configure the workflow in Jamf School you will need - -- A Jamf Setup Manager Configuration Profile (configured for your deployment, example profile below) uploaded to Jamf School -- Jamf Setup Manager PKG (available from GitHub) uploaded to Jamf School -- An Automated Device Enrolment Profile with at least one setup assistant pane configured, “Wait for the configuration to be applied before continuing the Setup Assistant” box checked and an admin account configured as required and “skipped user creation” pane -- Other ADE profile setting should be set as required but Do Not select Auto Advance (see below) - -### Step 1 - -- Create a Payloadless Profile for Smart Group Targeting -- Navigate to profiles and create a new macOS Profile. -- Name it “Jamf Setup Manager Installed” -- Do not scope the profile and do not configure any payloads. Simply save the profile - -### Step 2 - -- Create a Smart Group to target your required Macs -- Navigate to Devices → Device Groups and create a new group. Ensure you select “Smart Group” -- Name the Group “Jamf Setup Manager Profile” skip all other panes until members -- In members select “Operating System” “equals” “Any” and then leave the min and max OS blank. This will target any and all macOS devices in my environment -- If you only want to select a subset of macOS devices, for example Lab Mac devices and not 1:1 devices, configure this group to target the desired devices in your environment -- Save Scope - -### Step 3 - -- Create a Smart Group to target devices with Jamf Setup Manager Profile Installed to deploy JSM pkg -- Navigate to Devices → Device Groups and create a new group. Ensure you select “Smart Group” -- Name the Group “Install Jamf Setup Manager”, skip all other panes until members -- In members select “Managed Profile (Installed)” “equals” and then select the Jamf Setup Manager Configuration Profile that you uploaded to Jamf School -- Save Scope -- Next in the Apps tab add the Jamf Setup Manager pkg and in the Profiles tab select the “Jamf Setup Manager Installed” profile you created in Step 1 -- If you named your profile in step 1 something different, be sure to select that profile in this step - -### Step 4 - -- Create a Smart Group to target devices with the “JSM Installed” profile installed and deploy the rest of the profile and apps -- Navigate to Devices → Device Groups and create a new group. Ensure you select “Smart Group” -- Name the group “macOS Management & Apps”, skip all other panes until members -- In members select ““Managed Profile (Installed)” “equals” and then select “Jamf Setup Manager Installed” profile that you created in Step 1 -- If you named your profile in step 1 something different, be sure to select that profile in this step -- Next in the Apps tab add any apps or packages that will not be installed via Installomator as part of the Jamf Setup Workflow and in the Profiles tab any any and all config needed to manage your Macs -- If you install packages or App Store apps through Jamf School, if you want to report on them as part of the Jamf Setup Manager workflow be sure to add Watchpaths for the apps / content into the Jamf Setup Manager Configuration Profile before uploading to Jamf School - -These chained Smart group actions then perform the following flow: - -- Scope the Jamf Setup Manager Config profiles to all macOS devices -- Once the Profile is reported as installed by Jamf School, it will then install the Jamf Setup Manager pkg (since we 100% know the config profile is on the device before the pkg, when know it’ll be configured in the correct manner) and the “Jamf Setup Manager Installed” profile -- Only when the device reports back that it has “Jamf Setup Manager Installed” profile will it move into the next smart group where it will receive the commands to install further apps / packages and the rest of the configuration profiles - -With this flow we are controlling the best we can that the first thing the device does it install Jamf Setup Manager and the required config rather than having Jamf Setup Manager queued rather down a list of apps that are installing. - -This activity log shows the order in which Jamf School issues and the device receives the commands. We can see that theres not a huge amount of time between all the actions but long enough that we can be sure that the device gets the Enterprise Install command to install Jamf Setup Manager before anything other apps - -## Workflow Warnings - -Since the Jamf Setup Manager workflow is very “specific” for Jamf School it shouldn’t be a surprise that there are some warnings, or gotcha’s. All mainly around the way that we’ve chained together the smart groups based on installed profiles, although it gives us the flow that we need it's also a little fragile. - -For example if you were to accidentally unscope the “Jamf Setup Manager Installed” profile from a device it would then fall out of scope of the “macOS Management & Apps” group, which is where all of the management and App Store apps are scoped. - -…and of course that means the device has the profiles removed and App Store apps removed AKA disaster 💥💥💥 - -The second smart group we create also is looking for a profile that is installed. You’re likely not going to unscope by accident this profile (although if you did is would mean the device has profiles removed and App Store app removed AKA disaster 💥💥💥) what is more likely to happen is that you UPDATE or REPLACE the “Jamf Setup Manager Configuration Profile” - -Let's say you upload your JSM configure Profile and call its “JSM Setup V1” and this is the profile that you select in the smart group in Step 1 above. You then edit the config profile and call it JSM Setup V1.1, maybe even delete the JSM Setup V1 from Jamf School. - -The smart group is still looking for a profile called “JSM Setup V1”. - -Depending on your setup and how you’ve managed your profiles in Jamf School your deployed devices might not longer have JSM Setup V1 installed, which means it falls out of the “Install Jamf Setup Manager” group which in turn will fall out of the “macOS Management & Apps” group….which is where all of the management and App Store apps are scoped. - -Again, of course that means the device has the profiles removed and App Store apps removed AKA disaster 💥💥💥 - -Also newly deployed devices might not run through the workflow correctly as they are now have JSM Setup V1.1 installed and the smart group is looking for JSM Setup V1. - -Bottom line here is be mindful about the name of your Jamf Setup Manager Profile and if you amend the config and upload a new version, scope that FIRST, then EDIT the smart group, wait for it to deploy and then remove the old profile. - -Although targeting the profile is what makes this workflow successful in Jamf School, it's also a house of cards.