Inventory Preload
Inventory Preload
The Inventory Preload setting allows you to upload computer and mobile device inventory data before devices are enrolled. The preloaded data will be applied to computers and mobile devices when inventory is collected based on a matching serial number. User data will be applied immediately when a comma-separated value (CSV) file is uploaded.
Important: The values in the CSV file must be separated by commas. Separating values in the CSV file using other characters such as semicolons will result in errors.
Data from the uploaded CSV file takes precedence over existing Jamf Pro data according to the following priorities:
-
The data will overwrite any existing active data records when duplicate serial numbers are found.
-
The data takes precedence over LDAP device data if LDAP is configured.
The preloaded data is used on an ongoing basis to update device inventory records in Jamf Pro when inventory is collected. For example, device inventory records are updated during the following events:
-
When uploading a CSV file with a unique device and set of device data. The next time inventory is collected and the specified device is updated in Jamf Pro, the inventory is updated with the Inventory Preload data.
-
When uploading a subsequent CSV for the same unique device with a different set of device data. The next time inventory is collected and the specified device is updated in Jamf Pro, the inventory is updated with the Inventory Preload data.
The inventory collection process runs following enrollment or according to the frequency in the Inventory Collection settings. For more information, see the following sections in this guide:
Important: When using Inventory Preload, any manual edits or mass action updates to computer and mobile device inventory details within Jamf Pro will be overwritten by the Inventory Preload data when inventory collection runs.
The following table lists the valid fields for Inventory Preload CSV uploads:
|
Field |
Computers |
Mobile Devices |
|
Serial Number (required) |
|
|
|
Device Type (required) Note: Only two values are valid: "Computer" or "Mobile Device" |
|
|
|
Username |
|
|
|
Full Name |
|
|
|
Email Address |
|
|
|
Phone Number |
|
|
|
Position |
|
|
|
Department |
|
|
|
Building |
|
|
|
Room |
|
|
|
PO Number |
|
|
|
PO Date |
|
|
|
Warranty Expiration |
|
|
|
AppleCare ID |
|
|
|
Purchase Price |
|
|
|
Life Expectancy |
|
|
|
Purchasing Account |
|
|
|
Purchasing Contact |
|
|
|
Lease Expiration |
|
|
|
Bar Code 1 |
|
|
|
Bar Code 2 |
|
|
|
Asset Tag |
|
|
|
Vendor |
|
|
|
Extension attributes (For more information, see the “Extension Attributes" section below.) |
|
|
The CSV template that can be downloaded from the Inventory Preload page contains all supported fields.
Example Workflow
The following example describes how data for a mobile device can be uploaded using Inventory Preload, how it updates Jamf Pro inventory records, and how inventory details can be updated by uploading subsequent CSV files.
-
A CSV file with the following contents is uploaded using Inventory Preload:
Serial Number
Device Type
Username
Building
Department
C8PLK8CLFM
Mobile Device
wcrandall
Hopkins Hall
Psychology
-
When mobile device serial number "C8PLK8CLFM" is enrolled, the following happens:
-
The mobile device is assigned to user "wcrandall".
-
The Building field for the mobile device is updated to be "Hopkins Hall".
-
The Department field for the mobile device is updated to be "Psychology".
-
-
The CSV file is revised to specify mobile device serial number "C8PLK8CLFM" is in building "Smith Hall".
-
The revised CSV file is uploaded to Jamf Pro using Inventory Preload.
-
The next time mobile device "C8PLK8CLFM" updates its inventory, the Building field will be updated to "Smith Hall".
Validation
Uploading a CSV file that contains building and department data requires the building and department to exist in Jamf Pro. If the building and department do not exist in Jamf Pro, the upload will fail.
Users
When a CSV file is uploaded, the CSV data is compared to the Jamf Pro inventory database to determine if new users need to be created or if the information for existing users will be updated.
The following fields are required in the CSV file for users to be created or updated in Jamf Pro:
|
|
New |
Update |
|
Username |
|
|
|
Email address |
|
|
If the CSV file contains a new username and an email address is provided, the new user is created in Jamf Pro.
If the CSV file contains an existing username, the following user-related fields are updated in Jamf Pro:
-
Full Name
-
Email Address
-
Phone Number
-
Position
When Data is Applied
Data from the uploaded CSV file is applied in Jamf Pro at different times depending on the data type.
User-related data, including the following fields, is applied immediately when the CSV file is uploaded:
-
Username
-
Full Name
-
Email Address
-
Phone Number
-
Position
Computer and mobile device data, including the device location, is applied on an ongoing basis each time inventory is collected.
Extension Attributes
Extension attributes are not provided in the CSV template since they vary by each configuration, but you can add them if needed. Extension attributes are dynamically mapped using the "EA " prefix in the column header (note the space after "EA"). For example, if the CSV data contains a column named "EA Memo1", the inventory preload update process will map the value in that column to an existing extension attribute in Jamf Pro named "Memo1".
Uploading a CSV File Using Inventory Preload
Requirements
To upload a CSV file, you need:
-
A Jamf Pro user account with all privileges for Inventory Preload Records
-
A Jamf Pro user account with Create and Update privileges for Users
For more information, see Jamf Pro User Accounts and Groups.
Procedure
-
Log in to Jamf Pro.
-
In the top-right corner of the page, click Settings
. -
Click Global Management.
-
Click Inventory Preload
. -
To download a CSV file template and prepare the data, click Template
. -
If your browser prompts you to allow downloads, click Allow.
-
Prepare the downloaded CSV file using an editor of your choice.
Important: If you edit the CSV file using Microsoft Excel on Windows, you must save the file using the file type, "CSV UTF-8 (Comma delimited)(*.csv)". If you saved the CSV file as an XLSX file, you can convert the file to "CSV UTF-8 (Comma delimited)(*.csv)" by using the Save As command and changing the file type. However, data may be lost depending on how your data was formatted.
-
After you have prepared your CSV file, click File Upload
in Jamf Pro. -
Drag or browse for your CSV file in the Upload Resource File dialog. Your file will be displayed in the dialog.
Important: New data will overwrite existing data for CSV rows that have matching Serial Numbers.
-
Click Confirm to upload the CSV file.
-
If the file is valid, the CSV data will appear in table format in the Jamf Pro window.
-
If the file is invalid, a list of errors will be displayed. Make note of the errors, click Decline. Fix the errors and try uploading it again.
-
Viewing and Exporting Active Data
View the active data in Jamf Pro or export it as a CSV file.
-
Log in to Jamf Pro.
-
In the top-right corner of the page, click Settings
. -
Click Global Management.
-
Click Inventory Preload
. The active data will be displayed. You can search, sort, and filter the data as needed.
-
To export the active data, select the checkboxes for each row of data you want to export, or click the top checkbox to select all rows.
-
Click Export selected items
in the top right corner of the pane. The exported file will be named "inventory-preload.csv".
Deleting Active Data
You can delete all active data that was previously uploaded to Inventory Preload. Deleting the active data effectively disables the Inventory Preload update process since no preloaded data will exist when inventory is collected.
All inventory details in Jamf Pro that were updated using Inventory Preload will remain intact.
-
Log in to Jamf Pro.
-
In the top-right corner of the page, click Settings
. -
Click Global Management.
-
Click Inventory Preload
. -
Click Delete Data, and then click Delete.
Warning: The delete action deletes all active data, regardless of which table data rows may be selected.
Viewing Inventory Preload Activity History
View the history of all uploaded resource files, including the filename, the name of the user who uploaded the file, and the date the file was uploaded.
-
Log in to Jamf Pro.
-
In the top-right corner of the page, click Settings
. -
Click Global Management.
-
Click Inventory Preload
. -
Click History
.
A list of all inventory preload activity is displayed. -
To add comments for records in the history list, click Add Note, enter a note, and then click Add Note again to save the note.
Related Information
For information about how to use Inventory Preload via the Jamf Pro API, see the Jamf developer resources:
https://www.jamf.com/developers/apis/