Prerequisites

Prerequisites for running the Export/Import tool are:

  1. Windows operation system versions must be compatible with .NET Core 8.x (.NET Runtime and ASP.NET Core Runtime). See Install .NET on Windows in the Microsoft documentation.
  2. Access to OData with read permissions for all data to export configuration.
  3. Access to OData with read/write permissions for all data to import configuration.

Credentials to access OData can be described differently depending on authentication mode.

Note: The OAuth authentication method has been deprecated and is no longer in acitve support. You can still use it, but we recommend that you use Entra ID.

Entra ID

  • Application ID in your Entra ID tenant.

  • If you are running Entra ID on a single tenant application, you also need to specify the guid of your Entra ID tenant.

NTLM

Specify your authorization type in the "--authorizationType NTLM" parameter. If you do not specify an authorization type, the application with run with Windows authentication as the default authorization type.

OAuth2

  • OAuth client ID
  • OAuth client secret

You can configure the OAuth client using WorkZone Configurator. Click Global > OAuth2 settings. You must configure the OAuth client with the following settings:

  • Enabled—Turned on
  • Allow Access Token Via Browser—Turned off
  • Allow offline access—Turned off
  • Require proof key for code exchange—Turned off
  • Grant type— CLNTCRED, Client credentials
  • User—<any user with the correct access rights>—See steps 3 and 4 above.

See Create a new OAuth2 setting in the WorkZone Configurator Administrator Guide.