Integration Definition (kourier_integration_def.aspx)


Purpose

Integration Definition is used to define entities for which you will be integrating. This could be anything from an EDI Trading Partner to a third-party CRM package.

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.

File/Key Field

KT_INTEGRATION/Integration ID

Fields

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

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.

 


User Guide - Table of Contents