Kourier Services

Kourier Integrator Online Help

Kourier Services

Purpose

A Service is typically used to group a collection of Kourier Export or Import Specifications into a logical unit of work, and then process the group to either move data outbound (between your U2 server and other applications or databases) or inbound (from other applications or databases to your U2 server). A service is comprised of the following:

an optional source DSN where incoming messages are received
one or more Kourier Service Commands to process incoming messages or to generate outgoing messages
an optional target DSN where outgoing messages are sent

Refer to the Kourier Services Guide and the Kourier Import Services Guide for more information on the use of services to transfer data between applications.

Available Toolbar Commands

	Click the New icon in the toolbar to save the current Service and then clear the page making it ready for a new item.
	Click the Save icon in the toolbar to save the current Service and return to the services listing.
	Click the Save As icon in the toolbar to save the Service to a new name. You will be prompted to enter a new name. Click OK to save the service to a new name and then continue editing the new service. Click Cancel to return to the existing Service without saving.
	Click the Delete icon in the toolbar to delete the current Service. You will be prompted with a "Are you sure you want to delete?" dialog. Clicking Yes will permanently delete the Service and then return to the Services listing. Click Cancel to return to the existing Service without deleting.
	Click the Run icon in the toolbar to run the Service manually. This will save your existing Service prior to running it. After clicking the Run icon, you will see a dialog requesting the Export Mode for running the Service: Full Refresh Net Change [default] Net Change with Deletes Click the OK button to run the Service after which a message window will display confirming that a Phantom process has been started and some additional helpful information such as: the OS Process number and the COMO file name. Click OK to dismiss the dialog and return to the Service page.
	Click the History icon in the toolbar to see the event history for this service. This will take you to the Event Log Listing which displays all events that have been generated for this service.
	Click the Statistics icon in the toolbar to view all of the statistics for this specific service. This will take you to the Service Statistics Listing and display the statistics that have been generated for this service.
	Click the DDL (Data Definition Language) button from the tool bar to create the DDL for all the export specifications referenced by the service. Once the DDL has been created a dialog is displayed showing the generated DDL. You can then copy this DDL and use it to correctly create the tables in your SQL Server database that match the data export specifications.
	Click the Generate Packages icon in the toolbar to generate SSIS packages for all of the Export Specifications included in the service.
	Click the Run Packages icon in the toolbar to generate SSIS packages for all of the Export Specifications included in the service.
	Click the Terminate icon in the toolbar to terminate the running instance of the current Service. You will be prompted with a dialog to confirm or cancel this command. This command should be used with care as it will attempt to immediately stop the current service, which could leave any data file extracts and file updates in an incomplete state. Recovery from using this command may require manual cleanup of the affected files and will most likely require a full refresh of any data being extracted.
	Click the Help balloon to open the help for this page.

File/Key Field

KT_SERVICES/Service ID

Prerequisites

If a source DSN or target DSN is specified, it should be entered using the Data Source Names screen.

Fields

Field Name	Description - Usage - Notes
Service	Enter a unique name for the service. By convention, services 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). Once you enter a service name, it cannot be changed.
Description	Enter a short descriptive name for this service. This name is displayed in on-line lookups.
Last Run Start	Display only field that shows the last run start date and time for this service.
Last Run End	Display only field that shows the last run end date and time for this service.
Elapsed Time	Display only field that shows the last run total elapsed time for this service.
Source Queue	If the service processes incoming data from an application, specify the pre-defined DSN to designate how Kourier will retrieve the data.
Source Append Address	Enter the append address that modifies the source DSN for this service. For more information on modifying DSNs with an append address, refer to the Kourier DSN Guide.
Command	Enter one or more Kourier commands to execute when this service runs. The most common commands used in a service are KMK.EXPORT followed by a list of export specifications and options for processing data exports or KMK.IMPORT followed by a list of import specifications and options for processing data imports. Each command can include parameters and options as required by the command verb. The command verb must be a specially written program that is compiled and cataloged in the account. Use the pipe character (\|) to separate multiple commands. Kourier commands are programs specially written to process messages. For information on available Kourier commands, refer to the Kourier Service Command Guide. Also see Kourier Commands for a complete list of available command keywords.
Target Queue	If the service sends data to an application, specify the pre-defined DSN to designate where Kourier will send the data.
Target Append Address	Enter the append address that modifies the target DSN for this service. For more information on modifying DSNs with an append address, refer to the Kourier DSN Guide. Note, it's very common to use substitution tags to build the append address for file names. Example: {$INT:SQL.SITE_ID}_{%sequence(MR%7)}_{%sql_table}.{%export_mode} This example results in a string that looks like this: 1A_0002879_customer.full when the Site ID is 1A, the SQL table is customer and the Service was run in full refresh mode. If you are defining a service that includes export specifications using multiple data export files (i.e., related files), use the {%source_id} substitution literal to access the value of the Source ID generated in the export. Example: `{%source_id}_{%sequence(MR%7)}_{%sql_table}.{%export_mode}` Refer to the Related Data Files Guide for more information on using this feature.
Save Undeliverable Messages	Kourier may occasionally be unable to send an outgoing message to a target DSN. This can happen when a network is down or when a server is off-line. This can result in an undeliverable message in the queue. If this field is checked, undeliverable messages will be saved in the outbound queue until the next time Kourier attempts to resend messages to that queue's DSN. If this field is not checked, undeliverable messages will not be saved. This field controls only outbound messages destined for a target DSN.
Autorun SSIS Packages	If this field is checked (recommended), the SSIS package will start running automatically after the associated data export has completed processing. If this field is not checked, you will need to setup a SQL job or other service to run the SSIS package.