Subscription Schedule

Purpose

When a user subscribes to a Kourier REST subscription, a Kourier Schedule named “.{gwuser}_nnnn” is created if it does not already exist. This schedule runs all subscriptions (services) for a specific Kourier REST Gateway user on a recurring basis.

Available Toolbar Commands

Click the Save icon in the toolbar to save the current schedule and return to the export specifications listing. Before the Schedule can be saved, the defined schedule items will be verified and if there are any errors you will need to correct them before you can save the Schedule.

Click the Delete icon in the toolbar to delete the current Schedule. 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 schedules listing. Click Cancel to return to the existing export without deleting.

Click the Run icon in the toolbar to run the Schedule manually. This will save your existing Schedule prior to running it.

After clicking the Run icon, you will see a dialog requesting the Export Mode for running the Schedule:

Full Refresh [default]

Net Change

Net Change with Deletes

Click the OK button to run the Schedule 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 Schedule page.

Click the History icon in the toolbar to see the event history for this Schedule. This will open the Event Log Listing page displaying all events that have been generated for this Schedule.

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 Start icon in the toolbar to start running the schedule tasks for this Schedule in the background. The Status will change to Started. The schedule will wait in the background until one of the schedule task intervals defined on the Schedules tab is due. At that time each service that has been selected on the Services tab will run. If there are more than one accounts selected on the Accounts tab then all of the selected services will run again in each account.

Click the Stop icon in the toolbar to stop running the schedule tasks for this Schedule in the background. The Status will change to Stopped.

Click the Terminate icon in the toolbar to terminate the running instance of the current Schedule and all associated Services. You will be prompted with a dialog to confirm or cancel this command. The Terminate command should be used with care as it will attempt to immediately stop the current schedule, which could leave unfinished services and related 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_SERVICE/Service ID

KTM001.xml - This file is used by the Kourier Services Management software in order to know when to run the scheduled tasks for each Schedule. When the user clicks the Start icon in the toolbar this file is updated with the schedule task information as defined on the Schedules tab . When the user clicks the Stop icon, the schedule task information is removed from this file for this Schedule.

Prerequisites

You need to have an Integration and one or more Services defined before you can create a schedule.

For the schedules to process in the background, the Kourier Services Management software must be installed and running as a Windows Service on the Windows server that is running IIS. See the product installation documentation for more information.

Primary Fields

Field Name

Description - Usage - Notes

Description

Enter a short descriptive name for this schedule, Such as Daily, Weekly, etc. This name is displayed in on-line lookups.

Integration

Select the Integration to associate with this schedule. Note, after saving the Schedule, this is a display only field.

Status

Shows if the schedule is Started, Running or Stopped.

If the Status shows Stopped it means that the Schedule was not started and it is not waiting to run in the background on your next pre-defined schedule. To start the schedule you need to define a valid schedule using the Schedules tab and then click on the Start icon in the toolbar.

If the Status shows Started, then the schedule has been started and is waiting in the background for the next scheduled time to run. To stop the schedule click on the Stop icon in the toolbar.

If the Status shows Running then the schedule is currently running all selected services within the specified accounts.

Last Run Start

Displays the last date and time when the last schedule run started.

Last Run End

Displays the last date and time when the last schedule run ended.

Elapsed Time

Displays the total elapsed time required to complete the last run of the service in HH:MM:SS

Additional Fields

Enter additional information for the schedule using the information within the tabs below.

Schedules

This tab displays the individual schedules defined for the overall Schedule. Depending on the schedule interval, not all fields below will display information.

Click the add button in the line item section command bar to add a new schedule item or click the Line number of an existing item to edit the schedule. At least one schedule line item must be defined. For more information on each individual field, see the help for Schedule Line Item.

Field Name	Description - Usage - Notes
Line	Display only incremental line number. Click to edit an existing schedule line item.
Interval	Displays the schedule time interval.
Start Time	Displays the schedule start time for running the schedule.
End Time	Displays the schedule end time for running the schedule.
Frequency	Displays the frequency for running the schedule.
Day of Month	Displays the day of month to run the schedule.
Run Once At	Displays when the specific time when the schedule will run once.
Export Mode	Displays the export mode that will be used for each service that runs as part of this schedule item.

Field / Command	Description - Usage - Notes
Service Names	Select the one or more services to process when the schedule runs.
	Click the Select All button to select all services on this tab.
	Click the Deselect All button to deselect all services on this tab.