Skip to content

Commit

Permalink
updated for v1.2beta3
Browse files Browse the repository at this point in the history
  • Loading branch information
scriptingosx committed Mar 5, 2025
1 parent 89d9033 commit 407d7f3
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 24 deletions.
8 changes: 6 additions & 2 deletions ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Setup Manager - Change Log

v1.2beta2
(2025-02-26)
v1.2beta3
(2025-03-05)

### New Features
- Setup Manager can send [webhooks](Docs/Webhooks.md) on start and finish, (#70)
Expand All @@ -16,6 +16,10 @@ v1.2beta2
- `message` and help:`message` now interpret [markdown formatting](ConfigurationProfile.md#markdown) (#46)

### Fixes and Improvements
- (beta3) return key connected to button in Setup Manager interface, (#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`
Expand Down
2 changes: 1 addition & 1 deletion Docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down
38 changes: 20 additions & 18 deletions Docs/Webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,38 +48,40 @@ 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
}
```

The data for the `finished` webhook includes the same as above, with some additional fields:

```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",
Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

---

Expand Down

0 comments on commit 407d7f3

Please sign in to comment.