Kourier Integrator Online Help

Generate SSIS Package

Purpose

To Generate the SSIS package associated with SQL Export Specification. There are several properties that must be entered prior to generating a SSIS package. See the field descriptions below for details. 

You must have one or more SSIS configuration files available to select and/or edit before you are able to generate a SSIS package. 

Available Toolbar Commands

Click the Generate icon in the toolbar to close the window and generate a SSIS package using the parameters entered on this page. The values entered will be saved for use on the next package.

Click the Cancel icon in the toolbar to close the window and return to the SQL Export Specifications page. No data will be saved and a SSIS package will not be generated.

Click the Help balloon to open the help for this page.

Cautions

The package generated will replace the existing package with the same name. Be sure to enter all path names using UNC format, and make sure those paths are accessible from the server where MS SQL Server is running. See the glossary entry for UNC for more information.

Package Configuration for SQL Export Fields

Field Name

Description - Usage - Notes

Name

The name of the SQL Export Specification currently being updated. This is display only.

Configuration File

Enter a UNC path to the SSIS package configuration you want to use for this package. This will default to the path name last used. To view or edit the contents of the Configuration File click the Edit Package icon . This will open the SSIS Configuration page.

Row Delimiter

There are 3 options for row delimiter: Carriage Return and a Line Feed {CR}{LF}, Carriage Return only {CR}, or Line Feed only {LF}. The default value is {CR}{LF}.

The row delimiter is used by the generated package to parse each line in the data file exported by Kourier. The delimiter should be determined based on three factors: 1) the operating system of the U2 server running Kourier; 2) the method used by Kourier to transfer the data files; 3) the operating system of the server where the exported data file will be saved and/or transferred. Refer to the table below:

U2 Server O/S

Kourier Transfer Method

Data File O/S

Row Delimiter

Windows

FILE

Windows

{CR}{LF}

UNIX

FTP (not in binary mode)

Windows

{CR}{LF}

UNIX

FTP (binary mode)

Windows

{LF}

UNIX

FILE

UNIX (Samba)

{LF}

UNIX

FILE

Windows (NFS)

{LF}

It's recommended that you test the Kourier export data file in its final destination to verify which row delimiter to use. If you select the incorrect delimiter for the package, it's likely that no data will be processed or there will be data conversion errors.

Text Qualifier

There are 3 options for text qualifier: None, Single Quote ('), Double Quote ("). This setting determines how text values are identified in the data file. The SSIS packages use a tab-delimited file for processing with each tab representing a separate column, Since it is possible for the data in that file to contain embedded tabs, it is important in this case to identify text values with a delimiter to avoid this issue. Select the option that best reflects how text values are represented in the export data file.

If "None" is selected, then the data between tabs in the export data file will be treated as a column. If either single quotes or double quotes are selected, then all data between the quote marks (even other tabs) will be treated as part of the data. 

First Row Contains Column Names

Enable this checkbox if the file to be used by the SSIS package will include column names as the first row in the file. This is the default behavior for files created by SQL Export Specifications.

Error if import file(s) are not present

Enable this checkbox if you would like to generate an error when the import files are not available for processing by the SSIS package. You should enable this if you will always expect a file to be ready for processing when the SSIS package runs. There are times when you may not want to do this. For example, if you are processing net change files at short time intervals it's possible that there will not always be a file available for processing.

Truncate table on full refresh

Enable this checkbox if you would like the generated SSIS packages to perform a truncate  command on the SQL table prior to doing a full data refresh for the table, which improves overall data loading performance. Note,  in order to avoid deleting non-associated data this option has no effect if the SQL table uses a Source ID column.

If the truncate option is not enabled or if the SQL table uses a Source ID column, rows from the SQL table will be removed prior to a full data refresh using DELETE commands, which is not as fast as using a TRUNCATE on the table.

Caution: This option should not be enabled if the SQL table uses triggers that need to execute when a row is deleted because the Truncate command will not activate the trigger.

Notification Threshold

Indicates the number of seconds that a SSIS package may run before Kourier sends an e-mail notification if a subsequent attempt to run the SSIS package fails because the package is locked (e.g. there is a row in the kourier_package_control table for the package without an end date or and abort date).  In most cases, a value of 300 seconds is reasonable. However, if you are receiving a large number of "Package is unable to continue because another instance of the package is running" e-mails, you may want to increase this value.

SQL Server

The name of the server where the SQL Server database is located. Defaults from the value saved in the selected configuration file.

SQL Database

The name of the SQL Server database you will be updating with the SSIS packages. Defaults from the value saved in the selected configuration file.

SQL Table

The name of the table to be updated by the SSIS package. This field is display only and defaults from the SQL Table name entered on the associated SQL Export Specification.

SQL Authentication Type

Determines what user name and password are used to access the SQL database. If you want to use the currently logged in user's username and password to log into the SQL database, select the Windows Authentication checkbox. Otherwise select SQL Server Authentication. Defaults from the value saved in the selected configuration file.

SQL Username

The SQL username to be used when the SSIS package logs into the SQL database. This is only used if SQL Server Authentication is selected. Defaults from the value saved in the selected configuration file.

SQL Password

The SQL password to be used when the SSIS package logs into the SQL database. This is only used if SQL Server Authentication is selected. Defaults from the value saved in the selected configuration file.

Package Name

This is the name of the SSIS package that will be generated. The default value is the name of the SQL Export Specification. Although the package name can be changed, it is recommended that you accept the default value.

Package Description

Enter a description for the package. This is optional and for informational purposes only.

Package Location

There are 2 options for the package location: File System and SQL Server.

  • Select File system if you want to store the generated packages in a specific location on the file system. A valid UNC path to this location will be required. This is the recommended option because using the file system allows you to organize packages better because you can setup your folder/file hierarchy to indicate integration, export, tables, etc.  If you choose this option, be sure to backup the folders used to save your packages.
  • Select SQL Server if you want to store the generated packages in within the SQL Server database. All packages will be saved into one repository, which can make it more difficult to manage your packages. If you choose this option you must be sure to backup your packages independently of the SQL database. All packages are stored in one larger repository.

Folder Path

Enter a valid UNC path to be used for saving generated SSIS packages. This is only used if the package location option of File System is selected.

Build Packages For

Select the SQL database version from the list of choices. This will determine how the SSIS packages are generated in order to be compatible with the various versions of the SQL Server software.