EnvironmentDataLoader

PowerShell toolset for importing and migrating data in Dynamics 365 Finance & Operations via the Data Management Framework (DMF) API.

Requirements

PowerShell 5.1 or later
Network access to the D365 F&O environment and Azure Blob Storage
A Microsoft Entra (Azure AD) account with permissions to sign in to D365
The Data Management workspace must be accessible in the target environment

Repository structure

EnvironmentDataLoader/
├── Invoke-BaselineImport.ps1     Import local packages (xlsx + Manifest) into D365
├── Invoke-TemplateExport.ps1     Export templates to local .zip files (uses template directly)
├── Invoke-ProjectExport.ps1      Build a DMF project from template lines, then export
├── Expand-ExportedPackages.ps1   Extract downloaded .zip files into review folders
├── Invoke-PackageUpload.ps1      Upload pre-built .zip files into D365
├── Get-ExecutionJobReport.ps1    Report on execution job results; surface errors for correction
├── resources/
│   └── 010 - System Setup/       Example baseline data package
│       ├── Manifest.xml
│       ├── PackageHeader.xml
│       └── *.xlsx
└── lib/
    ├── DmfOutput.ps1             Console output and transcript helpers
    ├── DmfRequest.ps1            REST client with automatic retry
    ├── DmfPackage.ps1            Package discovery and entity ordering
    └── DmfZip.ps1                DMF zip inspection helpers

Authentication

All scripts that connect to D365 use the Microsoft Entra device code flow. When authentication is required, the script prints a short code and a URL:

To sign in, use a web browser to open the page https://microsoft.com/devicelogin
and enter the code XXXXXXXXX to authenticate.

Open the URL in any browser, enter the code, and sign in with your D365 credentials. The token is obtained once per run and reused for all API calls in that session.

Client ID used: 1950a258-227b-4e31-a9cf-717495945fc2 (the public Azure CLI application — no app registration required).

Scripts

Invoke-BaselineImport.ps1

Discovers package folders under a local directory, builds a DMF zip from each one, uploads it to Azure Blob Storage, and imports it into D365 via ImportFromPackage.

Each package folder must contain:

Manifest.xml — entity definitions and file mappings
One or more .xlsx files — one per entity
(optional) ordering.json — per-package entity execution overrides

The manifest is rebuilt before upload with optimised ExecutionUnit / LevelInExecutionUnit / SequenceInLevel values so that independent entity chains can run in parallel inside D365 DMF.

Parameters

Parameter	Required	Default	Description
`-EnvironmentUrl`	Yes	—	D365 base URL, e.g. `https://contoso.operations.dynamics.com`
`-TenantId`	Yes	—	Entra tenant ID or domain, e.g. `contoso.onmicrosoft.com`
`-LegalEntityId`	Yes	—	D365 company to import into, e.g. `DAT`
`-PackageName`	No	—	Import exactly this folder without showing the menu
`-ResourcesPath`	No	`./resources`	Root directory containing package subfolders
`-OutputPath`	No	`$env:TEMP`	Directory for the temporary zip files
`-LogPath`	No	auto	Transcript log path; pass `''` to suppress
`-PollIntervalSeconds`	No	`30`	Status check interval (5–300)
`-TimeoutMinutes`	No	`60`	Per-package polling timeout (1–480)
`-MaxRetries`	No	`3`	Retry limit for transient REST failures (0–10)
`-Force`	No	off	Skip the confirmation prompt
`-WhatIf`	No	off	Validate without making any API calls
`-NoOverwrite`	No	off	Preserve existing D365 records
`-KeepZip`	No	off	Keep the generated zip after upload
`-PassThru`	No	off	Emit result objects: `Package, Status, ExecutionId, Elapsed`

Examples

# Interactive: discover all packages and select which to import
.\Invoke-BaselineImport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT'

# Non-interactive: import one package, skip confirmation, write a log
.\Invoke-BaselineImport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT' `
    -PackageName    '010 - System Setup' `
    -Force `
    -LogPath        'C:\Logs\import.log'

# Dry-run: validate all packages without touching D365
.\Invoke-BaselineImport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT' `
    -WhatIf

# Import from a custom directory into a non-default company
.\Invoke-BaselineImport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'USMF' `
    -ResourcesPath  'C:\DMF\Packages' `
    -NoOverwrite

Invoke-TemplateExport.ps1

Reads the list of DMF definition-group templates from a D365 environment, lets you select which ones to export, submits ExportToPackage jobs, polls for completion, and downloads the resulting zip files.

Prerequisite — a data project must already exist for each template. ExportToPackage resolves definitionGroupId against data projects (DataManagementDefinitionGroups), not templates (DefinitionGroupTemplateHeaders). This script passes the template ID straight through, so it only succeeds for templates that have an identically-named data project in the environment. Templates without one fail with:
HTTP 400: Data project <TemplateId> does not exist.
The failure is per-template — the run continues and reports the rest — but on a stock environment most templates will fail this way. To export templates that have no matching data project, use Invoke-ProjectExport.ps1, which builds the project from the template lines first. List the names this script can accept with GET /data/DataManagementDefinitionGroups.

Parameters

Parameter	Required	Default	Description
`-EnvironmentUrl`	Yes	—	D365 base URL
`-TenantId`	Yes	—	Entra tenant ID or domain
`-LegalEntityId`	Yes	—	D365 company to export from
`-TemplateName`	No	—	Export exactly this template (DefinitionGroupId) without showing the menu
`-DownloadPath`	No	`$env:TEMP`	Directory to save downloaded zip files; pass `''` to get the URL only
`-LogPath`	No	auto	Transcript log path; pass `''` to suppress
`-PollIntervalSeconds`	No	`30`	Status check interval (5–300)
`-TimeoutMinutes`	No	`60`	Per-template polling timeout (1–480)
`-MaxRetries`	No	`3`	Retry limit for transient REST failures (0–10)
`-Force`	No	off	Skip the confirmation prompt
`-WhatIf`	No	off	With `-TemplateName`: no API calls at all. Without: fetches the template list (read-only) for the menu, then exits without exporting
`-PassThru`	No	off	Emit result objects: `Template, TemplateId, Status, ExecutionId, DownloadUrl, DownloadedTo, Elapsed`

Examples

# Interactive: list all templates in the environment and choose which to export
.\Invoke-TemplateExport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT'

# Export a specific template and download the zip to C:\DMF\Downloads
.\Invoke-TemplateExport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT' `
    -TemplateName   'SystemSetupExport' `
    -DownloadPath   'C:\DMF\Downloads' `
    -Force

# Export several templates and capture results for further processing.
# Note: -Force skips only the "Proceed?" confirmation -- the selection menu is
# still shown.  Enter A at the prompt to pick every template.
# For an unattended all-templates sweep use Invoke-ProjectExport.ps1 -All -Force.
$exports = .\Invoke-TemplateExport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT' `
    -DownloadPath   'C:\DMF\Downloads' `
    -Force `
    -PassThru

$exports | Where-Object Status -eq 'Succeeded' | Select-Object TemplateId, DownloadedTo

# WhatIf with a named template — zero API calls, no authentication needed
.\Invoke-TemplateExport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT' `
    -TemplateName   'SystemSetupExport' `
    -WhatIf

Invoke-ProjectExport.ps1

Builds a dedicated DMF export project from a template's entity lines, then exports and downloads it. Unlike Invoke-TemplateExport.ps1 — which runs ExportToPackage directly against the template — this script first creates a named DMF project (DataManagementDefinitionGroups) populated with one entity record per template line, then exports that project.

Because it creates the data project itself, this script works for every template — including the ones Invoke-TemplateExport.ps1 cannot export because no matching data project exists. It is the right choice for exporting a whole environment; use it when you need a persistent, inspectable DMF project in D365 that matches the template structure, or when Invoke-TemplateExport.ps1 fails with "Data project ... does not exist."

Note that it writes to the source environment: one data project is created per template, and any existing project with the same name is deleted first. Templates that have no lines are reported as Skipped rather than exported.

Per-template flow:

Fetch all lines from DefinitionGroupTemplateLines for the selected template.
Delete any existing DMF project named "<TemplateId> <LegalEntityId>" (404 is silently ignored).
Create a fresh export project with that name.
POST one entity record to DataManagementDefinitionGroupDetails per template line.
Submit ExportToPackage, poll for completion, download the zip.

Parameters

Parameter	Required	Default	Description
`-EnvironmentUrl`	Yes	—	D365 base URL
`-TenantId`	Yes	—	Entra tenant ID or domain
`-LegalEntityId`	No	prompted	D365 company to export from; prompted interactively if omitted
`-TemplateName`	No	—	Process exactly this template (TemplateId) without showing the menu
`-All`	No	off	Process every validated template without showing the menu; cannot be combined with `-TemplateName`. With `-Force` it also requires `-LegalEntityId`
`-DownloadPath`	No	`$env:TEMP`	Directory to save downloaded zip files; pass `''` to get the URL only
`-LogPath`	No	auto	Transcript log path; pass `''` to suppress
`-PollIntervalSeconds`	No	`30`	Status check interval (5–300)
`-TimeoutMinutes`	No	`60`	Per-template polling timeout (1–480)
`-MaxRetries`	No	`3`	Retry limit for transient REST failures (0–10)
`-Force`	No	off	Skip the confirmation prompt
`-WhatIf`	No	off	With `-TemplateName`: no API calls at all. Without: fetches the template list (read-only) for the menu, then exits without creating or exporting
`-PassThru`	No	off	Emit result objects: `Template, TemplateId, ProjectName, LegalEntityId, Status, LinesAdded, ExecutionId, DownloadUrl, DownloadedTo, Elapsed`

Examples

# Interactive: list templates, prompt for selection and legal entity
.\Invoke-ProjectExport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com'

# Supply legal entity up front, select templates interactively
.\Invoke-ProjectExport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'USMF'

# Non-interactive: one template, skip confirmation, download to C:\DMF\Downloads
.\Invoke-ProjectExport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'USMF' `
    -TemplateName   '010 - System Setup' `
    -DownloadPath   'C:\DMF\Downloads' `
    -Force

# WhatIf with a named template — zero API calls
.\Invoke-ProjectExport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'USMF' `
    -TemplateName   '010 - System Setup' `
    -WhatIf

# Export multiple templates and capture results
$results = .\Invoke-ProjectExport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'USMF' `
    -DownloadPath   'C:\DMF\Downloads' `
    -Force `
    -PassThru

$results | Select-Object ProjectName, LinesAdded, Status, DownloadedTo

# Every template in the environment, fully unattended (no selection menu)
$results = .\Invoke-ProjectExport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'USMF' `
    -DownloadPath   'C:\DMF\Downloads' `
    -PollIntervalSeconds 10 `
    -All `
    -Force `
    -PassThru

# Anything that did not succeed can be re-run individually with -TemplateName
$results | Where-Object Status -notin 'Succeeded', 'Skipped' |
    Format-Table TemplateId, Status, ExecutionId

# Preview an all-templates sweep -- read-only, nothing created or exported
.\Invoke-ProjectExport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'USMF' `
    -All `
    -WhatIf

Expand-ExportedPackages.ps1

Extracts downloaded DMF package zip files into individual subfolders. Each subfolder becomes a self-contained package directory (Manifest.xml + xlsx files) that Invoke-BaselineImport.ps1 can import directly.

This is the review step in the migration pipeline: after extraction you can open, edit, or filter the xlsx files before re-importing into a target environment.

No D365 API calls are made — this script is entirely local.

Parameters

Parameter	Required	Default	Description
`-SourcePath`	Yes	—	Directory containing downloaded `.zip` files
`-DestinationPath`	No	`SourcePath`	Root directory where per-package subfolders are created
`-PackageName`	No	—	Extract exactly this zip (with or without `.zip` extension) without showing the menu
`-Force`	No	off	Delete and re-extract if the destination folder already exists
`-WhatIf`	No	off	Show what would be extracted without writing any files
`-PassThru`	No	off	Emit result objects: `Package, DefinitionGroupId, ExtractedTo, XlsxCount, EntityCount, Status`

Destination subfolders are named after the zip filename (without extension), preserving the timestamp so multiple exports of the same template do not collide. Existing folders are shown in the menu in cyan; they are skipped unless -Force is specified.

Examples

# Interactive: list all zips in the download folder and choose which to extract
.\Expand-ExportedPackages.ps1 `
    -SourcePath      'C:\DMF\Downloads' `
    -DestinationPath 'C:\DMF\Packages'

# Extract everything, overwriting any folders that already exist
.\Expand-ExportedPackages.ps1 `
    -SourcePath      'C:\DMF\Downloads' `
    -DestinationPath 'C:\DMF\Packages' `
    -Force

# Extract a single zip
.\Expand-ExportedPackages.ps1 `
    -SourcePath      'C:\DMF\Downloads' `
    -DestinationPath 'C:\DMF\Packages' `
    -PackageName     'SystemSetupExport_20240101120000'

# WhatIf: preview extraction targets without writing anything
.\Expand-ExportedPackages.ps1 `
    -SourcePath 'C:\DMF\Downloads' `
    -WhatIf

Invoke-PackageUpload.ps1

Uploads pre-built DMF package zip files directly to D365 without rebuilding the manifest. Use this when you have complete, ready-to-import zips — for example, packages downloaded directly from another environment or obtained from a third party.

The definition group ID used in the ImportFromPackage call is read from Manifest.xml inside each zip, so the package is imported exactly as assembled.

Parameters

Parameter	Required	Default	Description
`-EnvironmentUrl`	Yes	—	D365 base URL
`-TenantId`	Yes	—	Entra tenant ID or domain
`-LegalEntityId`	Yes	—	D365 company to import into
`-UploadPath`	Yes	—	Directory containing the `.zip` files to upload
`-PackageName`	No	—	Upload exactly this zip (with or without `.zip` extension) without showing the menu
`-LogPath`	No	auto	Transcript log path; pass `''` to suppress
`-PollIntervalSeconds`	No	`30`	Status check interval (5–300)
`-TimeoutMinutes`	No	`60`	Per-package polling timeout (1–480)
`-MaxRetries`	No	`3`	Retry limit for transient REST failures (0–10)
`-Force`	No	off	Skip the confirmation prompt
`-WhatIf`	No	off	Validate packages locally without making any API calls
`-NoOverwrite`	No	off	Preserve existing D365 records
`-PassThru`	No	off	Emit result objects: `Package, DefinitionGroupId, Status, ExecutionId, Elapsed`

Examples

# Interactive: list all zips in the folder and choose which to upload
.\Invoke-PackageUpload.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT' `
    -UploadPath     'C:\DMF\Downloads'

# Upload one specific package, skip confirmation, preserve existing records
.\Invoke-PackageUpload.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'USMF' `
    -UploadPath     'C:\DMF\Downloads' `
    -PackageName    'SystemSetupExport_20240101120000.zip' `
    -NoOverwrite `
    -Force

# Dry-run: validate all zips in the directory without connecting to D365
.\Invoke-PackageUpload.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT' `
    -UploadPath     'C:\DMF\Downloads' `
    -WhatIf

Get-ExecutionJobReport.ps1

Queries the D365 OData API for all DataManagementExecutionJobs whose Description begins with Copy legal entity and produces a professional, self-contained HTML report of every per-entity DataManagementExecutionJobDetails record, as well as a colour-coded console summary.

The HTML report includes summary cards (jobs, entities, clean/warning/error counts, failed records), source and target legal entity parsed from each job description, and a single table with all entity rows grouped by job. Designed to be run after an import — share the HTML file with the team, correct source data for flagged entities, and re-run as many times as needed.

Row colour coding:

Colour	Meaning
Green	Both staging and target finished with no failed records — no action needed
Yellow	Non-error anomaly or failed-record count > 0 — review recommended
Red	Staging or target error / aborted — manual data correction required

For any job that contains a red entity, the script additionally calls GetExecutionSummaryStatus from the D365 Data Management API to retrieve and display the platform-level execution result alongside the Execution ID for drill-down in D365 > Data management > Job history.

Parameters

Parameter	Required	Default	Description
`-EnvironmentUrl`	Yes	—	D365 base URL, e.g. `https://contoso.operations.dynamics.com`
`-TenantId`	Yes	—	Entra tenant ID or domain, e.g. `contoso.onmicrosoft.com`
`-LogPath`	No	auto	Transcript log path; pass `''` to suppress
`-HtmlPath`	No	auto	HTML report path; pass `''` to suppress HTML output
`-MaxRetries`	No	`3`	Retry limit for transient REST failures (0–10)
`-IssuesOnly`	No	off	Show only rows that need attention in both the console table and the HTML report; clean rows are still counted in the summary cards
`-PassThru`	No	off	Emit enriched detail objects to the pipeline (see below)

-PassThru objects include: JobId, JobDescription, DefinitionGroupId, EntityName, StagingStatus, TargetStatus, StagingRecordsToBeProcessedCount, TargetRecordsCreatedCount, TargetRecordsUpdatedCount, FailedRecords, NeedsAttention.

Examples

# Full report for all three-digit-prefix jobs
.\Get-ExecutionJobReport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com'

# Issues only -- save HTML to a specific path for sharing with the team
.\Get-ExecutionJobReport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -IssuesOnly `
    -HtmlPath       'C:\Reports\job_report.html'

# Full report; explicit paths for both the HTML and the log
.\Get-ExecutionJobReport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -HtmlPath       'C:\Reports\job_report.html' `
    -LogPath        'C:\Reports\job_report.log'

# Export all detail records to CSV for external tracking; suppress HTML
.\Get-ExecutionJobReport.ps1 `
    -EnvironmentUrl 'https://contoso.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -HtmlPath       '' `
    -PassThru |
    Export-Csv -Path 'C:\Reports\job_report.csv' -NoTypeInformation

Full migration pipeline

Use this workflow to copy data from one D365 environment (or legal entity) to another, with a local review stage in the middle and a post-import verification step.

Source environment / legal entity
        │
        │  Step 1 — Export
        ▼
C:\DMF\Downloads\  (zip files)
        │
        │  Step 2 — Extract
        ▼
C:\DMF\Packages\   (subfolders with Manifest.xml + xlsx)
        │
        │  Step 3 — Review / edit xlsx files
        ▼
C:\DMF\Packages\   (reviewed)
        │
        │  Step 4 — Import
        ▼
Target environment / legal entity
        │
        │  Step 5 — Verify results
        ▼
Get-ExecutionJobReport  (correct errors, repeat Step 4 as needed)

Step 1 — Export from source

Option A — build a project from template lines, then export (recommended; works for every template because it creates the data project it needs):

.\Invoke-ProjectExport.ps1 `
    -EnvironmentUrl 'https://source.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT' `
    -DownloadPath   'C:\DMF\Downloads' `
    -All `
    -Force

Option B — export directly from a template (fewer API calls, but only works for templates that already have an identically-named data project — see the note under Invoke-TemplateExport.ps1):

.\Invoke-TemplateExport.ps1 `
    -EnvironmentUrl 'https://source.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT' `
    -DownloadPath   'C:\DMF\Downloads' `
    -Force

Without -All or -TemplateName, all templates are listed in an interactive menu. Select the ones you want (individual numbers, ranges like 1-5, comma-separated list, or A for all). Each selected template is exported and downloaded as a zip.

For a whole-environment sweep, note that authentication happens once and the token lasts roughly an hour, while templates are processed sequentially. Lower -PollIntervalSeconds (e.g. 10) so completed jobs are detected promptly, and expect to re-authenticate for very large environments — the script warns as expiry approaches and reports affected templates in the summary so they can be re-run with -TemplateName.

Step 2 — Extract for review

.\Expand-ExportedPackages.ps1 `
    -SourcePath      'C:\DMF\Downloads' `
    -DestinationPath 'C:\DMF\Packages' `
    -Force

Each zip becomes a subfolder under C:\DMF\Packages. The subfolder contains Manifest.xml, PackageHeader.xml, and one xlsx file per entity.

Step 3 — Review and edit

Open the xlsx files in any spreadsheet application and make changes as needed — filter rows, update values, add or remove records. The manifest does not need to be edited; Invoke-BaselineImport.ps1 rebuilds it automatically.

Step 4 — Import into target

.\Invoke-BaselineImport.ps1 `
    -EnvironmentUrl 'https://target.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'USMF' `
    -ResourcesPath  'C:\DMF\Packages'

The script scans C:\DMF\Packages, presents a selection menu, builds upload zips with optimised entity ordering, and imports each one into the target legal entity.

Step 5 — Verify results and correct errors

After importing, run Get-ExecutionJobReport.ps1 against the target environment to see a colour-coded summary of every entity's staging and target status:

.\Get-ExecutionJobReport.ps1 `
    -EnvironmentUrl 'https://target.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -IssuesOnly

Red rows indicate entities with staging or target errors that require manual data correction. Correct the source xlsx files for those entities, then re-run Invoke-BaselineImport.ps1 for the affected packages. Repeat Steps 4–5 until the report shows no issues.

Direct zip transfer (skip the review step)

If you want to copy packages from one environment to another without opening the files, use Invoke-PackageUpload.ps1 directly on the downloaded zips:

# Step 1 — export and download  (same as above)
.\Invoke-TemplateExport.ps1 `
    -EnvironmentUrl 'https://source.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'DAT' `
    -DownloadPath   'C:\DMF\Downloads' `
    -Force

# Step 2 — upload directly (no extraction needed)
.\Invoke-PackageUpload.ps1 `
    -EnvironmentUrl 'https://target.operations.dynamics.com' `
    -TenantId       'contoso.onmicrosoft.com' `
    -LegalEntityId  'USMF' `
    -UploadPath     'C:\DMF\Downloads' `
    -Force

Entity execution ordering

Invoke-BaselineImport.ps1 applies an execution ordering to each entity in the manifest before uploading. This ensures that prerequisite entities (currencies, legal entities, address formats) are imported before the records that depend on them.

Each entity is assigned three values:

Value	Meaning
`ExecutionUnit` (EU)	Processing group — all levels in one EU complete before the next EU starts
`LevelInExecutionUnit` (LV)	Sequential level within an EU
`SequenceInLevel` (SEQ)	Parallel execution slot within a level — entities sharing the same EU+LV+SEQ run concurrently

The built-in defaults cover the most common D365 foundation entities. Any entity not found in the defaults table keeps the values from its Manifest.xml.

Customising order with ordering.json

Place an ordering.json file inside a package folder to override or extend the built-in defaults for that specific package. Package-level entries take precedence over built-in values.

{
  "My Custom Entity": { "EU": 1, "LV": 20, "SEQ": 60 },
  "Another Entity":   { "EU": 1, "LV": 20, "SEQ": 70 }
}

The file is optional. If absent, only built-in defaults are applied.

Library modules

The lib/ folder contains helpers that are dot-sourced by the main scripts. They are not intended to be called directly.

DmfOutput.ps1

Console output and transcript helpers.

Function	Description
`Write-Banner`	Prints the script title banner
`Write-Rule`	Prints a horizontal rule with an optional label
`Write-Step`	Cyan section heading
`Write-Info`	Gray informational line
`Write-Detail`	Dark gray detail line
`Write-OK`	Green success message
`Write-Warn`	Yellow warning message
`Write-Fail`	Red failure message
`Format-Elapsed`	Formats a `TimeSpan` as `2h 5m 30s` / `12m 4s` / `45s`
`Stop-RunTranscript`	Stops the PowerShell transcript if one is active

DmfRequest.ps1

Invoke-DmfRequest — wraps Invoke-RestMethod with:

Automatic retry with exponential back-off plus jitter for HTTP 5xx, 408, and network errors
Dedicated HTTP 429 (throttling) handling — see below
OData / D365 error detail extraction from response bodies
Non-retryable treatment of HTTP 401 and other 4xx responses

Invoke-DmfDownload — wraps Invoke-WebRequest -OutFile with the same retry policy, for package downloads from Azure blob storage (which throttles independently of the D365 API). Suppresses the PS progress bar and clears any partially written file before a retry, so a truncated download is never mistaken for a good one.

HTTP 429 handling

Throttling is treated as its own error class rather than as just another transient fault:

Behaviour	Detail
Server hint honoured exactly	`Retry-After` in either spec form — delta-seconds (`120`) or HTTP-date (`Wed, 21 Oct 2015 07:28:00 GMT`) — plus `x-ms-retry-after-ms` (Dataverse / Power Platform), which takes precedence when present
Separate retry budget	A throttling storm no longer consumes the allowance reserved for genuine 5xx/network faults, and vice versa
Bounded waiting	Any single wait is capped, and a total throttle-wait budget stops a run hanging indefinitely behind an unhealthy endpoint
Jittered fallback	When the server sends no hint, back-off uses equal jitter so parallel exports don't resynchronise and re-throttle the endpoint together

Device-code sign-in also handles throttling: the RFC 8628 slow_down signal (and a 429 on the token endpoint) now lengthens the polling interval instead of aborting sign-in.

Retry policy is overridable by setting these before the first request:

Variable	Default	Purpose
`$Script:MaxRetries`	3	Transient (5xx / 408 / network) retries
`$Script:ThrottleMaxRetries`	6	HTTP 429 retries
`$Script:MaxRetryAfterSeconds`	300	Ceiling on any single wait
`$Script:MaxThrottleWaitSeconds`	900	Total time spent waiting out throttling

DmfPackage.ps1

Export	Description
`$entityOrdering`	Ordered hashtable of built-in EU/LV/SEQ defaults
`Get-PackageInfo`	Inspects a package folder and returns metadata
`Resolve-EntityOrdering`	Merges built-in defaults with a package's `ordering.json`

DmfZip.ps1

Get-ZipPackageInfo — opens a DMF zip and returns metadata read from the embedded Manifest.xml: definition group name, entity count, and validation status. Used by both Invoke-PackageUpload.ps1 and Expand-ExportedPackages.ps1.

Name		Name	Last commit message	Last commit date
Latest commit History 7 Commits
lib		lib
resources/010 - System Setup		resources/010 - System Setup
.gitignore		.gitignore
Expand-ExportedPackages.ps1		Expand-ExportedPackages.ps1
Get-ExecutionJobReport.ps1		Get-ExecutionJobReport.ps1
Invoke-BaselineImport.ps1		Invoke-BaselineImport.ps1
Invoke-PackageUpload.ps1		Invoke-PackageUpload.ps1
Invoke-ProjectExport.ps1		Invoke-ProjectExport.ps1
Invoke-TemplateExport.ps1		Invoke-TemplateExport.ps1
README.md		README.md
details.txt		details.txt
endpoints.md		endpoints.md

Folders and files

Latest commit

History

Repository files navigation

EnvironmentDataLoader

Contents

Requirements

Repository structure

Authentication

Scripts

Invoke-BaselineImport.ps1

Parameters

Examples

Invoke-TemplateExport.ps1

Parameters

Examples

Invoke-ProjectExport.ps1

Parameters

Examples

Expand-ExportedPackages.ps1

Parameters

Examples

Invoke-PackageUpload.ps1

Parameters

Examples

Get-ExecutionJobReport.ps1

Parameters

Examples

Full migration pipeline

Step 1 — Export from source

Step 2 — Extract for review

Step 3 — Review and edit

Step 4 — Import into target

Step 5 — Verify results and correct errors

Direct zip transfer (skip the review step)

Entity execution ordering

Customising order with ordering.json

Library modules

DmfOutput.ps1

DmfRequest.ps1

HTTP 429 handling

DmfPackage.ps1

DmfZip.ps1

About

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages