Microsoft SSIS plugin

The Microsoft SQL Server Integration Services (SSIS) plugin enables you to deploy Integration Services packages from a local file system to a Microsoft SQL Server.

Before you begin

To use the Microsoft SSIS plugin, complete the following prerequisite tasks:

  1. Verify that your Deployment Automation user role allows you to manage plugins. For details, see Server roles and system security.

  2. Download the Deployment Automation plugin bundle, extract the Microsoft SSIS plugin zip file from the bundle, and load the file into Deployment Automation. For details, see Load and upgrade plugins.

To use the plugin's Deploy step, open a component or global process and navigate to Database > SSIS in the Tools pane.

For details on creating processes, see Create and design component processes and Create and design global processes.

Back to top

Step: Deploy

Use the Deploy step to deploy DTSX packages from a local file system to a Microsoft SQL database.

The deployed packages are saved in the dbo.sysssispackages table in the msdb database:

System Databases/msdb/dbo.sysssispackages

The following table describes the step's properties.

Property Description
Name Enter a name for the step. By default, the step is named Deploy.
Directory Offset

(Optional) Enter a path to the directory where you want to run the step, relative to the current working directory.

By default, the step runs in your current working directory.


Specify which files to deploy.

Enter each file name on a new line. To match a set of files, use wildcards. For example, to deploy all files, enter **/*.


(Optional) Specify the files you want to exclude from deployment.

To exclude a set of files, use regular expressions. Enter each file name or expression on a new line.

SQL Username

If you're using Microsoft SQL authentication, enter the username for the Microsoft SQL database user with package deployment permissions.

To use Microsoft Windows authentication, leave the field empty.

Default username: ${p:resource/ssis.username}

SQL Password

If you're using Microsoft SQL authentication, enter the password for the specified Microsoft SQL database user.

To use Microsoft Windows authentication, leave the field empty.

SQL Server Name

If you're deploying to a Microsoft SQL server that is not the default or local server, enter the name of the server.

Default name: ${p:resource/ssis.server}

DTUTIL Executable File

The dtutil utility handles the deployment of SSIS packages. If the dtutil executable file is not on the system path, for example:

C:\Program Files\Microsoft SQL Server\150\DTS\Binn\dtutil

enter the full path to the file.

Fail Mode

Specify the condition for failing the step:

  • Fail fast (default). Fail the step immediately if a file fails to deploy.

  • Fail on any failure. Attempt to deploy all the files, and fail at the end if any files failed to deploy. This option is useful for identifying invalid packages. The packages are deployed to the SQL server even if the step fails.

Note: After you run the process, check the step's output property failedPackages for a list of files that the plugin failed to deploy. For details on how to view output properties, see View a component process request.

Ignore Failure Select this option if you want the step to always be considered successful.
Working directory

Enter an alternative absolute path to the working directory for the step.

To use the default working directory for the process, leave the field empty.

Post Processing Script

Select a custom post-processing script. To run the step's default script, leave the field empty.

To create your custom post-processing script, click Add , and enter script details in the Create Script dialog box.

A post-processing script helps ensure that expected results occur. It runs after a step finishes processing. For details, see Manage post-processing scripts.

Precondition (Optional) Enter a JavaScript script to define a condition that must exist before the step can run. The condition resolves to true or false.
Use Impersonation Select this option if you want an agent to run the step as a different user. Specify the impersonation details for a Windows or UNIX/Linux agent, as described in Use impersonation to run processes.
Hint (Optional) Add a comment to the step. To view the comment, point to the step in the design space.
Hidden properties (Optional)
Output properties secure rules

Specify properties you want to be treated as secure. Secure properties are stored encrypted, and their values are displayed obscured in the Deployment Automation user interface.

Use regular expressions to select multiple properties. Enter each property name or expression on a new line.

Example: To select all properties with names that start with prop, use this regular expression: prop.*

Debug Output Select this option to log debug information during the run.

Back to top

See also: