ODBC to SQL Export Specification


Purpose

This page is used to define ODBC to SQL Server Export Specifications, which are used to extract data from files using an ODBC connection to Microsoft SQL server. 

An ODBC Export Specification has two parts: selection and export. The selection portion of an export allows you to specify any selection criteria to apply to the data before the data export file is created. The export portion lists the fields to be included in the data export file, the column headings to use, and any data conversion required.

 

note
WidgetNote

If you exporting data from an ODBC file to a flat file, use the ODBC to File Export Specification to define your exports. 

 

Here's the typical workflow when creating a ODBC to SQL Export Specification:

  1. Create an export and add one or more line items.
  2. Use the Test command to verify the export is working correctly.
  3. Generate the DDL for the export, use this to create the target SQL table.
  4. Create the SSIS package with the Generate Package command.
  5. An export is typically automated and processed as part of a Kourier Service using the command KMK.EXPORT.    

Available Toolbar Commands

Click the New icon in the toolbar to save the current export specification and then clear the page making it ready for a new item.

Click the Save icon in the toolbar to save the current export specification and return to the export specifications listing.

Click the Save As icon in the toolbar to save the current export specification to a new name. You will be prompted to enter a new name. Click OK to save the export to a new name and then continue editing the export. Click Cancel to return to the existing export without saving.

Click the Delete icon in the toolbar to delete the current export specification. You will be prompted with a "Are you sure you want to delete?" dialog. Clicking Yes will permanently delete the export and then return to the export specifications listing. Click Cancel to return to the existing export without deleting.

Click the Test icon in the toolbar to test an export. Testing an export will perform a sample data extract using all of the information entered on the export specification and then outputs the results to the screen where it can be viewed and validated. Typically a test is performed to ensure that the correct data fields are being extracted and all data conversions, formats, and formulas are working correctly.

After clicking the Test icon, you will see a dialog requesting additional information:

  • Export file to test: Select one of the export data files to use in the test. The first export data file entered is selected by default. Note, this prompt will only be available if multiple data export files have been entered on the export specification.
  • Sample Number of records: Defaults to 100. This number determines how many records are processed and exported to the screen.
  • Record IDs to export: If you want to test individual records, enter one or more item ids. Entering a value here overrides the sample number of records.
  • Export Format: Select the export format for viewing the test data.

  

tip
WidgetTip
Select MultiValue to view the exported data in a detailed data view which shows the data for each field in its native MultiValue format (including value and sub-value delimiters) and without processing it through formats, conversions, etc. This is very useful if you need to see exactly what exported data looks like, which may help you understand why the export format, conversions or formulas are not working. 

 

Click the OK button to view the export results or click the Cancel button to return to the Export Specification page.

 

note
WidgetNote

For this feature to work correctly you will need to: 1) Add the Kourier website as a trusted site so pop-up dialogs appear and 2) enable the automatic prompting for downloads option in your browser's internet options (e.g., for Internet Explorer this setting is found in Security | Custom Level dialog). 

 

To see the runtime statistics for an individual export, click the Statistics icon from the toolbar. This will take you to the Export Statistics listing which displays all export statistics that have been captured for the export.

To create the DDL from a SQL export specification, you may click the DDL button from the tool bar. Once the DDL has been created a dialog appears allowing you to view the DDL. This feature is useful when you need to only create the DDL for an single export instead of all of the exports associated with a master file.

To create the SSIS Package from a SQL Export Specification, you may click the Generate Package button from the tool bar. Note, your current SQL Export Specification will be saved before you can create the SSIS package. This will open a new Generate SSIS Package page where you will be asked to enter a number of parameters before the SSIS package can be generated.   

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

File/Key Field

KT_EXPORTS/Export Name

Prerequisites

If an export contains user-defined literals, they should be entered using Substitution Literals.

Fields

Field Name

Description - Usage - Notes

Name

Enter a unique name for the export. By convention, exports are named using an Integration ID such as KS for KommerceServer, followed by an underscore and a string that describes its purpose (e.g., KS_CONTACTS). 

Title

Enter a short descriptive name for this export. This name is displayed in on-line lookups.

Export Format

Enter the export format. If the export verb is KEXPORT, the possible choices are shown below.  Other export verbs (normally user-written BASIC programs)  may or may not support these formats.

Format

Description

TAB

Data values are delimited by the tab character.  Use this format to generate files that can be automatically loaded in the Excel or other PC applications.  This format must be used when using the Generate SSIS packages feature.

PIPE

Data values are delimited by the pipe character.  This format is primarily used when debugging the output. Note, you will not be able to generate SSIS packages using the PIPE format.

Last Update

Display only field, shows the last date/time that the export specification was saved.

Note

Enter a free form comment or note for this Export Specification. If a note is entered, a small icon will display on the Export Specification listing. Hovering your mouse over the icon on that listing will display about 40 characters of the note for quick reference.

Last Package Generation

Display only field, shows the last date/time that the associated SSIS package was successfully generated for this export specification.

ODBC Connection

Select an ODBC Connection from the list of available choices to indicate what type of database will be used for the ODBC connection. For example: Oracle 11g, MS Access, MS SQL. These must be defined using the ODBC Connection page

Source Table

Enter the name the ODBC table to be used as the source of the data. To enter a list of  related export files, click the drop-down icon

Note, if more than one file is entered, the field will be disabled (grayed out) and only the primary file name will be displayed, followed by the total number of files in brackets. For example. If the primary file is GL, and there are two additional related GL files, the field will be disabled and display as "GL [3]". Use the drop-down icon to edit the list of files. Refer to the Related Data Files Guide for more information on using this feature.

Where

Enter the selection criteria statement using the query syntax that is native to the source ODBC database. This is used to limit the data selected from the Source table. This field may also contain substitution tags.

Net Change Where

Enter any additional selection criteria using the query syntax that is native to the source ODBC database to provide additional data filtering before processing the file. This query will likely include a last change date column.

Net Change with Checksum

Enable Net Change with Checksum to provide an additional level of filtering when records are exported. This feature is useful if the ODBC file contains attributes that are not included in the export specification.

Target SQL Table

Enter the name the SQL Server table to be used as the source of the data. This name will be used in any DDL that is generated and when generating SSIS packages for this export. 

Export Options

Enter any valid export options:

Option

Usage

COL.HDR.SUPP

Use this option to suppress columnar headings. Syntax is:  COL.HDR.SUPP

EXPORT-REPEAT-VALUES

If this option is specified, Kourier will repeat the last non-null value or sub-value of a field. Syntax is:  EXPORT-REPEAT-VALUES

EXPORT-STAMP

Used by the KEXPORT command to specify the attribute which should receive a time/date stamp when a record is exported. Syntax is:  EXPORT-STAMP "amc".

EXPORT-SUBNAME

Used by the KEXPORT command to specify the name of the export subroutine associated to the export. Syntax is:  EXPORT-SUBNAME "subroutinename".

XML-FORM-TAG

When creating an XML export, this option indicates the form tag of the XML document. Syntax is:  XML-FORM-TAG "elementname".

XML-ROOT-TAG

When creating an XML export, this option indicates the root element tag of the XML document. Syntax is:  XML-ROOT-TAG "elementname".  Default value is: Kourier file=export_data_file

XML-TRANS-TAG

When creating an XML export, this option indicates the transaction tag of the XML document. Syntax is:  XML-TRANS-TAG "elementname".  Default value is: Trans id=@ID


 

Line Item Fields

Click the Add button in the line item section command bar to add a new line item field. See help for ODBC to SQL Export Specification Line Item