Comparing and Merging Process Apps

This topic describes how to use the compare and merge feature. For high-level information and use cases, see Compare and Merge.

To compare two process apps:

Open one of the process apps. This needs to be the process app that you want to merge items into, and is referred to as the "open process app."
Select Compare from the Composer menu, and then select the process app that you want to compare to the open process app. This is referred to as the "comparison process app" and will be displayed on the right, while the open process app will be displayed on the left. To open this process app, do one of the following:
- Choose With Local File to compare with a blueprint file stored on your computer. In the standard Windows dialog box that opens, locate the file (typically with an .msd extension), and then click Open.
- Choose With Published Process App to compare with a process app stored in the repository: In the Select Published Process App Dialog Box, select the version of the published process app, and then click Open.
- Choose With recently compared Local File to compare with the last process app you compared that is stored on your computer.
The Compare Process Apps Mode opens. The comparison process starts, and a progress bar is displayed at the bottom of the window.
After the comparison process finishes, the differences are highlighted in the colors shown in the Legend. A Comparison Report at the top of the editor uses a callout to textually summarize each change in both process apps.
If you click an item in App Explorer in either the Comparison Report, the open process app, or the comparison process app, the item opens in the other two areas as well. The views are synchronized, so you can see the item side-by-side for easy comparison. If an item only exists on one side, an explanatory message is displayed on the other side.

To copy items:

In the comparison process app, right-click the item you want to copy.
Select Copy to Open Process App. This command is only available for items that can be copied (that is, items that do not exist in the open process app).
Note: For performance reasons, the comparison is not fully updated automatically. A "comparison is out-of-date link warns you about this. Click the link or the Refresh button at the top right corner to update the comparison.

Note: The following limitations currently apply:

You cannot merge the properties of an item; you must manually change them. For example, if the Size value on the Options tab of a Text field Property Editor differs, you must type the comparison value into the Property Editor for the field in the open process app. (Alternatively, you can delete the field from the open process app and then copy it from the comparison process app.) However, you can copy objects in an item; for example, if a Multi-Selection field has an additional value in the comparison process app, you can copy it from the Options tab of the Property Editor for the field.
Related items are not copied along with an item. For example, when you copy a state to an open process app, the connecting transitions are not copied with it. In some cases, if a related item is essential to an item you want to copy, you must copy the related item first. For example, if a form exists only in the comparison process app, and the form is based on a table that is only in the comparison process app, you must copy the table first. SBM Composer provides a warning in this case.

To dismiss an item:

Click the callout in the Comparison Report. If the Show dismissed items check box is selected at the top of the report or in the Options menu, the item is crossed out and a lighter shade; otherwise, it is hidden. Dismissed items are not highlighted as differences in the comparison process app or open process app.
CAUTION:
The state of an item persists in subsequent comparison sessions, if the sessions are consecutive. For example, if you dismiss an item, close the comparison or close SBM Composer, and then run the comparison again in a later session, dismissed items remain dismissed. However, if you compare with a different process app between sessions, the item will no longer be dismissed when you resume the comparison.

To restore a dismissed item:

Make sure the Show dismissed items check box is selected.
Click the callout.

To restore all dismissed items:

Select Restore Dismissed Differences in the Options menu.

To hide translated strings:

Select the Ignore localizable properties check box on the Comparison Report or in the Options menu at the top of the report.

To hide unchanged items:

Clear the Show unchanged items in collections check box on the Comparison Report or in the Options menu at the top of the report.

To export the comparison report:

Click Export at the top right corner.
Browse to the folder where you want to store the report, and then click OK.

Three files are placed in the folder. Open the HTML file named "report" to view the report.

To close the comparison:

Click the Close Comparison button at the top right corner. The normal view of the open process app is restored.

To change the comparison colors:

Click Composer Options on the Composer menu.
Click the Comparison tab.
Change the colors as described in Comparison Options.

To store, restore, or reset the layout of the three windows in comparison mode:

Click Layout at the top right corner.
Do one of the following:
- Click Store Layout to store the current layout as a custom layout.
- Click Restore Layout to arrange the windows using the stored custom layout.
- Click Reset Layout to arrange the windows using the default layout.
- Click Auto Restore if you want the windows to be arranged using the stored custom layout every time you enter comparison mode.

For more information about these options, see Compare Process Apps Mode.