Search Documentation by Keyword

Invoke-MedmComponent

You are here:
← All Topics

Executes a Markit EDM component from the command line using the CADISProcessAgent executable. Internally, this cmdlet is invoked by Test-MedmComponent.

Inject data and perform other pre-execution data manipulation using the -SetupSqlDir and -SetupSqlFiles parameters. SQL scripts will be executed against the database, and CSV files will be imported as described in Import-CsvTable.

If specified, -CleanupSqlDir and -CleanupSqlFiles indicate any SQL scripts to be run in order to clean up after component execution and restore system state.

All -xxxSqlFiles parameters provide an array of regex patterns. Files will be recursively located in directory -xxxSqlDir, and executed or imported in the order listed. If a given regex pattern returns more than one result, then files returned for that pattern will be executed or imported in the order returned.

Syntax

Invoke-MedmComponent `
    [-ProcessAgentPath <string>] `
    [-DbServer <string>] `
    [-DbName <string>] `
    [-SetupSqlDir <string>] `
    [-SetupSqlFiles <string>] `
    -ComponentName <string> `
    -ComponentType <string> `
    [-ConfigurableParams <string>] `
    [-CleanupSqlDir <string>] `
    [-CleanupSqlFiles <string>]

Parameters

ParameterRDescription
DbServerThe target SQL Server database server address.

Default: $Global:MedmDbServer

Example: -DbServer "MyDbServer"
DbNameThe target SQL Server database name.

Default: $Global:MedmDbName

Example: -DbServer "MyDb"
SetupSqlDirA directory containing SQL scripts to be executed prior to component invocation. Relative paths will be resolved relative to the current directory.

Default: $pwd

Example: -SetupSqlDir ".\SetupSql"
SetupSqlFilesA comma-delimited list of RegEx patterns indicating SQL script files to be executed and/or CSV data files to be imported. All files must be nested within the directory indicated by -SetupSqlDir.

Example: -SetupSqlFiles "\.csv$"
ComponentName*The name of the MEDM component to be executed.

Example: -ComponentName "My Solution"
ComponentType*The type of the MEDM component to be executed. Valid values: DataPorter, DataInspector, DataMatcherProcess, DataConstructor, Solution.

Example: -ComponentType: "Solution"
ConfigurableParamsA delimited list of MEDM configurable parameter name=value pairs. Pairs are delimited with a ":". Only include parameters that must be explicitly set; those retaining default values may be omitted. Parameter names and values must not contain characters "=" or ":".

Example: -ConfigurableParams "param1=value1:param2=value2"
CleanupSqlDirA directory containing SQL scripts to be executed following component invocation. Relative paths will be resolved relative to the current directory.

Default: $pwd

Example: -CleanupSqlDir ".\CleanupSql"
CleanupSqlFilesA comma-delimited list of RegEx patterns indicating SQL script files to be executed following component invocation. All must be nested within the directory indicated by -CleanupSqlDir.

Example: -CleanupSqlFiles "\.sql$"
ProcessAgentPathPath to command line executable for target MEDM version.

Default: $Global:MedmProcessAgentPath

Example: -ProcessAgentPath "C:\Program Files\Markit Group\Markit EDM_10_5_3_1\CadisProcessAgent.exe"
×