Skip to content

Dialog Timeouts

Kevin edited this page Oct 17, 2024 · 2 revisions

As a default, super dialogs (that appear in the middle of the screen and are expecting a response from the user) will wait forever for a user to respond. Conversely, super notifications (that normally appear in the top right) are temporary and dissmiss automatically.

Obviously, waiting indefinitely for a user that may never respond prevents the workflow from continuing. Thus, there are several options for controlling dialog timeouts so the super workflow can continue or try again later.

Default Dialog Timeout

Sets an automatic timeout for all interactive dialogs in seconds.

Command option example:
--dialog-timeout-default=600

Command option disable example:
--dialog-timeout-default=X

Configuration profile example:
<key>DialogTimeoutDefault</key>
<string>600</string>

Again, using this option overrides the default interactive dialog behavior of never timing out. Timeouts less than 60 seconds or more than 86400 seconds (1 day) are rounded accordingly. Also, if a days or date deadline is soon then any dialog timeout option times above 120 seconds (2 minutes) are reduced to 120 seconds. Additionally, note that the --test-mode option will temporary override this timeout.

Each dialog type has unique behavior when the timeout expires. Also, if possible (given other display options) the countdown of the timeout is displayed in dialogs. See the other timeout options documented later on this page for further details.

User Authentication Dialog Timeout

On Mac computers with Apple Silicon, the number of seconds to wait for the user to successfully authenticate when presented with the user authenticated dialog.

Command option example:
--dialog-timeout-user-auth=600

Command option disable example:
--dialog-timeout-user-auth=X

Configuration profile example:
<key>DialogTimeoutUserAuth</key>
<string>600</string>

Using this option overrides both the default user authentication dialog behavior of never timing out and the --dialog-timeout-default option. Timeouts less than 60 seconds or more than 86400 seconds (1 day) are rounded accordingly. Also, if a days or date deadline is soon then any dialog timeout option times above 120 seconds (2 minutes) are reduced to 120 seconds. Additionally, note that the --test-mode option will temporary override this timeout.

If the user doesn't authenticate the macOS update/upgrade within this timeout then the workflow exits and tries again later based on the error deferral timer.

If you are also using any --display-accessory-* option, a limitation of IBM Notifier prevents the timeout countdown from being displayed in the user authentication dialog. However, the timeout still expires in the specified time.

The dialog timeout in a user authentication dialog

The dialog timeout in a user authentication dialog

User Choice Dialog Timeout

Sets an automatic timeout for the user choice (restart/install or defer) dialog in seconds.

Command option example:
--dialog-timeout-user-choice=600

Command option disable example:
--dialog-timeout-user-choice=X

Configuration profile example:
<key>DialogTimeoutUserChoice</key>
<string>600</string>

Using this option overrides both the default user choice dialog behavior of never timing out and the --dialog-timeout-default option. Timeouts less than 60 seconds or more than 86400 seconds (1 day) are rounded accordingly. Also, if a days or date deadline is soon then any dialog timeout option times above 120 seconds (2 minutes) are reduced to 120 seconds. Additionally, note that the --test-mode option will temporary override this timeout.

If the user choice dialog timeout expires then then the dialog is automatically deferred. This also increments the counter of any --deadline-count-soft or --deadline-count-hard count deadlines.

If you are also using the --deferral-timer-menu and--display-accessory-* options, a limitation of IBM Notifier prevents the timeout countdown from being displayed in the restart or defer dialog. However, the timeout still expires in the specified time.

The dialog timeout in a user choice dialog

The dialog timeout in a user choice dialog

User Scheduled Install User Choice Dialog Timeout

Sets an automatic timeout for the scheduled install user choice dialog in seconds.

Command option example:
--dialog-timeout-user-schedule=600

Command option disable example:
--dialog-timeout-user-schedule=X

Configuration profile example:
<key>DialogTimeoutUserSchedule</key>
<string>600</string>

Using this option overrides both the default scheduled install user choice dialog behavior of never timing out and the --dialog-timeout-default option. Timeouts less than 60 seconds or more than 86400 seconds (1 day) are rounded accordingly. Also, if a days or date deadline is soon then any dialog timeout option times above 120 seconds (2 minutes) are reduced to 120 seconds. Additionally, note that the --test-mode option will temporary override this timeout.

If the user scheduled install dialog timeout expires then the dialog is automatically deferred. This also increments the counter of any --deadline-count-soft or --deadline-count-hard count deadlines.

The countdown of the timeout is always displayed in the scheduled install user choice dialog.

The dialog timeout in a scheduled install user choice dialog

The dialog timeout in a scheduled install user choice dialog

Soft Deadline Dialog Timeout

Sets an automatic timeout for the soft deadline restart dialog in seconds.

Command option example:
--dialog-timeout-soft-deadline=600

Command option disable example:
--dialog-timeout-soft-deadline=X

Configuration profile example:
<key>DialogTimeoutSoftDeadline</key>
<string>600</string>

Using this option overrides both the default interactive dialog behavior of never timing out and the --dialog-timeout-default option. Timeouts less than 60 seconds or more than 86400 seconds (1 day) are rounded accordingly. Also, if a days or date deadline is soon then any dialog timeout option times above 120 seconds (2 minutes) are reduced to 120 seconds. Additionally, note that the --test-mode option will temporary override this timeout.

If the soft dialog timeout expires then the "Restart" button is automatically selected. In other words, if you set either the --dialog-timeout-soft-deadline or the --dialog-timeout-default options along with any of the soft deadline options then you are effectively setting the behavior to act as a hard deadline after the soft dialog timeout expires.

The countdown of the timeout is always displayed in the soft deadline restart dialog.

The dialog timeout in a soft deadline dialog

The dialog timeout in a soft deadline dialog

Insufficient Storage Dialog Timeout

Sets an automatic timeout for the insufficient storage dialog in seconds.

Command option example:
--dialog-timeout-insufficient-storage=1800

Command option disable example:
--dialog-timeout-insufficient-storage=X

Configuration profile example:
<key>DialogTimeoutInsufficientStorage</key>
<string>1800</string>

Using this option overrides both the default interactive dialog behavior of never timing out and the --dialog-timeout-default option. Timeouts less than 60 seconds or more than 86400 seconds (1 day) are rounded accordingly. Also, if a days or date deadline is soon then any dialog timeout option times above 120 seconds (2 minutes) are reduced to 120 seconds. Additionally, note that the --test-mode option will temporary override this timeout.

If the user is unable to make enough free storage space available before the timeout then the workflow exits and tries again later based on the error deferral timer.

The countdown of the timeout is always displayed in the insufficient storage dialog.

The dialog timeout in an insufficient storage dialog

The dialog timeout in an insufficient storage dialog

Power Required Dialog Timeout

Sets an automatic timeout for the power required dialog in seconds.

Command option example:
--dialog-timeout-power-required=1800

Command option disable example:
--dialog-timeout-power-required=X

Configuration profile example:
<key>DialogTimeoutPowerRequired</key> <string>1800</string>

Using this option overrides both the default interactive dialog behavior of never timing out and the --dialog-timeout-default option. Timeouts less than 60 seconds or more than 86400 seconds (1 day) are rounded accordingly. Also, if a days or date deadline is soon then any dialog timeout option times above 120 seconds (2 minutes) are reduced to 120 seconds. Additionally, note that the --test-mode option will temporary override this timeout.

If the user is unable to attach the Mac to a power adapter before the timeout then the workflow exits and tries again later based on the error deferral timer.

The countdown of the timeout is always displayed in the power required dialog.

The dialog timeout in a power required dialog

The dialog timeout in a power required dialog

Delete All Dialog Timeouts

Delete all locally set dialog timeouts, thus returning to the default behavior of not timing out for any interactive dialog.

Command option example:
--dialog-timeout-delete-all

This option can not be set via a MDM configuration profile. However, any other dialog timeout options that are specified via a super MDM configuration profile remain in effect.

Clone this wiki locally