Share via

Merge-NAVApplicationObject

Module:
Microsoft.Dynamics.Nav.Model.Tools Module

Compares the changes that have been made to application objects between two versions of Business Central, and applies the difference to a third set of application objects. The result of the merge is a number of text files with the merged application objects. Any conflicts that the cmdlet cannot merge are identified in conflict files.

Syntax

Default (Default) 

Merge-NAVApplicationObject
    [-OriginalPath] <String[]>
    [-ModifiedPath] <String[]>
    [-TargetPath] <String[]>
    [-ResultPath] <String>
    [-PassThru]
    [-Legacy]
    [-DateTimeProperty <DateTimePropertyAction>]
    [-ModifiedProperty <ModifiedPropertyAction>]
    [-VersionListProperty <VersionListPropertyAction>]
    [-DocumentationConflict <DocumentationConflictAction>]
    [-Strict]
    [-Force]
    [-DisableCommentOut]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use the Merge-NAVApplicationObject cmdlet to calculate the changes that have been made to application objects between two versions of Business Central, and to apply the difference to a third set of application objects. You specify an original version and compare that to a latest version. The difference is then applied to the target version. The result of the merge is a number of text files with the merged application objects. Any conflicts that the cmdlet cannot merge are identified in conflict files.

For example, you can use the cmdlet to apply changes from an update to your version of Business Central. The following list provides examples of the parameter values that you can specify when you merge versions of Business Central:

OriginalPath - Objects from the Microsoft release of Business Central.

ModifiedPath - Objects from your solution based on Business Central, such as MySolution.

TargetPath - Objects from the updated version of Business Central, such as Cumulative Update 1.

ResultPath - Text files with the result of the merge, such as MySolution upgraded to Business Central Cumulative Update 1.

The Merge-NAVApplicationObject cmdlet compares OriginalPath to ModifiedPath, applies as many changes as possible to TargetPath, and the resulting text files are stored in the folder that is specified by the ResultPath parameter.

Examples

EXAMPLE 1

Merge-NAVApplicationObject -OriginalPath C:\Microsoft\NAV\DE\RTM\*.TXT -TargetPath C:\Microsoft\NAV\DE\CU1\*.TXT -ModifiedPath C:\Solution\NAV\DE\RTM\*.TXT -ResultPath C:\Solution\NAV\DE\CU1\
          Processed 14 objects:
          Inserted   0 objects
          Deleted    0 objects
          Merged     3 objects
          Identical  9 objects
          Conflict   2 objects
          Failed     0 objects
          Processed 5 changes:
          Conflict   1 changes
          % Merged   80,00

This example compares the application objects from the German version of Business Central to a customized solution that modified that version. The result of the comparison is applied to the German version of Business Central Cumulative Update 1. The final result is stored in the folder that is specified in the -ResultPath parameter. When the merge completes, the summary of the result is shown.

EXAMPLE 2

Merge-NAVApplicationObject -OriginalPath C:\Solution\ORIGINAL\COD1-RTM.TXT -ModifiedPath C:\Solution\MODIFIED\My-COD1-RTM.txt -TargetPath C:\Solution\TARGET\COD1-CU1.TXT -ResultPath C:\Solution\RESULT\My-COD1-CU1.TXT - -PassThru

This example compares a text file with codeunit 1 from the original release of Business Central to a modified version of codeunit 1. The result of the comparison is applied to a version of codeunit 1 from Cumulative Update 1. The final result is stored in the file that is specified in the -ResultPath parameter. When the merge completes, the summary of the result is shown.

EXAMPLE 3

Merge-NAVApplicationObject -OriginalPath C:\Solution\ORIGINAL\*.TXT -ModifiedPath C:\Solution\MODIFIED\*.txt -TargetPath C:\Solution\TARGET\*.TXT -ResultPath C:\Solution\RESULT\ -PassThru | Sort-Object ObjectType, Id | Format-Table


ObjectType  Id  MergeResult  Original              Target                 Modified               Result                 Conflict               Error
----------  --  -----------  --------              ------                 --------               ------                 --------               -----
Codeunit    1   Conflict     C:\Solution\ORIGIN...  C:\Solution\TARGET...  C:\Solution\MODIFI...  C:\Solution\RESULT...  C:\Solution\CONFLI...
Codeunit    6   Merged       C:\Solution\ORIGIN...  C:\Solution\TARGET...  C:\Solution\MODIFI...  C:\Solution\RESULT...
Codeunit    7   Identical    C:\Solution\ORIGIN...  C:\Solution\TARGET...  C:\Solution\MODIFI...  C:\Solution\RESULT...
Codeunit    8   Conflict     C:\Solution\ORIGIN...  C:\Solution\TARGET...  C:\Solution\MODIFI...  C:\Solution\RESULT...  C:\Solution\CONFLI...
Codeunit    9   Merged       C:\Solution\ORIGIN...  C:\Solution\TARGET...  C:\Solution\MODIFI...  C:\Solution\RESULT...
Page        6   Identical    C:\Solution\ORIGIN...  C:\Solution\TARGET...  C:\Solution\MODIFI...  C:\Solution\RESULT...
Page        7   Identical    C:\Solution\ORIGIN...  C:\Solution\TARGET...  C:\Solution\MODIFI...  C:\Solution\RESULT...
Table       4   Identical    C:\Solution\ORIGIN...  C:\Solution\TARGET...  C:\Solution\MODIFI...  C:\Solution\RESULT...
Table       14  Identical    C:\Solution\ORIGIN...  C:\Solution\TARGET...  C:\Solution\MODIFI...  C:\Solution\RESULT...

This example compares two sets of text files and applies the result of the comparison to a third version. The final result is stored in the folder that is specified in the -ResultPath parameter. When the merge completes, the summary of the result is shown as a table.

EXAMPLE 4

$myVariable = Merge-NAVApplicationObject -OriginalPath .\ORIGINAL\*.txt -TargetPath .\TARGET\*.txt
          -ModifiedPath .\MODIFIED\*.txt -ResultPath .\RESULT -Force

          $myVariable.Summary

          $myVariable |
          Where-Object MergeResult -eq 'Conflict' |
          Select Original, Target |
          Format-List
          Processed 14 objects:
          Inserted   0 objects
          Deleted    0 objects
          Merged     3 objects
          Identical  9 objects
          Conflict   2 objects
          Failed     0 objects
          Processed 5 changes:   Conflict   1 changes
          % Merged   80,00


          OriginalPath : C:\Solution\ORIGINAL\COD1.TXT
          TargetPath   : C:\Solution\TARGET\COD1.TXT

          OriginalPath : C:\Solution\ORIGINAL\COD8.TXT
          TargetPath   : C:\Solution\TARGET\COD8.TXT

This example compares two sets of text files and applies the result of the comparison to a third version. The final result is stored in the folder that is specified in the -ResultPath parameter. When the merge completes, the files with conflicting code are shown in a list.

EXAMPLE 5

Merge-NAVApplicationObject -OriginalPath .\ORIGINAL\*.txt -TargetPath .\TARGET\*.txt
          -ModifiedPath .\MODIFIED\*.txt -ResultPath .\RESULT -Force -PassThru |

          Where-Object MergeResult -eq 'Conflict' |
          foreach { NOTEPAD.EXE $_.Conflict }

This example compares two sets of text files and applies the result of the comparison to a third version. The final result is stored in the folder that is specified in the -ResultPath parameter. When the merge completes, the files with conflicting code are opened in Notepad.

EXAMPLE 6

Merge-NAVApplicationObject -OriginalPath .\ORIGINAL\pag9999.txt -ModifiedPath .\MODIFIED\pag9999.txt `
          -TargetPath .\TARGET\pag9999.txt -ResultPath .\RESULT\pag9999a.txt -Force -DocumentationConflict Strict

          Merge-NAVApplicationObject -OriginalPath .\ORIGINAL\pag9999.txt -ModifiedPath .\MODIFIED\pag9999.txt `
          -TargetPath .\TARGET\pag9999.txt -ResultPath .\RESULT\pag9999a.txt -Force -DocumentationConflict ModifiedFirst
          Processed 1 objects:
          Inserted   0 objects
          Deleted    0 objects
          Merged     0 objects
          Identical  0 objects
          Conflict   1 objects
          Failed     0 objects
          Processed 2 changes:
          Conflict   1 changes
          % Merged   50,00

          Processed 1 objects:
          Inserted   0 objects
          Deleted    0 objects
          Merged     1 objects
          Identical  0 objects
          Conflict   0 objects
          Failed     0 objects
          Processed 2 changes:
          Conflict   0 changes
          % Merged   100,00

This example compares the documentation triggers in two versions of a page object and applies the result of the comparison to a third version. The final result is stored in the file that is specified in the -ResultPath parameter. This is then repeated. In the first command, the -DocumentationConflict parameter is set to Strict so that conflicting documentation is captured as conflicts. In the second command, the conflicting entries are both inserted into the resulting file with the content from MODIFIED listed first. When the merge completes, a summary of the merge is shown.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DateTimeProperty

Specifies the value of the Date and Time properties for the merged application objects. The following options are available:

Now

In the result of the application merge, the Date and Time properties are set to the current date and time.

Clear

In the result of the application merge, the Date and Time properties are empty.

FromTarget

In the result of the application merge, the Date and Time properties are set to the value from the target application objects. This is the default value.

FromModified

In the result of the application merge, the Date and Time properties are set to the value from the modified application objects.

Parameter properties

Type:DateTimePropertyAction
Default value:None
Accepted values:Now, Clear, FromTarget, FromModified
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableCommentOut

Specifies if the cmdlet must not comment out merged code that cannot be imported into the development environment.

Merged code is passed through a simple parser, and any indication that it cannot be imported into the development environment results in commenting out the code. Use this parameter to disable this functionality. Code can be commented out if the merge results in unbalanced BEGIN and END statements, such as if both MODIFIED and TARGET contain an END statement.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DocumentationConflict

Specifies how conflicting lines in documentation triggers are merged. Set this parameter when you are merging objects with the same type of content in the documentation trigger, such as technical descriptions or a version list. The following options are available:

Strict

Conflicting lines of documentation are reported as conflicts in the same way as all other conflicts. Use this value when the objects contain technical descriptions in the documentation triggers.

ModifiedFirst

Conflicting lines of documentation are merged into the result file with the content from the modified object listed first. Use this value when the objects contain version history in the documentation triggers. This is the default value.

TargetFirst

Conflicting lines of documentation are merged into the result file with the content from the target object listed first. Use this value when the objects contain version history in the documentation triggers.

Parameter properties

Type:DocumentationConflictAction
Default value:None
Accepted values:Strict, ModifiedFirst, TargetFirst
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Forces the cmdlet to overwrite any existing files in the Result folder.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Legacy

Reduces the scope of the cmdlet. Do not set this parameter.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DevBaseCompatibility

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ModifiedPath

Specifies the application objects that you want to compare to the original version.

For example, to compare all text files in the MODIFIED folder that is a subfolder to the current folder, type .\MODIFIED*.txt.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Modified

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ModifiedProperty

Specifies the value of the Modified property for the merged application objects. The following options are available:

Yes

In the result of the application merge, the Modified property is set to Yes.

No

In the result of the application merge, the Modified property is set to No.

FromTarget

In the result of the application merge, the Modified property is set to the value from the target application objects. This is the default value.

FromModified

In the result of the application merge, the Modified property is set to the value from the modified application objects.

Parameter properties

Type:ModifiedPropertyAction
Default value:None
Accepted values:Yes, No, FromTarget, FromModified
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OriginalPath

Specifies the application objects that are the baseline of the file comparison.

For example, to use all text files in the ORIGINAL folder that is a subfolder to the current folder, type .\ORIGINAL*.txt.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Original

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Specifies if the cmdlet must return a FileInfo object for each .delta file that is created by the comparison. If you do not set this parameter, the cmdlet returns a list of the files.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResultPath

Specifies the folder where the result of the merge between the two versions of application objects must be put. The folder must already exist.

For example, to use the RESULT folder that is a subfolder to the current folder, type .\RESULT.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Result

Parameter sets

(All)
Position:4
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Strict

Specifies if the cmdlet must report all conflicts, including non-functional conflicts such as the order in which variables or methods are listed in the text files. If this parameter is not set, these conflicts are suppressed to reduce "noise".

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TargetPath

Specifies the application objects that the difference between the original version and the modified version must be applied to.

For example, to use all txt files in the TARGET folder that is a subfolder to the current folder, type .\ TARGET*.txt.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Target

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VersionListProperty

Specifies if you want to update the Version List property for the application objects. The default value is Clear. The following options are available:

Clear

In the result of the application merge, the Version List property is empty. This is the default value.

FromTarget

In the result of the application merge, the Version List property is set to the value from the target application objects.

FromModified

In the result of the application merge, the Version List property is set to the value from the modified application objects.

Parameter properties

Type:VersionListPropertyAction
Default value:None
Accepted values:Clear, FromTarget, FromModified
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

A summary of all the merge operations or an object representing each merge operation individually.

When you use the PassThru parameter, the Merge-NAVApplicationObject cmdlet returns an object that represents each merge operation. Otherwise, an object representing just a summary is returned.