Kourier Integrator Online Help

Integration Definition

Purpose

The Integration Definition is used to define an integration/project ID and description for the entities or project categories for which you will be using Kourier Integrator. This could be anything from an EDI Trading Partner to a third-party CRM package, to a SQL data warehouse.

The screen is deceptively simple, in that all you enter is an ID and a description for the Integration. However, this ID is used throughout the system to help identify all the other aspects of the integration - Data Source Names and Export Specifications, etc.

You may optionally specify name-value-pairs for the integration. These can be any free-form data values that you care to associate to an integration.

For example, consider an environment where you exchange EDI transactions between several trading partners. By defining a PARTNER value pair in each of your EDI integrations, you could easily write your integration to use this value without having to write a custom screen to store and modify it.

Available Toolbar Commands

Click the New icon in the toolbar to save the current integration definition and then reset the page for new data entry.

Click the Save icon in the toolbar to save the current integration definition and return to the integration listing.

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

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

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

File/Key Field

KT_INTEGRATION/Integration ID

Fields

Field Name

Description - Usage - Notes

Integration ID

Enter the name for your integration entity. If it is an EDI trading partner, it could be the name of the company. Or if it is a third party application, it could be the name of the software. In any case, the name should be easily identifiable as being that integration entity. 

Description

Enter a complete description for your integration entity, something to further describe the entity and distinguish it from other entities. 

Line Item Fields

Field Name

Description - Usage - Notes

Property

Enter the free-form name of this line item's name-value-pair.

Value

Enter the free-form value of this line item's name-value-pair. When writing your custom integration, you can access this value using the "INT" namespace substitution tag.