Intent JSON Metadata Synchronizer

The Intent JSON Metadata Synchronizer CLI tool can be used to synchronize an object graph in a JSON file into an Intent Architect package within any supported designer. It supports importing into various Intent Architect specialization types, making it suitable for a wide range of domain modeling scenarios, including traditional domain models and integration events.

The tool supports configurable specialization types and profiles, allowing you to import JSON data into custom Intent Architect element types tailored to the selected profile and target package. For example, the "DomainDocumentDB" profile targets domain-related specializations (e.g., classes and attributes), while "EventingMessages" targets event-related types (e.g., messages and properties).

Pre-requisites

Latest Long Term Support (LTS) version of .NET.

Installation

The tool is available as a .NET Tool and can be installed with the following command:

dotnet tool install Intent.MetadataSynchronizer.Json.CLI --global --prerelease

Note

If dotnet tool install fails with an error to the effect of The required NuGet feed can't be accessed, perhaps because of an Internet connection problem. and it shows a private NuGet feed URL, you can try add the --ignore-failed-sources command line option (source).

You should see output to the effect of:

You can invoke the tool using the following command: intent-json-metadata-synchronizer
Tool 'intent.metadatasynchronizer.json.cli' (version 'x.x.x') was successfully installed.

Usage

intent-json-metadata-synchronizer [options]

Options

Option	Description
--config-file <config-file>	Path to a JSON formatted file containing options to use for execution of this tool as an alternative to using command line options. The --generate-config-file option can be used to generate a file with all the possible fields populated with null.
--generate-config-file	Scaffolds into the current working directory a "config.json" for use with the --config-file option.
--source-json-folder <source-json-folder>	The path to the folder containing JSON files to parse and synchronize into the Intent Architect Package.
--isln-file <isln-file>	The Intent Architect solution (.isln) file containing the Intent Architect Application into which to synchronize the metadata.
--application-name <application-name>	The name of the Intent Architect Application (as per the Application Settings view) containing the Intent Architect Package into which to synchronize the metadata.
--package-id <package-id>	The id of the Intent Architect Package containing the Intent Architect Package into which to synchronize the metadata.
--target-folder-id <target-folder-id>	The target folder within the Intent Architect package into which to synchronize the metadata. If unspecified then the metadata will be synchronized into the root of the Intent Architect package.
--casing-convention <AsIs/PascalCase>	Casing convention to be applied on imported elements. Options are PascalCase or AsIs.
--profile <DomainDocumentDB/EventingMessages>	Import profile to use. "DomainDocumentDB" for traditional domain models with Document DB annotations. "EventingMessages" for integration events. Defaults to "DomainDocumentDB".
--version	Show version information
-?, -h, --help	Show help and usage information

Configuration file

The --config-file option expects the name of a file containing configuration options to be used as an alternative to adding them as CLI options. A template for the configuration file can be generated using the --generate-config-file option. The content of the generated template is as follows:

{
  "SourceJsonFolder": null,
  "IslnFile": null,
  "ApplicationName": null,
  "PackageId": null,
  "TargetFolderId": null,
  "CasingConvention": "AsIs",
  "Profile": "DomainDocumentDB"
}

Profile Configuration

The tool supports profile-based configuration to automatically set appropriate specialization types and annotation styles for different use cases:

• Profile: The import profile to use. Options are:
  • "DomainDocumentDB": For traditional domain models with classes, attributes, and Document DB annotations (primary key stereotypes applied to "Id" attributes). This is the default.
  • "EventingMessages": For integration events with custom specialization types and no primary key stereotypes.

For example, to import JSON data as integration events:

{
  "Profile": "EventingMessages"
}

The profile automatically configures all specialization types and annotation behavior. For advanced customization, you can modify the profile settings in the source code.