Skip to content

Configuration Profile Keys

darlow86 edited this page Apr 17, 2024 · 23 revisions

Required Keys

AppInstalls Key

[array of dict]

This option is used to configure the applications that should be installed via Installomator.

Installo app icon name

Each app to be installed needs the following stored in a dict within the array
appIcon
Location of the icon to be displayed in the information window. Spaces should not be escaped
example: /Library/Application Support/School Assembly/chromeicon.png

appLabel
Installomator label of the app to be installed. Installomator labels can be found here
example: googlechromepkg

appName
The text to be displayed in the information window. This can be different than the installomator label
example: Chrome Browser

AppWatch Key

[array of dict]

This option is used to configure the applications who's installation status should be checked via a watchpath

watch app icon and name

School Assembly does not install these items, they should be installed by VPP, App Installers or Jamf Schools 'In-house' app option. This option simply checks if the item is present on the device. If the App is not yet present on the device School Assembly holds on this item until it is before moving on to the next

Each app to be checks needs the following stored in a dict within the array
appIcon
Location of the icon to be displayed in the information window. Spaces should not be escaped
example: /Library/Application Support/School Assembly/keynoteicon.png

appLocation
Location of the app to be checked and watched. Spaces should not be escaped
example: /Library/Applications/Keynote.app

appName
The text to be displayed in the information window. This can be different than the actual name of the app (ie Teams instead of Microsoft Teams New)
example: Keynote


Optional Keys

runLocal Key

[bool]
default: false

This option is used to toggle between deployment and testing modes.

Setting runLocal to true will configure School Assembly to testing mode. This disables full-screen blur for the swiftDialog window and requires an admin password to be entered in an interactive way (for example, if ran through terminal you will get a password prompt in the terminal window)

Setting runLocal to false will configure macOS Onbaorder to deployment mode. This assumes that the script is deployed and run with root privileges through the Jamf School Scripting Module. macOS Onbaorder will run with full-screen blur enabled, resulting in a locked screen for end users during the onboarding workflow.

If this key is not present in the configuration profile it will default to false (Deployment Mode)

Running School Assembly locally without setting this key to true will result in failed Installomator installations

appLogging Key

[bool]
default: false

This option is used to toggle standard or verbose logging of the process that converts configuration profile items into array items to be ran by the School Assembly script.

Setting appLogging to true will log the Icon Location, Display Name and Installomator Label for each app in the AppInstalls key and Icon Location, App Location and Display Name for each app in the AppWatch key.

Use the verbose log to ensure that each element has been correctly read from the configuration profile and the exact string that has been inserted into the script array

Navigate to /var/tmp/jsmacOSOnboarder.log to view log

If this key is not present in the configuration profile it will default to false

userGreeting Key

[bool]
default: false

This option is used to toggle between the logged in username or the computer name in the main window greeting.

User Greeting

Setting the UserGreeting to true will display the username of the logged in user.

Setting the UserGreeting to false will display the computer name

If this key is not present in the configuration profile it will default to false

mainMessage Key

[string]
default: Lets install some apps on your device! This might take a while....

This option is used to set a message in the main window.

MainMessage

This value can accept markdown notation in order to format (bold, italics, newline) the text that is displayed.

If this key is not present in the configuration profile it will display the default Lets install some apps on your device! This might take a while.... string

completeTitle Key

[string]
default: Complete

This option is used to set the title in the complete window used to inform users that the process it complete

Complete title

If this key is not present in the configuration profile it will display the default Complete string

completeMessage Key

[string]
default: Your device is now ready. Go be awesome!

This option is used to set a message in the complete window used to inform users that the process it complete

complete message

This value can accept markdown notation in order to format (bold, italics, newline) the text that is displayed.

If this key is not present in the configuration profile it will display the default Your device is now ready. Go be awesome! string

Clone this wiki locally