Change Data Capture Capability Using Web Services

Copyright © 2010 Kinaxis Inc. All Rights Reserved. 1

Copyright © 2010 Kinaxis Inc. All Rights Reserved.

Bob May

senior product manager

Change Data Capture Capability Using Web Services


Agenda

• RapidResponse web services overview• Use cases• Capture worksheet data• Change Data Capture (CDC)• Configuring and using CDC• Wrap-up


RapidResponse Web Services

web services

RapidResponseERP etc.

web services client

• Published application programming interface using web services for data integration

1

2

4

• Stateless• Interoperable across platforms• Supports open standards like HTTP(s) and SOAP• Conforms to SOAP 1.1, WS-I Basic Profile 1.1, WS-I

Basic Security Profile 1.0 and documented via WSDL 1.1

3


Web Services Use Cases

• Extract plan data from RapidResponse– Low frequency– Full data update– Extract sales and operations planning data when a new S&OP

plan is committed– Extract planned work order/purchase order data as part of a full

MRP plan regeneration

• Change data capture– High frequency– Net change updates– Extract sales order schedule dates established in RapidResponse– Extract new purchase order releases established in RapidResponse


Configuring Web Services Users

• “Use web services” is a specific new permission

• Controls access to web services

• Should not be used as a general admin or planning login; only login to confirm access to resources and for testing

• One web service user per web service client application due to concurrency restriction


Capture Worksheet Data

• Ensure web services user has access to required resources– Scenarios– Workbooks– Filters– Sites

• Create web services client program:– Provide workbook identifier, settings and variables using

GetWorkbookData method– For each worksheet in the workbook, extract one or more blocks of

data using GetWorksheetData method and process each block– Use CloseWorksheet when done to free up working resources


Change Data Capture

• Ensure web services user has access to required resources– Instances– Workbooks (CDC)– Filters– Sites

• Create web services client program:– Use CaptureDataChanges to set a capture synchronization point– Provide workbook identifier, settings and variables using

GetCaptureChanges method– For each worksheet in the workbook, extract one or more blocks of

data using GetWorksheetChangedData method and process each block

– Use CloseWorksheet when done to free up working resources


CDC Instance Configuration• An instance is a set of hidden scenarios bound to a permanent

scenario that is monitored for data changes• Forms the framework for managed data collection through the web

services API• Enable capture of all changes, re-capture in the event of a failure,

capture each change only once• Create an instance for each unique combination of scenario, capture

frequency, and web services user


Change Data Capture Using Instances

Extract PO Changes

Extract SO Changes

Set CaptureSync Point

1 2

Clear CaptureSync Point

3

Set CaptureSync Point

4

Extract PO Changes

Extract SO Changes

5

Data Changes to Monitored Scenario

Time


CDC Workbooks

• New workbook type• Configuration options include:

– Optionally monitor changes, adds, deletes– Exclude changes introduced by data updating– Establish key fields, monitored fields and reference fields

(Note that monitored fields can be input or calculated fields)

• Workbook automatically includes:– Changed by, inserted by, before/after change values– Capture/clear actions to support workbook testing

Demo


Web Services Caveats

• Web services output does not include formatting - Use alerts to format output data

• Capture workbook data cannot process cross-tabbed or subtotaled worksheets

• CDC is net-change data only - Use Data Change Tracking for all transactions


Other Notes• System configuration

– Configure a web services port– Configure for http or https– Client web service toolkit (e.g. Apache Axis2, WCF)

• Resources– Activity is logged to the web service log– Administration guide includes a web service API overview

and a reference guide

Sample client code provided in C#, VB.NET, Java


Wrap-up

• RapidResponse 10.0 supports two new classes of low latency, data integration web services• Get Workbook Data• Change Data Capture

• Configuration within RapidResponse is provided through new administration tools and standard resources (workbooks, filters, sites, scenarios, instances)

• Significant resources are included that support development of clients that access the new web services


Thank You!

Documents

Change Data Capture Capability Using Web Services