Catalog Compare Documentation

Version 11.1.2.0

Getting Started

Prerequisites

Before installing CatalogCompare, confirm that your environment meets the following requirements:

  • SQL Server 2012 or later — any edition that supports SSIS (Standard, Enterprise, or Developer). Express edition does not include SSIS.
  • SSIS Catalog (SSISDB) — must exist on the SQL Server instance. CatalogCompare connects to the SSIS Catalog to browse and compare catalog artifacts.
  • .NET Framework 4.8 — must be installed on the machine where CatalogCompare will run. Included with Windows 10 version 1903 and later.
  • Windows — CatalogCompare is a Windows desktop application.

Installation

CatalogCompare is installed using the DILM Installation Manager (DIM). If you do not already have DIM installed, download it from dilmsuite.com.

  1. Launch DILM Installation Manager from the Windows Start Menu: Start > DILMSuite > DILM Installation Manager.
  2. DIM loads the product catalog and displays available products.
  3. Locate the CatalogCompare product card.
  4. Click the Install button on the CatalogCompare card.
  5. DIM downloads the installer, verifies its integrity, and launches the MSI.
  6. Windows displays a User Account Control (UAC) prompt. Click Yes to allow the installation.
  7. CatalogCompare is installed to C:\Program Files\DILMSuite\CatalogCompare\ and is available from the Start Menu under DILMSuite.

Subscription Activation

CatalogCompare requires an active DILM Suite subscription. On first launch, you must verify your subscription by entering your purchase credentials. This is a one-time process.

What You Need

  • Order Number — the numeric order number from your DILM Suite purchase confirmation email or your account at dilmsuite.com
  • Email Address — the email address used when purchasing the subscription

Activating Your Subscription

  1. Launch CatalogCompare from the Windows Start Menu: Start > DILMSuite > CatalogCompare.
  2. On first launch, the application starts in limited mode. The status bar indicates that subscription information needs to be configured.
  3. Click View on the menu bar, then click Subscription.
  4. The DILMSuite Subscription Viewer dialog opens.
  5. In the Order Number field, enter your order number.
  6. In the Email field, enter the email address from your purchase.
  7. Click the Load button.
  8. When verification succeeds, the dialog populates with your subscription details.
  9. Confirm the status shows active, then click OK.

After activation, the status bar updates with your subscription details and all features become available. Your credentials are stored locally and you will not be prompted again on future launches.

Free Trials

A DILM Suite free trial is a fully functional subscription with an end date. If your order is a free trial, activate it exactly as described above — enter your order number and email and click Load. During the trial, all features are enabled and the status bar shows Free Trial along with the number of days remaining and the trial end date. When the trial period ends, the subscription is treated as expired until you convert it to a paid subscription.

Next Steps

Continue to Connecting to a Catalog to connect CatalogCompare to your SSIS Catalog instances.

Back to top

Connecting to SSIS Catalogs

CatalogCompare displays two side-by-side panes. Each pane can be loaded from a separate SSIS Catalog instance — or from a catalog manifest file (see Loading a Catalog Manifest File below). To get started, connect the left pane to your first catalog.

Connecting to the First Catalog

  1. In the left pane, locate the Source text box at the top. (The label reads Source: while the pane is empty. After a live connection it changes to SQL Server Instance:; after loading a manifest file it reads Catalog Manifest File:.)
  2. Type the name of the SQL Server instance that hosts your SSIS Catalog — for example, localhost, MYSERVER, or MYSERVER\SQL2019. You can leave it blank and pick a server from the connection dialog instead.
  3. Click the Connect button next to the text box.
  4. The Connect dialog opens (described in detail below). Choose your authentication method, confirm or change the server name, and supply credentials if your authentication method requires them.
  5. Optionally click Test Connection to verify the server is reachable and that the target catalog exists before connecting.
  6. Click Connect to connect. On a successful connection, the left pane displays the catalog tree for that instance.

To disconnect, click the Clear button next to the Connect button. This clears the tree and resets the pane.

Right-clicking the Source text box opens a context menu with the standard edit commands (Cut, Copy, Paste, Select All) plus Connect… and Load Catalog Manifest… — so both ways of loading a pane are also available directly from the text box. The … button between the text box and the Connect button is a third shortcut for loading a manifest file.

Connecting to a Second Catalog

To compare two SSIS Catalog instances side by side, connect the right pane to a second catalog.

  1. In the right pane, locate the Source text box.
  2. Type the name of the second SQL Server instance, or leave it blank to pick one in the dialog.
  3. Click the Connect button.
  4. Complete the Connect dialog as described above.
  5. On a successful connection, the right pane displays the catalog tree for the second instance.

Both panes operate independently. You can connect, disconnect, and reconnect either pane without affecting the other.

The Connect Dialog

Clicking Connect opens a connection dialog modeled on the SQL Server Management Studio (SSMS) “Connect to Server” experience. The same dialog is shared across the DILM Suite, so it behaves identically here and in the DILM Deployment Utility. The dialog is a single window with four tabs — Connection, Browse, History, and Connection String — with a shared status line and the Test Connection, Connect, and Cancel buttons below the tabs.

Connection Tab

The Connection tab holds the connection fields:

  • Server name — the SQL Server instance hosting the catalog. This is a drop-down that remembers servers you have connected to before (see Recent Servers below). Type a name or pick a recent one. Pressing Enter here connects immediately when the authentication method needs no credentials, or moves focus to the User name field when it does.
  • Database name — the database the connection targets. It defaults to SSISDB, the Integration Services catalog — the correct value for CatalogCompare, so you can normally leave it alone. The box is an editable drop-down: opening it retrieves the list of databases from the server using the credentials currently entered in the dialog (the list is fetched once per server-and-credentials combination; if retrieval fails, the box stays typeable and a message appears in the status line).
  • Authentication — the method used to sign in. The list mirrors SSMS:
    • Windows Authentication — connect using your current Windows account. No user name or password is needed.
    • SQL Server Authentication — connect with a SQL login. Enter the User name and Password.
    • Microsoft Entra methods — for Azure SQL Database and Azure SQL Managed Instance: Entra Password, Entra Integrated, Entra MFA (interactive multi-factor), Entra Managed Identity, Entra Service Principal, and Entra Default. The User name and Password fields are enabled, relabeled, or disabled to match the method (for example, Service Principal uses the user name as the client ID and the password as the client secret; Managed Identity and Default need no credentials).
  • User name / Password — enabled only for the authentication methods that require them; the credential rows are hidden entirely for methods that need none. Passwords are used for the current connection only and are never written to disk.
  • Encryption — how the connection is encrypted: Optional, Mandatory (the default), or Strict (TDS 8.0). With Strict, the server certificate is always validated and Trust server certificate is disabled.
  • Trust server certificate — when checked, the server’s TLS certificate is accepted without validating its chain. Useful for on-premises servers with self-signed certificates. Disabled when Encryption is Strict.
  • Advanced… — opens an Advanced Properties dialog (a property grid mirroring SSMS’s advanced connection options: timeouts, MARS, application intent, packet size, connection resiliency, and similar). Only values you change from their defaults are added to the connection string. Your advanced settings are remembered between sessions.

Browse Tab

The Browse tab discovers servers: Local Servers (instances installed on this machine, including LocalDB), Network Servers (instances on the network whose SQL Server Browser service responds), and Registered Servers (servers you have registered in SSMS). Double-click a server to fill in the Server name field on the Connection tab.

History Tab

The History tab lists your recent connections — the same most-recently-used list that feeds the Server name drop-down, shown with the authentication, encryption, and trust-certificate choices recorded for each server. Pick an entry to populate the Connection tab with those values.

Connection String Tab

The Connection String tab shows the connection string that the current field values produce — and it is editable. Copy and Paste exchange the string with the clipboard, Apply parses an edited string back into the Connection tab fields, and Reset regenerates the string from the current fields. The password is never displayed or copied — it appears as a fixed run of bullet characters; leaving that mask untouched keeps the current password, while typing anything else sets a new one.

Buttons

  • Test Connection — attempts the connection and confirms the target database (SSISDB by default) exists, without committing. Use it to validate credentials before connecting.
  • Connect — commits the connection and closes the dialog.
  • Cancel — closes the dialog without connecting.

The target catalog is SSISDB — CatalogCompare connects to the Integration Services catalog on the instance you select, and the Database name box defaults accordingly.

Recent Servers and Re-Prompting

The Server name drop-down is a most-recently-used (MRU) list. After a successful connection, CatalogCompare adds the server — along with the authentication method, encryption, and trust-certificate choices you used — to the list, so reconnecting later is a single pick. The list holds your ten most recent servers, most recent first. Passwords are never stored in the MRU; you re-enter them (when the method requires one) on each connection.

Every time you click Connect, CatalogCompare re-opens the dialog so you can confirm or change the server and credentials — it does not silently reuse a prior connection. To make reconnecting fast, the dialog is pre-filled with the choices from your current session, so you can simply click Connect to reconnect to the same server.

Loading a Catalog Manifest File

Either pane can be loaded from a catalog manifest file (*.catalog.manifest.json) instead of a live connection. A manifest is a point-in-time snapshot of a catalog’s metadata — folders, projects, packages, parameters, environments, variables, connections, and references. Loading one produces a file-backed side that browses and compares exactly like a live one, so you can compare a live catalog against yesterday’s snapshot, or compare two snapshot files against each other with no connection to either server.

Where Manifest Files Come From

CatalogCompare writes them automatically. Set the Manifest JSON folder on the Script Locations tab in Options; from then on, every time a catalog is loaded or refreshed in either pane, CatalogCompare refreshes that catalog’s manifest at:

<Manifest JSON folder>\<server-instance>\<server-instance>_<catalog>.catalog.manifest.json

For example, connecting to instance d2\Dev with a Manifest JSON folder of E:\dilm\manifests writes E:\dilm\manifests\d2_Dev\d2_Dev_SSISDB.catalog.manifest.json. Each server instance gets its own subfolder, so snapshots from multiple servers coexist under one root. When the Manifest JSON folder is not configured (the default), no manifests are written.

Loading a Manifest

Each pane offers three equivalent entry points:

  • Click Support > Load Catalog Manifest > Catalog 1… (or Catalog 2…) on the menu bar.
  • Click the … button between the pane’s Source text box and its Connect button.
  • Right-click the Source text box and click Load Catalog Manifest….

An Open dialog appears, filtered to *.catalog.manifest.json and starting in the configured Manifest JSON folder (when one is set). Pick a manifest file, and CatalogCompare imports it and populates the pane’s catalog tree.

Working with a File-Backed Side

  • The pane’s header label changes to Catalog Manifest File: and the text box shows the manifest path. The status bar shows the originating server name with a (file) suffix — for example, Instance 1: d2\Dev (file) — while the tree root shows the server name unsuffixed, so comparison output reads naturally.
  • If the import encounters recoverable problems, the status bar reports the warning count; details are written to the application log.
  • F5 (or a Refresh command) re-imports the manifest file from disk, just as it reloads a live catalog on a connected side.
  • The Connect button still reads Connect: clicking it starts a live connection that replaces the file-backed side.
  • The Clear button resets the pane, same as for a live side.
  • Catalog Statistics is not available for a file-backed side (statistics are gathered from the live server).
  • Comparison works normally in every combination — live vs. live, file vs. live, and file vs. file. Actions that must read from or write to a side’s server are disabled while that side is file-backed; see Comparing Against a Catalog Manifest for the details, including which deployments still work from a manifest to a live catalog.

Understanding the Catalog Tree

After connecting, each pane displays a tree view of the SSIS Catalog hierarchy. The tree is organized as follows:

SQL Server Instance (root)
└── SSISDB Catalog
    ├── Catalog Properties
    │   └── [Property Name]: [Value]
    └── Folder
        ├── Projects
        │   └── Project
        │       ├── Project Connections
        │       ├── Project Parameters
        │       ├── Project References
        │       └── Packages
        │           └── Package
        │               ├── Package Properties
        │               ├── Package Connections
        │               ├── Package Parameters
        │               └── Package References
        └── Environments
            └── Environment
                └── Environment Variable [DataType]: Value
  • SQL Server Instance — the root node, showing the server name you entered
  • SSISDB Catalog — the Integration Services catalog on that instance
  • Catalog Properties — server-level catalog configuration values
  • Folders — organizational containers within the catalog. Each folder can contain projects and environments.
  • Projects — deployed SSIS projects. Expand a project to see its connections, parameters, package references, and packages.
  • Packages — individual SSIS packages within a project. Expand a package to see its properties, connections, parameters, and references.
  • Environments — collections of environment variables used to parameterize project and package execution. Each variable shows its data type and value.

Next Steps

Continue to Viewing Catalog Artifacts to learn how to navigate the tree and inspect artifact details.

Back to top

Viewing Catalog Artifacts

After connecting to a catalog (see Connecting to SSIS Catalogs), the pane displays a tree view of the catalog hierarchy. You can expand any node to reveal its children.

  • Click the expand arrow to the left of a node, or double-click the node, to expand it.
  • The tree hierarchy follows the structure described in the Connecting chapter: SQL Server Instance > SSISDB Catalog > Folder > Projects / Environments.
  • Expanding a folder reveals its Projects container and its Environments container.
  • Each level can be expanded further to drill into specific artifacts.

Viewing Project Properties

Expanding a project node reveals the following child nodes:

  • Project Connections — connection managers configured at the project level
  • Project Parameters — project-level parameters and their current values
  • Project References — environment references associated with the project
  • Packages — the individual SSIS packages deployed in the project

Expanding a package node reveals additional detail:

  • Package Properties — metadata about the package, such as its description and version
  • Package Connections — connection managers defined at the package level
  • Package Parameters — package-level parameters and their current values
  • Package References — environment references scoped to the package

Each of these nodes represents the artifact data stored in the SSIS Catalog for that project or package.

Viewing Package Contents

When Compare Package Contents is enabled in the Options dialog (see Options), each package node carries an additional Contents node. Expanding it reveals the package’s internal design — the same objects you would see if you opened the package in the SSIS designer — read from the package’s .dtsx definition. The Contents subtree is organized into these categories:

  • Package Properties — package-level properties captured from the .dtsx.
  • Connection Managers (in package) — connection managers defined inside the package, distinct from the catalog-level Package Connections node described above.
  • Log Providers — the package’s configured log providers.
  • Parameters (in package) — package parameters as defined in the .dtsx.
  • Executables — the package’s control flow: its tasks and containers. Expanding a task or container reveals its own Properties and, where applicable, nested Components (for a Data Flow Task), nested Executables, Precedence Constraints, Event Handlers, and Variables.
  • Precedence Constraints — the constraints that connect executables in the control flow.
  • Event Handlers — event handlers defined on the package.
  • Variables — package-scoped variables.

Most items expand to a Properties folder listing their individual property values; long values are truncated in the tree with an ellipsis (…). To keep the tree responsive, very large property lists load on demand — an [Expand N properties] or [Show remaining N properties] node appears, and clicking it loads the rest.

The Contents subtree is populated when you connect, and a comparison colors it just like the rest of the tree. See Comparing Catalogs for how content differences are surfaced and the Options chapter for the compare-depth and content-related settings.

Viewing Environments and Variables

Expanding the Environments container under a folder reveals the environments defined in that folder. Expanding an environment node reveals its variables.

Each environment variable appears in the tree in the format:

Environment Variable [DataType]: Value

For example, a connection string variable might appear as Environment Variable [String]: Data Source=MYSERVER;....

Environment variables are used to parameterize project and package execution by mapping variable values to project or package parameters through references.

Expanding and Collapsing Nodes

CatalogCompare provides a right-click context menu with expand and collapse options to help you manage tree depth without manually expanding each node.

To expand a node and all its descendants at once:

  1. Right-click a node in the tree — for example, a folder or a project.
  2. Click Expand All… from the context menu.
  3. The selected node and all child nodes expand to show full detail.

Collapse All… reverses this operation, collapsing the selected node and all its descendants. Expand Differences… is useful after comparing two catalogs — it expands only nodes that contain differences. This option is covered in the Comparing Catalogs chapter.

The project-level context menu also provides granular expand options that expand only to a specific depth within the project:

  • Expand to Project Connections…
  • Expand to Project Parameters…
  • Expand to Project References…
  • Expand to Packages…

The folder-level context menu provides similar options:

  • Expand to Projects…
  • Expand to Environments…

These options are useful when you want to inspect a specific artifact type without expanding all nested levels.

Next Steps

Continue to Comparing Catalogs to learn how to compare two connected catalog instances and interpret the results.

Back to top

Comparing Catalogs

Initiating a Comparison

Before comparing, load both panes — from live SSIS Catalog instances, from catalog manifest files, or one of each (see Connecting to SSIS Catalogs).

  1. Connect the left pane to the first catalog instance (or load a catalog manifest file).
  2. Connect the right pane to the second catalog instance (or load a catalog manifest file).
  3. Click the Compare button at the bottom-left of the form.
  4. CatalogCompare compares the two catalog trees and applies color and font indicators to nodes that differ.

To refresh both catalogs and re-run the comparison in one action, right-click any node and click Refresh Both TreeViews and Compare… from the context menu. This reloads both catalog trees and immediately performs a new comparison — useful when the catalogs may have changed since the last load.

After a comparison, the right-click context menu on any node includes Expand Differences…. This option recursively expands only the nodes that contain differences, making it easy to locate changes without manually expanding every level. To perform this expansion automatically after each comparison, enable the AutomaticallyExpandDifferencesAfterCompare option in the settings.

Comparing Against a Catalog Manifest

Either pane can be loaded from a catalog manifest file instead of a live connection — see Loading a Catalog Manifest File. Comparison behaves identically in every combination: live vs. live, file vs. live, and file vs. file. Diff indicators, Expand Differences, package content comparison, and the Package Version Mismatch report all work the same way against a file-backed side.

A file-backed side carries the full catalog model but has no server behind it, so the context-menu actions adjust to what is possible:

Available on a file-backed side — everything that works from the model alone: browsing and item detail, comparison, single-artifact Generate Script… for environments and references, parameter and connection parameter literal scripts, the Git / Markdown exports, and the Package Version Mismatch report.

Disabled while a side is file-backed — actions that must read from or write to that side’s server: Add Folder, Rename Folder…, Delete Folder… and Delete All Folders, Delete Project… / Delete Environment… / Delete Reference…, Update Value… on environment variables, Export ISPAC (the project binary is fetched from the live server, not from the manifest), folder- and catalog-level script generation (Generate Script… on a folder, Generate Scripts for Folder and Contents…, Generate All Catalog Scripts, and the Generate Scripts for Differences… variants), and refreshing contents from the server.

Deploying from a manifest to a live catalog works for the artifacts CatalogCompare recreates from the model: Deploy Environment…, Deploy Reference(s)…, and the parameter / connection parameter literal deployments are enabled from a file-backed source to a live target. (They are disabled when the target side is the file-backed one — there is no server to deploy to.) Deployments that ship the project binary — Deploy Project…, Deploy Package(s)…, Deploy Folder…, and the folder-level deploy-all / deploy-differences operations — require both sides to be live.

Reading Diff Indicators

After a comparison, CatalogCompare applies visual indicators to nodes based on whether they match, differ, or are absent in the opposite catalog.

Different nodes stand out with distinct colors in each pane. In the left pane, nodes that differ from the right catalog display blue text on a light blue background. In the right pane, nodes that differ from the left catalog display dark green text on a light green background. These colors make differing nodes immediately visible at a glance.

Ancestor nodes of different nodes display italic text, inheriting the same color as their pane — blue italic in the left pane, dark green italic in the right pane. This propagation signals that a difference exists somewhere below that node, so you can spot where changes are located without expanding every level of the tree.

Matching nodes — nodes that are identical in both catalogs — keep their default appearance: black text on a white background. No indicator is applied when the values match.

Missing nodes — nodes that exist in one catalog but not the other — simply do not appear in the opposite pane. The absence of a node is the indicator itself.

Broken references — environment references that do not resolve to a valid environment — display dark gray text on a WhiteSmoke background, distinguishing them from both matching and differing nodes.

Comparing Package Contents

When Compare Package Contents is enabled (see Options), a comparison looks inside each package and colors its Contents subtree using the same difference indicators as the rest of the tree. An item whose internal design differs between the two catalogs — a changed task property, an added variable, a modified connection manager — is painted in the difference color, and its parent category folder and the package’s Contents node inherit that color. This lets you spot which packages drifted internally, and where, without expanding every one.

The Compare Depth option controls how much detail the comparison surfaces: at Identity you learn only that a package’s contents differ, while TopProperties, AllProperties, and IncludeScriptBodies progressively reveal which elements and property values changed. See Options for the full description of these settings and of Ignore Layout and Ignore Log Providers, which suppress categories of change that are usually noise.

Note that the Ignore VersionGUID option is enabled by default, so a package whose only difference is the VersionGUID that SSIS rewrites on every save is not flagged as changed. Turn that option off if you want VersionGUID differences reported.

Values Everywhere

Values Everywhere surfaces where an environment variable’s value flows across the catalog. For any parameter whose value is set by an environment reference — where the ValueState is Referenced — CatalogCompare traces which environment variable drives it and displays child nodes under the parameter. These child nodes show:

  • The reference name, in the format EnvironmentVariable-->ParameterName
  • The actual value drawn from the environment variable

This lets you see the downstream impact of an environment variable. Every parameter that references it appears with its resolved value, so you can understand how a single variable affects multiple packages, projects, or parameters across the catalog.

During a comparison, Values Everywhere child nodes inherit their parent parameter’s diff colors. If the resolved value differs between the two catalogs, the child node displays in blue (left pane) or dark green (right pane), using the same indicators described in the previous section. This makes differences in referenced values visible at the same level of detail as any other catalog artifact.

Package Version Mismatch Report

The Package Version Mismatch Report surfaces every package whose version differs between the paired catalogs, including packages that exist in only one catalog. The report is available at three scopes: a single project, a folder, or an entire catalog.

Launching the report

  1. Connect both panes and run a Compare.
  2. Right-click a project, a folder, or the SSISDB catalog node in either pane.
  3. Click Package Version Mismatches… from the context menu.

The report opens in its own window, with columns for Folder, Project, Package, the version from each catalog, and a Differs On column describing which fields drove the mismatch (for example, “Version”, “Presence”).

Filtering results

The Differs On column header exposes a drop-down multi-select filter. Check one or more values to show only those rows; uncheck all to clear the filter. The empty-state overlay follows the filtered row count, so it is immediately obvious when a filter has hidden every row.

You can also right-click any cell to filter by that cell’s exact value. The same context menu includes a Clear Filter command that restores the full row set.

Exporting results

The toolbar at the top of the report includes Copy, CSV, and Markdown export actions. Exported files are named using the scope type and scope name, so files from different scopes don’t overwrite each other:

  • Project-scope file: <ServerName>_<FolderName>_<ProjectName>.<ext>
  • Folder-scope file: <ServerName>_Folder-<FolderName>.<ext>
  • Catalog-scope file: <Catalog1ServerName>_Catalog.<ext>

The catalog-scope filename includes the originating Catalog 1 instance name so multiple catalog-vs-catalog comparisons written into the same folder don’t collide.

Deploying from the report

The Deploy Selected… button deploys the highlighted rows’ packages from Catalog 1 to Catalog 2 using the same incremental deploy_packages path as the tree’s Deploy Packages… action, grouped by folder and project. Select one or more rows (Ctrl+click and Shift+click work as usual), click Deploy Selected…, and confirm.

  • Rows showing (missing) in the Catalog 1 column are skipped — there is nothing on Catalog 1 to deploy. Deploying in the other direction, or removing the extra package from Catalog 2, is done from the catalog trees.
  • Rows whose project does not exist on Catalog 2 are skipped — deploy_packages requires an existing target project. Use Deploy Project… from the tree first.
  • Successfully deployed rows are grayed out; the grid intentionally keeps showing the pre-deploy comparison values. Re-run Compare to refresh.
  • The button requires live connections on both sides; it is disabled when either pane was loaded from a catalog manifest file.

Window placement

The report’s size, location, and maximized state are remembered between sessions. If your display configuration changes, CatalogCompare clamps the restored window to the working area of an available screen so the report always opens somewhere visible.

Deploying Packages Between Catalogs

Once a comparison identifies a package or project that needs to move, you can deploy packages directly from one catalog to the paired catalog without leaving CatalogCompare. Deployment uses the SSIS 2019+ [catalog].deploy_packages interface and surfaces the SSISDB operation_id in the status bar on completion.

Deploying a single package

  1. In either catalog pane, expand the tree to the package you want to deploy.
  2. Right-click the package node.
  3. Click Deploy Package… from the context menu.
  4. In the destination picker, select the target folder and project on the paired catalog. The destination folder and project must already exist.
  5. CatalogCompare extracts the target .dtsx from the source project’s ispac, submits it to the destination catalog, and reports the SSISDB operation_id in the status bar.

Package-scope parameters are registered automatically by SSISDB during deployment; you do not need to enumerate or send them separately.

Deploying multiple packages in one batch

  1. In either catalog pane, right-click the source project node.
  2. Click Deploy Packages… from the context menu.
  3. In the modal that opens, tick the packages you want to deploy. Select All, Select None, and Select Mismatched helpers are available above the list. Select Mismatched auto-checks every package whose paired counterpart on the other catalog differs by Version, GUID, or Comments — letting you deploy only the packages that actually drifted, without scanning the list by hand. The button is disabled until a Compare has run and at least one mismatched package exists.
  4. Pick a destination folder and project on the paired catalog when prompted.
  5. Click Deploy. All selected packages are sent in a single deploy_packages call with an N-row table-valued parameter, producing one SSISDB operation_id that appears in the status bar.

The batch flow avoids per-package round-trips to SSISDB, so deploying a dozen packages takes roughly the same time as deploying one.

Back to top

Options

CatalogCompare’s Options dialog controls comparison behavior, logging, confirmation dialogs, scripting, and output folder locations. To open the dialog, click View > Options… on the menu bar.

The SSIS Catalog Compare Options dialog is organized into six tabs — Compare Options, Logging, Confirmation Dialogs, Scripting Options, Admin Folder, and Script Locations — with the OK, Save, Load, and Cancel buttons below the tabs. The sections that follow describe each tab.

Compare Options

Compare Options checkboxes control which catalog artifacts and values participate in comparisons. Enable a checkbox to exclude the corresponding category from comparison results.

  • Ignore Case Sensitivity (Values Only) — when enabled, value comparisons treat uppercase and lowercase characters as identical. Applies only to values, not to artifact names.
  • Ignore Catalog Environment Variable Values — when enabled, environment variable values are excluded from comparison results. Environment variables still appear in the tree, but value differences are not flagged.
  • Ignore Catalog Broken Environments — when enabled, environment references that do not resolve to a valid environment are excluded from comparison results.
  • Ignore Override Values — when enabled, parameter override values are excluded from comparison results.
  • Ignore Sensitive Value Mismatches — when enabled, parameters marked as sensitive are excluded from comparison results. Sensitive values cannot be read from the catalog, so they always appear as mismatches unless this option is enabled.
  • Ignore Catalog Properties — when enabled, catalog-level properties (such as default logging level and retention period) are excluded from comparison results.
  • Ignore Package Properties — when enabled, package-level properties are excluded from comparison results.
  • Ignore Package Version — when enabled, package version differences are excluded from comparison results. Disabled by default.
  • Ignore VersionGUID — when enabled, differences in a package’s VersionGUID are not flagged. SSIS regenerates this GUID every time a package is saved, so it changes even when nothing meaningful about the package has changed. Enabled by default so routine save churn does not surface as a difference. This option is independent of Ignore Package Version and Ignore Package Properties — the VersionGUID is still loaded and displayed in the tree; only its mismatches are suppressed.
  • Ignore Project Parameters — when enabled, project-level parameters are excluded from the match-and-color pass. Useful when environment-specific project parameters legitimately diverge between catalogs and you want to focus the comparison on deployed assets.
  • Ignore Package Parameters — when enabled, package-level parameters are excluded from comparison results, including one-sided parameters that exist in only one catalog. Mirrors the Ignore Package Properties behavior.
  • Ignore Connections — when enabled, connection manager entries are excluded from comparison results.
  • Hide Data Type — when enabled, data type information is hidden from the tree display. Data type nodes still participate in comparison logic but are not visible.
  • Don’t Zip Scripts — when enabled, scripting operations produce individual script files instead of packaging them into ZIP archives (SCCPAC or CATPAC files).
  • Automatically Expand Differences After Compare — when enabled, CatalogCompare automatically expands all nodes that contain differences after each comparison completes, removing the need to manually expand or use the right-click Expand Differences option.

Package Content Compare

The Compare Options tab also hosts the Package Content Compare group. Package Content Compare looks inside each SSIS package (.dtsx) and compares its internal design — tasks, connection managers, parameters, variables, precedence constraints, event handlers, and log providers — so you can see exactly what changed within a package, not just that its version differs. When enabled, each package node gains a Contents subtree (see Viewing Catalog Artifacts) that is diff-colored after a comparison.

  • Compare Package Contents — the master switch for the feature. When enabled (the default), CatalogCompare parses each package’s contents and compares them during a Compare. When disabled, the Contents subtree is not built and package internals are not compared. The remaining controls in this group are active only when this box is checked.
  • Compare Depth — controls how deeply the content comparison descends when it finds a changed item:
    • Identity (hash only) — compares a hash of each package’s contents. Fastest; tells you that a package’s contents differ without listing which elements changed.
    • TopProperties (the default) — compares the top-level properties of each changed item. A balance of detail and speed.
    • AllProperties — walks every property, including nested elements, for a full attribute-level diff.
    • IncludeScriptBodies — everything in AllProperties plus the decoded source of Script Tasks and Script Components. The most thorough and the slowest.
  • Ignore Layout (designer position/size) — when enabled (the default), purely cosmetic designer coordinates (the position and size of items on the design surface) are excluded, so moving a task on the canvas is not reported as a difference.
  • Ignore Log Providers — when enabled (the default), a package’s log providers are excluded from the content comparison, since these are frequently deploy-time-only differences.

Logging

  • Log Depth — controls the detail level of application logging. Available levels:
    • Light — logs high-level operations only
    • Medium — logs operations and key decision points
    • Heavy — logs detailed operation steps and intermediate values
    • Extreme — logs everything, including low-level data; useful for troubleshooting
  • Log File Retention Days — controls how long log files are kept before automatic cleanup. Available values: 7, 15, 30, 90, 180, or 360 days.

Confirmation Dialogs

CatalogCompare displays confirmation dialogs before deploy operations. Each checkbox suppresses a specific confirmation dialog.

  • Don’t Show Folder Deploy Confirmation Dialog — suppresses the confirmation prompt before deploying a folder.
  • Don’t Show Project Deploy Confirmation Dialog — suppresses the confirmation prompt before deploying a project.
  • Don’t Show Project Overrides Deploy Confirmation Dialog — suppresses the confirmation prompt before deploying project parameter overrides.
  • Don’t Show Environment Deploy Confirmation Dialog — suppresses the confirmation prompt before deploying an environment.
  • Don’t Show Reference Deploy Confirmation Dialog — suppresses the confirmation prompt before deploying an environment reference.
  • Don’t Show Connection Deploy Confirmation Dialog — suppresses the confirmation prompt before deploying a connection.

Scripting Options

  • Use SSMS Templates — when enabled, generated scripts use SQL Server Management Studio template syntax, inserting template parameters (such as server name) that SSMS can prompt for at execution time. When disabled, scripts contain literal values.
  • Clear Target Directory Before Scripting Starts — when enabled, CatalogCompare deletes all existing files in the script output directory before generating new scripts. This prevents stale scripts from previous runs from mixing with current output.

Script Locations

The Script Locations tab gathers every output folder CatalogCompare writes to — the admin folder, scripting archives, manifest snapshots, and the export destinations (formerly separate Admin Folder and Export Locations tabs) — in one place. Click the browse button next to any row to select a folder.

  • Admin Folder — the directory used for administrative script output; it acts as the default parent location for the other folders on this tab. It is also the default location offered when saving an options file with the Save button.
  • SCCPAC Folder — the directory where SCCPAC (SSIS Catalog Compare Package) files are written.
  • CATPAC Folder — the directory where CATPAC (Catalog Package) files are written.
  • Manifest JSON — the root folder for automatic catalog manifest snapshots. When set, every catalog load or refresh writes (or refreshes) that catalog’s <server-instance>_<catalog>.catalog.manifest.json file into a per-instance subfolder of this root. The folder is also the starting location for the Load Catalog Manifest open dialog. Leave it blank (the default) to disable manifest snapshots. See Loading a Catalog Manifest File.
  • Git Export — the default directory for git-friendly exports (Export Catalog for Git, Export Folder for Git). CatalogCompare remembers the last folder used and pre-selects it for subsequent git exports.
  • MD Export — the default directory for Markdown exports (Export Catalog/Folder to Markdown and the differences-only variants).
  • Version Diffs — the directory where the Package Version Mismatch report writes its CSV and Markdown export files.

For details on export operations, see Exporting Catalog Data.

Saving and Loading Settings

The Options dialog includes four buttons at the bottom for managing settings:

  • OK — applies the current settings to the running session and closes the dialog.
  • Save — writes the current settings to a JSON file at a location you choose (the dialog starts in your configured Admin Folder). Use Save to create a portable settings file that can be shared or reloaded later.
  • Load — reads settings from a previously saved JSON file and populates the dialog with those values. After loading, click OK to apply the loaded settings to the current session.
  • Cancel — closes the dialog without applying any changes.

Automatic Persistence

In addition to the explicit Save button, CatalogCompare automatically persists the current Options to %LOCALAPPDATA%\SSIS Catalog Compare\options.json. This cross-session store is written when you apply changes and when the application closes, and it is loaded automatically on the next launch, so your preferences survive a restart — and application updates — without any manual export step. (On the first launch after upgrading from an older build, settings are migrated once from the legacy %APPDATA%\DILMSuite\CatalogCompare\options.json location.)

Next Steps

Continue to Exporting Catalog Data to learn how to export catalog metadata as JSON or ISPAC files, or skip ahead to Scripting Catalogs for SQL script generation.

Back to top

Exporting Catalog Data

CatalogCompare can export catalog artifacts as ISPAC project archives, git-friendly JSON snapshots, or Markdown documents. Exports capture the current state of catalog objects in portable formats for documentation, version control, or offline review. All export operations require a valid DILM Suite subscription.

This chapter covers ISPAC export for deployable project archives, Git export for version-control-friendly JSON snapshots, Markdown export for AI-readable documents, and the automatic catalog manifest snapshots that feed the Load Catalog Manifest feature.

Note: Earlier versions offered a raw JSON export (Export Catalog/Folder/Project…). That export was removed in v11.0 — the automatic catalog manifest snapshots (below) supersede it with a curated, versioned, re-loadable format.

ISPAC Export

ISPAC export extracts a project from the catalog as an Integration Services Project Archive (.ispac) file. ISPAC files are the standard deployment format for SSIS projects and can be deployed directly using SQL Server Management Studio, the SSIS deployment wizard, or CatalogCompare’s DILM Deployment Utility.

  1. In either catalog pane, expand the tree to locate the project.
  2. Right-click the project node.
  3. Click Export ISPAC from the context menu.
  4. In the folder browser dialog, select the destination folder.
  5. Click OK. CatalogCompare extracts the ISPAC file and writes it to the selected folder.

The status bar confirms the export path on success. CatalogCompare remembers the last folder used for ISPAC exports between operations.

Git Export

Git export writes catalog metadata as deterministic, git-friendly JSON files organized into a folder structure that mirrors the catalog hierarchy. This format is designed for committing to a Git repository, where sorted keys, consistent formatting, and one-file-per-artifact make diffs meaningful and merges manageable. Git export requires a valid DILM Suite subscription.

Output Structure

Git export creates a directory tree that mirrors the catalog structure:

<export-root>/
  <server-name>/
    <folder-name>/
      folder.json
      environments/
        <environment-name>.json
      projects/
        <project-name>/
          project.json
          parameters.json
          packages/
            <package-name>.json
          connections/
            <connection-name>.json
          references/
            <reference-name>.json

Each JSON file is formatted for clean diffs:

  • Properties are sorted alphabetically by key
  • Indented for readability
  • Null and default values are omitted
  • UTF-8 encoding without BOM
  • Sensitive values are replaced with <sensitive>

Exporting a Catalog for Git

  1. In either catalog pane, right-click the SSISDB catalog node.
  2. Click Export Catalog for Git… from the context menu.
  3. In the folder browser dialog, select the root export folder.
  4. Click OK. CatalogCompare writes JSON files for every folder, project, environment, package, connection, and reference in the catalog.

The status bar confirms the export path on success.

Exporting a Folder for Git

  1. In either catalog pane, expand the tree to locate the folder.
  2. Right-click the folder node.
  3. Click Export Folder for Git… from the context menu.
  4. In the folder browser dialog, select the root export folder.
  5. Click OK. CatalogCompare writes JSON files for the folder and all its contents.

Git Export Folder Setting

CatalogCompare remembers the last Git export folder used and pre-selects it in the folder browser dialog for subsequent exports. The default folder can also be set in Options on the Script Locations tab.

Markdown Export

Markdown export writes catalog content as Markdown files designed for AI analysis. Unlike Git export (version-control-friendly JSON), Markdown export produces human-readable, token-efficient documents that large language models can parse directly. The feature produces one .md file per catalog folder, making it easy to feed a single folder’s contents — or an entire catalog — to an AI tool for review. Markdown export requires a valid DILM Suite subscription.

Exporting a Folder to Markdown

  1. In either catalog pane, expand the tree to locate the folder.
  2. Right-click the folder node.
  3. Click Export Folder to Markdown… from the context menu.
  4. In the folder browser dialog, select the destination folder.
  5. Click OK. CatalogCompare writes <ServerName>_<FolderName>.md containing the folder’s projects, packages, parameters, environments, connections, and references.

The status bar confirms the export path on success.

Exporting a Catalog to Markdown

  1. In either catalog pane, right-click the SSISDB catalog node.
  2. Click Export Catalog to Markdown… from the context menu.
  3. In the folder browser dialog, select the destination folder.
  4. Click OK. CatalogCompare writes one .md file per catalog folder into the selected destination.

Exporting Differences Only

After a Compare operation, Markdown export offers differences-only variants that write only nodes flagged as mismatched — the same nodes highlighted by the existing Expand Differences option. Output filenames end in .diff.md to distinguish them from full exports. Unlike full exports, the diff files land in a per-instance subdirectory of the selected destination (<destination>\<server-instance>\, mirroring the manifest snapshot layout) so diff sets from different instances don’t mingle. Menu items are disabled until a Compare has been run.

  1. Run a Compare operation between two catalogs.
  2. Right-click a folder or the catalog node.
  3. Click Export Folder Differences to Markdown… or Export Catalog Differences to Markdown….
  4. Select the destination folder and click OK.

Only folders that contain at least one mismatched item produce a .diff.md file; folders with no differences are skipped.

Markdown Export Output

Each .md file includes the folder metadata, environments, projects, packages, parameters, connections, and references rendered as headings, bullet lists, and tables:

  • Properties are sorted alphabetically within each collection
  • Sensitive parameter values are replaced with <sensitive>
  • Empty sections are omitted
  • UTF-8 encoding without BOM

Markdown Export Folder Setting

CatalogCompare remembers the last Markdown export folder used and pre-selects it in the folder browser dialog for subsequent exports. The setting persists between sessions.

Catalog Manifest Snapshots (Automatic)

Unlike the exports above, catalog manifest snapshots are written automatically — there is no menu command. When a Manifest JSON folder is configured in Options on the Script Locations tab, every catalog load or refresh writes (or refreshes) a machine-readable snapshot of that catalog:

<Manifest JSON folder>\<server-instance>\<server-instance>_<catalog>.catalog.manifest.json

Each server instance gets its own subfolder under the root, so snapshots from multiple servers coexist. The snapshot captures the catalog’s folders, projects, packages, parameters, environments, variables, connections, and references as of that load.

Manifest files exist to be loaded back into CatalogCompare: either pane can open one in place of a live connection, enabling offline and point-in-time comparisons (file vs. live, or file vs. file). See Loading a Catalog Manifest File.

When no Manifest JSON folder is configured (the default), no snapshots are written. A snapshot failure never interrupts the catalog load — it is logged and reported in the status bar.

Next Steps

For script generation (SQL scripts and SCCPAC/CATPAC archives), see Scripting Catalogs. For export folder configuration, see Options.

Back to top

Scripting Catalogs

CatalogCompare can generate deployment scripts for SSIS Catalog artifacts — from a single project or environment up to the entire catalog. Scripts capture the current state of catalog objects so they can be recreated on another server or saved for version control. This chapter covers all scripting workflows, starting with individual artifacts and building up to full catalog export.

Script Naming Convention

Before the walkthroughs, it helps to understand how generated scripts are named so you can identify output files. Scripts follow this naming convention:

<Order>_<ServerName>_<CatalogName>_<FolderName>_[ObjectName].<ObjectType>.sql

The order prefix determines deployment sequence:

  • 1 — folder creation scripts
  • 2 — project deployment scripts (ISPAC files use the project name instead of this pattern)
  • 3 — package parameter scripts
  • 4 — environment scripts
  • 5 — environment reference scripts

Generating a Script for an Individual Artifact

The simplest scripting operation generates a script for a single catalog artifact. The type of output depends on the artifact — projects produce ISPAC files, while all other artifacts (folders, environments, environment references) produce SQL scripts.

Projects

A project’s script equivalent is its ISPAC file. Right-click the project node and click Export ISPAC from the context menu — see Exporting Catalog Data for the walkthrough.

An ISPAC (Integration Services Project Archive) file contains the compiled project and can be deployed directly using SQL Server Management Studio or the SSIS deployment wizard. Because the project binary is fetched from the live server, Export ISPAC is not available on a side loaded from a catalog manifest file.

Folders

  1. In either catalog pane, expand the tree to locate the folder.
  2. Right-click the folder node.
  3. Click Generate Script… from the context menu.
  4. CatalogCompare generates a SQL script that recreates the folder. The script is named using the pattern 1_<ServerName>_<CatalogName>_<FolderName>.folder.sql.

Environments

  1. In either catalog pane, expand the tree to locate the environment.
  2. Right-click the environment node.
  3. Click Generate Script… from the context menu.
  4. CatalogCompare generates a SQL script that recreates the environment and its variables. The script is named using the pattern 4_<ServerName>_<CatalogName>_<FolderName>_<EnvironmentName>.environment.sql.

Environment References

  1. In either catalog pane, expand the tree to locate the environment reference under a project.
  2. Right-click the reference node.
  3. Click Generate Script… from the context menu.
  4. CatalogCompare generates a SQL script that recreates the environment reference.

Script output location is controlled by the SCCPAC Folder setting in Options.

Generating Scripts for a Folder and Contents

Folder-level scripting generates scripts for a folder and everything it contains — all projects, environments, and references. The result is a complete set of individual scripts plus an SCCPAC archive that bundles them together.

  1. In either catalog pane, expand the tree to locate the folder.
  2. Right-click the folder node.
  3. Click Generate Scripts for Folder and Contents… from the context menu.
  4. CatalogCompare generates individual scripts for the folder and all its child artifacts (projects as ISPAC files, other artifacts as SQL scripts).
  5. After individual scripts are generated, CatalogCompare packages them into an SCCPAC file — a ZIP archive named after the folder.

The SCCPAC file is written to the SCCPAC Folder configured in Options. If the Don’t Zip Scripts option is enabled in Options, the individual scripts are generated but the SCCPAC archive is not created.

Generating All Catalog Scripts

Full catalog scripting generates scripts for every folder in the catalog and bundles them into a single CATPAC archive. This is the most comprehensive scripting operation.

  1. In either catalog pane, right-click the SSISDB catalog node at the top of the tree.
  2. Click Generate All Catalog Scripts from the context menu.
  3. CatalogCompare generates scripts for every folder and its contents, producing individual SQL scripts and ISPAC files for all artifacts.
  4. Each folder’s scripts are packaged into an SCCPAC file.
  5. All SCCPAC files are then bundled into a single CATPAC file.

The CATPAC file is written to the CATPAC Folder configured in Options.

If the Clear Target Directory Before Scripting Starts option is enabled in Options, the output directory is emptied before the scripting operation begins. This prevents stale scripts from previous runs from mixing with current output.

Additional Scripting Operations

Beyond the primary scripting workflows above, CatalogCompare provides specialized scripting operations for parameters, connections, environments, references, and differences. These operations are available from context menus throughout the catalog tree.

Parameter Scripts

Parameter scripts generate SQL that sets parameter values to their current literal values.

  • Generate Project Parameter Literals Scripts… — right-click a project to generate scripts that set all project parameter values to their current literals. Useful for capturing the current parameter state for deployment to another environment.
  • Generate Project Parameter Literals Diff Scripts… — right-click a project after a comparison to generate scripts only for project parameters that differ between the two catalogs. Requires a prior comparison.
  • Generate Package Parameter Literals Scripts… — right-click a package to generate scripts that set all package parameter values to their current literals.

Connection Parameter Scripts

Connection parameter scripts generate SQL that sets connection-related parameter values.

  • Generate Project Connection Parameter Literals Scripts… — right-click a project to generate scripts that set connection parameter values to their current literals.
  • Generate Project Connection Parameter Literals Diff Scripts… — right-click a project after a comparison to generate scripts only for connection parameters that differ. Requires a prior comparison.
  • Generate Package Connections Parameter Literals Scripts… — right-click a package to generate scripts that set package connection parameter values to their current literals.

Environment Scripts

  • Generate All Environment Scripts… — right-click the Environments node under a folder to generate scripts for all environments in that folder at once, rather than scripting them individually.

Reference Scripts

  • Generate All Project Reference Scripts… — right-click the References node under a project to generate scripts for all environment references assigned to that project at once.

Diff Scripts

Diff scripts generate SQL only for artifacts that differ between the two catalogs. These operations require a prior comparison.

  • Generate Scripts for Differences… (folder level) — right-click a folder after a comparison to generate scripts only for artifacts within that folder that differ between the two catalogs.
  • Generate Scripts for Differences… (catalog level) — right-click the SSISDB catalog node after a comparison to generate scripts for all differences across the entire catalog.

SCCPAC and CATPAC Archive Hierarchy

CatalogCompare uses two archive formats to package generated scripts: SCCPAC files for folder-level archives and CATPAC files for catalog-level archives. Understanding the hierarchy helps you work with these files and extract the scripts you need.

SCCPAC Files

An SCCPAC (SSIS Catalog Compare Package) file is a ZIP archive that contains all scripts for a single catalog folder. Inside an SCCPAC you will find:

  • Folder creation script — SQL script that recreates the folder (prefix 1)
  • Project ISPAC files — one ISPAC per project in the folder
  • Environment scripts — SQL scripts that recreate environments and their variables (prefix 4)
  • Reference scripts — SQL scripts that recreate environment references (prefix 5)

The SCCPAC file is named after the folder it represents. For example, a folder named “ETL” produces an SCCPAC file named ETL.sccpac.

CATPAC Files

A CATPAC (Catalog Package) file is a ZIP archive that contains all SCCPAC files from a catalog. The hierarchy is:

  • CATPAC (.catpac)
    • SCCPAC (.sccpac) — one per folder
      • Individual scripts (SQL and ISPAC files)

A CATPAC represents a complete snapshot of the catalog’s scriptable artifacts. To restore a full catalog, extract the CATPAC, then extract each SCCPAC, and deploy the individual scripts in order prefix sequence.

Relationship to the Catalog Tree

The archive hierarchy mirrors the catalog tree structure:

  • The SSISDB catalog maps to a single CATPAC file
  • Each folder in the catalog maps to an SCCPAC file inside the CATPAC
  • Each artifact (project, environment, reference) within a folder maps to an individual script inside the SCCPAC

This one-to-one mapping means you can locate any artifact’s script by following the same path you would use in the catalog tree.

If the Don’t Zip Scripts option is enabled in Options, scripting operations produce the individual scripts but skip the SCCPAC and CATPAC archive creation step.

Next Steps

This is the final chapter in the CatalogCompare documentation. For exporting catalog data as JSON or ISPAC files, see Exporting Catalog Data. For configuration reference, see Options. For a complete table of contents, return to the CatalogCompare User Documentation.

Back to top

SSIS Catalog Compare is part of the DILM Suite. Documentation version 1.0.0.