Skip to content
Simone Martorelli edited this page Oct 2, 2024 · 3 revisions

Welcome to the IBM Data Shift wiki!

In this wiki, you'll find useful information about the app, how to use it, and how to customize it for your organization or team.

Follow this step-by-step process to get up to speed with deploying your customized instance of IBM Data Shift.

1 - Rebrand the App

The rebranding process is straightforward. You’ll need to customize a few elements such as the app icon, app name, and a few other minor details. Follow the detailed process outlined here.

2 - Customise the behaviour of the App

Once you are familiar with the "standard" behavior of the app, as described here, you can explore how to further customize it to better suit your needs.

While the main workflow of the app (the migration process) isn’t highly customizable, the post-migration steps and startup checks certainly are.

Startup Checks

By default, at startup, the app checks whether the device it's running on is managed in a recognized environment. Follow this guide to configure this check.

Post Migration Steps

After the migration, the app performs some post-migration steps on the new device.

These steps include:

  • Apple ID login check
  • Jamf Inventory Update

To enable or disable these steps, follow this guide, which explains how to deploy custom settings for the app.

Local Path included or excluded from Migration

IBM Data Shift offers various migration options:

  • Lite: Only the Desktop and Documents folders are migrated.
  • Complete: All applications, user preferences, and the entire User folder are migrated (with the exception of the Library folder, where only Application Support and Preferences folders are included).
  • Advanced Selection: Users can manually select what to migrate from the files and applications included in the "Complete" option.

In the AppContext.swift file, there are three arrays:

  • urlExclusionList -> Defines the local paths excluded from the migration scan.
  • explicitAllowList -> Defines the local paths explicitly included in the migration scan. If a subpath of an excluded path (defined in the urlExclusionList) is included in the explicitAllowList, it will still be migrated.
  • excludedFiles -> Defines the file extensions excluded from the migration scan.

Administrators can customize these arrays, but be aware that including large directories may significantly slow down the pre-migration scan and increase the app’s memory usage.

We recommend customizing these arrays if there are specific apps you want to exclude from migration or paths with configurations you want users to migrate.

3 - Archive, Sign and Notarise the App

Once everything is ready, all that’s left is to sign the app, submit it to Apple’s services for notarization, and export the result. To do this, follow this guide, which will walk you through the process step by step.

4 - Distribute the App

When distributing the app, don't forget that IBM Data Shift requires full disk access on the device. We recommend deploying a PPPC profile to devices with the app installed to prevent multiple prompts for access to folders and files. Follow the detailed process outlined here

You can also deploy a single profile that includes both the custom settings and the PPPC payload together.