Distributing Associate App
Since a recent change by Apple about the Developer Enterprise Program usage guidelines, all NewStore apps are being distributed via Apple Business Manager. This topic explains how to distribute NewStore Associate App using Apple Business Manager.
This example uses simpleMDM as an MDM application to distribute NewStore Associate App. Actual steps to distribute NewStore Associate App for your business may vary based on the MDM application you use.
Prerequisites for selecting an MDM application
- Ensure that the MDM application you want to use to distribute NewStore Associate App supports AppConfig.
- NewStore recommends using simpleMDM or jamf Pro as MDM applications, as we provide full support for them. NewStore does not guarantee support for distributing NewStore Associate App via any other MDM applications.
Note the following about NewStore Associate App when it is distributed with Apple Business Manager:
- It is built with NewStore's Distribution Certificates.
- It is distributed using NewStore's App Store Connect Account.
- It is downloaded using your Apple Business Manager account, which allows you to distribute the app manually or using an MDM.
Apps published privately in App Store Connect cannot be seen in the public App Store, but can be downloaded via Apple Business Manager.
Custom Appsin Apple Business Manager.
- In Apple Business Manager, go to
- Ensure that
Custom Appsis set to
- In Apple Business Manager, go to
- (Optional) Connect your MDM to Apple Business Manager.
- To download your server token, in your Apple Business Manager
account, go to
Apps and Books>
My Server Tokens, and click
- Upload the server token to your MDM application.
- The name of your organization (
Organization Name) and your
Apple IDshould appear in the list.
- To download your server token, in your Apple Business Manager account, go to
Requesting access to Associate App
Ensure you have an Apple Business Manager account. See ABM.
In Apple Business Manager, in the lower left corner, click
Send your Apple Business Manager organization name and the
Organization IDto your contact point at NewStore.
You contact point will inform you when your organization is configured on the NewStore side.
In the same screen, in the
Custom Appssection, click
(Optional) If you use an MDM application, ensure your devices are enrolled in Apple Business Manager.
Go to the
Custom Appssection, you should see the app. It might take a few minutes to appear once NewStore has added your organization ID to its setup.
Your NewStore apps will appear in the
Custom Apps tab, and not in the
Apps and Books tab.
- In Apple Business Manager, click
Custom Appsand click the app name.
- In the app details, find
Licence typeand select one of the following options:
Managed: use this option if you have an MDM application.
Redemption Codes: use this option if you want to manually distribute the app.
- Select the number of apps you require and click
It might take some minutes for you to have access to the licenses. The
available licenses appear in
Custom Apps >
Manage Licenses. Once
ready, you can either use your MDM application to distribute the app, or
share the redemption codes.
For more information about licenses, see the Apple documentation.
Syncing with your MDM
Before you start distributing, sync your NewStore apps in the MDM application you are using. The available licenses should appear in the MDM now.
Appstab in your MDM application, the list of NewStore apps and associated licenses should appear.
If you cannot see the NewStore apps or available licenses in your MDM application, contact the support team.
Configuring Associate App before distribution
Currently, you can use
Managed Configuration Support to configure
NewStore Associate App in your MDM application before distribution:
In your MDM application, go to
Managed Configuration Support.
Configure the following keys (an example is shown in the screenshot below):
test: Specify the tenant string provided by NewStore, to be used for testing the app. The string includes a
-stagingin the name as a suffix.
live: Specify the tenant string provided by NewStore, to be used for using the app in a live environment. The string does not include
-stagingas a suffix.
storeId: Specify the store ID to which the device is going to be assigned for the tenant. For more information on enabling associates to automatically switch stores, see Using your credentials .
If both the
livekeys have been configured and set, Associate App opens in the
liveenvironment by default when launched or opened. Associates can then manually switch to the
testenvironment if needed.
This configuration is required only for new retailers with
tenants available only on the
production environment. To properly set
existing retailers in the platform with tenants on
production environments, set the following keys:
stage: Specify the stage for the apps (
pfor production or
tenant: Specify the name of the tenant.
storeId: Specifies the store ID to which the device is assigned for the tenant.
Using TestFlight to access beta builds
We use TestFlight as a tool to access beta builds before the official release of a new version of Associate App. It is provided and maintained by Apple, and offers easy-to-use access via an Apple Account.
To receive access to a beta build, you must request access to an external testing group. These are created and maintained by NewStore. NewStore will provide an invitation link to onboard you to the testing group.
Once onboarded, every build uploaded to TestFlight is accessible and the user is notified.
Request an external testing group from NewStore.
Open the public invitation link provided by NewStore to onboard onto the testing group.
NewStore Associate Appto open the menu for the app.
Installto download the latest version or tap
Previous buildsto choose a build to download.
The version and build number are provided by NewStore.
You must bootstrap the downloaded Associate App versions via TestFlight. Either scan a provided QR code or enter this URL in the Safari Browser of your device:
Add an additional
storeIdparameter to create an automatic assignment to a store for any user logging in.
Configuring Associate App with a PLIST configuration file
Most of the MDM applications require a
ManagedAppConfig.plist file to be uploaded. This PLIST file
contains the necessary keys to configure the application during the distribution to the devices.
Ensure that the
test values have been set in the PLIST file.
(Optional) Specify a value for the
storeId to which the device will be assigned to, so that
associates are automatically assigned to this store when they log into the app on this device.
See Using your credentials .
A sample PLIST configuration file is provided here:
<?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 are using
Meraki as your MDM application, you may have to copy the values manually to your
AppConfiguration file. For more information, see Using the Managed App Settings Payload.