You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: ConfigurationProfile.md
+24-28Lines changed: 24 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,8 @@
2
2
3
3
The project some sample files to get you started:
4
4
-[sample plist](Examples/sample-com.jamf.setupmanager.plist) for Jamf Pro
5
-
-[sample plist](Examples/sample-waitForUserEntry.plist) for Jamf Pro with [two phase workflow](Docs/JamfPro-TwoPhase.md)
6
-
-[configuration profile](Examples/sample-jamfschool.mobileconfig) for Jamf School
5
+
-[sample plist](Examples/sample-waitForUserEntry) for Jamf Pro with [two phase workflow](Docs/JamfPro-TwoPhase.md)
6
+
-[configuration profile](Example/sample-jamfschool.mobileconfig) for Jamf School
7
7
8
8
9
9
## Top-level keys
@@ -12,11 +12,11 @@ The project some sample files to get you started:
12
12
13
13
(Boolean, default: `false`)
14
14
15
-
When this is set to `true` any steps that actually change software on the disk will not be performed. This will also allow you to launch Setup Manager by double-clicking as the user. This can be useful to test a profile, or to take screenshots for documentation.
15
+
When this is set to `true` any steps that actually change software on the disk will not be performed. This will also allow you to launch Setup Manager by double-clicking as the user. This can be useful to test a profile, or to take screen shots for documentation.
16
16
17
17
These behaviors change in debug mode:
18
18
- checks for the existence of the Jamf binary and keychain are skipped
19
-
- Jamf Setup Manager will accept enrollmentActions from a non-managed preference file
19
+
- Jamf Setup manager will accept enrollmentActions from a non-managed preference file
20
20
-`policy`, `recon`, and `shell` actions that require root are replaced with a delay (and will always complete successfully)
21
21
-`watchPath` and `wait` actions timeout and fail after 10 seconds
22
22
@@ -54,7 +54,7 @@ Example:
54
54
<string>Please wait a few moments while we install essential software…</string>
55
55
```
56
56
57
-
The message can use [substitutions](#substitution).
57
+
The message can use [substitutions](#substitution):
58
58
59
59
Example:
60
60
@@ -73,11 +73,11 @@ When this key is set, Setup Manager treats it as an image/[icon source](#icon-so
73
73
74
74
(String, optional, default: `enrollment`)
75
75
76
-
**Beta:** We believe the run at login window feature may require more testing, especially in some edge cases. When, after thorough testing, you believe this works in your workflow, feel free to deploy it, and please let us know about your success or any issues you might encounter.
76
+
**Beta:** We believe the run at login window feature may require more testing, especially in some edge cases. When, after thorough testing, you believe this works in your workflow, feel free to deploy it, and please let us know about success or any issues you might encounter.
77
77
78
-
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 Auto Advance) and user-initiated enrollment.
78
+
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.
79
79
80
-
When the `runAt` value is set to `loginwindow` Setup Manager will launch only when the login window is shown. This is useful for fully automated enrollments using Auto Advance.
80
+
When the `runAt` value is set to `loginwindow` Setup Manager will launch only when the login window is shown. This is useful for fully automated enrollments using AutoAdvance.
81
81
82
82
A setting of `loginwindow` will only work with enrollment setups that eventually end on the login window (i.e. a user has to be created automatically, the device is bound to a directory, etc).
83
83
@@ -125,14 +125,14 @@ Example:
125
125
126
126
This key changes the duration (in seconds) of the "final countdown" before the app automatically performs the `finalAction` (continue or shut down). Set to `-1` (or any negative number) to disable automated execution.
127
127
128
-
Example:
128
+
Examples:
129
129
130
130
```xml
131
131
<key>finalCountdown</key>
132
132
<integer>30</integer>
133
133
```
134
134
135
-
Disable the countdown:
135
+
Disable the
136
136
137
137
```xml
138
138
<key>finalCountdown</key>
@@ -143,7 +143,7 @@ Disable the countdown:
143
143
144
144
(String, optional, default: `continue`)
145
145
146
-
This key sets the action and label for the button shown when Setup Manger has completed. When this key is set to `shutdown` (no space!) it will shut down the computer, otherwise it will just quit Setup Manager ("continue"). This is also the action that is performed when the `finalCountdown` timer runs out.
146
+
This key sets the action and label for the button shown when Setup Manger has completed. When this key is set to `shutdown` (no space!) it will shut down the computer, other wise it will just quit Setup Manager ("continue"). This is also the action that is performed when the `finalCountdown` timer runs out.
147
147
148
148
When the `DEBUG` preference is set, shutdown will merely quit/continue.
149
149
@@ -186,7 +186,7 @@ Example:
186
186
187
187
(String, Jamf Pro only)
188
188
189
-
Set this to `$JSSID` in the configuration profile and Setup Manager will be aware of its computer's id in Jamf Pro. It will be displayed in the 'About this Mac…' popup, when clicked with the option key.
189
+
Set this to `$JSSID` in the configuration profile and Setup Manager will be aware of its computer's id in Jamf Pro. It will be displayed in the 'About this Mac…' popup.
190
190
191
191
Example:
192
192
@@ -229,7 +229,7 @@ This will set the computer name to `Mac-DEF456` where `DEF456` are the center si
229
229
230
230
(String, optional)
231
231
232
-
When set, the "About this Mac" info window will show this value instead of the real serial number. This is useful when making screenshots or recordings for documentation or presentations where you do not want to expose real serial numbers.
232
+
When set, the "About this Mac" info window will show this value instead of the real serial number. This is useful when making screen shots or recordings for documentation or presentations where you do not want to expose real serial numbers.
233
233
234
234
Note: This is for display only. [Substitutions](#substitution) will still use the real serial number.
235
235
@@ -286,7 +286,7 @@ The label is used as the name of the action in display.
286
286
287
287
(String, optional, localized)
288
288
289
-
The [icon source](#icon-sources)used for the display of the label. Different types of actions will have different default icons, which are used when no `icon` key is present.
289
+
The icon source string used for the display of the label. Different types of actions will have different default icons, which is used when no `icon` key is present.
290
290
291
291
There are several different types of actions, and these are defined by additional keys. These keys will be on the same level as the keys above.
292
292
@@ -308,7 +308,7 @@ When the command given in `shell` requires arguments they are listed here, one i
308
308
309
309
(Bool, default: `false`, optional)
310
310
311
-
When this key is set to `true`, Setup Manager will only run this when itself is running as root. Otherwise, it will fail the action. When `DEBUG` is enabled, it will replace the action with a delay instead.
311
+
When this key is set to `true` Setup Manager will only run this when itself is running as root. Otherwise it will fail the action. When `DEBUG` is enabled, it will replace the action with a delay instead.
312
312
313
313
Example:
314
314
@@ -336,11 +336,7 @@ Example:
336
336
337
337
(String, Jamf Pro only)
338
338
339
-
This will run the Jamf Pro policy or polices with the given trigger name. This is the equivalent of running
This will run the jamf policy or polices with the given trigger name. This is the equivalent of running `jamf policy -event <triggername>`
344
340
345
341
Example:
346
342
@@ -390,7 +386,7 @@ Example:
390
386
</dict>
391
387
```
392
388
393
-
Note: This is intended to check if an app is installed from the Mac App Store or by Jamf App Installers. In my experience, these installation methods are quite unreliable, hence the timeout. Since you cannot anticipate the order in which these apps may be installed, it is best to put the `watchPath` actions at the end. For large installations, such as Xcode, or Adobe apps, you want to set a large timeout.
389
+
Note: This is intended to check if app are installed from the Mac App Store or Jamf App Installers. In my experience, these installation methods are quite unreliable, hence the timeout. Since you cannot anticipate the order in which these apps may be installed, it is best to put the `watchPath` actions at the end. For large installations (Xcode) you want to set a large timeout.
394
390
395
391
### Wait
396
392
@@ -419,7 +415,7 @@ Example:
419
415
420
416
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.'
421
417
422
-
When the user entry is saved and this action is reached, it 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. It will also save the data from the user entry to the [user data file](Docs/Extras.md#user-data-file).
418
+
When the user entry is saved and this action is reached, it 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. It will also save the data from the user entry to the [user data file](Docs/Extras.md#user-data-file)
423
419
424
420
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.
425
421
@@ -442,7 +438,7 @@ Regardless of whether there is a `waitForUserEntry` action or not, Setup Manager
442
438
443
439
This will run a Jamf Inventory update.
444
440
445
-
This action exists mainly for troubleshooting. You should generally not need to add a recon step. By default, Setup Manager will automatically run an inventory update before and after running the enrollment actions. If you have a `waitForUserEntry` action configured, this will also run a recon/inventory update.
441
+
You should usually not need to add a recon step. By default Setup Manager will automatically run an inventory update before and after running the enrollment actions.
446
442
447
443
Example:
448
444
@@ -531,7 +527,7 @@ When the icon source starts with `name:`, Setup Manager will get the icon with t
531
527
532
528
### SF Symbols:
533
529
534
-
When the icon source starts with `symbol:`, Setup Manager will create the icon using that symbol's name. You can look up symbol names using the [SF Symbols](https://developer.apple.com/sf-symbols/) app.
530
+
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.
535
531
536
532
Note that the availability and appearance of SF Symbols may vary with the OS version and language/region.
537
533
@@ -561,7 +557,7 @@ Data from user entry is written, together with some other data to a file when Se
561
557
562
558
(String, localized)
563
559
564
-
Provide a default value in one of two ways:
560
+
Provide a default value in two ways:
565
561
566
562
Example:
567
563
@@ -681,9 +677,9 @@ The default validation message will show the regular expression the value is not
681
677
682
678
### Conditionally show the user entry for certain users
683
679
684
-
You can configure Setup Manager to only show the user entry section when specified users have authenticated in enrollment customization. This enables workflows, where certain users (techs and admins) get the option to re-assign the device to another user, but other users don't see the option.
680
+
You can configure Setup Manager to only show the user entry section when specified users have authentication in enrollment customization. This enables workflows, where certain users (techs and admins) gets the option to re-assign the device to another user, but other users don't see the option.
685
681
686
-
For this, you need to setup the top-level `userID` to receive the `$EMAIL` variable. This will communicate to SetupManager the user who logged in with customized enrollment. Then you add key `showForUserIDs` with an array of user emails to the `userEntry` dict. When both `userID` and `userEntry.showForUserIDs` are set, the user entry UI will only show for the listed users.
682
+
For this, you need to setup the top-level `userID` to receive the `$EMAIL` variable. This will communicate the user who logged in with customized enrollment back into Setup Manager. Then you add key `showForUserIDs` with an array of user emails to the `userEntry` dict. When both `userID` and `userEntry.showForUserIDs` are set, the user entry UI will only show for the listed users.
687
683
688
684
#### `showForUserIDs`
689
685
@@ -746,7 +742,7 @@ Example:
746
742
747
743
## Localization
748
744
749
-
The app will pick up the user choice of the UI language for the interface elements. (Table of currently available languages below.) The app will fall back to English for other language choices.
745
+
The app will pick up the user choice of the UI language for the interface elements. (Table of currently available languages below) The app will fall back to English for other language choices.
750
746
751
747
You can provide localizations for the custom texts given in the configuration profile.
Copy file name to clipboardExpand all lines: Docs/Extras.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ Note that the custom schema can become confused when you switch between enrollme
19
19
20
20
## Quit
21
21
22
-
The command-Q keyboard shortcut to quit the app is disabled. Use `shift-control-command-E` instead. This should only be used when debugging and troubleshooting, as it will leave the client in an undetermined state when installations are aborted.
22
+
The command-Q keyboard short cut to quit the app is disabled. Use `shift-control-command-E` instead. This should only be used when debugging and trouble-shooting, as it will leave the client in an undetermined state when installations are aborted.
23
23
24
24
## Logging
25
25
@@ -33,7 +33,8 @@ You may also need to remember to remove the [flag file](#flag-file) before launc
33
33
34
34
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.
35
35
36
-
For testing, you can also re-launch Setup Manager from the command line as root with `sudo "/Applications/Utilities/Setup Manager/Contents/MacOS/Setup Manager"`
36
+
37
+
For testing, you can also re-launch Setup Manager from the command line as root with `sudo "/Applications/Utilities/Setup Manager.app/Contents/MacOS/Setup Manager"`
0 commit comments