From 45887cb9de5ea247154f3a0a142aa94a5e0d9e54 Mon Sep 17 00:00:00 2001 From: Alfi Cody Date: Tue, 22 Sep 2026 11:12:18 +0200 Subject: [PATCH 1/2] Feature: Add DocumentRouting switch to Environment service cmdlets --- build/update-docs.ps1 | 4 +-- build/vsts-prerequisites.ps1 | 2 +- .../functions/get-d365environment.ps1 | 13 +++++++-- .../functions/restart-d365environment.ps1 | 11 +++++-- .../functions/start-d365environment.ps1 | 14 +++++++-- .../functions/start-d365environmentv2.ps1 | 12 ++++++-- .../functions/stop-d365environment.ps1 | 18 ++++++++---- .../internal/functions/get-servicelist.ps1 | 14 +++++++-- d365fo.tools/tests/functions/AGENTS.md | 13 +++++++++ .../functions/Get-D365Environment.Tests.ps1 | 15 +++++++++- .../Invoke-D365ModuleBuild.Tests.ps1 | 4 +-- .../Restart-D365Environment.Tests.ps1 | 15 +++++++++- .../functions/Start-D365Environment.Tests.ps1 | 15 +++++++++- .../Start-D365EnvironmentV2.Tests.ps1 | 15 +++++++++- .../functions/Stop-D365Environment.Tests.ps1 | 23 +++++++++++---- docs/AGENTS.md | 13 +++++++++ docs/Get-D365Environment.md | 22 ++++++++++++-- docs/Get-D365LcsAssetFile.md | 2 +- docs/Get-D365LcsSharedAssetFile.md | 2 +- docs/Invoke-D365LcsUpload.md | 2 +- docs/Invoke-D365ModuleBuild.md | 20 ++----------- docs/Restart-D365Environment.md | 24 ++++++++++++--- docs/Start-D365Environment.md | 23 +++++++++++++-- docs/Start-D365EnvironmentV2.md | 23 ++++++++++++--- docs/Stop-D365Environment.md | 29 +++++++++++++++---- 25 files changed, 275 insertions(+), 73 deletions(-) create mode 100644 d365fo.tools/tests/functions/AGENTS.md create mode 100644 docs/AGENTS.md diff --git a/build/update-docs.ps1 b/build/update-docs.ps1 index 08e86f709..109d03380 100644 --- a/build/update-docs.ps1 +++ b/build/update-docs.ps1 @@ -5,7 +5,7 @@ $path = "$PSScriptRoot\.." Import-Module "$path\d365fo.tools" -Force -Remove-Item -Path "$path\docs\*.md" +Remove-Item -Path "$path\docs\*.md" -Exclude "AGENTS.md" $null = New-MarkdownHelp -Module d365fo.tools -OutputFolder "$path\docs" -Force -Get-ChildItem -Path "$path\docs" -Recurse -File | Set-PSMDEncoding \ No newline at end of file +Get-ChildItem -Path "$path\docs" -Recurse -File -Exclude "AGENTS.md" | Set-PSMDEncoding \ No newline at end of file diff --git a/build/vsts-prerequisites.ps1 b/build/vsts-prerequisites.ps1 index 22502d431..8254c6051 100644 --- a/build/vsts-prerequisites.ps1 +++ b/build/vsts-prerequisites.ps1 @@ -2,7 +2,7 @@ Write-Host "The user running is: $($env:UserName)" # $modules = @("PSFramework", "Az.Storage", "AzureAd", "PSNotification", "PSOAuthHelper", "PowerShellGet", "PackageManagement","ImportExcel","PSScriptAnalyzer") -$modules = @("PSFramework", "PSScriptAnalyzer", "Az.Storage", "PSOAuthHelper", "ImportExcel") +$modules = @("PSFramework", "PSScriptAnalyzer", "Az.Storage", "PSOAuthHelper", "ImportExcel", "PSModuleDevelopment", "platyPS") Write-Host "Installing Pester, maximum version 4.99.99" -ForegroundColor Cyan Install-Module "Pester" -MaximumVersion 4.99.99 -Force -Confirm:$false -Scope CurrentUser -AllowClobber -SkipPublisherCheck diff --git a/d365fo.tools/functions/get-d365environment.ps1 b/d365fo.tools/functions/get-d365environment.ps1 index 2f1664620..9027abe33 100644 --- a/d365fo.tools/functions/get-d365environment.ps1 +++ b/d365fo.tools/functions/get-d365environment.ps1 @@ -17,6 +17,7 @@ Batch Financial Reporter DMF + DocumentRouting .PARAMETER Aos Instruct the cmdlet to query the AOS (IIS) service @@ -29,6 +30,9 @@ .PARAMETER DMF Instruct the cmdlet query the DMF service + + .PARAMETER DocumentRouting + Instruct the cmdlet query the document routing service .PARAMETER OnlyStartTypeAutomatic Instruct the cmdlet to filter out services that are set to manual start or disabled @@ -63,9 +67,9 @@ Will query the Aos & Batch services on the machine. .EXAMPLE - PS C:\> Get-D365Environment -FinancialReporter -DMF + PS C:\> Get-D365Environment -DocumentRouting - Will query the FinancialReporter & DMF services on the machine. + Will query the DocumentRouting service on the machine. .EXAMPLE PS C:\> Get-D365Environment -OutputServiceDetailsOnly @@ -108,6 +112,9 @@ function Get-D365Environment { [Parameter(Mandatory = $false, ParameterSetName = 'Specific')] [switch] $DMF, + [Parameter(Mandatory = $false, ParameterSetName = 'Specific')] + [switch] $DocumentRouting, + [switch] $OnlyStartTypeAutomatic, [switch] $OutputServiceDetailsOnly @@ -117,7 +124,7 @@ function Get-D365Environment { $All = $false } - if ( (-not ($All)) -and (-not ($Aos)) -and (-not ($Batch)) -and (-not ($FinancialReporter)) -and (-not ($DMF))) { + if ( (-not ($All)) -and (-not ($Aos)) -and (-not ($Batch)) -and (-not ($FinancialReporter)) -and (-not ($DMF)) -and (-not ($DocumentRouting))) { Write-PSFMessage -Level Host -Message "You have to use at least one switch when running this cmdlet. Please run the cmdlet again." Stop-PSFFunction -Message "Stopping because of missing parameters" return diff --git a/d365fo.tools/functions/restart-d365environment.ps1 b/d365fo.tools/functions/restart-d365environment.ps1 index e1f18d64c..03f407a3c 100644 --- a/d365fo.tools/functions/restart-d365environment.ps1 +++ b/d365fo.tools/functions/restart-d365environment.ps1 @@ -17,6 +17,7 @@ Batch Financial Reporter DMF + DocumentRouting .PARAMETER Aos Instructs the cmdlet to work against the AOS (IIS) service @@ -29,6 +30,9 @@ .PARAMETER DMF Instructs the cmdlet to work against the DMF service + + .PARAMETER DocumentRouting + Instructs the cmdlet to work against the Document Routing service .PARAMETER Kill Instructs the cmdlet to kill the service(s) that you want to restart @@ -62,9 +66,9 @@ This will stop the AOS and Batch services and then start the AOS and Batch services again. .EXAMPLE - PS C:\> Restart-D365Environment -FinancialReporter -DMF + PS C:\> Restart-D365Environment -DocumentRouting - This will stop the FinancialReporter and DMF services and then start the FinancialReporter and DMF services again. + This will stop the DocumentRouting service and then start the DocumentRouting service again. .EXAMPLE PS C:\> Restart-D365Environment -All -Kill @@ -103,6 +107,9 @@ function Restart-D365Environment { [Parameter(Mandatory = $false, ParameterSetName = 'Specific', Position = 5 )] [switch] $DMF, + [Parameter(Mandatory = $false, ParameterSetName = 'Specific', Position = 6 )] + [switch] $DocumentRouting, + [switch] $Kill, [Parameter(Mandatory = $False)] diff --git a/d365fo.tools/functions/start-d365environment.ps1 b/d365fo.tools/functions/start-d365environment.ps1 index 171639f22..5f91aacff 100644 --- a/d365fo.tools/functions/start-d365environment.ps1 +++ b/d365fo.tools/functions/start-d365environment.ps1 @@ -16,6 +16,8 @@ Aos Batch Financial Reporter + DMF + DocumentRouting .PARAMETER Aos Start the Aos (iis) service @@ -28,6 +30,9 @@ .PARAMETER DMF Start the Data Management Framework service + + .PARAMETER DocumentRouting + Start the Document Routing service .PARAMETER OnlyStartTypeAutomatic Instruct the cmdlet to filter out services that are set to manual start or disabled @@ -69,9 +74,9 @@ This will start the Aos & Batch D365FO services on the machine. .EXAMPLE - PS C:\> Start-D365Environment -FinancialReporter -DMF + PS C:\> Start-D365Environment -DocumentRouting - This will start the FinancialReporter and DMF services on the machine. + This will start the DocumentRouting service on the machine. .NOTES Author: Mötz Jensen (@Splaxi) @@ -102,6 +107,9 @@ function Start-D365Environment { [Parameter(Mandatory = $false, ParameterSetName = 'Specific', Position = 5 )] [switch] $DMF, + [Parameter(Mandatory = $false, ParameterSetName = 'Specific', Position = 6 )] + [switch] $DocumentRouting, + [switch] $OnlyStartTypeAutomatic, [switch] $ShowOriginalProgress @@ -113,7 +121,7 @@ function Start-D365Environment { $All = $false } - if ( (-not ($All)) -and (-not ($Aos)) -and (-not ($Batch)) -and (-not ($FinancialReporter)) -and (-not ($DMF))) { + if ( (-not ($All)) -and (-not ($Aos)) -and (-not ($Batch)) -and (-not ($FinancialReporter)) -and (-not ($DMF)) -and (-not ($DocumentRouting))) { Write-PSFMessage -Level Host -Message "You have to use at least one switch when running this cmdlet. Please run the cmdlet again." Stop-PSFFunction -Message "Stopping because of missing parameters" return diff --git a/d365fo.tools/functions/start-d365environmentv2.ps1 b/d365fo.tools/functions/start-d365environmentv2.ps1 index 4b61d801b..f4fd1431f 100644 --- a/d365fo.tools/functions/start-d365environmentv2.ps1 +++ b/d365fo.tools/functions/start-d365environmentv2.ps1 @@ -26,6 +26,9 @@ .PARAMETER DMF Start the Data Management Framework service + + .PARAMETER DocumentRouting + Start the Document Routing service .PARAMETER OnlyStartTypeAutomatic Instruct the cmdlet to filter out services that are set to manual start or disabled @@ -67,9 +70,9 @@ This will start the Aos & Batch D365FO services on the machine. .EXAMPLE - PS C:\> Start-D365EnvironmentV2 -FinancialReporter -DMF + PS C:\> Start-D365EnvironmentV2 -DocumentRouting - This will start the FinancialReporter and DMF services on the machine. + This will start the DocumentRouting service on the machine. .EXAMPLE PS C:\> Enable-D365Exception @@ -105,6 +108,9 @@ function Start-D365EnvironmentV2 { [Parameter(Mandatory = $false, ParameterSetName = 'Specific', Position = 4 )] [switch] $DMF, + [Parameter(Mandatory = $false, ParameterSetName = 'Specific', Position = 5 )] + [switch] $DocumentRouting, + [switch] $OnlyStartTypeAutomatic, [switch] $ShowOriginalProgress @@ -116,7 +122,7 @@ function Start-D365EnvironmentV2 { $All = $false } - if ( (-not ($All)) -and (-not ($Aos)) -and (-not ($Batch)) -and (-not ($FinancialReporter)) -and (-not ($DMF))) { + if ( (-not ($All)) -and (-not ($Aos)) -and (-not ($Batch)) -and (-not ($FinancialReporter)) -and (-not ($DMF)) -and (-not ($DocumentRouting))) { Write-PSFMessage -Level Host -Message "You have to use at least one switch when running this cmdlet. Please run the cmdlet again." Stop-PSFFunction -Message "Stopping because of missing parameters" return diff --git a/d365fo.tools/functions/stop-d365environment.ps1 b/d365fo.tools/functions/stop-d365environment.ps1 index a7083141e..cec57134c 100644 --- a/d365fo.tools/functions/stop-d365environment.ps1 +++ b/d365fo.tools/functions/stop-d365environment.ps1 @@ -16,6 +16,8 @@ Aos Batch Financial Reporter + DMF + DocumentRouting .PARAMETER Aos Stop the Aos (iis) service @@ -28,6 +30,9 @@ .PARAMETER DMF Start the Data Management Framework service + + .PARAMETER DocumentRouting + Stop the Document Routing service .PARAMETER Kill Instructs the cmdlet to kill the service(s) that you want to stop @@ -63,9 +68,9 @@ This will stop the Aos & Batch D365FO services on the machine. .EXAMPLE - PS C:\> Stop-D365Environment -FinancialReporter -DMF + PS C:\> Stop-D365Environment -DocumentRouting - This will stop the FinancialReporter and DMF services on the machine. + This will stop the DocumentRouting service on the machine. .EXAMPLE PS C:\> Stop-D365Environment -All -Kill @@ -103,11 +108,14 @@ function Stop-D365Environment { [switch] $DMF, [Parameter(Mandatory = $false, ParameterSetName = 'Specific', Position = 6 )] - [Parameter(Mandatory = $false, ParameterSetName = 'Default', Position = 6 )] - [switch] $Kill, + [switch] $DocumentRouting, [Parameter(Mandatory = $false, ParameterSetName = 'Specific', Position = 7 )] [Parameter(Mandatory = $false, ParameterSetName = 'Default', Position = 7 )] + [switch] $Kill, + + [Parameter(Mandatory = $false, ParameterSetName = 'Specific', Position = 8 )] + [Parameter(Mandatory = $false, ParameterSetName = 'Default', Position = 8 )] [switch] $ShowOriginalProgress ) @@ -115,7 +123,7 @@ function Stop-D365Environment { $All = $false } - if ((-not ($All)) -and (-not ($Aos)) -and (-not ($Batch)) -and (-not ($FinancialReporter)) -and (-not ($DMF))) { + if ((-not ($All)) -and (-not ($Aos)) -and (-not ($Batch)) -and (-not ($FinancialReporter)) -and (-not ($DMF)) -and (-not ($DocumentRouting))) { Write-PSFMessage -Level Host -Message "You have to use at least one switch when running this cmdlet. Please run the cmdlet again." Stop-PSFFunction -Message "Stopping because of missing parameters" return diff --git a/d365fo.tools/internal/functions/get-servicelist.ps1 b/d365fo.tools/internal/functions/get-servicelist.ps1 index 3ff7a7f3c..3f6e88feb 100644 --- a/d365fo.tools/internal/functions/get-servicelist.ps1 +++ b/d365fo.tools/internal/functions/get-servicelist.ps1 @@ -20,6 +20,9 @@ .PARAMETER DMF Switch to instruct the cmdlet to output the data management service name + + .PARAMETER DocumentRouting + Switch to instruct the cmdlet to output the document routing service name .EXAMPLE PS C:\> Get-ServiceList -All @@ -48,7 +51,10 @@ Function Get-ServiceList { [switch] $FinancialReporter, [Parameter(Mandatory = $false, ParameterSetName = 'Specific', Position = 5 )] - [switch] $DMF + [switch] $DMF, + + [Parameter(Mandatory = $false, ParameterSetName = 'Specific', Position = 6 )] + [switch] $DocumentRouting ) if ($PSCmdlet.ParameterSetName -eq "Specific") { @@ -61,11 +67,12 @@ Function Get-ServiceList { $batchname = "DynamicsAxBatch" $financialname = "MR2012ProcessService" $dmfname = "Microsoft.Dynamics.AX.Framework.Tools.DMF.SSISHelperService.exe" + $documentroutingname = "DocumentRoutingService" [System.Collections.ArrayList]$Services = New-Object -TypeName "System.Collections.ArrayList" if ($All) { - $null = $Services.AddRange(@($aosname, $batchname, $financialname, $dmfname)) + $null = $Services.AddRange(@($aosname, $batchname, $financialname, $dmfname, $documentroutingname)) } else { if ($Aos) { @@ -80,6 +87,9 @@ Function Get-ServiceList { if ($DMF) { $null = $Services.Add($dmfname) } + if ($DocumentRouting) { + $null = $Services.Add($documentroutingname) + } } $Services.ToArray() diff --git a/d365fo.tools/tests/functions/AGENTS.md b/d365fo.tools/tests/functions/AGENTS.md new file mode 100644 index 000000000..1ebfe5a0a --- /dev/null +++ b/d365fo.tools/tests/functions/AGENTS.md @@ -0,0 +1,13 @@ +# Unit Tests for Public Functions + +Do not hand-edit `*.Tests.ps1` files here. They are generated. + +To generate / update all parameter unit tests after adding or changing a public function, run from the repo root with PowerShell 5: + +```powershell +pwsh -NoProfile -File ./build/generate-parameterunittests.ps1 +``` + +The script takes no parameters. It deletes and regenerates every `*.Tests.ps1` file in this folder, so always run it after a parameter signature change and include the full regeneration in your commit. + +Requires `PSModuleDevelopment` (`Invoke-PSMDTemplate`). Install prerequisites with `build/vsts-prerequisites.ps1` if the template command is missing. diff --git a/d365fo.tools/tests/functions/Get-D365Environment.Tests.ps1 b/d365fo.tools/tests/functions/Get-D365Environment.Tests.ps1 index edd881999..24e42afd9 100644 --- a/d365fo.tools/tests/functions/Get-D365Environment.Tests.ps1 +++ b/d365fo.tools/tests/functions/Get-D365Environment.Tests.ps1 @@ -95,6 +95,19 @@ $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False } + It 'Should have the expected parameter DocumentRouting' { + $parameter = (Get-Command Get-D365Environment).Parameters['DocumentRouting'] + $parameter.Name | Should -Be 'DocumentRouting' + $parameter.ParameterType.ToString() | Should -Be System.Management.Automation.SwitchParameter + $parameter.IsDynamic | Should -Be $False + $parameter.ParameterSets.Keys | Should -Be 'Specific' + $parameter.ParameterSets.Keys | Should -Contain 'Specific' + $parameter.ParameterSets['Specific'].IsMandatory | Should -Be $False + $parameter.ParameterSets['Specific'].Position | Should -Be -2147483648 + $parameter.ParameterSets['Specific'].ValueFromPipeline | Should -Be $False + $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False + $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False + } It 'Should have the expected parameter OnlyStartTypeAutomatic' { $parameter = (Get-Command Get-D365Environment).Parameters['OnlyStartTypeAutomatic'] $parameter.Name | Should -Be 'OnlyStartTypeAutomatic' @@ -132,7 +145,7 @@ Describe "Testing parameterset Specific" { <# Specific - - Specific -ComputerName -Aos -Batch -FinancialReporter -DMF -OnlyStartTypeAutomatic -OutputServiceDetailsOnly + Specific -ComputerName -Aos -Batch -FinancialReporter -DMF -DocumentRouting -OnlyStartTypeAutomatic -OutputServiceDetailsOnly #> } diff --git a/d365fo.tools/tests/functions/Invoke-D365ModuleBuild.Tests.ps1 b/d365fo.tools/tests/functions/Invoke-D365ModuleBuild.Tests.ps1 index bfd89e329..bdf38268f 100644 --- a/d365fo.tools/tests/functions/Invoke-D365ModuleBuild.Tests.ps1 +++ b/d365fo.tools/tests/functions/Invoke-D365ModuleBuild.Tests.ps1 @@ -1,4 +1,4 @@ -Describe "Invoke-D365ModuleBuild Unit Tests" -Tag "Unit" { +Describe "Invoke-D365ModuleBuild Unit Tests" -Tag "Unit" { BeforeAll { # Place here all things needed to prepare for the tests } @@ -146,7 +146,7 @@ Describe "Invoke-D365ModuleBuild Unit Tests" -Tag "Unit" { Describe "Testing parameterset __AllParameterSets" { <# __AllParameterSets -Module - __AllParameterSets -Module -OutputDir -LogPath -MetaDataDir -ReferenceDir -BinDir -IncludeReports -ShowOriginalProgress -OutputCommandOnly -Verbosity -Verbosity + __AllParameterSets -Module -OutputDir -LogPath -MetaDataDir -ReferenceDir -BinDir -IncludeReports -ShowOriginalProgress -OutputCommandOnly -Verbosity #> } diff --git a/d365fo.tools/tests/functions/Restart-D365Environment.Tests.ps1 b/d365fo.tools/tests/functions/Restart-D365Environment.Tests.ps1 index dfd741007..5a08486b4 100644 --- a/d365fo.tools/tests/functions/Restart-D365Environment.Tests.ps1 +++ b/d365fo.tools/tests/functions/Restart-D365Environment.Tests.ps1 @@ -95,6 +95,19 @@ $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False } + It 'Should have the expected parameter DocumentRouting' { + $parameter = (Get-Command Restart-D365Environment).Parameters['DocumentRouting'] + $parameter.Name | Should -Be 'DocumentRouting' + $parameter.ParameterType.ToString() | Should -Be System.Management.Automation.SwitchParameter + $parameter.IsDynamic | Should -Be $False + $parameter.ParameterSets.Keys | Should -Be 'Specific' + $parameter.ParameterSets.Keys | Should -Contain 'Specific' + $parameter.ParameterSets['Specific'].IsMandatory | Should -Be $False + $parameter.ParameterSets['Specific'].Position | Should -Be 6 + $parameter.ParameterSets['Specific'].ValueFromPipeline | Should -Be $False + $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False + $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False + } It 'Should have the expected parameter Kill' { $parameter = (Get-Command Restart-D365Environment).Parameters['Kill'] $parameter.Name | Should -Be 'Kill' @@ -132,7 +145,7 @@ Describe "Testing parameterset Specific" { <# Specific - - Specific -ComputerName -Aos -Batch -FinancialReporter -DMF -Kill -ShowOriginalProgress + Specific -ComputerName -Aos -Batch -FinancialReporter -DMF -DocumentRouting -Kill -ShowOriginalProgress #> } diff --git a/d365fo.tools/tests/functions/Start-D365Environment.Tests.ps1 b/d365fo.tools/tests/functions/Start-D365Environment.Tests.ps1 index 7cbe2f884..5240ac022 100644 --- a/d365fo.tools/tests/functions/Start-D365Environment.Tests.ps1 +++ b/d365fo.tools/tests/functions/Start-D365Environment.Tests.ps1 @@ -95,6 +95,19 @@ $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False } + It 'Should have the expected parameter DocumentRouting' { + $parameter = (Get-Command Start-D365Environment).Parameters['DocumentRouting'] + $parameter.Name | Should -Be 'DocumentRouting' + $parameter.ParameterType.ToString() | Should -Be System.Management.Automation.SwitchParameter + $parameter.IsDynamic | Should -Be $False + $parameter.ParameterSets.Keys | Should -Be 'Specific' + $parameter.ParameterSets.Keys | Should -Contain 'Specific' + $parameter.ParameterSets['Specific'].IsMandatory | Should -Be $False + $parameter.ParameterSets['Specific'].Position | Should -Be 6 + $parameter.ParameterSets['Specific'].ValueFromPipeline | Should -Be $False + $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False + $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False + } It 'Should have the expected parameter OnlyStartTypeAutomatic' { $parameter = (Get-Command Start-D365Environment).Parameters['OnlyStartTypeAutomatic'] $parameter.Name | Should -Be 'OnlyStartTypeAutomatic' @@ -132,7 +145,7 @@ Describe "Testing parameterset Specific" { <# Specific - - Specific -ComputerName -Aos -Batch -FinancialReporter -DMF -OnlyStartTypeAutomatic -ShowOriginalProgress + Specific -ComputerName -Aos -Batch -FinancialReporter -DMF -DocumentRouting -OnlyStartTypeAutomatic -ShowOriginalProgress #> } diff --git a/d365fo.tools/tests/functions/Start-D365EnvironmentV2.Tests.ps1 b/d365fo.tools/tests/functions/Start-D365EnvironmentV2.Tests.ps1 index b23bc0236..f84600ab0 100644 --- a/d365fo.tools/tests/functions/Start-D365EnvironmentV2.Tests.ps1 +++ b/d365fo.tools/tests/functions/Start-D365EnvironmentV2.Tests.ps1 @@ -76,6 +76,19 @@ $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False } + It 'Should have the expected parameter DocumentRouting' { + $parameter = (Get-Command Start-D365EnvironmentV2).Parameters['DocumentRouting'] + $parameter.Name | Should -Be 'DocumentRouting' + $parameter.ParameterType.ToString() | Should -Be System.Management.Automation.SwitchParameter + $parameter.IsDynamic | Should -Be $False + $parameter.ParameterSets.Keys | Should -Be 'Specific' + $parameter.ParameterSets.Keys | Should -Contain 'Specific' + $parameter.ParameterSets['Specific'].IsMandatory | Should -Be $False + $parameter.ParameterSets['Specific'].Position | Should -Be 5 + $parameter.ParameterSets['Specific'].ValueFromPipeline | Should -Be $False + $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False + $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False + } It 'Should have the expected parameter OnlyStartTypeAutomatic' { $parameter = (Get-Command Start-D365EnvironmentV2).Parameters['OnlyStartTypeAutomatic'] $parameter.Name | Should -Be 'OnlyStartTypeAutomatic' @@ -113,7 +126,7 @@ Describe "Testing parameterset Specific" { <# Specific - - Specific -Aos -Batch -FinancialReporter -DMF -OnlyStartTypeAutomatic -ShowOriginalProgress + Specific -Aos -Batch -FinancialReporter -DMF -DocumentRouting -OnlyStartTypeAutomatic -ShowOriginalProgress #> } diff --git a/d365fo.tools/tests/functions/Stop-D365Environment.Tests.ps1 b/d365fo.tools/tests/functions/Stop-D365Environment.Tests.ps1 index 44cf0569c..d496c1d65 100644 --- a/d365fo.tools/tests/functions/Stop-D365Environment.Tests.ps1 +++ b/d365fo.tools/tests/functions/Stop-D365Environment.Tests.ps1 @@ -95,6 +95,19 @@ $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False } + It 'Should have the expected parameter DocumentRouting' { + $parameter = (Get-Command Stop-D365Environment).Parameters['DocumentRouting'] + $parameter.Name | Should -Be 'DocumentRouting' + $parameter.ParameterType.ToString() | Should -Be System.Management.Automation.SwitchParameter + $parameter.IsDynamic | Should -Be $False + $parameter.ParameterSets.Keys | Should -Be 'Specific' + $parameter.ParameterSets.Keys | Should -Contain 'Specific' + $parameter.ParameterSets['Specific'].IsMandatory | Should -Be $False + $parameter.ParameterSets['Specific'].Position | Should -Be 6 + $parameter.ParameterSets['Specific'].ValueFromPipeline | Should -Be $False + $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False + $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False + } It 'Should have the expected parameter Kill' { $parameter = (Get-Command Stop-D365Environment).Parameters['Kill'] $parameter.Name | Should -Be 'Kill' @@ -103,13 +116,13 @@ $parameter.ParameterSets.Keys | Should -Be 'Default', 'Specific' $parameter.ParameterSets.Keys | Should -Contain 'Default' $parameter.ParameterSets['Default'].IsMandatory | Should -Be $False - $parameter.ParameterSets['Default'].Position | Should -Be 6 + $parameter.ParameterSets['Default'].Position | Should -Be 7 $parameter.ParameterSets['Default'].ValueFromPipeline | Should -Be $False $parameter.ParameterSets['Default'].ValueFromPipelineByPropertyName | Should -Be $False $parameter.ParameterSets['Default'].ValueFromRemainingArguments | Should -Be $False $parameter.ParameterSets.Keys | Should -Contain 'Specific' $parameter.ParameterSets['Specific'].IsMandatory | Should -Be $False - $parameter.ParameterSets['Specific'].Position | Should -Be 6 + $parameter.ParameterSets['Specific'].Position | Should -Be 7 $parameter.ParameterSets['Specific'].ValueFromPipeline | Should -Be $False $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False @@ -122,13 +135,13 @@ $parameter.ParameterSets.Keys | Should -Be 'Default', 'Specific' $parameter.ParameterSets.Keys | Should -Contain 'Default' $parameter.ParameterSets['Default'].IsMandatory | Should -Be $False - $parameter.ParameterSets['Default'].Position | Should -Be 7 + $parameter.ParameterSets['Default'].Position | Should -Be 8 $parameter.ParameterSets['Default'].ValueFromPipeline | Should -Be $False $parameter.ParameterSets['Default'].ValueFromPipelineByPropertyName | Should -Be $False $parameter.ParameterSets['Default'].ValueFromRemainingArguments | Should -Be $False $parameter.ParameterSets.Keys | Should -Contain 'Specific' $parameter.ParameterSets['Specific'].IsMandatory | Should -Be $False - $parameter.ParameterSets['Specific'].Position | Should -Be 7 + $parameter.ParameterSets['Specific'].Position | Should -Be 8 $parameter.ParameterSets['Specific'].ValueFromPipeline | Should -Be $False $parameter.ParameterSets['Specific'].ValueFromPipelineByPropertyName | Should -Be $False $parameter.ParameterSets['Specific'].ValueFromRemainingArguments | Should -Be $False @@ -144,7 +157,7 @@ Describe "Testing parameterset Specific" { <# Specific - - Specific -ComputerName -Aos -Batch -FinancialReporter -DMF -Kill -ShowOriginalProgress + Specific -ComputerName -Aos -Batch -FinancialReporter -DMF -DocumentRouting -Kill -ShowOriginalProgress #> } diff --git a/docs/AGENTS.md b/docs/AGENTS.md new file mode 100644 index 000000000..be9c0e2dc --- /dev/null +++ b/docs/AGENTS.md @@ -0,0 +1,13 @@ +# Module Documentation + +Do not hand-edit `*.md` files here. They are generated. + +To generate / update all markdown help files after adding or changing a public function, run from the repo root with PowerShell 5: + +```powershell +pwsh -NoProfile -File ./build/update-docs.ps1 +``` + +The script takes no parameters. It deletes and regenerates every `*.md` file in this folder, so always run it after a comment-based help change and include the full regeneration in your commit. + +Requires `platyPS` (`New-MarkdownHelp`). Install prerequisites with `build/vsts-prerequisites.ps1` if the help command is missing. diff --git a/docs/Get-D365Environment.md b/docs/Get-D365Environment.md index d0053db89..0a3e257f7 100644 --- a/docs/Get-D365Environment.md +++ b/docs/Get-D365Environment.md @@ -20,7 +20,7 @@ Get-D365Environment [[-ComputerName] ] [-All] [-OnlyStartTypeAutomatic ### Specific ``` -Get-D365Environment [[-ComputerName] ] [-Aos] [-Batch] [-FinancialReporter] [-DMF] +Get-D365Environment [[-ComputerName] ] [-Aos] [-Batch] [-FinancialReporter] [-DMF] [-DocumentRouting] [-OnlyStartTypeAutomatic] [-OutputServiceDetailsOnly] [] ``` @@ -67,10 +67,10 @@ Will query the Aos & Batch services on the machine. ### EXAMPLE 6 ``` -Get-D365Environment -FinancialReporter -DMF +Get-D365Environment -DocumentRouting ``` -Will query the FinancialReporter & DMF services on the machine. +Will query the DocumentRouting service on the machine. ### EXAMPLE 7 ``` @@ -112,6 +112,7 @@ Aos Batch Financial Reporter DMF +DocumentRouting ```yaml Type: SwitchParameter @@ -185,6 +186,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DocumentRouting +Instruct the cmdlet query the document routing service + +```yaml +Type: SwitchParameter +Parameter Sets: Specific +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OnlyStartTypeAutomatic Instruct the cmdlet to filter out services that are set to manual start or disabled diff --git a/docs/Get-D365LcsAssetFile.md b/docs/Get-D365LcsAssetFile.md index c28ba6b4a..ae0a20859 100644 --- a/docs/Get-D365LcsAssetFile.md +++ b/docs/Get-D365LcsAssetFile.md @@ -164,7 +164,7 @@ Default value is "Software Deployable Package" Type: LcsAssetFileType Parameter Sets: (All) Aliases: -Accepted values: Model, ProcessDataPackage, SoftwareDeployablePackage, GERConfiguration, DataPackage, PowerBIReportModel, ECommercePackage, NuGetPackage, RetailSelfServicePackage, CommerceCloudScaleUnitExtension +Accepted values: Model, ProcessDataPackage, SoftwareDeployablePackage, GERConfiguration, DataPackage, Backup, PowerBIReportModel, ECommercePackage, NuGetPackage, RetailSelfServicePackage, CommerceCloudScaleUnitExtension Required: False Position: 2 diff --git a/docs/Get-D365LcsSharedAssetFile.md b/docs/Get-D365LcsSharedAssetFile.md index 085e3c694..55e1ffd42 100644 --- a/docs/Get-D365LcsSharedAssetFile.md +++ b/docs/Get-D365LcsSharedAssetFile.md @@ -181,7 +181,7 @@ Default value is "Software Deployable Package" Type: LcsAssetFileType Parameter Sets: (All) Aliases: -Accepted values: Model, ProcessDataPackage, SoftwareDeployablePackage, GERConfiguration, DataPackage, PowerBIReportModel, ECommercePackage, NuGetPackage, RetailSelfServicePackage, CommerceCloudScaleUnitExtension +Accepted values: Model, ProcessDataPackage, SoftwareDeployablePackage, GERConfiguration, DataPackage, Backup, PowerBIReportModel, ECommercePackage, NuGetPackage, RetailSelfServicePackage, CommerceCloudScaleUnitExtension Required: False Position: 2 diff --git a/docs/Invoke-D365LcsUpload.md b/docs/Invoke-D365LcsUpload.md index e684b0b25..192c60381 100644 --- a/docs/Invoke-D365LcsUpload.md +++ b/docs/Invoke-D365LcsUpload.md @@ -160,7 +160,7 @@ Default value is "Software Deployable Package" Type: LcsAssetFileType Parameter Sets: (All) Aliases: -Accepted values: Model, ProcessDataPackage, SoftwareDeployablePackage, GERConfiguration, DataPackage, PowerBIReportModel, ECommercePackage, NuGetPackage, RetailSelfServicePackage, CommerceCloudScaleUnitExtension +Accepted values: Model, ProcessDataPackage, SoftwareDeployablePackage, GERConfiguration, DataPackage, Backup, PowerBIReportModel, ECommercePackage, NuGetPackage, RetailSelfServicePackage, CommerceCloudScaleUnitExtension Required: False Position: 4 diff --git a/docs/Invoke-D365ModuleBuild.md b/docs/Invoke-D365ModuleBuild.md index bdd7ac2da..2ed104c76 100644 --- a/docs/Invoke-D365ModuleBuild.md +++ b/docs/Invoke-D365ModuleBuild.md @@ -1,4 +1,4 @@ ---- +--- external help file: d365fo.tools-help.xml Module Name: d365fo.tools online version: @@ -15,8 +15,7 @@ Build a package / module (X++ compile + labels, reports optional) ``` Invoke-D365ModuleBuild [-Module] [[-OutputDir] ] [[-LogPath] ] [[-MetaDataDir] ] [[-ReferenceDir] ] [[-BinDir] ] [-IncludeReports] - [-ShowOriginalProgress] [-OutputCommandOnly] [[-Verbosity] ] [-ProgressAction ] - [] + [-ShowOriginalProgress] [-OutputCommandOnly] [[-Verbosity] ] [] ``` ## DESCRIPTION @@ -222,21 +221,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProgressAction -{{ Fill ProgressAction Description }} - -```yaml -Type: ActionPreference -Parameter Sets: (All) -Aliases: proga - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/docs/Restart-D365Environment.md b/docs/Restart-D365Environment.md index 0d0e6e061..411d87170 100644 --- a/docs/Restart-D365Environment.md +++ b/docs/Restart-D365Environment.md @@ -20,8 +20,8 @@ Restart-D365Environment [[-ComputerName] ] [-All] [-Kill] [-ShowOrigin ### Specific ``` -Restart-D365Environment [[-ComputerName] ] [-Aos] [-Batch] [-FinancialReporter] [-DMF] [-Kill] - [-ShowOriginalProgress] [] +Restart-D365Environment [[-ComputerName] ] [-Aos] [-Batch] [-FinancialReporter] [-DMF] + [-DocumentRouting] [-Kill] [-ShowOriginalProgress] [] ``` ## DESCRIPTION @@ -62,10 +62,10 @@ This will stop the AOS and Batch services and then start the AOS and Batch servi ### EXAMPLE 5 ``` -Restart-D365Environment -FinancialReporter -DMF +Restart-D365Environment -DocumentRouting ``` -This will stop the FinancialReporter and DMF services and then start the FinancialReporter and DMF services again. +This will stop the DocumentRouting service and then start the DocumentRouting service again. ### EXAMPLE 6 ``` @@ -100,6 +100,7 @@ Aos Batch Financial Reporter DMF +DocumentRouting ```yaml Type: SwitchParameter @@ -173,6 +174,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DocumentRouting +Instructs the cmdlet to work against the Document Routing service + +```yaml +Type: SwitchParameter +Parameter Sets: Specific +Aliases: + +Required: False +Position: 7 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kill Instructs the cmdlet to kill the service(s) that you want to restart diff --git a/docs/Start-D365Environment.md b/docs/Start-D365Environment.md index 4bb574ecd..a6bb028ab 100644 --- a/docs/Start-D365Environment.md +++ b/docs/Start-D365Environment.md @@ -21,7 +21,7 @@ Start-D365Environment [[-ComputerName] ] [-All] [-OnlyStartTypeAutomat ### Specific ``` Start-D365Environment [[-ComputerName] ] [-Aos] [-Batch] [-FinancialReporter] [-DMF] - [-OnlyStartTypeAutomatic] [-ShowOriginalProgress] [] + [-DocumentRouting] [-OnlyStartTypeAutomatic] [-ShowOriginalProgress] [] ``` ## DESCRIPTION @@ -72,10 +72,10 @@ This will start the Aos & Batch D365FO services on the machine. ### EXAMPLE 6 ``` -Start-D365Environment -FinancialReporter -DMF +Start-D365Environment -DocumentRouting ``` -This will start the FinancialReporter and DMF services on the machine. +This will start the DocumentRouting service on the machine. ## PARAMETERS @@ -101,6 +101,8 @@ Includes: Aos Batch Financial Reporter +DMF +DocumentRouting ```yaml Type: SwitchParameter @@ -174,6 +176,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DocumentRouting +Start the Document Routing service + +```yaml +Type: SwitchParameter +Parameter Sets: Specific +Aliases: + +Required: False +Position: 7 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OnlyStartTypeAutomatic Instruct the cmdlet to filter out services that are set to manual start or disabled diff --git a/docs/Start-D365EnvironmentV2.md b/docs/Start-D365EnvironmentV2.md index 84be2f719..91ce764b0 100644 --- a/docs/Start-D365EnvironmentV2.md +++ b/docs/Start-D365EnvironmentV2.md @@ -19,8 +19,8 @@ Start-D365EnvironmentV2 [-All] [-OnlyStartTypeAutomatic] [-ShowOriginalProgress] ### Specific ``` -Start-D365EnvironmentV2 [-Aos] [-Batch] [-FinancialReporter] [-DMF] [-OnlyStartTypeAutomatic] - [-ShowOriginalProgress] [] +Start-D365EnvironmentV2 [-Aos] [-Batch] [-FinancialReporter] [-DMF] [-DocumentRouting] + [-OnlyStartTypeAutomatic] [-ShowOriginalProgress] [] ``` ## DESCRIPTION @@ -71,10 +71,10 @@ This will start the Aos & Batch D365FO services on the machine. ### EXAMPLE 6 ``` -Start-D365EnvironmentV2 -FinancialReporter -DMF +Start-D365EnvironmentV2 -DocumentRouting ``` -This will start the FinancialReporter and DMF services on the machine. +This will start the DocumentRouting service on the machine. ### EXAMPLE 7 ``` @@ -171,6 +171,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DocumentRouting +Start the Document Routing service + +```yaml +Type: SwitchParameter +Parameter Sets: Specific +Aliases: + +Required: False +Position: 6 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OnlyStartTypeAutomatic Instruct the cmdlet to filter out services that are set to manual start or disabled diff --git a/docs/Stop-D365Environment.md b/docs/Stop-D365Environment.md index 17e07ea98..fbc526655 100644 --- a/docs/Stop-D365Environment.md +++ b/docs/Stop-D365Environment.md @@ -19,8 +19,8 @@ Stop-D365Environment [[-ComputerName] ] [-All] [-Kill] [-ShowOriginalP ### Specific ``` -Stop-D365Environment [[-ComputerName] ] [-Aos] [-Batch] [-FinancialReporter] [-DMF] [-Kill] - [-ShowOriginalProgress] [] +Stop-D365Environment [[-ComputerName] ] [-Aos] [-Batch] [-FinancialReporter] [-DMF] + [-DocumentRouting] [-Kill] [-ShowOriginalProgress] [] ``` ## DESCRIPTION @@ -63,10 +63,10 @@ This will stop the Aos & Batch D365FO services on the machine. ### EXAMPLE 5 ``` -Stop-D365Environment -FinancialReporter -DMF +Stop-D365Environment -DocumentRouting ``` -This will stop the FinancialReporter and DMF services on the machine. +This will stop the DocumentRouting service on the machine. ### EXAMPLE 6 ``` @@ -100,6 +100,8 @@ Includes: Aos Batch Financial Reporter +DMF +DocumentRouting ```yaml Type: SwitchParameter @@ -173,6 +175,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DocumentRouting +Stop the Document Routing service + +```yaml +Type: SwitchParameter +Parameter Sets: Specific +Aliases: + +Required: False +Position: 7 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kill Instructs the cmdlet to kill the service(s) that you want to stop @@ -182,7 +199,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 7 +Position: 8 Default value: False Accept pipeline input: False Accept wildcard characters: False @@ -199,7 +216,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 8 +Position: 9 Default value: False Accept pipeline input: False Accept wildcard characters: False From 23eccf6022c078870c72fca269804a2252b4e691 Mon Sep 17 00:00:00 2001 From: Alfi Cody Date: Tue, 22 Sep 2026 11:22:52 +0200 Subject: [PATCH 2/2] Fix: Keep FinancialReporter-DMF examples so all switches stay covered by Help.Example.Parameters tests --- d365fo.tools/functions/get-d365environment.ps1 | 5 +++++ d365fo.tools/functions/restart-d365environment.ps1 | 5 +++++ d365fo.tools/functions/start-d365environment.ps1 | 5 +++++ d365fo.tools/functions/start-d365environmentv2.ps1 | 5 +++++ d365fo.tools/functions/stop-d365environment.ps1 | 5 +++++ docs/Get-D365Environment.md | 11 +++++++++-- docs/Restart-D365Environment.md | 9 ++++++++- docs/Start-D365Environment.md | 7 +++++++ docs/Start-D365EnvironmentV2.md | 9 ++++++++- docs/Stop-D365Environment.md | 9 ++++++++- 10 files changed, 65 insertions(+), 5 deletions(-) diff --git a/d365fo.tools/functions/get-d365environment.ps1 b/d365fo.tools/functions/get-d365environment.ps1 index 9027abe33..d2b93aca7 100644 --- a/d365fo.tools/functions/get-d365environment.ps1 +++ b/d365fo.tools/functions/get-d365environment.ps1 @@ -66,6 +66,11 @@ Will query the Aos & Batch services on the machine. + .EXAMPLE + PS C:\> Get-D365Environment -FinancialReporter -DMF + + Will query the FinancialReporter & DMF services on the machine. + .EXAMPLE PS C:\> Get-D365Environment -DocumentRouting diff --git a/d365fo.tools/functions/restart-d365environment.ps1 b/d365fo.tools/functions/restart-d365environment.ps1 index 03f407a3c..fce37ff53 100644 --- a/d365fo.tools/functions/restart-d365environment.ps1 +++ b/d365fo.tools/functions/restart-d365environment.ps1 @@ -65,6 +65,11 @@ This will stop the AOS and Batch services and then start the AOS and Batch services again. + .EXAMPLE + PS C:\> Restart-D365Environment -FinancialReporter -DMF + + This will stop the FinancialReporter and DMF services and then start the FinancialReporter and DMF services again. + .EXAMPLE PS C:\> Restart-D365Environment -DocumentRouting diff --git a/d365fo.tools/functions/start-d365environment.ps1 b/d365fo.tools/functions/start-d365environment.ps1 index 5f91aacff..23838d4f7 100644 --- a/d365fo.tools/functions/start-d365environment.ps1 +++ b/d365fo.tools/functions/start-d365environment.ps1 @@ -73,6 +73,11 @@ This will start the Aos & Batch D365FO services on the machine. + .EXAMPLE + PS C:\> Start-D365Environment -FinancialReporter -DMF + + This will start the FinancialReporter and DMF services on the machine. + .EXAMPLE PS C:\> Start-D365Environment -DocumentRouting diff --git a/d365fo.tools/functions/start-d365environmentv2.ps1 b/d365fo.tools/functions/start-d365environmentv2.ps1 index f4fd1431f..6a0e1df4a 100644 --- a/d365fo.tools/functions/start-d365environmentv2.ps1 +++ b/d365fo.tools/functions/start-d365environmentv2.ps1 @@ -69,6 +69,11 @@ This will start the Aos & Batch D365FO services on the machine. + .EXAMPLE + PS C:\> Start-D365EnvironmentV2 -FinancialReporter -DMF + + This will start the FinancialReporter and DMF services on the machine. + .EXAMPLE PS C:\> Start-D365EnvironmentV2 -DocumentRouting diff --git a/d365fo.tools/functions/stop-d365environment.ps1 b/d365fo.tools/functions/stop-d365environment.ps1 index cec57134c..512df94f4 100644 --- a/d365fo.tools/functions/stop-d365environment.ps1 +++ b/d365fo.tools/functions/stop-d365environment.ps1 @@ -67,6 +67,11 @@ This will stop the Aos & Batch D365FO services on the machine. + .EXAMPLE + PS C:\> Stop-D365Environment -FinancialReporter -DMF + + This will stop the FinancialReporter and DMF services on the machine. + .EXAMPLE PS C:\> Stop-D365Environment -DocumentRouting diff --git a/docs/Get-D365Environment.md b/docs/Get-D365Environment.md index 0a3e257f7..ded3b8247 100644 --- a/docs/Get-D365Environment.md +++ b/docs/Get-D365Environment.md @@ -67,12 +67,19 @@ Will query the Aos & Batch services on the machine. ### EXAMPLE 6 ``` +Get-D365Environment -FinancialReporter -DMF +``` + +Will query the FinancialReporter & DMF services on the machine. + +### EXAMPLE 7 +``` Get-D365Environment -DocumentRouting ``` Will query the DocumentRouting service on the machine. -### EXAMPLE 7 +### EXAMPLE 8 ``` Get-D365Environment -OutputServiceDetailsOnly ``` @@ -80,7 +87,7 @@ Get-D365Environment -OutputServiceDetailsOnly Will query all D365FO service on the machine. Will omit the servername from the output. -### EXAMPLE 8 +### EXAMPLE 9 ``` Get-D365Environment -FinancialReporter | Set-Service -StartupType Manual ``` diff --git a/docs/Restart-D365Environment.md b/docs/Restart-D365Environment.md index 411d87170..f6fe9102e 100644 --- a/docs/Restart-D365Environment.md +++ b/docs/Restart-D365Environment.md @@ -62,12 +62,19 @@ This will stop the AOS and Batch services and then start the AOS and Batch servi ### EXAMPLE 5 ``` +Restart-D365Environment -FinancialReporter -DMF +``` + +This will stop the FinancialReporter and DMF services and then start the FinancialReporter and DMF services again. + +### EXAMPLE 6 +``` Restart-D365Environment -DocumentRouting ``` This will stop the DocumentRouting service and then start the DocumentRouting service again. -### EXAMPLE 6 +### EXAMPLE 7 ``` Restart-D365Environment -All -Kill ``` diff --git a/docs/Start-D365Environment.md b/docs/Start-D365Environment.md index a6bb028ab..d288515d8 100644 --- a/docs/Start-D365Environment.md +++ b/docs/Start-D365Environment.md @@ -72,6 +72,13 @@ This will start the Aos & Batch D365FO services on the machine. ### EXAMPLE 6 ``` +Start-D365Environment -FinancialReporter -DMF +``` + +This will start the FinancialReporter and DMF services on the machine. + +### EXAMPLE 7 +``` Start-D365Environment -DocumentRouting ``` diff --git a/docs/Start-D365EnvironmentV2.md b/docs/Start-D365EnvironmentV2.md index 91ce764b0..72c25d129 100644 --- a/docs/Start-D365EnvironmentV2.md +++ b/docs/Start-D365EnvironmentV2.md @@ -71,12 +71,19 @@ This will start the Aos & Batch D365FO services on the machine. ### EXAMPLE 6 ``` +Start-D365EnvironmentV2 -FinancialReporter -DMF +``` + +This will start the FinancialReporter and DMF services on the machine. + +### EXAMPLE 7 +``` Start-D365EnvironmentV2 -DocumentRouting ``` This will start the DocumentRouting service on the machine. -### EXAMPLE 7 +### EXAMPLE 8 ``` Enable-D365Exception ``` diff --git a/docs/Stop-D365Environment.md b/docs/Stop-D365Environment.md index fbc526655..ce78f3fc5 100644 --- a/docs/Stop-D365Environment.md +++ b/docs/Stop-D365Environment.md @@ -63,12 +63,19 @@ This will stop the Aos & Batch D365FO services on the machine. ### EXAMPLE 5 ``` +Stop-D365Environment -FinancialReporter -DMF +``` + +This will stop the FinancialReporter and DMF services on the machine. + +### EXAMPLE 6 +``` Stop-D365Environment -DocumentRouting ``` This will stop the DocumentRouting service on the machine. -### EXAMPLE 6 +### EXAMPLE 7 ``` Stop-D365Environment -All -Kill ```