Navigation

Key name: Navigation
Element type: Dictionnary
Status: Optional

Lets you customize some properties relative to the navigation view. This view is at the bottom of the window and displays the navigation buttons. The last slide will display a Quit button instead of the Next button. This Quit button will terminate the app. It will quit the app only if all the mandatory monitors specified in the monitors are installed and if the current slide is valid.

note

Since Octory 3.1.0 the navigation view no longer draws its own background: the buttons sit directly on the window background, or on the slide BackgroundImage when one is set, 15 pt away from the window edge. The Previous, Next and Quit buttons are drawn as capsule shaped buttons. A NextButtonTextColor or PreviousButtonTextColor you configured still applies to the button title.

Keys

Name	Type	Required
IsHidden	Boolean
PreviousButtonText	String
NextButtonText	String
PreviousButtonTextColor	String
NextButtonTextColor	String
QuitButtonText	String
InstallationIncompleteQuitText	String
UserCanQuitIfInstallationIsIncomplete	Boolean
MandatoryFilesMissingQuitText	String
PendingActionsLoadingQuitText	String
ShowsInstallationProgress	Boolean

Detail

IsHidden

Type: Boolean
Explanation: If set to true, the navigation view will be hidden (useful when displaying one slide in full screen for example). Default is false.

PreviousButtonText

Type: String
Explanation: Text displayed for the "Previous" button (left).

NextButtonText

Type: String
Explanation: Text displayed for the "Next" button (right).

PreviousButtonTextColor

Type: String
Explanation: The text color of the "Previous" button (left).

NextButtonTextColor

Type: String
Explanation: The text color of the "Next" button (right).

QuitButtonText

Type: String
Explanation: Let you customize the text of the "Quit" button which appears on the last slide.

InstallationIncompleteQuitText

Type: String
Explanation: Displayed text in an alert when the user clicks the "Quit" button while all mandatory applications/packages are not installed.

UserCanQuitIfInstallationIsIncomplete

Type: Boolean
Explanation: If set to true, this key allows the user to quit the app with the "Quit" Button or the Quit shortcut even if all mandatory applications/packages are not installed. Default is false.

info

If the user closes the Octory window (using the title bar close button), the behavior you specified is ignored and the app is terminated with no conditions. To avoid that, checkout IsClosable key in Window.

MandatoryFilesMissingQuitText

Type: String
Explanation: Displayed text in an alert when the user clicks the "Quit" button while all mandatory files are not present on the device.

PendingActionsLoadingQuitText

Type: String
Explanation: Displayed text in a popup when the user clicks the "Quit" button while actions at Termination as running.

ShowsInstallationProgress

Type: Boolean
Default: false
Availability: 3.1.0+
Explanation: If set to true, a compact progress bar is displayed in the navigation view, between the Previous and the Next buttons, with a status line below it describing what is currently happening (for example Working on Jamf, Slack, then 2 of 3 steps complete, then All steps complete).

info

The progress bar tracks exactly the same monitors as the INSTALLATION_COMPLETE placeholder: mandatory monitors, ignoring those whose condition evaluates to false. It lets you show the installation progress without placing a MonitorsDisplay component on a slide, so the end user keeps seeing the progress while navigating between slides.

Example

The following hide the navigation view while enabling user to quit even if not all mandatory monitors are installed.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <!-- ... -->
    <key>Navigation</key>
    <dict>
        <key>IsHidden</key>
        <true/>
        <key>UserCanQuitIfInstallationIsIncomplete</key>
        <true/>
    </dict>
    <!-- ... -->
</dict>
</plist>