Kourier Integrator Online Help

Quick Start Workbench Configuration

Purpose 

The Quick Start Workbench Configuration controls how SQL Table and Column names are generated in Schemas, Exports and Services when using the Kourier Quick Start Workbench. The values entered on this page are used by all Integrations within the connected MV account.

Refer to the Moving MultiValue Data to SQL Server Guide for more information on using the Quick Start Workbench to analyze MultiValue Data, generate and manipulate Schemas, generate SQL Tables, and generate Kourier Exports and Services.

Available Toolbar Commands

Click the Save icon in the toolbar to save the current Quick Start Workbench Configuration and return to the previously viewed page. Before the Configuration is saved, it is checked to ensure that it will generate fully SQL-compliant table and column names. If there are any errors, the offending character or setting is displayed at the top of the page so that corrections may be made.

Click the Test icon in the toolbar to test the current Configuration settings. After confirming that the current changes will be saved, a dialog box will be presented into which a test string may be entered. Once the Continue button is clicked, the converted string is displayed after applying the Quick Start Configuration rules.

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

File/Key Field

KT_CONTROL/'QS_CONFIG'

Cautions

The Source ID Property defined in the General tab must be defined in every Integration which will used to export data to SQL Server. 

The Quick Start Configuration defined on this page is used for all Integrations within the MV account.

Fields

There are three tabs on this page: General, Special Characters, and Special Characters. The information that can be entered for each of the three tabs is described below:

This tab displays and updates control table values which are used when generating Schemas from MultiValue data files, and when generating Exports and Services from a Schema using the Quick Start Workbench.

Field

Description - Usage - Notes

Source ID Column Name

If Kourier will be used to move data from multiple MultiValue accounts into a single SQL Server database, a Source ID must be defined for each table so that Full Refresh exports will replace only data from the source MV Account. The Column Name defined here will be added to every generated Export for this purpose. If you are only moving data from a single MV account, then this field may be left blank.

Source ID Property

The name of the Property which must be defined in each Integration within the MV Account. This field may also contain substitution tags. For compatibility with older versions of Kourier, this field is often set to "SITE_ID".

Source ID Data Type

The default SQL Data Types for Source ID columns.

Natural Key Column Name

The default name to use for the Natural key SQL column.

Natural Key Data Type

The default SQL Data Types to use for Natural Keys.

Multi-value Surrogate Key Column Name 

The default name to use for the SQL column name for MultiValue surrogate keys.

Multi-value Surrogate Key Data Type 

The default SQL Data Types to use for MultiValue surrogate key columns.

Multi-subvalue Surrogate Key Column Name 

The default name to use for the SQL column name for Multi-SubValue surrogate keys.

Multi-subvalue Surrogate Key Data Type 

The default SQL Data Types to use for Mult-SubValue surrogate key columns.

Export Timestamp Column Name

The name of the SQL Column which will be generated for every Export to store the datetime stamp indicating when the Row was exported by Kourier. If left null, no Export Timestamp Column will be generated.

Use Dictionary Column Name

If this checkbox is checked, Kourier will use the Dictionary Names as the starting value for generated SQL Column names. If left unchecked (the default), Kourier will use the Column Headings as defined in the source Dictionaries rather than the Dictionary Names (IDs).

Column Casing

There are three options for how Kourier will set the casing of generated SQL Column Names:

  • Lower Case: Spaces are converted to underscores, and the column heading is all in lower case. For example, "PART DESCRIPTION"   becomes "part_description".
  • Upper Case: Spaces are converted to underscores, and the column heading is all in upper case. For example, "PART DESCRIPTION" becomes "PART_DESCRIPTION".
  • Title Case: Spaces are removed, the column heading is converted to lower case, and the first letter of each space-delimited word is converted to upper case. For example, "PART DESCRIPTION" becomes "PartDescription"

This tab displays and updates control table replacement values which are used to generate SQL compliant table and column names using the Quick Start Workbench. A list of characters which are illegal in SQL table and column names is presented, with the option to replace each offending character with a SQL compliant string. Illegal characters will be stripped from the table and column names unless a replacement is defined here. Certain characters (such as $ or %) convey specific information as to the contents of the column, and so may be converted as desired. 

A special case is the underscore character "_", which is a legal character in SQL table names, but which is generally removed when using Title Case. If the underscore character should be retained, enter the underscore in its replacement field.

If you have selected "Title Case" for the Column Casing option in the General tab, before converting a column name or table name to camel case, any special character mapped to the "_" character will be converted to a space before performing the conversion on the string.

String Conversions allow you to consistently change strings found in MV file names and column headings to other standardized, more readable strings. String Conversions are structured as Line Items, so that you may add as many String Conversions as may be required by your business. Typical string conversions would be to change "ADDR1" to "Address1", "AMOUNT" to "Amt", etc.

Click the add button in the line item section command bar to add a new String Conversion or click the Line number to edit an existing line item. For more information on each individual field, see the Quick Start String Conversion Line Item 

Related Topics: 

Quick Start String Conversion Line Item