Edit

Install the Warehouse Management mobile app

This article explains how to download and install the Warehouse Management mobile app on each of your mobile devices, and how to configure the app to connect to your Microsoft Dynamics 365 Supply Chain Management environment. You can configure each device manually, or you can import connection settings through a file or by scanning a QR code.

The Warehouse Management mobile app is only for your internal business use. You may not republish or distribute the Warehouse Management mobile app externally in any app store or similar distribution service.

Operating system requirements

The Warehouse Management mobile app is available for Microsoft Windows, Google Android, and Apple iOS operating systems. To use the app, your mobile devices must have one of the following operating systems installed:

  • Windows 10 May 2020 update 1904.1 or later
  • Android 7.0 or later
  • iOS 13.0 or later

Get the Warehouse Management mobile app

For smaller deployments, you'll typically install the app on each device from the relevant store. Then, manually configure the connection to the environments that you're using.

For larger deployments, automate app deployment and configuration. This approach is more convenient if you manage many devices. For example, use a mobile device management and mobile application management solution such as Microsoft Intune. For information about how to mass deploy installations and updates for the Warehouse Management mobile app, see Mass deploy the mobile app with user-based authentication.

Install the app from an app store

The easiest way to install the app on a single device is to install it from an app store. The store always provides the latest generally available version. Microsoft Intune can also fetch apps from the app stores. Use one of the following links to install the app from an app store:

Download the app from Microsoft App Center

Instead of installing the app from an app store, you can download it from the Microsoft App Center. The App Center provides installable packages that you can sideload. In addition to the current version, the App Center also lets you download previous versions and might provide preview versions with upcoming features that you can try out. To download current, previous, or preview versions of the Warehouse Management mobile app from Microsoft App Center, use one of the following links:

For information about how to install a build downloaded from the App Center, see Install a build.

The Warehouse Management mobile app isn't available in app stores in China. However, you can download it from Microsoft App Center and use it along with Dynamics 365 Supply Chain Management operated by 21Vianet in China.

Decide which authentication methods you'll use

Because the Warehouse Management mobile app has read and write access to some of your Supply Chain Management data, each device must authenticate with Supply Chain Management. The app supports several authentication methods. Before you start to deploy the app, learn about the available authentication methods and decide which one you want to use.

After a device authenticates with Supply Chain Management, each worker who uses that device signs in by using their Supply Chain Management worker account. The app loads the worker's personal preferences, such as their default warehouse and app preferences. Therefore, different workers can sign in and out for each shift, while the device itself remains authenticated with Supply Chain Management.

For details about each authentication method and how to set it up, see User-based authentication for the Warehouse Management mobile app.

Important

Use username/password authentication for all new and existing deployments. You can optionally combine it with brokered authentication to support SSO. Device code flow remains available for backward compatibility, but Microsoft no longer recommends it because it's a frequent target of phishing attacks. It's blocked by default in new Microsoft Entra ID tenants, it isn't supported on iOS, and it doesn't support single sign-on (SSO).

If a device is lost or compromised, you can revoke its authentication by following the instructions provided in Remove access for a device that uses user-based authentication.

Note

Shared Device Mode authentication isn't currently supported for the Warehouse Management mobile app.

Configure the application by importing connection settings

To make it easier to maintain and deploy the application on many mobile devices, import the connection settings instead of manually entering them on each device. The following table summarizes the available methods and when to use each one.

Method Best for Platform support
MDM managed configuration (ConnectionsJson key) Enterprise deployments with a mobile mass deployment (MDM) provider. The provider pushes connection settings through app configuration policies without touching the device file system. Android, Windows, iOS
QR code Small to medium deployments, or individual device setup. The app scans a QR code containing the connection JSON. Android, Windows, iOS
JSON file import (connections.json) Deployments where you can place files on the device file system. Windows, Android (limited—see the note after this table)
Manual input Individual device setup or troubleshooting. Android, Windows, iOS

Important

Android platform limitation: Starting with Android 11 (API level 30), Google enforces scoped storage restrictions that prevent external tools (including MDM file push, file managers, and USB file transfer) from writing to an app's private data folder. This restriction means the connections.json file can't be placed at the default path (Android/data/com.Microsoft.WarehouseManagement/files) by any tool other than the app itself. You can still use the app's Add from file option to browse and select a JSON file stored in an accessible location (such as the downloads folder), but automatic file-based import at the default path isn't possible on Android.

For enterprise Android deployments, use either the MDM managed configuration method (which uses providers such as Microsoft Intune or SOT to deliver connection settings through app configuration policies) or the QR code method. Learn more in Mass deploy the mobile app with user-based authentication.

The following subsections explain how to create and import the settings.

Create a connection settings file or QR code

You can import connection settings from either a file or a QR code. (Learn more in Read connection settings from a QR code.) For both approaches, you must first create a settings file that uses JavaScript Object Notation (JSON) format and syntax. The file must include a connection list that contains the individual connections that you need to add.

The following table summarizes the parameters that you can specify for each connection. Required parameters are listed first, followed by optional parameters.

Parameter Description
"ConnectionName" Specify the name of the connection setting. The maximum length is 20 characters. Because this value is the unique identifier for a connection setting, ensure that it's unique in the list. If a connection that has the same name already exists on the device, the settings from the imported file override it.
"ActiveDirectoryResource" Specify the root URL of Supply Chain Management.
"Company" Specify the legal entity in Supply Chain Management that you want the application to connect to.
"AuthCloud"

Specify the type of Microsoft Entra ID app registration to authenticate with:

  • "AzureGlobal" (recommended) – Authenticate by using the global Microsoft Entra ID application that Microsoft registers and maintains. This option supports most scenarios, including Microsoft Entra Conditional Access. You don't have to register or maintain your own Microsoft Entra ID app, and you must not specify an "ActiveDirectoryClientAppId" value for the connection.
  • "Manual" – Authenticate through your own custom Microsoft Entra ID app registration. Use this option only when the global application doesn't apply to your deployment. If you choose this option, you must register and maintain a custom app in Microsoft Entra ID and specify an "ActiveDirectoryClientAppId" value for the connection.
"ActiveDirectoryClientAppId" (Optional) Required only when you set "AuthCloud": "Manual". Specify the client ID of your custom app registration. Learn more in Manually create an application registration in Microsoft Entra ID.
"ConnectionType"

(Optional) Specify how the connection authenticates with the environment. The default value is "UsernamePassword". Valid values are:

Note: Device code flow is still accepted for backward compatibility, but Microsoft no longer recommends it because it's a frequent target of phishing attacks. Microsoft Entra ID security default settings block device code flow by default in new tenants (including new tenants that are created for testing), and it isn't supported on iOS. Specify "UsernamePassword" in new connection settings, and update existing settings that use "DeviceCode".

"UseBroker"

(Optional) This parameter applies only to the "UsernamePassword" connection type. It determines whether a broker is used for single sign-on (SSO) authentication. Set it to "true" for broker-based authentication. Set it to "false" to require manual input of a user name and password. Learn more about the broker that each platform requires in Device requirements.

"DomainName" (Optional) This parameter applies only to the "UsernamePassword" connection type. It allows you to implement a simplified sign-in process. If you don't set this field, workers must always enter their full Microsoft Entra ID user principal name (UPN) to sign in. A UPN has the form <user name>@<domain name>. If you specify the <domain name> part here, workers can sign in by entering only the <user name> part. (Even if you set the domain name here, workers can still sign in using their full UPN.)
"ActiveDirectoryTenant" (Optional) Applies only when you set "AuthCloud": "Manual". Specify the Microsoft Entra ID domain name that you're using with the Supply Chain Management server. This value has the form https://login.windows.net/<your-Microsoft-Entra-ID-domain-name>. Here's an example: https://login.windows.net/contosooperations.onmicrosoft.com. Learn more about how to find your Microsoft Entra ID domain name in Locate important IDs for a user.

The following example shows a valid connection settings file that contains three connections: Connection1 uses the global application (no client ID is needed), Connection2 uses a custom app registration with brokered authentication, and Connection3 uses a custom app registration where workers enter a user name and password manually.

{
    "ConnectionList": [
        {
            "ConnectionName": "Connection1",
            "ActiveDirectoryResource": "https://yourenvironment1.cloudax.dynamics.com",
            "Company": "USMF",
            "ConnectionType": "UsernamePassword",
            "UseBroker": true,
            "AuthCloud": "AzureGlobal"
        },
        {
            "ConnectionName": "Connection2",
            "ActiveDirectoryClientAppId": "aaaaaaaa-bbbb-ccccc-dddd-eeeeeeeeeeee",
            "ActiveDirectoryResource": "https://yourenvironment2.cloudax.dynamics.com",
            "Company": "USMF",
            "ConnectionType": "UsernamePassword",
            "UseBroker": true,
            "AuthCloud": "Manual"
        },
        {
            "ConnectionName": "Connection3",
            "ActiveDirectoryClientAppId": "aaaaaaaa-bbbb-ccccc-dddd-eeeeeeeeeeee",
            "ActiveDirectoryResource": "https://yourenvironment3.cloudax.dynamics.com",
            "ActiveDirectoryTenant": "https://login.windows.net/contosooperations.onmicrosoft.com",
            "Company": "USMF",
            "ConnectionType": "UsernamePassword",
            "UseBroker": false,
            "DomainName": "contosooperations.onmicrosoft.com",
            "AuthCloud": "Manual"
        }
    ]
}

You can either save the information as a JSON file or generate a QR code that has the same content. If you save the information as a file, save it by using the default name, connections.json, especially if you'll store it in the default location on each mobile device.

Save the connection settings file on each device

Typically, you'll use a device management tool or script to distribute the connection settings files to each device that you're managing. If you use the default name and location when you save the connection settings file on each device, the Warehouse Management mobile app automatically imports it, even during the first run after the app is installed. If you use a custom name or location for the file, the app user must specify the values during the first run. However, the app continues to use the specified name and location afterward.

Every time that the app starts, it reimports the connection settings from their previous location to check for changes. The app updates only connections that have the same names as the connections in the connection settings file. User-created connections that use other names aren't updated.

You can't remove a connection by using the connection settings file.

As mentioned, the default file name is connections.json. The default file location depends on which type of device you're using:

  • Windows: C:\Users\<User>\AppData\Local\Packages\Microsoft.WarehouseManagement_8wekyb3d8bbwe\LocalState
  • Android: Android\data\com.Microsoft.WarehouseManagement\files See the important note about Android scoped storage limitations earlier in this section.
  • iOS: File sharing isn't supported. Use QR codes or MDM managed configuration instead.

Usually, the paths are automatically created after the first run of the app. However, you can manually create them if you must transfer the connection settings file to the device before installation.

Note

If you uninstall the app, the default path and its contents are removed.

Import the connection settings

Follow these steps to import connection settings from a file or a QR code.

  1. Start the Warehouse Management mobile app on your mobile device. The first time that you start the app, a welcome message appears. Select Connect.

  2. If you're importing the connection settings from a file and you used the default name and location when you saved the file, the app might find the file automatically. In this case, skip ahead to step 4. Otherwise, select Set up connection, and then continue to step 3.

  3. In the Connection setup dialog, select Add from file or Add from QR code, depending on how you want to import the settings:

    • If you're importing the connection settings from a file, select Add from file, browse to the file on your local device, and select it. If you select a custom location, the app stores it and automatically uses it the next time.
    • If you're importing the connection settings by scanning a QR code, select Add from QR code. The app prompts you for permission to use the device's camera. After you give permission, the camera starts, so that you can use it for scanning. Depending on the quality of the device's camera and the complexity of the QR code, you might find it difficult to get a correct scan. In that case, try to reduce the complexity of the QR code by generating only one connection per QR code. (Currently, you can use only the device's camera to scan the QR code.)
  4. After the connection settings load successfully, the selected connection appears.

  5. The app connects to your Supply Chain Management server and shows the sign-in page.

Manually configure the application

If you don't have a file or QR code, you can manually configure the app on the device so that it connects to the Supply Chain Management server through the Microsoft Entra ID application.

  1. Start the Warehouse Management mobile app on your mobile device.

  2. If the app starts in Demo mode, select Connection settings. If the Sign-in page appears when the app starts, select Change connection.

  3. Select Set up connection.

  4. Select Input manually. The New Connection page appears and shows the settings that you need to enter manually.

  5. Enter the following information:

    • Connection name – Enter a name for the new connection. This name appears in the Select connection field the next time you open the connection settings. The name you enter must be unique. (In other words, it must differ from all other connection names that are stored on your device, if any other connection names are stored there.)

    • Environment URL – Specify the root URL of Supply Chain Management.

      Important

      • Don't end this value with a slash (/).
      • Ensure that the HTTPS (SSL) certificate is valid.
    • Company – Enter the legal entity (company) in Supply Chain Management that you want the application to connect to.

    • Authentication method – Select one of the following values to specify the method that you use to authenticate with Supply Chain Management. The method that you select here must match the setup of the app in Azure.

      • Username and password (recommended) – Authenticate by using SSO or by asking the user to enter a user name and password. Username and password supports brokered authentication, which provides phishing-resistant sign-in.
      • Device code (not recommended) – Authenticate by using the device code flow. This option remains available for backward compatibility, but Microsoft no longer recommends it because it's a frequent target of phishing attacks. Microsoft Entra ID security defaults block it by default in new tenants (including new tenants that are created for testing), it isn't available on iOS, and it doesn't support SSO or brokered authentication. If a device is still configured this way, reconfigure it to use Username and password.
    • Cloud – Specify the type of Microsoft Entra ID app registration to authenticate with:

      • Azure Global (recommended) – Authenticate by using the global Microsoft Entra ID application that's registered and maintained by Microsoft. This option supports most scenarios, including Microsoft Entra Conditional Access. You don't have to register or maintain your own Microsoft Entra ID app, and you don't have to enter a client ID or tenant.
      • Manual – Authenticate through your own custom Microsoft Entra ID app registration. Use this option only when the global application doesn't apply to your deployment because you connect to a Finance + Operations (on-premises) environment, you connect to a cloud other than Azure Global (such as a sovereign cloud), or you have specific requirements that the global application doesn't meet. If you choose this option, you must register and maintain a custom app in Microsoft Entra ID and specify a Microsoft Entra ID client ID value for the connection.
    • Microsoft Entra ID client ID – This field is available only when the Cloud field is set to Manual. Enter the client ID of your custom app registration. Learn more in User-based authentication.

    • Microsoft Entra ID tenant – (Optional) This field is available only when the Cloud field is set to Manual. Enter the Microsoft Entra ID domain name that you're using with the Supply Chain Management server. This value has the form https://login.windows.net/<your-Microsoft-Entra-ID-domain-name>. Here's an example: https://login.windows.net/contosooperations.onmicrosoft.com. Learn more about how to find your Microsoft Entra ID domain name in Locate important IDs for a user.

      Important

      Don't end this value with a slash (/).

    • Use Broker – This option applies only when the Authentication method field is set to Username and password. It determines whether a broker is used for SSO authentication. Set this option to Yes for broker-based authentication and SSO. Set it to No to require manual input of a user name and password. Learn more about the broker that each platform requires in Device requirements.

    • Domain name – This field applies only when the Authentication method field is set to Username and password. You can use it to make sign-in easier for workers. If you don't set this field, workers must enter their full Microsoft Entra ID user principal name to sign in. A user principal name has the form <user name>@<domain name>. If you specify the <domain name> part here, workers can sign in by entering only the <user name> part. (Nevertheless, workers can still enter their full user principal name.)

  6. Select the Save button in the upper-right corner of the page.

  7. The app connects to your Supply Chain Management server and shows the sign-in page.

Remove access for a lost or compromised device

If a device is lost or compromised, remove its access to Supply Chain Management. The method you use to remove access depends on how the device is configured to authenticate with Supply Chain Management. For instructions, see Remove access for a device that uses user-based authentication.