Create a Model Deployment Package by Using MDSModelDeploy

  • Article

Applies to: SQL Server - Windows only Azure SQL Managed Instance

In Master Data Services, use the MDSModelDeploy tool to create a package. Depending on the commands you specify, the package can contain either:

  • Model objects only.

  • Model objects and data.

If you want to deploy a package that contains model objects only, you can use the model deployment wizard in the Master Data Manager web application instead. For more information, see Create a Model Deployment Package by Using the Wizard.

Prerequisites

To perform this procedure:

  1. The basic permissions required to run the MDSModelDeploy tool are the following:

    • The same Windows permission as the MDS Configuration Manager (administrator of Windows)

    • DBA permission on the MDS database.

  2. The permissions required to create the package using the MDSModelDeploy tool are the following:

    • MDS model administrator permission on the data model.

    • MDS ImportExport functional area permission.

  3. The permissions required to deploy a model using the MDSModelDeploy tool are the following:

    • MDS Explorer function permission

    • MDS System Administration function permission.

  4. The permissions required to list models using the MDSModelDeploy tool are the following:

    • MDS Explorer function permission

    • MDS model administrator permission on the data model on order to see the model in the list.

A model must exist for you to create a package of. For more information, see Create a Model (Master Data Services).

For more information, see Administrators (Master Data Services).

To create a model deployment package by using MDSModelDeploy

  1. Open an Administrator: Command Prompt.

  2. Navigate to the location of MDSModelDeploy.exe.

    • If MDS was installed in the default location, the file is in drive:\Program Files\Microsoft SQL Server\130\Master Data Services\Configuration.

    • If MDS was not installed in the default location, search the local computer for MDSModelDeploy.exe.

  3. Optional. View options and help.

    • To display all available options, type MDSModelDeploy and press Enter.

    • To display help for an option, type the following, where OptionName is the name of the option: MDSModelDeploy help OptionName.

  4. Optional. If you have multiple web applications, determine the name of the service you will deploy to by typing this command and pressing Enter:

    MDSModelDeploy listservices

    A list of values is returned, for example MDS1, Default Web Site, MDS. The first value in this list (in this case, MDS1) is needed to deploy the model.

  5. To create a package that contains model objects and data, type the following, where ModelName, VersionName, ServiceName, and PackageName are the names of the model, version, service, and of the .pkg output file respectively:

    MDSModelDeploy createpackage -model ModelName -version VersionName -service ServiceName -package PackageName -includedata

    If you do not want to include data, do not use the -version and -includedata switches.

  6. Press Enter. When the package is successfully created, a message stating "MDSModelDeploy operation completed successfully" is displayed.

Next Steps

See Also

Model Deployment Options (Master Data Services)
Deploying Models (Master Data Services)