updated for v1.2.2

ChangeLog.md

@@ -1,7 +1,24 @@
 #  Setup Manager - Change Log
 
-v1.2beta2
-(2025-02-26)
+## v1.2.2
+(2025-04-17)
+- signed a helper script that could lead to unexpected background item prompts
+- disabled command-W keystroke
+- fixed a stall in `waitForUserEntry` with Jamf School
+- fixed link to computer record in Teams message (#110)
+- minor documentation fixes
+
+## v1.2.1
+(2025-04-02)
+
+- updated included Installomator script to [v10.8](https://github.com/Installomator/Installomator/releases/tag/v10.8)
+- now tries for 15 seconds to reload local `background` image file (#105), this should help in situations where the image file is installed after Setup Manager
+- improved monitoring of Jamf Pro enrollment process and completion during the "Getting Ready" phase
+- minor documentation fixes (#106)
+
+
+v1.2
+(2025-03-17)
 
 ### New Features
 - Setup Manager can send [webhooks](Docs/Webhooks.md) on start and finish, (#70)
@@ -16,6 +33,10 @@ v1.2beta2
 - `message` and help:`message` now interpret [markdown formatting](ConfigurationProfile.md#markdown) (#46)
 
 ### Fixes and Improvements
+- (beta3 and release) return key connected to final action and save buttons (#93)
+- (beta3) added an `event` field to standard webhook data, (#94)
+- (beta3) "facts" in Teams message are no longer in random order
+- (beta3) improved reliablity of running at login window (#77)
 - (beta2) an empty `userEntry` dictionary in the profile no longer chokes the UI (#85)
 - (beta2) MDM check more resilient to certain profile configs (#87)
 - (beta2) the `name` field in WebHook data was shortened from `SetupManagerFinished` and `SetupManagerStarted` to `Finished` and `Started`

ConfigurationProfile.md

@@ -115,7 +115,7 @@ When this key exists, Setup Manager will prompt for user data while the enrollme
 
 (Dict of Strings, optional)
 
-When this key exists, Setup Manager will show a "Help" button (a circled question mark) in the lower right corner while it is running. You can add sub-keys with content for the help, which are described in [Help](#help). When Setup Manager has completed, the "Help" button will be replaced with the "Continue" and/or "Shutdown" button.
+When this key exists, Setup Manager will show a "Help" button (a circled question mark) in the lower right corner while it is running. You can add sub-keys with content for the help, which are described in [Help](#help-1). When Setup Manager has completed, the "Help" button will be replaced with the "Continue" and/or "Shutdown" button.
 
 #### `accentColor`
 
@@ -148,7 +148,7 @@ Example:
 
 (Number/integer, optional, default: `60`)
 
-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.
+This key changes the duration (in seconds) of the "final countdown" before the app automatically performs the `finalAction`. Set to `-1` to disable automated execution.
 
 Example:
 
@@ -173,7 +173,7 @@ This key sets the action and label for the button shown when Setup Manger has co
 There are three options:
 - `continue`: (default) merely quits Setup Manager and allows the user to continue (probably Setup Assistant or login window)
 - `restart`: restarts the Mac
-- `shut down`: (no space!) shuts down the Mac
+- `shutdown`: (no space!) shuts down the Mac
 
 **Warning:** `restart` and `shutdown` options will force their action immediately. If a user is logged in (after user-initiated enrollment), they may lose data from open, unsaved documents.
 
@@ -218,7 +218,7 @@ Example:
 
 (String, Jamf Pro only)
 
-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.
+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`](#conditionally-show-the-user-entry-for-certain-users) key to control which users see the user entry UI.
 
 Example:
 
@@ -478,7 +478,7 @@ Example:
 
 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 notfications. You can override this in the `arguments`.
+Note: by default, Setup manager will add `NOTIFY=silent` to the arguments to suppress notifications. You can override this in the `arguments`.
 
 #### `installomator`
 

Docs/FAQ.md

@@ -20,7 +20,7 @@ There can be many causes for this. A few common causes are:
 
 No.
 
-Setup Manager will run fine without Jamf Connect. You can even build 'single-touch' style workflows with Setup Manager without Jamf Connect. Some features, such as pre-assigning a device to a specific user require Jamf Connect, though.
+Setup Manager will run fine without Jamf Connect. You can even build 'single-touch' style workflows with Setup Manager without Jamf Connect. Some workflows, 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?
 
@@ -52,3 +52,6 @@ With Jamf Pro, you can set the Setup Manager pkg to install at the `login` trigg
 
 This is not, however, the primary workflow for Setup Manager and not something that we will test or verify. We believe running right after enrollment over Setup Assistant is the preferable deployment.
 
+## Installer or Policy Script is failing with access errors
+
+For some policy scripts or installers it may be necessary to give the Setup Manager app Full Disk Access or some other exemptions with a PPPC Profile. 

Docs/Webhooks.md

@@ -48,17 +48,18 @@ For the `started` webhook, Setup Manager attaches this data:
 
 ```json
 {
-  "name": "Started",                     // string
-  "timestamp": "2025-01-14T15:11:28Z",   // time setup manager started, date as string, iso8601
-  "started": "2025-01-14T15:11:27Z",     // time webhook was sent, date as string, iso8601 
-  "modelName": "MacBook Air",            // string
-  "modelIdentifier": "Mac14,2",          // string
-  "macOSBuild": "24C101",                // string
-  "macOSVersion": "15.2.0",              // string
-  "serialNumber": "ABCD1234DE",          // string
-  "setupManagerVersion": "1.2"           // string
-  "jamfProVersion": "11.13.0"            // optional, only for Jamf Pro, string
-  "jssID": 1234                          // optional, only when `jssID` is set in profile, string
+  "name": "Started",                       // string
+  "event": "com.jamf.setupmanager.started" // string
+  "timestamp": "2025-01-14T15:11:28Z",     // time setup manager started, date as string, iso8601
+  "started": "2025-01-14T15:11:27Z",       // time webhook was sent, date as string, iso8601 
+  "modelName": "MacBook Air",              // string
+  "modelIdentifier": "Mac14,2",            // string
+  "macOSBuild": "24C101",                  // string
+  "macOSVersion": "15.2.0",                // string
+  "serialNumber": "ABCD1234DE",            // string
+  "setupManagerVersion": "1.2"             // string
+  "jamfProVersion": "11.13.0"              // optional, only for Jamf Pro, string
+  "jssID": 1234                            // optional, only when `jssID` is set in profile, string
 }
 ```
 
@@ -66,20 +67,21 @@ The data for the `finished` webhook includes the same as above, with some additi
 
 ```json
 {
-  "name": "Finished",                    // string
-  "duration": 53,                        // integer
-  "finished": "2025-01-14T15:12:20Z",    // time Setup Manager finished, date as string, iso8601
-  "computerName": "Mac-123456"           // computer name, only when set through Setup Manager
-  "userEntry": {                         // data entered by the user
+  "name": "Finished",                       // string
+  "event": "com.jamf.setupmanager.finished" // string
+  "duration": 53,                           // integer
+  "finished": "2025-01-14T15:12:20Z",       // time Setup Manager finished, date as string, iso8601
+  "computerName": "Mac-123456"              // computer name, only when set through Setup Manager
+  "userEntry": {                            // data entered by the user
     "department": "IT",
     "computerName": "IT-ABC123",
     "userID": "a.b@example.,com",
     "assetTag": "abc54321"
   },
-  "enrollmentActions": [                 // array of enrollmentActions with status
+  "enrollmentActions": [                    // array of enrollmentActions with status
     {
       "label": "Microsoft 365",
-      "status": "finished"               // status: "finished" or "failed"
+      "status": "finished"                  // status: "finished" or "failed"
     },
     {
       "label": "Google Chrome",
@@ -95,7 +97,11 @@ The data for the `finished` webhook includes the same as above, with some additi
 
 ### Microsoft Teams
 
-When you set up [an incoming webhook workflow with Microsoft Teams](https://support.microsoft.com/en-us/office/create-incoming-webhooks-with-workflows-for-microsoft-teams-8ae491c7-0394-4861-ba59-055e33f75498) the json payload is expected in a certain format. Use this webhook format in the Setup Manager profile:
+When you set up [an incoming webhook workflow with Microsoft Teams](https://support.microsoft.com/en-us/office/create-incoming-webhooks-with-workflows-for-microsoft-teams-8ae491c7-0394-4861-ba59-055e33f75498) the json payload is expected in a certain format. 
+
+**Important Note:** _The Teams Workflow Webhook URL will contain ampersands `&`. Since configuration profiles are XML files, you need to escape/replace all ampersands in the URL with the XML escape sequence `&`._
+
+Use this webhook format in the Setup Manager profile:
 
 ```xml
 <dict>

LICENSE.md

@@ -1,2 +1 @@
-Offered under the terms of the [Jamf Concepts Use Agreement](https://resources.jamf.com/documents/jamf-concept-projects-use-agreement.pdf).
-
+Offered under the terms of the [Jamf Software License and Service Agreement](https://resources.jamf.com/documents/jamf-SLASA.pdf).

README.md

@@ -32,8 +32,8 @@ Setup Manager provides:
   - user initiated enrollment
   - handsfree deployment with AutoAdvance (beta)
 - customized branding
-- localized interface and custom text
-- support for Jamf Pro and Jamf School
+- localized interface and localizable custom text
+- works with Jamf Pro and Jamf School
 
 ## Installation and Configuration
 
@@ -63,7 +63,6 @@ Setup Manager requires macOS 12.0.0 or higher. It will work only with Jamf Pro o
 - 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, or use the option to run at login window
 - Policies that are triggered by `enrollmentComplete` may delay or even 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.
 
 ---