Plug-in Documentation

Microsoft SSIS

Overview

The Microsoft SSIS plug-in provides deployment automation of packages to SQL database servers that can work alone or with other deployed packages to provide solutions to complex business needs.

Compatibility

This plug-in requires version 6.0.1 or later of IBM UrbanCode Deploy.

This plug-in is supported to run on all operating systems that are supported by the IBM UrbanCode Deploy agent.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode products.

History

Version 2

  • Fixed APAR PH05484 Invalid SERVER argument to deploy step.
  • Fixed an issue where file mappings would deploy twice.

Version 1.730108 March 3, 2016

  • Initial release of the plug-in.

Steps

Process steps in the Microsoft SSIS plug-in

Deploy

Deploy a DTSX file from a local file system to a Microsoft SQL database.

Input properties for the Deploy step
Label Type Description Required
Directory Offset String The directory offset relative to the current working directory where the step should run. No
DTUTIL Executable File String Absolute path to DTUTIL exectable file. Only specify this if the file isnt already on your system path.
(e.g. C:\Program Files\Microsoft SQL Server\110\DTS\Binn\dtutil)
No
Excludes String Any files in the working directory to exclude from package deployment. You may specify regular
expressions.
No
File to Deployment Name Mappings String SSIS packages to deploy along with an explicit deployment name. Separate packages from their name with =, and
separate multiple package mappings by new line. If not in the working directory, you must specify an absolute path
(e.g. C:/ProgramFiles/DTSXPackages/mypackage.dtsx=NameOfDeployment). You must either specify your files in this field or
in the Includes field.
No
Includes String The SSIS packages to deploy to the Microsoft SQL database separated by new lines.
If not in the working directory, you must specify an absolute path (e.g. C:/ProgramFiles/DTSXPackages/mypackage.dtsx).
You may specify wildcards (e.g. **/* will include all files in the working directory). You must either specify
your files in this field or in the File to Deployment Name Mappings field.
No
On Failure Select Box Choice of action when a deployment fails on a particular package.
(Fast Fail: Step will fail right away when a deployment fails, and will not attempt to deploy any additional files.
Best Effort: Step will attempt to deploy all packages, and will fail at the end if any failures occur. Useful to pinpoint which packages are invalid.
Warn: Step will continue on if deployment fails, and print a warning declaring the file that failed.)
No
SQL Password String The password related to the specified Microsoft SQL database user to authenticate with. This is
required only if SQL authentication is being used. If this is not specified, Windows authentication will
be used.
No
SQL Server Name String SQL Server name. Required when specifying a non-local or non-default server when deploying
an SSIS package. (SERVERNAME\INSTANCENAME)
No
SQL Username String The username with package deployment permissions on the Microsoft SQL database. This is
required only if SQL authentication is being used. If this is not specified, Windows authentication will
be used.
No