CDC Documentation Template Comparison Object

Cross Database Comparison
Documentation of Comparison Object <Comparison Object>
www.sap.com
TABLE OF CONTENT
GENERAL PURPOSE....................................................................................................................................... 3
Relevant processes and interfaces ............................................................................................................... 3
GLOBAL PARAMETERS ................................................................................................................................. 3
CONNECTION PARAMETERS ........................................................................................................................ 3
Source 1 ............................................................................................................................................................ 3
Source 2 ............................................................................................................................................................ 3
DATA MODEL ................................................................................................................................................... 4
Description ....................................................................................................................................................... 4
Foreign key relations ....................................................................................................................................... 4
Source 1 ............................................................................................................................................................ 4
Source 2 ............................................................................................................................................................ 4
Mapping ............................................................................................................................................................ 4
Context fields ................................................................................................................................................... 5
Conversions ..................................................................................................................................................... 5
Filters ................................................................................................................................................................ 5
Fixed Filters ....................................................................................................................................................... 5
Variable (Instance Specific) Filters .................................................................................................................... 5
LIMITATIONS .................................................................................................................................................... 6
ENHANCEMENTS AND MODIFICATIONS...................................................................................................... 6
CONTACT PERSONS....................................................................................................................................... 6
CHANGES ......................................................................................................................................................... 6
©2014 SAP AG. All rights reserved.
SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign,
SAP BusinessObjects Explorer, StreamWork, SAP HANA, and other
SAP products and services mentioned herein as well as their
respective logos are trademarks or registered trademarks of SAP AG
in Germany and other countries.
Business Objects and the Business Objects logo, BusinessObjects,
Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and
other Business Objects products and services mentioned herein as
well as their respective logos are trademarks or registered trademarks
of Business Objects Software Ltd. Business Objects is an SAP
company.
Sybase and Adaptive Server, iAnywhere, Sybase 365, SQL
Anywhere, and other Sybase products and services mentioned herein
as well as their respective logos are trademarks or registered
trademarks of Sybase, Inc. Sybase is an SAP company.
All other product and service names mentioned are the trademarks of
their respective companies. Data contained in this document serves
informational purposes only. National product specifications may vary.
These materials are subject to change without notice. These materials
are provided by SAP AG and its affiliated companies ("SAP Group")
for informational purposes only, without representation or warranty of
any kind, and SAP Group shall not be liable for errors or omissions
with respect to the materials. The only warranties for SAP Group
products and services are those that are set forth in the express
warranty statements accompanying such products and services, if
any. Nothing herein should be construed as constituting an additional
warranty.
DOCUMENTATION OF COMPARISON OBJECTS
This document provides background information on the Comparison Object <Comparison Object>.
GENERAL PURPOSE
<Explain within this section what the overall purpose and background of the Comparison Object is and why it
was created. Describe the different use cases of the object and when this Comparison Object should be
used.
Explain in business terms what objects are compared between the two systems (e.g. sales orders, business
partners, materials, …) >
Relevant processes and interfaces
Comparison Object <Comparison Object> is intended to verify the data consistency within the following
business processes and interfaces.
Business Process / Interface
Name
<Name of business process / interface
according to Solution Manager
documentation>
System/Step
Sender
<Name of business process step
and system according to Solution
Manager documentation>
System/Step
Receiver
<Name of business process step
and system according to Solution
Manager documentation>
GLOBAL PARAMETERS
Parameter
Value
Extraction Strategy
<Value>
Comparison block size
<Value>
Maximum number of errors
< Value>
CONNECTION PARAMETERS
Source 1
Parameter
Value
Source Type
<ABAP/FIXS/FIXL/…>
<Parameter Name>
<Parameter Value>
Source 2
Parameter
Value
Source Type
<ABAP/FIXS/FIXL/…>
3
DOCUMENTATION OF COMPARISON OBJECTS
<Parameter Name>
<Parameter Value>
DATA MODEL
An overview of the data model is shown in picture 1.
Figure 1: Data model
<Replace the screen shot of the data model as modeled in the Cross Database Comparison>
Description
<Provide a high level description of the data model in non-technical terms>
Foreign key relations
This section describes the join-conditions between the different tables in each source.
Source 1
Table~Field
(arrow from)
<table>~<field>
Table~Field
(arrow to)
<table>~<field>
Source 2
Table~Field
(arrow from)
<table>~<field>
Table~Field
(arrow to)
<table>~<field>
Mapping
This section describes the relation between the fields and tables that are compared by Comparison Object
<Comparison Object>
Table~Field
Table~Field
Mapping Name
Comparison Key
Source 1
Source 2
<Mapping Name>
<No.>
<table>~<field>
<table>~<field>
4
DOCUMENTATION OF COMPARISON OBJECTS
Context fields
Context fields are used to document additional data that is not directly compared but is important to assess
the criticality of an inconsistency or to identify context persons (e.g. based on a company code for financial
data). Use this section to document which context fields have been created and why.
Source
Table name
<1/2>
<table name>
Field name
Purpose
<field name>
<explain the reason for this filter usage>
Conversions
Conversions are used to translate from one format into another, e.g. adding leading zeros.
Conversion ID
Source 1
Conversion ID
Source 2
<Conversion type, e.g.
increase to n digits>
<Conversion type, e.g.
increase to n digits>
Mapping Name
<used mapping name>
Purpose
<describe why this
conversion was created on
instance level and how it
should be used>
Filters
Fixed Filters
Fixed filters are valid for all created Comparison Instances of a Comparison Object. They should usually
restrict the selection of compared objects to a specific fixed subset within a system (e.g. only objects of a
certain sub-type are exchanged from one system to another) or imply logical conditions, .e.g only open or
closed orders should be considered. Use this section to document which fixed filters have been created and
why.
Source
<1/2>
Table name
<table name>
Field name
Filter Value
Purpose
<field name>
<used filter value>
<explain the reason for this filter usage>
Variable (Instance Specific) Filters
Instance Specific filters are defined on Comparison Object level, but the actual value is maintained on the
Comparison Instance. Each Comparison Instance is utilizing its own set of values. These filters are used to
allow a parallelization by defining ranges of objects (e.g. execute Comparison Runs for Open Orders and
Closed Orders separately) or to restrict execution and access to data by organizational units (e.g. one
Comparison Instance per company code). Use this section to document which options for variable filters
have been defined and why.
Mapping
Name
Table~Field
Source 1
Table~Field
Source 2
<used
mapping
name>
<table>~<field>
<table>~<field>
Data Type
<data type, e.
Integer,
absolute time
stamp, variable
Purpose
<describe why this filter was created on
instance level and how it should be used>
5
DOCUMENTATION OF COMPARISON OBJECTS
time stamp>
LIMITATIONS
<Use this section to describe whether any limitations exist for the Comparison Object, e.g. any missing, but
important fields that could not be mapped due to a highly complex data model including aggregation and
summarizations or missing knowledge about the data model. Describe for each limitation what the impact is>
ENHANCEMENTS AND MODIFICATIONS
<Use this section to describe whether changes have been done to the generated extractors. Describe for
each change what the impact is and why it was done>
CONTACT PERSONS
Role
Name
Company
Contact Data
Requestor
<Name>
<Company name>
<eMail / adress / phone number>
Developer
<Name>
<Company name>
<eMail / adress / phone number>
Provider of
data model
<Name>
<Company name>
<eMail / adress / phone number>
CHANGES
No
Description
Changed at/by
<No.>
<Short description of change and reason>
<date / name>
<No.>
<Short description of change and reason>
<date / name>
<No.>
<Short description of change and reason>
<date / name>
6