Skip to content

Installing MetaDataTool

The Streaming Integration Platform depends on the presence of several types of metadata, some of which is produced by a .NET command line utility called metadatatool, which can be installed on a suitable Linux or Windows system.

Install MetaDataTool

dotnet tool install -g Synergex.MetaDataTool

As the tool is installed you should see messages like this:

You can invoke the tool using the following command: metadatatool
Tool 'synergex.metadatatool' (version '1.0.26245.2131') was successfully installed.

Verify MetaDataTool was installed

metadatatool

You should see help information, like this:

MetaDataTool is a command-line utility to generate various kinds of metadata
useful when working with the Streaming Integration Platform, Gantry SQL, and
Synergy repositories.

Usage: metadatatool <mode> [<arguments>]

Modes:

   addkeys        Adds ISAM key definition SDL snippets to SDL schema files.
   help           Show this information.
   isamfdl        Generate ISAM metadata from FDL files.
   isamfile       Generate ISAM metadata from ISAM files.
   keysdl         Generate ISAM key definition SDL snippets.
   sql            Generate SQL metadata from repository definitions.
   update         Check NuGet.org for a newer version of this tool.
   version        Print version information.

To uninstall: dotnet tool uninstall --global Synergex.MetaDataTool

In isamfdl mode the utility reads one or more OpenVMS FDL files and produces
ISAM metadata files.

In isamfile mode the utility reads one or more SDMS ISAM files and produces
ISAM metadata files.

In keysdl mode the utility reads a combination of ISAM and Synergy repository
metadata and produces Synergy Data Language (SDL) files containing SDL key
definition snippets that can be added to existing structure definitions.

In addkeys mode the utility adds key-definition snippets produced by keysdl to
existing SDL schema files.

In sql mode the utility reads one or more FILE definitions from a Synergy
repository and produces SQL metadata files.