Creating an extended integration for Apple Business Manager assets

To integrate Oomnitza with Apple Business Manager, you must add a new mobile device management (MDM) server.

The requirements that must be met to complete this integration successfully are as follows:

• You have set up Apple Business Manager.
• You have not attached MDM servers to Apple Business Manager.

Restriction

The integration cannot be completed if you have attached MDM servers to your Apple Business Manager. 

About Apple Business Manager

Apple Business Manager offers a centralized platform for managing Apple devices such as iPhones, iPads, Macs, and Apple TVs, and services such as apps, books, and custom content. It is a web-based portal that Apple provides to businesses and educational institutions for managing and deploying Apple devices and services in their organizations. 

The Apple Business Manager asset integration fetches a list of devices that are assigned to the Mobile Device Management (MDM) server at the time of the request.

Apple Developer Documentation: Get a List of Devices

Apple Developer Documentation: Mobile Device Management Protocol Reference

Content

• Creating the integration
• Creating custom mappings

Before you start

Add your Apple Business Manager credentials to Oomnitza before you create the integration. 

 Adding Apple Business Manager credentials to Oomnitza

Creating the asset integration

1. In Oomnitza, click Configuration> Integrations> Overview.
2. Click Block view
3. Scroll down to the Extended section for asset integrations.
4. Click NEW INTEGRATION.
5. Select the integration in the sidebar.
6. Click ADD.

Integration details overview

More information is provided about the following fields to help you complete the integration:

Software data

Depending on the asset integration, an option might be available to ingest desktop software information such as the name and version of the software installed on an asset. To view the software information in Oomnitza, you must have the software module. 

Installation types

• Cloud. Store credentials in the Oomnitza cloud.
• Local. Store credentials locally. If you want to sync Oomnitza with vendor applications that require AWS or OAUTH authentication, select cloud as the type of installation. Local installations don't support AWS and OAuth authentication. 

Integration preferences

• Create & Update. Add and update records.
• Create only. Add records.
• Update only. Update records.

Integration details

To review or update the integrations details, click Edit .

When you edit the Integration details section, you can select the name or names of integration contacts.  Integration contacts will receive an in-app notification and an email, when the integration fails, when the integration fails to complete within 24 hours, or when the scheduled integration fails to run.

1. Update the integration name.
2. Select an installation type.
3. For integration preferences, select an option.
4. Enter the name of the integration user.  

Credential details

If you selected Cloud as the installation type, choose one of the following options:

• Select the credentials that were created for the integration.
• Edit the credentials that were created for the integration.
• Create new credentials

Scheduling the integration

By default, data is synced once every day. Change the interval or the time so that the data is streamed when your system isn't busy.

1. Click Edit .
2. Make and save your changes.

Mapping fields to Oomnitza

To map the fields to Oomnitza, click Edit .

  Select Edit integration to add rules for syncing data. Filtering integration results.  

Click SMART MAPPING.

You can add new fields to your integration by selecting Add new field   on the mapping page. 
Creating custom API fields. 

Creating custom mappings

Map Apple fields to Oomnitza fields to get the asset information that you need. For the field mapping, complete these steps:

1. Click Smart Mapping to automatically detect matching fields. Values from the integration can also be dragged to the associated Oomnitza field, or selected from the integration field dropdown.
2. You can create custom mappings to map any other field that you want to add to Oomnitza. To create an optional custom mapping, complete the following steps:
   1. Click the down arrow on the field that you want to map.
   2. Select Add new Oomnitza field.
   3. Change the name of the field.
   4. Select the Unique checkbox if you want to use this custom field as the sync key.
   5. Click CREATE.
3. Map and assign a sync key to a unique field, such as the Serial Number.
4. Click UPDATE.

Tracking information for asset loads 

When the integration is run, you can track the name of the credentials that were used and the source of the data. To do this, you map the Connect: Credentials field to Oomnitza. 

Custom mappings

Asset Tag
Color
Description
Device Assigned By
Device Assigned Date
Device Family
Model
OP Date
OP Type
OS
Profile Assign Time
Profile Push Time
Profile Status
Profile UUID
Serial Number

Launching the integration

Your integration is in Draft mode until the required mandatory fields are added. When added, click Launch to activate your integration. 

If you selected Cloud as the installation type when creating the integration, see Running an extended integration

If you selected Local as the installation type when creating the integration, see Running an extended integration locally.

Viewing data ingested by Oomnitza

Viewing ingested asset data

For asset integrations, click Hardware. If the asset integration also ingests software data, click Software.

Viewing ingested user data

For user integrations, click People. If you chose the option to ingest User and SaaS user data, click Software > SaaS, click the SaaS app, and then click the Users tab. 

Related Links

• Running an extended integration
• Troubleshooting integrations
• Mapping extended integrations

Using workflows to complete actions 

Use Oomnitza integration points to complete actions such as:

• Fetching, removing, and assigning a device profile
• Disowning a device
• Activating a device lock  

See Creating workflows for Apple Business Manager assets.