Export (0) Print
Expand All

Create Parameters

You use SQL Server Data Tools (SSDT) to create project parameters and package parameters. The following procedures provide step-by-step instructions for creating package/project parameters.

Note Note

If you are converting a project that you created using an earlier version of Integration Services to the project deployment model, you can use the Integration Services Project Conversion Wizard to create parameters based on configurations. For more information, see Deploy Projects to Integration Services Server.

To create package parameters

  1. Open the package in SQL Server Data Tools, and then click the Parameters tab in the SSIS Designer.

    Package Parameters Tab
  2. Click the Add Parameter button on the toolbar.

    Add Toolbar Button
  3. Enter values for the Name, Data Type, Value, Sensitive, and Required properties in the list itself or in the Properties window. The following table describes these properties.

    Property

    Description

    Name

    The name of the parameter.

    Data type

    The data type of the parameter.

    Default value

    The default value for the parameter assigned at design time. This is also known as the design default.

    Sensitive

    Sensitive parameter values are encrypted in the catalog and appear as a NULL value when viewed with Transact-SQL or SQL Server Management Studio.

    Required

    Requires that a value, other than the design default, is specified before the package can execute.

    Description

    For maintainability, the description of the parameter. In SQL Server Data Tools (SSDT), set the parameter description in the Visual Studio Properties window when the parameter is selected in the applicable parameters window.

    Note Note

    When you deploy a project to the catalog, several more properties become associated with the project. To see all properties for all parameters in the catalog, use the catalog.object_parameters (SSISDB Database) view.

  4. Save the project to save changes to parameters. Parameter values are stored in the project file.

    Caution note Caution

    You can in-place edit in the list or use the Properties window to modify the values of parameter properties. You can delete a parameter by using the Delete (X) toolbar button. Using the last toolbar button, you can specify a value for a parameter that is used only when you execute the package in SQL Server Data Tools.

    Note Note

    If you re-open the package file without opening the project in SQL Server Data Tools, the Parameters tab will be empty and disabled.

To create project parameters

  1. Open the project in SQL Server Data Tools.

  2. Right-click Project.params in Solution Explorer, and then click Open (OR) double-click Project.params to open it.

    Project Parameters Window
  3. Click the Add Parameter button on the toolbar.

    Add Toolbar Button
  4. Enter values for the Name, Data Type, Value, Sensitive, and Required properties.

    Property

    Description

    Name

    The name of the parameter.

    Data type

    The data type of the parameter.

    Default value

    The default value for the parameter assigned at design time. This is also known as the design default.

    Sensitive

    Sensitive parameter values are encrypted in the catalog and appear as a NULL value when viewed with Transact-SQL or SQL Server Management Studio.

    Required

    Requires that a value, other than the design default, is specified before the package can execute.

    Description

    For maintainability, the description of the parameter. In SQL Server Data Tools, set the parameter description in the Visual Studio Properties window when the parameter is selected in the applicable parameters window.

  5. Save the project to save changes to parameters. Parameter values are stored in configurations in the project file. Save the project file to commit to disk any changes in the parameter values.

    Caution note Caution

    You can in-place edit in the list or use the Properties window to modify the values of parameter properties. You can delete a parameter by using the Delete (X) toolbar button. Using the last toolbar button to open the Manage Parameter Values dialog box, you can specify a value for a parameter that is used only when you execute the package in SQL Server Data Tools.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft