Guide Overview
This guide is designed to give Incident IQ administrators an overview of the following Jamf School integration app related topics:
Guide Index
You can use the following links below to quickly navigate to a specific section in this document. To quickly return to this index simply use the “Return to Index” link located at the end of any section.
Introduction
The Jamf School integration app is designed to give school districts the ability to create, manage, and automatically assign assets to students in Incident IQ by utilizing Jamf asset data. In addition, this integration with Incident IQ also allows agents and admins the ability to view an asset’s metadata in one convenient location. This includes basic device information, OS and firmware versions, as well as other data agents may find useful during the course of working a ticket.
When installed, you can access the Jamf School Integration app by selecting Incident IQ Apps > Apps Management. This will take you to your Installed Apps page where you can select the Options button to access the Jamf School Integration app management page.
App Installation
To install the Jamf School integration app, begin by clicking on Incident IQ Apps > Browse on the left navigation bar.
Underneath the Asset Management section, click on the Jamf School app. From here, simply select Install and follow the steps to complete the installation.
Once installed in Incident IQ you will need to click on Manage App Settings.
From here, you will need to allow access to your Jamf asset data by entering the following Jamf School information in the General Settings Tab:
- Network ID – This can be found by selecting Devices > Enroll Device(s) within Jamf School.
- API Key – This key can be found or a new one generated by clicking on Organization > Settings > API within Jamf School.
- Instance Url – The URL used to access your Jamf School instance.
Setting up Automated Asset Creation
First, you will need to ensure that the Create Asset option is turned on. This is located in the in the General Settings tab of the app.
Next you will need to ensure that locations have been setup in the Locations Tab. Please keep in mind that assets need to have a location when brought into the system. The way this works during a sync is as follows:
- If an asset matches a custom mapping, then the asset will get created and assigned to the corresponding location the mapping is set to.
- If an asset does not match a custom mapping, or no custom mappings are present, and a default location is selected, then the asset will get created and assigned to the default location.
- If an asset does not match a custom mapping, or no custom mappings are present, and there is no default location set, then the asset will not be created during a sync.
For additional details, please refer to the Locations Tab section of this document.
And finally, you will need to ensure that the particular model of the asset in mapped in the Model Mapping Tab.
Please note, when you first install your app these fields will be blank. This is because Incident IQ has not yet run a sync to scan which models are stored in Jamf School. To pull model information in, simply click on Run Sync in the General Settings Tab. Once completed, you should see a full list of all available models in your Jamf School instance.
Application Overview
The following section is designed to give you a detailed overview of each tab of the application and their intended purpose. For this integration in particular, this includes:
Overview Tab
The Overview Tab provides gives you the ability to quickly review the status of the most recent sync between Incident IQ and Jamf School.
While syncs will automatically run overnight, you can start a manual sync at any time during the day by clicking on the Start Sync button.
Additionally, you can use the View Details button to take you directly to the Sync History tab where you can review the count of assets updated, added, or skipped over during the most recent sync.
General Settings Tab
The General Settings tab houses many of the settings that control when information is brought in or updated automatically, as well as field mappings between the Jamf School and Incident IQ. As such, you can find the following settings here:
- Authentication fields to enter the Jamf School Network ID, API Key, and Instance Url.
- Options that control if assets are automatically created, updated, and deleted during system syncs.
- The ability to turn on automatic room assignment for assets if you are storing this data in Jamf.
- Custom field asset mapping options to pull in additional data for use in asset filters and custom view columns
- An option to enable the use of remote asset features available in Jamf directly on an asset detail’s page by administrators and agents with the correct permissions
At the top you will find fields where you can enter in the following Jamf School authentication information:
- Network ID
- API Key
- Instance Url
The Mapping section manages what data is created and updated in Incident IQ based on data coming from Jamf. This includes:
- Only Update Custom Fields: Selecting this option will only allow new information being pulled into custom fields to update during a sync.
- Create Asset: Selecting this will automatically create assets in IIQ to match any new device discovered in Jamf during a sync.
- Update Asset: Selecting this will automatically update assets in IIQ to match any updates to a device’s data discovered in Jamf during a sync.
- Delete Asset: Selecting this will automatically delete assets in IIQ to match any assets deletions that have occurred in Jamf during a sync.
Turning on the Create Rooms option will allow syncs to automatically create rooms associated with assets in Jamf for your locations if these rooms do not already exists in Incident IQ. Additionally, the Update Asset Owner option will try to automatically update owner information in Incident IQ during every system sync.
The Map custom values from jamfSchool section allows you point specific field from Jamf to specific asset fields in Incident IQ, as well as gives you the ability to pull in custom data fields for use in filters and custom view column options. To set one of these fields up, you will need to begin by clicking on the Add button.
Next, you will need to fill out the following field mapping options:
- Select the data field in Jamf School
- Set whether the data only pulls from Jamf to Incident IQ, sends from Incident IQ to Jamf, or flows in both directions (if both, data will push from Incident IQ to Jamf first.)
- Specify if the data should map to an existing default field, or if it should be pulled in from.
- If you pulling this information into a custom field, you will also need to set a field name, select a field type (text, number, or date), and set whether the field information needs to be searchable through filters.
Location Mappings Tab
The Locations tab houses the fields needed to set where assets automatically get assigned to
First, you will always want to ensure that a default location has been set in Incident IQ near the top of the tab. When set, the default location will be utilized as an assets location if it does not match any of your custom location mappings. This is especially important if you are using the Jamf School integration to automatically create assets because assets must have a location set to be created.
The Custom Mapping Options allows you to choose how you would like devices to map in IIQ.
When either is selected, you will be presented with a list of locations currently in the system. From here, you can select Auto-Map Location Names to match location names between IIQ and Jamf. Alternatively, you can also manually search for and select your location assignments if needed.
Model Mappings Tab
The Model Mappings tab allows you to select or modify your model mappings between Jamf School and Incident IQ. This essentially tells the system what model the asset should have in Incident IQ based on incoming model data during syncs.
You can use the Auto-Map Models button to automatically attempt to match models in your list of devices with models that already exist in IIQ.
Alternatively, you can also manually select what model your device should map to using the drop-down menus to the right of each listed device.
If your device will not auto-map and is not available from the drop-down options, then it most likely does not currently exist in IIQ. In this case, simply select the Create New Model button on the right of the device mapping in question to automatically create and activate this model during your data sync.
Sync History Tab
This tab allows you to view your sync history between Incident IQ and Jamf School.
Every sync, whether it completed successfully or not, is logged for reference purposes and available for review in the View details of a sync list.
Clicking on any sync, in particular, will open that sync’s details. From here, you can review the full list of what devices were updated, created, deleted, or skipped during the sync. Additionally, you can narrow down your view by using the filter options at the top of the list.
Asset History Tab
The Asset History tab allows you to search for any device’s basic information currently located in Jamf School.
Simply enter in a valid serial number in the Search for asset field to begin your search.
Once you’ve selected a device, you’ll be able to see the following information:
- Asset Tag
- External ID
- Model
- Owner Email
- Serial Number
- Room
Additionally, you’ll also see a list of actions applied to this device during recent system syncs.
Remote Device Actions
Under the General Settings tab at the bottom of the page, you can enable remote device actions that administrators and agents with the correct permissions can access directly on an asset’s details page in Incident IQ. These options include:
jamfSchool: Move a Device: Update the location of a Jamf School managed device.
jamfSchool: Refresh Inventory: Allow a user to schedule a full inventory refresh of the given device.
jamfSchool: Remote Restart Device: Allow a user to remotely restart a Jamf School managed device.
jamfSchool: Remote Unenroll Device: Allow a user to schedule the removal of the management profile from a Jamf School managed device.
jamfSchool: Remote Wipe Device: Allow a user to remotely wipe a Jamf School managed device.
jamfSchool: Restore Device: Allow a user to remotely restore a Jamf School managed device.
jamfSchool: Trash a Device: Allow a user to remotely trash a Jamf School managed iOS device.
jamfSchool: Update the eSIM Cellular Plan: Query a carrier URL for active eSIM cellular-plan profiles.
Please note, administrators are given full access to all remote features permissions by default. However, each of the remote features listed above are controlled by an individual permission. This makes it possible to customize which permissions an agent has access to, without needing to give them full access to all of the remote features. These permissions can be found underneath the App Specific section on policies and individual user permissions pages.
On the asset details page you will have access to preform these actions.
Frequently Asked Questions
The following section consists of common questions that users have when installing and setting up the Jamf School integration. Please note, if you do not find to an issue you are experiencing in this section please contact the Incident IQ Customer Support team for further assistance.
What location should I use for my default location?
If you are unsure of what location you should utilize, we recommend setting the district/central office as your default location. Alternatively, you may also setup an entirely separate location (such as “Unassigned”) to utilize for this purpose as well.
Can I pull room information from Jamf School into Incident IQ?
If you are storing room information in Jamf School, you can tie this information to assets stored in Incident IQ. This includes the ability to create rooms for any given location if they do not already exist in the system. To do so, you will want to go to the General Settings tab and enable the room number option.
Can I map certain fields in Jamf School to default or custom asset fields in Incident IQ?
You can pull in data from Jamf School for use in asset filtering and custom view columns in the General Setting tab of the integration app. To set one of these fields up, you will need to begin by clicking on the Add button at the bottom of the Map custom values from jamfSchool section.
From here, you will now need to set the following:
- Select the specific data field in Jamf School you want to pull in as a custom field
- Set whether the data only pulls from Jamf to Incident IQ, sends from Incident IQ to Jamf, or flows in both directions (if both, data will push from Incident IQ to Jamf first.)
- Specify if the data should map to a custom field
- And finally, set a field name, select a field type (text, number, or date), and set whether the field information needs to be searchable through filters.
Why are assets not getting created during syncs?
For a sync to create assets automatically, the following options need to be turned on or mapped in app management as detailed in this section of this article:
- The Create asset option must be turned on in the General Settings tab.
- Location mappings, or a default location, must be set in the Location Mappings tab.
- The model of the device must be mapped in the Model Mappings tab.
Please note, if your asset does not have a model associated with it in Jamf School, then the asset cannot be added automatically. However, you can manually create or import the asset into the system to circumvent this issue. During the next system sync, if Incident IQ detects a matching serial number inside of Jamf School, the system will then automatically associate the Jamf data with this asset.
Why are asset tags not updating during syncs?
By default, Incident IQ does not have the option to update asset tags automatically enabled for asset integrations. To turn on asset tag updates during syncs, select Incident IQ Apps > Manage from the left navigation bar, and the click on the Data Mapping tab. From here, check the Asset Tag option underneath the Asset Field Mappings section and then save.
Please note, even though this option is not enable by default, the asset tag field is required for asset creation. Because of this, when an asset is created during a sync without this option enable the following will occur:
- If asset tag information is available, then the asset will be created with the asset tag stored in the Jamf School.
- If asset tag information is not available, then the asset will be created with the serial number filled in for the asset tag.