Contact UsContact Us

Deploying and licensing Orbit Note for iOS (MDM)

Deploying and Licensing OrbitNote for iOS via MDM

This guide provides instructions for IT administrators to deploy the OrbitNote for iOS app and activate premium features across multiple devices using a Mobile Device Management (MDM) solution.

Prerequisites

Before you begin, please ensure you have the following:

  • An MDM solution (e.g., Jamf School, Jamf Pro, Microsoft Intune, Kandji, Mosyle).

  • Apple School Manager or Apple Business Manager.

  • OrbitNote for iOS app licenses acquired through the Apps and Books program (formerly VPP).

  • Target devices that are supervised (recommended for best results).

Method 1: Using Managed App Configuration (Recommended)

This is the most efficient method for licensing the app in bulk. It allows you to remotely push the license information directly to the app on each device.

Step 1: Deploy the App as a Managed App

For Managed App Configuration to work, OrbitNote for iOS must be deployed as a managed app from your MDM solution. Do not have users install it manually from the App Store.

  1. Log in to your MDM dashboard.

  2. Ensure you have licenses for OrbitNote for iOS available in your Apps and Books library.

  3. Assign the app to your target device groups and push the installation.

Step 2: Create and Apply the Configuration

Your MDM will have a section for the app titled "Managed Configuration," "App Configuration," or similar. In this section, you will provide a key-value pair to license the app.


Configuration Key

Value

Supported App Version

OrbitNoteTakeHomeCode

Your Take Home Code (e.g., ABCDE12345)

5.0.26 or newer

OrbitNoteEmail

Your licensing email address

5.0.26 or newer

Note: Keys are case-sensitive and must be entered exactly as shown. If your primary software is ClaroRead, then you can use your Claro Cloud username for the value of OrbitNoteEmail.

Most MDM platforms provide a simple interface where you enter the Key (e.g., OrbitNoteTakeHomeCode) and the Value (your actual code) into separate fields.

If your MDM requires you to use .plist or .xml format, use the template below. Paste this into the configuration field and replace the key and value with your information.  Use OrbitNoteTakeHomeCode or OrbitNoteEmail as required.

<?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>OrbitNoteTakeHomeCode</key>

    <string>YOUR_CODE_HERE</string>

</dict>

</plist>


If you get format errors, your MDM probably expects a different format, so try removing the following:

<?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">


If you still get format errors; try removing the following as well:


<plist version="1.0"> and </plist>


Step 3: Scope and Save

Assign or "scope" this configuration to the same devices that received the app. Once saved, your MDM will send the configuration to the devices, and the app's premium features will be unlocked automatically.


Method 2: For Small Deployments (Not Recommended for Volume)

In-App Purchase

This method is intended for individual users, not institutional deployment. In-App Purchases are tied to a single Apple ID and do not support volume purchasing. Each device would need to complete the purchase process manually. We do not recommend this for licensing more than a few devices.

Exam mode

Exam mode is a special setting that can be applied to OrbitNote that restricts all features that are normally prohibited in exam usage (see exam mode).

Exam mode can be configured using MDMs.  Similar to the above instructions, you can use these keys and values when configuring your MDM:



Configuration Key

Value

Supported App Version

OrbitNoteExamModeEnabled

“YES” or “NO”

0 or 1


Sending “YES” or 1 enables exam mode.


Sending “NO” or 0 disables exam mode.

5.0.26 or newer

OrbitNoteExamModePassword

Your password used to enable or disable exam mode.


Example “password1234”

5.0.26 or newer

Still need help? Contact us here