v1.2.1

ChangeLog.md

@@ -1,10 +1,23 @@
 #  Setup Manager - Change Log
 
+## 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)
+  - (beta2) added [a specific webhook to send a message to Microsoft Teams](Docs/WebHooks.md#Microsoft-Teams)
 - User Entry:
-  - `email`, `endUsername`, `realname`, `position` and  `phone` fields added. These will be submitted to Jamf Pro when Setup Manager finishes and during a `waitForUserEntry` action (#24)
-  - you can set custom and localized labels for user entry fields in the profile with a `label` key (#40)
+  - `email`, `endUsername`, `realname`, `position` and  `phone` fields added. These will be submitted to Jamf Pro when Setup Manager finishes and during a `waitForUserEntry` action
+  - you can set custom and localized labels for user entry fields in the profile with a `label` key
 - [User Data file](Docs/Extras.md#user-data-file) now contains a list of enrollmentActions
 - added 'restart' option to ['finalAction'](ConfigurationProfile.md#finalAction) (#38, #58)
 - [icon sources](ConfigurationProfile.md#icon-source) and [`accentColor`](ConfigurationProfile.md#accentColor) can now have [a dark mode alternative defined in the profile](ConfigurationProfile.md#dark-mode) (#61)
@@ -12,23 +25,32 @@
 - `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`
+- (beta2) early log entry when debug mode is enabled
 - icon for `waitForUserEntry` can be changed from the profile
-- shell actions correctly show success or failure, depending on their exit code (#39)
+- shell actions correctly show success or failure, depending on their exit code#39)
 - Jamf Pro policy actions show success or failure in most situations. Note that there are many things a policy can potentially do. Not all failures are caught. This registers failed pkg installations and policy scripts that return a non-zero exit code, which should cover most situations. Note also, these checks will only work on macOS 13 and higher. On macOS 12, Jamf policies will always be reported as success.
 - read enrollment actions data from profile after user-initiated enrollments more reliably
 - now tries for 15 seconds to reload images with local file paths, this should help in situations were the resources file are installed after Setup Manager
 - many other fixes and improvements
+- updated included Installomator to 10.7
 - user data file will contain the enrollment user when the `userID` key is set
 - battery warning threshold is now different for Intel (%50) and Apple silicon (%20) Macs. This matches Apple's warnings before applying software updates
 
 ### Deprecations and Removals
 - the minimum macOS requirement for Setup Manager will be raised to macOS 13 soon
-- `showBothButtons` option removed and non-functional, there will always be just one final action button displayed (#180)
+- `showBothButtons` option removed and non-functional, there will always be just one final action button displayed
 - the method for providing localized texts in the configuration profile changed in version 1.1. The previous method (by appending the two letter language code to the key) is considered deprecated. It will continue to work for the time being but will be removed in a future release. It is _strongly_ recommended to change to the [new dictionary-based solution](ConfigurationProfile.md#localization).
 
 ### Beta Features
 
-Even though we are confident that the 1.2 release is overall stable and ready to be used in production, we believe this feature may require more testing. When, after thorough testing in your environment, you conclude this works for your workflow, please let us know about success or any issues you might encounter.
+Even though we are confident that the release is overall stable and ready to be used in production, we believe this feature may require more testing. When, after thorough testing in your environment, you conclude this works for your workflow, please let us know about success or any issues you might encounter.
 
 - Setup Manager can now run over Login Window, instead of immediately after installation. This also allows Setup Manager to work with AutoAdvance. Use [the new `runAt` key](ConfigurationProfile.md#runAt) in the profile to determine when Setup Manager runs
 

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`
 

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": "SetupManagerStarted",         // 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": "SetupManagerStarted",         // 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-M7WGMK",
+    "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",
@@ -93,5 +95,21 @@ 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. 
 
+**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>
+  <key>kind</key>
+  <string>teams</string>
+  <key>url</key>
+  <string>--insert url from Teams Workflows here--</string>
+</dict>
+```
+
+This `dict` replaces the simple `string` syntax.

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.
 
 ---