PayloadKit

Baseline by Second Son Consulting

com.secondsonconsulting.baseline

Baseline by Second Son Consulting Configuration

macOS

Configuration Keys (38)

KeyTypeTitle
PFC_SegmentedControl_0required
string
InitialScripts

Define scripts that are run immediately as the user logs in, prior to any Baseline SwiftDialog windows. These scripts are the place to add your custom welcome messages or pre-flight scripts.

arrayInitialScripts
Installomator

Define Installomator labels to be run by Baseline. For information specific to Installomator, see the Installomator Github: https://github.com/Installomator/Installomator

arrayInstallomator Labels
Packages

Define Packages to be run by Baseline

arrayPackages
Scripts

Define Scripts to be run by Baseline

arrayScripts
WaitFor

Define files which you want Baseline to wait for. Use this for items not directly installed by Baseline, like VPP or MDM installed apps.

arrayWaitFor
FinalScripts

Define scripts that are run just before completion dialogs. For reporting webhooks, cleanup tasks, etc. Similar to InitialScripts, these items do not appear on the List View.

arrayFinalScripts
WaitForTimeout

When using WaitFor, enter the number of seconds you wish to wait before Baseline considers remaining items a failure. This timer does not start until all other items are processed. Default if key is omitted is 600.

integerWaitFor Timeout
Restart

This setting controls whether Baseline forces a restart after completion.

Default: true

booleanForce Restart
LogOut

This setting controls whether Baseline forces a restart after completion.

Default: false

booleanForce Log Out
CleanupAfterUse

This setting controls whether Baseline deletes it's install directory after use: /usr/local/Baseline.

Default: true

booleanCleanup After Use
IgnoreDefaultInstallomatorOptions

By default, Baseline uses "NOTIFY=silent" and "BLOCKING_PROCESS_ACTION=kill" Installomator options. Setting this to True means Baseline will not use those options.

Default: false

booleanIgnore Default Installomator Options
SkipSuccessDialog

If set to true, Baseline will not present a Success dialog at completion.

Default: false

booleanSkip Success Dialog
SkipFailDialog

If set to true, Baseline will not present a Failure dialog at completion.

Default: false

booleanSkip Failure Dialog
SilentMode

If set to true, no dialog windows will be created. All items and item types will process as normal.

Default: false

booleanSilent Mode
CloseListBeforeFinalScripts

If set to true, Baseline will close the list view window before running FinalScripts. Use this option if you want to utilize FinalScripts to have the user complete actions prior to the Baseline completion dialog.

Default: false

booleanClose List View Before Final Scripts
DialogListOptions

SwiftDialog options for the primary Baseline progress list window.

stringDialog List Window Options
DialogSuccessOptions

SwiftDialog options for the Success Dialog window.

stringDialog Success Window Options
DialogFailureOptions

SwiftDialog options for the Failure Dialog window.

stringDialog Failure Window Options
DialogInspectModeOptions

SwiftDialog options for Inspect Mode. Most options should be in the JSON file, but some can be passed here. See swiftDialog documentation for specifics.

stringDialog Inspect Mode Window Options
InspectModeJSON

Path to your Inspect Mode JSON file. Using this option enables "Inspect Mode". DialogListView options will not be respected, and no Baseline DialogListView will be drawn. Inspect Mode is enabled after InitialScripts

stringInspect Mode JSON
BlurScreen

This setting controls whether Baseline uses the SwiftDialog --blurscreen feature. Default is true. If you set to false, consider using --ontop in your DialogListOptions key

Default: true

booleanBlur Screen
ShowList

If false, the ListView will not show any list items. Instead, a standard Dialog window is drawn with the options configured in `DialogListOptions`. If used with progress bar, the progress bar will still be displayed.

Default: true

booleanShow List
ProgressBar

This setting controls whether Baseline displays a progress bar.

Default: false

booleanShow Progress Bar
ProgressBarDisplayNames

This setting controls whether Baseline displays the current item being processed under the progress bar.

Default: false

booleanShow Display Names on Progress Bar
InstallomatorSwiftDialogIntegration

Tell Installomator to use it's built in SwiftDialog integration for the List View.

Default: false

booleanUse Installomator SwiftDialog Integration
JamfVerbose

If set to true, when a Script is processing a jamf policy (/usr/local/bin/jamf), Baseline will watch the Jamf log to provide more verbose output on that line item. Similar to the Installomator integration, text and a progress circle will be used for all jamf items.

Default: false

booleanVerbose Jamf Items
Button1Enabled

This setting enables SwiftDialog "Button 1" (the OK button) on the Baseline List View. This allows users to dismiss the list view and continue working while Baseline runs. By default this button is disabled.

Default: false

booleanButton 1 Enabled
GlobalDialogStatusIconWait

The icon used for the wait list status, if no specific wait status icon is set.

stringGlobal Status Icon - Wait
GlobalDialogStatusIconSuccess

The icon used for the success list status, if no specific success status icon is set.

stringGlobal Status Icon - Success
GlobalDialogStatusIconFail

The icon used for the fail list status, if no specific fail status icon is set.

stringGlobal Status Icon - Fail
PendingWaitForIcon

The icon used for the "pending" status of all WaitFor items. Leave blank for nothing. Use "pending" for swiftDialog Default.

stringWait For Pending Icon
ReinstallDialog

Deprecated: This feature was removed in v.2.3, as it is no longer needed. This setting controls whether Baseline will reinstall SwiftDialog as the final step before completion. Default behavior if this key is omitted will reinstall SwiftDialog if a custom PNG is found in /Library/Application Support/Dialog/Dialog.png. Leave this as default if you use Baseline to deploy a custom SwiftDialog icon. Set to false if you do not want Baseline to ever reinstall SwiftDialog. Set to True if you always want to reinstall SwiftDialog after each Baseline.

booleanReinstall SwiftDialog
ExitCondition

Define a file or folder path. When Baseline starts, if this file or folder exists, Baseline will exit quietly without processing any items. Use this option if your management tool may re-send scripts when not desired.

stringExit Condition
BailOutFile

Define a file path. If this file exists at any point while Baseline is running, Baseline will exit and will not process additional items.

stringBail Out File
DefaultInstallomatorRetries

Default number of retries for Installomator items. Default 0

Default: 0

integerDefault Installomator Retries
DefaultScriptRetries

Default number of retries for Script items. Default 0

Default: 0

integerDefault Script Retries
DefaultPackageRetries

Default number of retries for Package items. Default 0

Default: 0

integerDefault Package Retries
dict
DisplayName

The name you want to appear in SwiftDialog and logs. Initial Scripts will only be shown to the user if the item Fails.

stringDisplay Name
ScriptPath

A path to the script you want to run. Can be a local file path or a URL.

stringScript Path
SHA256

The expected SHA256 of the script being run.

stringSHA256
MD5

The expected MD5 of the script being run.

stringMD5
Arguments

Arguments you want to pass to the script when it is run.

stringArguments
AsUser

Enable this option to run the script as the logged in user.

booleanRun as User
Retries

The number of times Baseline will retry this specific item if it fails. If omitted, will use the Global Retries Default.

Default: 0

integerRetries
CurlOptions

Custom Curl Options to used when downloading this script.

stringCurl Options
dict
DisplayName

The name you want to appear in the SwiftDialog menu as this Installomator label is processed.

stringDisplay Name
Label

The Installomator label.

stringLabel
Arguments

Arguments you want to pass to the Installomator command for this label.

stringArguments
Icon

The icon you want to appear in the SwiftDialog menu as this Installomator label is processed. Can be a URL or local file path.

stringIcon
Subtitle

The subtitle text to appear on this line item.

stringSubtitle
StatusIconWait

The icon used for the wait list status, for this specific line item.

stringWait Icon
StatusIconSuccess

The icon used for the success list status, for this specific line item.

stringSuccess Icon
StatusIconFail

The icon used for the fail list status, for this specific line item.

stringFail Icon
Retries

The number of times Baseline will retry this specific item if it fails. If omitted, will use the Global Retries Default.

Default: 0

integerRetries
HideListView

Hide the window while this item is running. Default is false

Default: false

booleanHide List While Running
dict
DisplayName

The name you want to appear in the SwiftDialog menu as this package is installed.

stringDisplay Name
PackagePath

A path to the package you want to install. Can be a local file path or a URL.

stringPackage Path
TeamID

The expected TeamID of the package being installed.

stringTeamID
SHA256

The expected SHA256 of the package being installed.

stringSHA256
MD5

The expected MD5 of the package being installed.

stringMD5
Arguments

Arguments you want to pass to the installer command for this package.

stringArguments
Icon

The icon you want to appear in the SwiftDialog menu as this package is installed. Can be a URL or local file path.

stringIcon
Subtitle

The subtitle text to appear on this line item.

stringSubtitle
StatusIconWait

The icon used for the wait list status, for this specific line item.

stringWait Icon
StatusIconSuccess

The icon used for the success list status, for this specific line item.

stringSuccess Icon
StatusIconFail

The icon used for the fail list status, for this specific line item.

stringFail Icon
Retries

The number of times Baseline will retry this specific item if it fails. If omitted, will use the Global Retries Default.

Default: 0

integerRetries
HideListView

Hide the window while this item is running. Default is false

Default: false

booleanHide List While Running
CurlOptions

Custom Curl Options to used when downloading this package.

stringCurl Options
dict
DisplayName

The name you want to appear in the SwiftDialog menu as this script is run.

stringDisplay Name
ScriptPath

A path to the script you want to run. Can be a local file path or a URL.

stringScript Path
SHA256

The expected SHA256 of the script being run.

stringSHA256
MD5

The expected MD5 of the script being run.

stringMD5
Arguments

Arguments you want to pass to the script when it is run.

stringArguments
AsUser

Enable this option to run the script as the logged in user.

booleanRun as User
Icon

The icon you want to appear in the SwiftDialog menu as this script is run. Can be a URL or local file path.

stringIcon
Subtitle

The subtitle text to appear on this line item.

stringSubtitle
HideListView

Hide the window while this item is running. Default is false

Default: false

booleanHide List While Running
StatusIconWait

The icon used for the wait list status, for this specific line item.

stringWait Icon
StatusIconSuccess

The icon used for the success list status, for this specific line item.

stringSuccess Icon
StatusIconFail

The icon used for the fail list status, for this specific line item.

stringFail Icon
Retries

The number of times Baseline will retry this specific item if it fails. If omitted, will use the Global Retries Default.

Default: 0

integerRetries
HideListView

Hide the window while this item is running. Default is false

Default: false

booleanHide List While Running
CurlOptions

Custom Curl Options to used when downloading this script.

stringCurl Options
dict
DisplayName

The name you want to appear in the SwiftDialog menu for this item we are waiting for.

stringDisplay Name
Path

A path to the file you want Baseline to wait for.

stringPath
Icon

The icon you want to appear in the SwiftDialog menu for this item. Can be a URL or local file path.

stringIcon
Subtitle

The subtitle text to appear on this line item.

stringSubtitle
dict
DisplayName

The name you want to appear SwiftDialog and logs. Final Scripts will only be shown to the user if the item Fails.

stringDisplay Name
ScriptPath

A path to the script you want to run. Can be a local file path or a URL.

stringScript Path
SHA256

The expected SHA256 of the script being run.

stringSHA256
MD5

The expected MD5 of the script being run.

stringMD5
Arguments

Arguments you want to pass to the script when it is run.

stringArguments
AsUser

Enable this option to run the script as the logged in user.

booleanRun as User
Retries

The number of times Baseline will retry this specific item if it fails. If omitted, will use the Global Retries Default.

Default: 0

integerRetries
CurlOptions

Custom Curl Options to used when downloading this script.

stringCurl Options