Self-Managed Monitors

With the Managed monitor, you can update Octory's monitors yourself using the octo-notifier command line tool. This could be used to update monitors in combination with any scripts you are using. It could be when deploying applications, updating dock setting or pretty much anything else...

Keys

Name	Type	Possible values	Required
Type	String	Managed	Required
Name	String	-	Required
Detail	String	-
DisplayName	String	-
GenerateVariable	Boolean	-
IconURL	String	-
IsMandatory	Boolean	-
IsHidden	Boolean	-
Condition PRO	String	-

Detail

Type Required

Type: String
Possible values: Managed
Explanation: Monitor type has to be Managed.

Name Required

Type: String
Explanation: The name of the application or package as it will appear in the MDM log or in the /Applications folder for App Store downloads. You have to ensure that the value of this key is contained in the name of the installed package or application.

Detail

Type: String
Explanation: Description text displayed under the name or display name in the MonitorsDisplay component.

DisplayName

Type: String
Explanation: The name which will be displayed to the user in the MonitorsDisplay component. Otherwise, it’s the Name key which is displayed, or the Identifier key if specified.

GenerateVariable

Type: Boolean
Explanation: If set to true, Octory will generate a variable for this monitor, associated to its current installation state. This variable can then be used as any other in a action or to be watched in the logs. The format is [NAME]_INSTALLATION_STATE and thus can take 4 values “Installing”, “Installed”, “Not installed”, “Installation failed”.
For example with “Dock_Settings” for the Name key, this could give: DOCK_SETTINGS_INSTALLATION_STATE: Installing

IconURL

Type: String
Explanation: Let you specify a local or online URL for the icon to be shown in the MonitorsDisplay component. Octory will use a generic icon image if not specified.

IsMandatory

Type: Boolean Default: true Explanation: When set to false, the app monitor will be displayed in the MonitorsDisplay component but will not prevent the overall installation to be marked as complete and thus the app to be terminated when not all app monitors are installed.

IsHidden

Type: Boolean
Default: false
Explanation: If true, the monitor will not be displayed in the MonitorsDisplay compoenent. A hidden monitor can still be mandatory, this is more a UI option.

Condition PRO

Type: String
Explanation: Conditions to decide if the monitor should be shown in MonitorsDisplay component. When the condition evolves, an animation occurs in the MonitorsDisplay component to insert or remove the monitor. More information on conditions.

Example

Monitor for the dock settings, installed via script.

<?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>Monitoring</key>
	<dict>
		<key>Monitors</key>
		<array>
			<dict>
				<key>Type</key>
				<string>Managed</string>
				<key>Name</key>
				<string>DockSettings</string>
				<key>DisplayName</key>
				<string>Dock Settings</string>
				<key>Detail</key>
				<string>Standardized Dock layout deployment</string>
			</dict>
		</array>
	</dict>
	<!-- ... -->
</dict>
</plist>