dq xi seiebel ucm_user guide
TRANSCRIPT
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
1/68
Data Quality for Oracles Siebel UCM 11.7.0.0
April 2008
BusinessObjects Data QualityManagement for Oracles Siebel UCM 8.0
Users Guide
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
2/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
&RQWDFWLQIRUPDWLRQ Contact us on the Web at http://www.businessobjects.com/support
If you find any problem with this documentation, please report it to Business Objects
in writing at [email protected].
If your issue concerns a Business Objects product and not the documentation, please
contact our Customer Support experts.
&RS\ULJKW Copyright 2008 Business Objects. All rights reserved.
3DWHQWV Business Objects owns the following U.S. patents, which may cover products that are
offered and sold by Business Objects: 5,555,403, 6,247,008 B1, 6,578,027 B2,
6,490,593 and 6,289,352.
7UDGHPDUNV Business Objects, the Business Objects logo, Crystal Reports, and Crystal Enterprise
are trademarks or registered trademarks of Business Objects SA or its affiliated
companies in the United States and other countries. All other names mentioned herein
may be trademarks of their respective owners.
7KLUGSDUW\FRQWULEXWRUV Business Objects products in this release may contain redistributions of software
licensed from third-party contributors. Some of these individual components may
also be available under alternative licenses. A partial listing of third-party
contributors that have requested or permitted acknowledgments, as well as required
notices, can be found at: http://www.businessobjects.com/thirdparty
http://www.businesobjects.com/supportmailto:[email protected]:[email protected]://www.businesobjects.com/support -
8/2/2019 Dq Xi Seiebel Ucm_user Guide
3/68
8 r
&RQWHQWV
Preface.............................................................................................................7About this guide.........................................................................................7
Conventions ...............................................................................................7
Assumed audience .....................................................................................7
Naming conventions ..................................................................................7
About versions ...........................................................................................7
Access the latest Business objects documentation ....................................8
Chapter 1:
Overview ........................................................................................................ 9
Data quality overview ....................................................................................10
What is data quality? ...............................................................................10
What steps are involved in data quality? .................................................10What is Data Quality for Oracles Siebel UCM?...........................................13
Who updates Data Quality for Oracles Siebel UCM?............................13
Siebel Data Quality Universal Connector license and documentation....13
Firstlogic ..................................................................................................13
Address-cleansing transforms..................................................................13
Parsing and standardization-transforms...................................................13
Match transforms .....................................................................................13
Flexible business rules and configuration................................................13
Introduction to BusinessObjects Data Quality XI..........................................14
Data quality hub.......................................................................................14
More information about BusinessObjects Data Quality XI.....................14
Access BusinessObjects Data Quality XI documentation .......................15
Chapter 2:
Installation ................................................................................................... 17
System requirements on your Siebel systems ................................................18
Operating system requirements ...............................................................18
Installation scenarios ......................................................................................19
System with Windows server ..................................................................19
The installation process..................................................................................20
Prerequisite: Siebel Data Quality Universal Connector ..........................20
Step 1: Install BusinessObjects Data Quality XI, copy the dataflows, and
disable unused address engines ...............................................................20
Step 2: Install the Data Quality for Oracles Siebel UCM software........20Step 3: Application Administration setup................................................20
BusinessObjects Data Quality XI installation notes and procedures .............21
Install BusinessObjects Data Quality XI .................................................21
Copy dataflows and transforms to BusinessObjects Data Quality XI
installation................................................................................................21
Disable unused address cleanse engines..................................................22
Installing Data Quality for Oracles Siebel UCM on your Siebel system .....24
Install your Data Quality for Oracles Siebel UCM software .................24
Manual updates to configuration .............................................................24
http://-/?-http://-/?- -
8/2/2019 Dq Xi Seiebel Ucm_user Guide
4/68
7 v r P i w r p 9 h h R h y v Y D s P h p y r T v r i r y 8 S H & & h q P h p y r T v r i r y 8 S H & ' V r B v q r
Start the BusinessObjects Data Quality XI Server..................................24
Administrative setup ...................................................................................... 26
Change the third-party DLL name ..........................................................26
Edit the Siebel configuration file (for clients)......................................... 26
Enabling data quality through the Siebel application.............................. 26
Chapter 3:
Configuring Data Quality for Oracles Siebel UCM............................... 29
The client configuration file .......................................................................... 30
Format of the file..................................................................................... 30
Editing the file......................................................................................... 30
File parameters ........................................................................................ 30
Default Siebel configuration supported ......................................................... 31
Business components supported by default ............................................31
UCM batch object supported................................................................... 31
Siebel fields supported by default...........................................................31
Chapter 4:
Using Data Quality for Oracles Siebel UCM.......................................... 35
Interactive cleansing with Data Quality for Oracles Siebel UCM ............... 36
Using interactive cleansing .....................................................................36
Interactive matching and consolidation with Data Quality for Oracles
Siebel UCM ...................................................................................................37
Populate the match key value.................................................................. 37
Identify duplicate records........................................................................ 37
Remove duplicate records .......................................................................37
Batch processing ............................................................................................ 39
Setting the Where Clause ........................................................................39
Batch option components ........................................................................39
Creating a new batch job ......................................................................... 40
Running a batch job................................................................................. 41
Running the batch process from the command line ................................ 41Incremental Data Matching jobs .............................................................42
Batch jobs with the UCM Batch Manager .............................................. 42
Batch job considerations ................................................................................ 44
Cleansing business components in proper order .....................................44
Running batch processes simultaneously................................................44
Avoid cleansing the siebel administrator record ................................. 44
Consolidation after batch match ....................................................................45
Viewing duplicate records....................................................................... 45
Merge duplicate records .......................................................................... 45
For UCM Batch Manager........................................................................ 45
Chapter 5:
Concepts for customized applications....................................................... 47
Master configuration...................................................................................... 48
Configuration options.............................................................................. 49
Dataflow input/output field names ................................................................ 52
Add a new field .......................................................................................52
Remove a field ........................................................................................52
Example: adding new fields for cleansing/matching.....................................53
Working with address-cleansing errors ......................................................... 55
Posting address errors to your Siebel database ....................................... 55
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
5/68
8 r
Customizing and suppressing error messages .........................................55
Chapter 6:
Tips and troubleshooting............................................................................ 57
Parsing and standardization............................................................................58
Error on M/M field ..................................................................................58
BusinessObjects Data Quality XI...................................................................59
BusinessObjects Data Quality XI connection troubles............................59
Logging....................................................................................................59
Crash on DQXI service............................................................................59
Address cleanse transform change me setting .....................................60
Transaction dataflows..............................................................................60
Address cleansing...........................................................................................61
1030 error.................................................................................................61
Error on State or Country fields...............................................................61
Match/consolidate ..........................................................................................62
Interactive matching seems unusually slow ............................................62
Batch processing errors ..................................................................................63
Problems processing large record sets.....................................................63
Match Key Generation.............................................................................63Client and server issues ..................................................................................64
Client hangs .............................................................................................64
Client hangs/Data Quality Server windows Service not started
automatically............................................................................................64
Appendix A:
Reference.......................................................................................................65
Business component and dataflow reference...........................................65
Index ..............................................................................................................67
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
6/68
7 v r P i w r p 9 h h R h y v Y D s P h p y r T v r i r y 8 S H & & h q P h p y r T v r i r y 8 S H & ' V r B v q r
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
7/68
3UHIDFH
$ERXWWKLVJXLGHThis guide provides a general overview of BusinessObjects Data QualityManagement for Oracles Siebel UCM 8.0, as well as specific information for
installing and integrating this product into your Siebel environment.
&RQYHQWLRQV This document follows these conventions:
$VVXPHGDXGLHQFH This manual assumes that the people responsible for integrating BusinessObjects
Data Quality Management for Oracles Siebel UCM 8.0 are experienced users of
Siebel UCM and that the Siebel system has been fully configured to work with
this product.
This manual does not explain basic operation of Siebel UCM. For questions about
Siebel UCM, consult the appropriate Siebel documentation or Siebel technical
support.
1DPLQJFRQYHQWLRQV For brevity, BusinessObjects Data Quality Management for Oracles Siebel UCM8.0 is often in this guide called Data Quality for Oracles Siebel UCM.
$ERXWYHUVLRQV BusinessObjects Data Quality Management for Oracles Siebel UCM 8.0
supports only version 8.0 of Oracles Siebel UCM.
& R Q Y H Q W L R Q ' H V F U L S W L R Q
Bold We use bold type for file names, paths, emphasis, and text that
you should type exactly as shown. For example, Type cd\
dirs.
Italics We use italics for emphasis and text for which you should sub-
stitute your own data or values. For example, Type a name for
your file, and the .txt extension (testfile.txt).
Menu
commands
We indicate commands that you choose from menus in the fol-
lowing format: Menu Name > Command Name. For example,
Choose File > New.
We use this symbol to alert you to important information and
potential problems.
We use this symbol to point out special cases that you should
know about.
We use this symbol to draw your attention to tips that may be
useful to you.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
8/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
$FFHVVWKHODWHVW%XVLQHVVREMHFWVGRFXPHQWDWLRQ
In addition to the documentation installed on your computer during installation of
this product, you can access all the supported Business Objects documentation
from the Business Objects Customer Support site.
1. Go to http://www.businessobjects.com.
2. From the Support pull-down menu, choose Documentation.
3. On the Documentation screen, choose Product Guides and navigate to the
document that you want to view.
You can view the PDFs online or save them to your computer.
http://www.businessobjects.com/http://www.businessobjects.com/ -
8/2/2019 Dq Xi Seiebel Ucm_user Guide
9/68
8 u h r ) P r v r
&KDSWHU2YHUYLHZ
Before using BusinessObjects Data Quality Management for Oracles Siebel
UCM 8.0, you should understand some data quality concepts. A basic familiarity
with these concepts will help you to understand what Data Quality for Oracles
Siebel UCM does, and why your company benefits from data quality.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
10/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
'DWDTXDOLW\RYHUYLHZ
:KDWLVGDWDTXDOLW\" Data quality is a process of arranging customer information in a logical and
consistent order while cleansing, standardizing, and enhancing the data. The
process then combines related records to avoid duplicate entries. This process
adds value by creating a single view of your customers.
:KDWVWHSVDUHLQYROYHGLQGDWDTXDOLW\"
Generally, data quality requires five main steps:
This version of Data Quality for Oracles Siebel UCM fulfills these steps of the
data quality process:
parsing
correction
standardization
matching
consolidation
3DUVLQJ Parsing involves checking the structure and content of each field of a contacts
information, for example. During parsing, checks ensure that data appears where
it belongs; an address does not appear in a name field, for example. Some of the
more common elements to search for in a record during parsing include first and
last name, title, company name, business versus personal mailing address, e-mail
address, phone number (business, cell, fax), and social security number. Data in
Siebel is often entered in discrete fields, and doesnt need to be parsed. However,
you may configure your application to accept a multiline input that is parsed.
& R U U H F W L R Q
Correctioncan begin after parsing is complete and data resides in the proper
fields. In order to correct data, it becomes necessary to use secondary data
sources, such as the U.S. Postal Services National Directory or an international
postal directory, to check and validate address information. Using these
secondary sources, a program can check, for example, whether La Crosse,
Wisconsin is associated with the ZIP code 54601, whether Harborview Plaza is
actually a valid street name in La Crosse, and whether 100 is a valid address forthat street.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
11/68
8 u h r ) P r v r
6WDQGDUGL]DWLRQAfter correcting the
data, it is important
to standardizethe
data.
Standardization
works in
conjunction with
correction and parsing as it arranges customer information in a consistent andpreferred format. This facilitates successful matching and consolidation of data
elements. Examples of standardization include removal of dashes from a phone
number or social security number, use of a common abbreviation such as DEPT
for department number, or common representations of title such as Mr., Ms.,
Mrs., and Jr. It also includes the application of standard address elements such as
converting Street to St and converting South West to SW.
0DWFKLQJ Once a quality customer record exists, matchingshould become part of the data
quality analysis to eliminate redundancies. During the matching step, software
searches existing customer data records using specific business-defined criteria to
look for similar records. If no match is found, the data quality process is
complete. If a match is found, however, then there is one final step required.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
12/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
&RQVROLGDWLRQ When a match is found, simply identifying all of the related records in the
database is not enough to create a single view of the customer. Consolidationuses
the data found during matching to combine all of the similar data into a single
consolidated view of each customer. In Data Quality for Oracles Siebel UCM,
consolidation is accomplished by eliminating inferior records, or by merging the
matching records through Siebels merge process.
These data quality concepts provide a foundation that helps a business to develop
a clear picture of the customer, which can improve both efficiency and
effectiveness. Because there are so many touch points for customer data in an
organization, this activity has far-reaching implications in how you conductbusiness on a day-to-day basis.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
13/68
8 u h r ) P r v r
:KDWLV'DWD4XDOLW\IRU2UDFOHV6LHEHO8&0"
Data Quality for Oracles Siebel UCM is software that provides the correction
and standardization steps in the data quality process.
:KRXSGDWHV'DWD
4XDOLW\IRU2UDFOHV6LHEHO8&0"
Data Quality for Oracles Siebel UCM is created and maintained by Business
Objects, an SAP Company.
6LHEHO'DWD4XDOLW\8QLYHUVDO&RQQHFWRUOLFHQVHDQGGRFXPHQWDWLRQ
To install and use Data Quality for Oracles Siebel UCM, you must have a
software license for the Siebel Data Quality Universal Connector as part of your
Siebel configuration. The Siebel Data Quality Universal Connector is licensed
separately from Siebel UCM 8.0.
The functionality of the Siebel Data Quality Universal Connector used by this
product is documented in the Oracle publication, Siebel Data Quality
Administration Guide, Version 8.0.
)LUVWORJLF Within the GUI of Data Quality for Oracles Siebel UCM and in the document
Siebel Data Quality Administration Guide, Version 8.0, the term Firstlogic is
mentioned as a setting, technology, and as a software vendor. Since the creation
of the Siebel Data Quality Universal Connector, Firstlogic has been acquired by
Business Objects and the technologies or settings referred to as Firstlogic are
used by this product. In short, when you see the word Firstlogic, it applies to this
product.
$GGUHVVFOHDQVLQJWUDQVIRUPV
The address-cleansing transforms use address directories compiled from postal
authorities such as the United States Post Office, and other sources. Depending on
the country transforms you purchase, Data Quality for Oracles Siebel UCM can
cleanse both domestic (U.S.) and global addresses.
3DUVLQJDQGVWDQGDUGL]DWLRQWUDQVIRUPV
The parsing and standardization transforms use name dictionaries to find and, if
necessary, add or fix name and firm (business name) information from your
source data. For example, based on the name dictionary information, you can add
to your data other name-related components, such as gender, titles, and so on.
0DWFKWUDQVIRUPV The match transforms bring sophisticated record-matching and consolidation
technology to your Siebel applications.
)OH[LEOHEXVLQHVVUXOHVDQGFRQILJXUDWLRQ
Siebel administrators can fine-tune the results of Data Quality for Oracles Siebel
UCM by making changes to the BusinessObjects Data Quality XI dataflows that
are provided with the program.For information about modifying dataflows, see
the BusinessObjects Data Quality XI documentation.
You can integrate Data Quality for Oracles Siebel UCM no matter how youve
customized your Siebel application. For information about how to configure Data
Quality for Oracles Siebel UCM for a customized Siebel application, see
Concepts for customized applications on page 47.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
14/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
,QWURGXFWLRQWR%XVLQHVV2EMHFWV'DWD4XDOLW\;,
As a Data Quality for Oracles Siebel UCM user, you may wonder what
BusinessObjects Data Quality XI is and what it means to you. After installation,
you can use Data Quality for Oracles Siebel UCM with little thought given to
BusinessObjects Data Quality XI, because it handles the data quality processes
behind the scenes. The version of BusinessObjects Data Quality XI shipped as
part of the Data Quality for Oracles Siebel UCM is customized to run only aspart of the Data Quality for Oracles Siebel UCM, but the technology of
BusinessObjects Data Quality XI offers other potential solutions to your
enterprises data quality needs.
This section provides an overview of what BusinessObjects Data Quality XI
does, independent of its use within the Data Quality for Oracles Siebel UCM,
and tells you where you can find more information about BusinessObjects Data
Quality XI.
'DWDTXDOLW\KXE BusinessObjects Data Quality XI is the next generation data quality platform that
allows you to tie in all of your data quality needs to a single hub. Many users of
Data Quality for Oracles Siebel UCM also have data quality needs in otherapplications or other areas of their enterprise. Instead of having many disparate
solutions for each area of your enterprise, you can use BusinessObjects Data
Quality XI as the backbone for all of your data quality needs. With
BusinessObjects Data Quality XI, you can centralize and standardize this
processing through the following features.
&HQWUDOL]HGEXVLQHVVUXOH
UHSRVLWRU\
All of the business rule definitions are stored in a single repository that can be
shared by all applications that use BusinessObjects Data Quality XI. You can
organize business rules into reusable objects that can be shared to meet your
enterprise requirements.
You can use the same objects in a project for the Data Quality for Oracles SiebelUCM, your own custom application that incorporates BusinessObjects Data
Quality XI, or direct batch processing through BusinessObjects Data Quality XI
itself. This means that you can create data quality standards that are truly shared
across your entire enterprise.
6HUYLFHRULHQWHG
DUFKLWHFWXUH
BusinessObjects Data Quality XI is built on service-oriented architecture
principles. That means that BusinessObjects Data Quality XI is a service that can
work with your other applications.
You can set up any number of instances of the BusinessObjects Data Quality XI
Server software, and your applications (including Data Quality for Oracles
Siebel UCM) can communicate with that server directly, or via a web server using
the BusinessObjects Data Quality XI web service. This means that all of your
data quality processing can happen in one centralized area.
0RUHLQIRUPDWLRQDERXW%XVLQHVV2EMHFWV'DWD4XDOLW\;,
For more information about BusinessObjects Data Quality XI, see the
BusinessObjects Data Quality XI documentation. The documentation is available
in electronic format, both in a printable PDF file and an online help format.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
15/68
8 u h r ) P r v r
$FFHVV%XVLQHVV2EMHFWV'DWD4XDOLW\;,GRFXPHQWDWLRQ
After installing BusinessObjects Data Quality XI, you can access the
documentation from shortcuts on the Start menu.
To access the documentation:
1. Choose Start > Programs > BusinessObjects XI Release 2 >
Data Quality 11.7 > Documentation.
2. Click the appropriate shortcut for the documentation you want to view.
Documentation is installed as a separate component. The documentation
for BusinessObjects Data Quality XI is an optional installation component in
most cases. If you dont install the documentation while installing
BusinessObjects Data Quality XI, it wont be available on your system.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
16/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
17/68
8 u h r ! ) D h y y h v
&KDSWHU,QVWDOODWLRQ
This chapter explains the requirements and procedures for installing the
BusinessObjects Data Quality Management for Oracles Siebel UCM 8.0.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
18/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
6\VWHPUHTXLUHPHQWVRQ\RXU6LHEHOV\VWHPV
In some cases the requirements for servers or thick clients that use Data Quality
for Oracles Siebel UCM exceed those of regular Siebel servers or thick clients.
These requirements are documented in the following sections.
2SHUDWLQJV\VWHPUHTXLUHPHQWV
This section describes which operating systems are supported for this product.
6XSSRUWHGVHUYHU
RSHUDWLQJV\VWHPV
Windows 2000
Windows 2003
6XSSRUWHGFOLHQWRSHUDWLQJV\VWHPV
Windows 2000
Windows XP
This section does not discuss the system requirements for running the
BusinessObjects Data Quality XI portion of BusinessObjects Data Quality
Management for Oracles Siebel UCM 8.0. For that information, see the
BusinessObjects Data Quality XI documentation that is included in this
software package.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
19/68
8 u h r ! ) D h y y h v
,QVWDOODWLRQVFHQDULRV
As you integrate Data Quality for Oracles Siebel UCM, you must consider that a
computer running Siebel software might be used as a server, a connected thick
client, a mobile thick client or a zero-footprint client.
6\VWHPZLWK:LQGRZVVHUYHUData Quality for Oracles Siebel UCM is run on either a Siebel server computer, athick (mobile) client computer, or a zero-footprint client computer.
&RQQHFWHGWKLFNFOLHQWV The term connected thick client refers to a thick client computer that always
has access to a Siebel server computer. These types of thick clients require some
setup to be able to run Data Quality for Oracles Siebel UCM, but only require a
very small amount of disk space for Data Quality for Oracles Siebel UCM-
related files (approximately 1 MB). If you want to use the Siebel Simulator to test
UCM workflows before publishing, you may be using this scenario.
0RELOHWKLFNFOLHQWV The term mobile thick client refers to a thick client computer that may be used
remotely and isnt always connected to a Siebel server computer.
These clients can be set up to access a remote Data Quality for Oracles Siebel
UCM server (one available via the network) or you can install an additional Data
Quality for Oracles Siebel UCM server directly to the remote client. If you want
to use the Siebel Simulator to test UCM workflows before publishing, you may
be using this scenario.
=HURIRRWSULQWFOLHQWV You can configure Data Quality for Oracles Siebel UCM to operate on
zero-footprint (thin) clients. In this scenario, no files are installed on the client
computer, but are instead installed to a server computer.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
20/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
7KHLQVWDOODWLRQSURFHVV
This section explains the high-level installation steps and tells you where to look
for more detailed steps.
3UHUHTXLVLWH6LHEHO
'DWD4XDOLW\8QLYHUVDO&RQQHFWRU
To install and use Data Quality for Oracles Siebel UCM, you must have a
software license for the Siebel Data Quality Universal Connector as part of yourSiebel configuration. The Siebel Data Quality Universal Connector is licensed
separately from Siebel UCM 8.0.
6WHS,QVWDOO%XVLQHVV2EMHFWV'DWD4XDOLW\;,FRS\WKHGDWDIORZVDQGGLVDEOHXQXVHGDGGUHVVHQJLQHV
Your first step is to install BusinessObjects Data Quality XI, copy the dataflows
that are used for Data Quality for Oracles Siebel UCM, and disable the unused
address engines.
For instructions on installing BusinessObjects Data Quality XI, see the
BusinessObjects Data Quality XI documentation, but for instruction on copying
the dataflows and other additional and necessary details, see BusinessObjects
Data Quality XI installation notes and procedures on page 21.
6WHS,QVWDOOWKH'DWD4XDOLW\IRU2UDFOHV6LHEHO8&0VRIWZDUH
Your next step is to install the software that powers the Data Quality for Oracles
Siebel UCM. This software allows your Siebel application to interact with the
BusinessObjects Data Quality XI Server you install in Step 1. You can install it to
the same computer that houses the Siebel server, or to any computer that is
available to the Siebel server and Siebel clients via the network.
For details on this installation step, see Installing Data Quality for Oracles
Siebel UCM on your Siebel system on page 24.
6WHS$SSOLFDWLRQ$GPLQLVWUDWLRQVHWXS
You must change the DLL name for Data Quality for Oracles Siebel UCM. You
do this through the Application Administration screens of your Siebel
application.
For details on this step, see Administrative setup on page 26.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
21/68
8 u h r ! ) D h y y h v
%XVLQHVV2EMHFWV'DWD4XDOLW\;,LQVWDOODWLRQQRWHVDQG
SURFHGXUHV
This section describes issues unique to installing BusinessObjects Data Quality
XI as part of Data Quality for Oracles Siebel UCM, including a procedure to
copy the Data Quality for Oracles Siebel UCM dataflows and transforms from
the BusinessObjects Data Quality Integration Studio Dataflows installation
media and disabling unused address cleanse engines. You must complete the
installation and configuration of BusinessObjects Data Quality XI before
proceeding to the rest of the installation of Data Quality for Oracles Siebel UCM.
,QVWDOO%XVLQHVV2EMHFWV'DWD4XDOLW\;,
You must install BusinessObjects Data Quality XI before installing the other
components of Data Quality for Oracles Siebel UCM. You can find instructions
for installing, configuring, and running BusinessObjects Data Quality XI in the
BusinessObjects Data Quality XI documentation.
%XVLQHVV2EMHFWV'DWD
4XDOLW\;,LQVWDOOPDFKLQH
You can install BusinessObjects Data Quality XI on the same machine as the
Siebel server, on a different machine, or even on a machine with a different
operating system than the one that contains your installation of Siebel.
Business Objects strongly recommends that you create a new database instance
(depending on your database) for the BusinessObjects Data Quality XI Metadata
Repository and Global Parsing Option dictionaries.
Information about the system requirements for the machine on which you install
BusinessObjects Data Quality XI and the recommendations provided here are
included with the BusinessObjects Data Quality XI documentation.
%XVLQHVV2EMHFWV'DWD
4XDOLW\;,SUHYLRXVO\
LQVWDOOHG
If you are already a BusinessObjects Data Quality XI customer (prior to the
installation of this product) and therefore have already installed a version of
BusinessObjects Data Quality XI, you must upgrade to BusinessObjects DataQuality XI 11.7.1.0, which is provided as part of this software package.
See the BusinessObjects Data Quality XI documentation for details of how to
upgrade.
&RS\GDWDIORZVDQGWUDQVIRUPVWR%XVLQHVV2EMHFWV'DWD4XDOLW\;,LQVWDOODWLRQ
The BusinessObjects Data Quality Integration Studio Dataflows installation
media that ships with this product contains dataflows and transforms in the form
of.xml files that are specific to the functionality of the Data Quality for Oracles
Siebel UCM. You must copy the dataflows and transforms from the installation
media to your BusinessObjects Data Quality XI installation.
If you have a previous installation of BusinessObjects Data Quality XI and
you have customized any dataflows or transforms, copying the dataflows and
transforms from the installation media will overwrite the existing files and
therefore overwrite any customizations you have made. Before copying the
dataflows and transforms to your BusinessObjects Data Quality XI
installation, you should make a backup copy of all the files in the
DataQualityinstall\repository\folder, where DataQualityinstallis the
location of your BusinessObjects Data Quality XI installation (by default, c:\
dqxi\11_7).
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
22/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
To copy the dataflows and transforms to your BusinessObjects Data Quality XI
installation:
1. From the BusinessObjects Data Quality Management for Oracles Siebel
UCM 8.0 UCM Dataflows installation media, copy the folder repository
(and all the folders and files within) to the folder DataQualityinstall\, where
DataQualityinstallis the location of your BusinessObjects Data Quality XI
installation (by default, c:\dqxi\11_7).
2. When prompted for permission to overwrite files, choose Yes to all. The
files are copied to their correct locations in subdirectories of the folder
DataQualityinstall\repository\.
3. Restart the BusinessObjects Data Quality XI Server.
'LVDEOHXQXVHGDGGUHVVFOHDQVHHQJLQHV
After installing BusinessObjects Data Quality XI and copying the additional
dataflows and transforms, you must disable in BusinessObjects Data Quality XI
the country-based address cleanse engines that you did not purchase in order for
this product to work properly.
The following is the list of BusinessObjects Data Quality XI address engines that
you can disable:
Australia Plugin
Canada Plugin
Global Address Cleanse Japan (for Japanese Unicode data)
Japan Plugin
Multi Country Plugin
USA Plugin
These address engines are configured with the assumption that you purchased all
of the address technology engines, so each engine is enabled upon installation. Ifyou purchased only a subset of the address processing engines, you must
manually disable the unused address cleanse engines.
To disable unused address cleanse engines:
1. In the BusinessObjects Data Quality XI Project Architect, go to projects/
blueprints/siebel/transactional_business_address_datacleanse.
2. Right-click any address cleanse engine you want to disable, and select
Disable from the context-sensitive menu.
Disabled engines are displayed as gray and indicated with the symbol 7 in
the upper-left corner.
3. Select the transform Global Suggest Lists Global.
4. For Global Suggest Lists Global, in the Option Group Name, select
ENGINES.
for
You may also want to disable individual address cleanse engines to allow
you to test only a certain address cleanse engine in isolation from others, or
for any other purposes. However, you must disable address cleanse engines
that are not purchased and used.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
23/68
8 u h r ! ) D h y y h v
5. In the Options pane, change the Value to NO for any engine you want to
disable, if the engine is available in the list.
6. Click the menu button Verify Project to make sure the dataflow is free of
errors.
7. Repeat the steps for other dataflows that use address cleanse transforms.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
24/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
,QVWDOOLQJ'DWD4XDOLW\IRU2UDFOHV6LHEHO8&0RQ\RXU6LHEHO
V\VWHP
After you have installed and configured BusinessObjects Data Quality XI
according to the instructions in the BusinessObjects Data Quality XI
documentation, the next step is to install Data Quality for Oracles Siebel UCM
on your Siebel system.
,QVWDOO\RXU'DWD4XDOLW\IRU2UDFOHV6LHEHO8&0VRIWZDUH
Usually you install this software to the same computer that houses your Siebel
server.
To install the software for the Data Quality for Oracles Siebel UCM:
1. From the Data Quality for Oracles Siebel UCM, run setup.exe.
2. After you accept the license agreement, follow the on-screen installation
instructions to install your software.
During the installation, you are prompted for various information about your
system and Siebel server. The installation attempts to automatically identify
some of this information. Be prepared to supply the following items, ifnecessary:
BusinessObjects Data Quality XI Server IP address and bootstrap file
location (by default, the bootstrap file is located in DataQualityinstall\
repository\configuration_rules\)
Destination folder location
Path to the Siebel root location directory (for example, c:\sba8\siebsrvr)
3. Reboot your system after the installation is complete.
If you chose the default location, setup installs files into the
c:\Program Files\BusinessObjects\DQ_for_Siebel folder and copies files to the
Siebelroot\bin and Siebelroot\SDQConnector folders. This Users Guide refers
to this path as the installation path. If you choose a different path for installation,
you must note this change when the document refers to the default path.
0DQXDOXSGDWHVWRFRQILJXUDWLRQ
You can make manual changes to the configuration information obtained at
installation. The configuration information is stored in the file
Siebelroot\SDQConnector\DQClient.xml.
If the setup routine could not connect to BusinessObjects Data Quality XI and
automatically update DQClient.xml, you must make these changes in order to
provide the information necessary for the Siebel server to communicate with the
BusinessObjects Data Quality XI Server. You must also make changes to this file
if the information about your BusinessObjects Data Quality XI Server changes.
For instruction on making changes to DQClient.xml, see The client
configuration file on page 30.
6WDUWWKH%XVLQHVV2EMHFWV'DWD4XDOLW\;,6HUYHU
After you have installed Data Quality for Oracles Siebel UCM, you must start
the BusinessObjects Data Quality XI Server (if it is not already running), before
this product can run data quality operations. For details on starting and stopping
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
25/68
8 u h r ! ) D h y y h v
the BusinessObjects Data Quality XI Server, see the BusinessObjects Data
Quality XI documentation.
Before executing the UCM process with data quality enabled, you must have
completed all setup procedures for your Siebel system, as described in the
Siebel UCM documentation.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
26/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
$GPLQLVWUDWLYHVHWXS
There is some further administrative setup to perform. Before you can use Data
Quality for Oracles Siebel UCM, you must change the third-party DLL name in
the Application Administration screens, edit the Siebel configuration file, and
enable data quality through the Siebel application.
&KDQJHWKHWKLUGSDUW\'//QDPH
To change the third-party DLL name:
1. Open the Site Map in the Siebel application.
2. Under Administration - Data Quality, clickData Quality Settings.
3. Click Third Party Administration.
4. For the Name Firstlogic, change the DLL Name from FirstlogicConnector
to DQClient.
For more information about using the administration screens, see the Siebel Data
Quality Administration Guide, Version 8.0.
(GLWWKH6LHEHOFRQILJXUDWLRQILOHIRUFOLHQWV
To enable data cleansing and deduplication, you must first set some
parameters in your Siebel configuration file. This is necessary only for your
clients, not your server. For UCM, this is necessary if you intend to run the
Siebel Simulator to test your UCM workflows.
1. Open your Siebel configuration file (siebel.cfg for example).
2. Locate the [DataCleansing] section.
3. For the value of the Enable parameter, enter True.
4. For the value of the Type parameter, enter Firstlogic.
This section of your configuration file might look like this:
[DataCleansing]
Enable = True
Type = Firstlogic
5. Save and close the configuration file.
(QDEOLQJGDWDTXDOLW\WKURXJKWKH6LHEHODSSOLFDWLRQ
After setting up your configuration file, there are some additional steps you
must take to enable data cleansing and deduplication in your client/server
architecture.
)RUEDWFKSURFHVVLQJ To enable batch processing via your clients:
1. From your Siebel application, choose Administration - Server
Configuration > Servers > Components.
Note: You can repeat these steps for the [DeDuplication] section
also.You can enable the Data Cleansing and Deduplication options
independently; the two dont need to be the same value. Restart your
Siebel Server after making changes to the configuration files in order
to activate the changes.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
27/68
8 u h r ! ) D h y y h v
2. Choose Data Quality Manager from the list.
3. Click the Component Parameters tab.
4. To enable batch data cleansing, set the Data Cleansing Enable Flag to
True.
5. Enter Firstlogic as the Data Cleansing Type.
6. To enable batch deduplication, set the Deduplication Enable Flag to True.
7. Enter Firstlogic as the Deduplication Data Type.
8. Restart your Siebel Server to enable the change.
)RULQWHUDFWLYHSURFHVVLQJ To enable interactive data cleansing and deduplication, follow these steps.
1. Navigate to Administration - Server Configuration > Enterprise >
Component Definitions.
2. Select the appropriate component (for example, Sales Object manager).
3. To enable interactive cleansing, set the Data Cleansing Enable Flag to
True.
4. Enter Firstlogic as the Data Cleansing Type.
5. To enable interactive deduplication, enter Firstlogic as the Deduplication
Data Type.
6. Set the Deduplication Enable Flag to True.
7. Restart your Siebel Server to enable the change.
If you are licensed to use List Import, repeat the previous steps on the following
components:
List Import Service Manager
Workflow Process Batch Manager
Workflow Process Manager
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
28/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
If you intend to use the UCM Batch Manager to execute CDM workflows,
repeat the previous steps on the UCM Batch Manager component. If you
want to use the interactive and batch process on regular CRM data of UCM,
you must also configure the UCM Object Manager.
For more information, see your Siebel UCM documentation and the Siebel
Data Quality Administration, Version 8.0 .
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
29/68
8 u h r " ) 8 s v t v t 9 h h R h y v s P h p y r T v r i r y V 8 H
&KDSWHU&RQILJXULQJ'DWD4XDOLW\IRU2UDFOHV6LHEHO8&0
Through the installation process, all of the necessary files are configured to
properly run BusinessObjects Data Quality Management for Oracles Siebel
UCM 8.0. You may, however, change items after installation. If you change
settings, refer to this chapter to reconfigure them properly.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
30/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
7KHFOLHQWFRQILJXUDWLRQILOH
During the installation process, you install the client configuration file
(DQClient.xml) to each of the thick clients and to the Siebel server. If your
configuration requires any variations from the default settings, you must edit this
file.
)RUPDWRIWKHILOH DQClient.xml is an XML file. Here are the files contents:
dqxiserver120004
projects\blueprints\siebel\read_configuration_file.xmlc:\dqxi\11_7\repository\
configuration_rules dqxiserver1_substitutions.xml
(GLWLQJWKHILOH To edit the file, change the value between the opening and closing parameter tags.
)LOHSDUDPHWHUV The following table explains the parameters and valid values in this file.
Q h h r r 9 r p v v
DQXI_SERVER_IP The IP address of the BusinessObjects Data Quality XI
Server.
DQXI_SERVER_PORT The port number of the BusinessObjects Data Quality XI
Server.
DQXI_INITIALIZATION
_DATAFLOW_NAME
The name and path of the dataflow file that contains the
initialization settings for BusinessObjects Data Quality
Management for Oracles Siebel UCM 8.0. By default,
this setting is
projects\blueprints\siebel\read_configuration_file.xml
DQXI_REPOSITORY
_PATH
The path to the location of the BusinessObjects Data
Quality XI repository folder.
DQXI_SUBSTITUTION
_FILE
The name of the file that contains the BusinessObjects
Data Quality XI substitutions for data fields. By default
the file is
dqxiserver1_substitutions.xml.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
31/68
8 u h r " ) 8 s v t v t 9 h h R h y v s P h p y r T v r i r y V 8 H
'HIDXOW6LHEHOFRQILJXUDWLRQVXSSRUWHG
Data Quality for Oracles Siebel UCM is designed to work out of the box with
Siebels default configuration. However, some Siebel users have customized
applications that use specialized Business Components or fields.
This section explains which business components and fields are supported by
default. If your Siebel configuration matches the configuration below, you can
move on to Using Data Quality for Oracles Siebel UCM on page 35. If your
configuration differs, you will need to perform some additional setup. See
Concepts for customized applications on page 47 for further details.
%XVLQHVVFRPSRQHQWVVXSSRUWHGE\GHIDXOW
The following business components are supported with the default configuration
of Data Quality for Oracles Siebel UCM.
Account
Business Address
Contact
List Management Prospective Contact
CUT Address (for Vertical)
Personal Address (for Horizontal)
8&0EDWFKREMHFWVXSSRUWHG
The ability to run UCM batch jobs on the following object types is supported with
the default configuration of Data Quality for Oracles Siebel UCM.
Account
Contact
6LHEHOILHOGVVXSSRUWHGE\GHIDXOW
This section discusses fields that are supported with the default configuration of
Data Quality for Oracles Siebel UCM.
If any of the default settings are missing from your configuration, you may need
to enter them in the Third Party Administration Field Mappings section for the
Business Components and their operations.
For example, the Contact Deduplication BC Operation may not include the
Primary State and Primary Street Address Field Mappings. If these mappings
do not exist, you must add them. For information on adding Field Mappings, see
the Siebel Data Quality Administration Guide, Version 8.0.
3DUVLQJDQG
VWDQGDUGL]DWLRQ
Parsing and standardization occurs on the following Siebel fields, by default.
Siebel Industry Applications usually require some additional configuration.
For information on how data quality fields are mapped to Siebel Business
Component fields, see the Siebel Data Quality Administration Guide,
Version 8.0.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
32/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
$GGUHVVFOHDQVLQJ Address cleansing occurs on the following Siebel fields, by default.
0DWFKLQJDQG
FRQVROLGDWLRQ
Matching and consolidation occurs on the following Siebel fields, by default.
7 v r p r A v r y q
Account Name
Location
Contact Last Name
First Name
Middle Name
Job Title
List Mgmt Prospective Contact Last Name
First Name
Middle Name
Job Title
Account
Primary Account Location
7 v r p r A v r y q
Business Address
CUT Address
Personal Address
List Mgmt Prospective Contact
Street Address
Street Address 2
City
State
Postal Code
Country
7 v r p r A v r y q
Account Primary Account Street Address
Primary Account City
Primary Account State
Primary Account Postal Code
Primary Account Country
Name
Location
Dedup Token
Id
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
33/68
8 u h r " ) 8 s v t v t 9 h h R h y v s P h p y r T v r i r y V 8 H
Contact First Name
Middle Name
Last Name
Primary Account Name
Account Location
Primary Street Address
Primary City
Primary State
Primary Postal Code
Primary Country
Dedup Token
Id
List Mgmt Prospective Contact First Name
Middle Name
Last Name
Account
Primary Account Location
Street Address
City
State
Postal Code
Country
Dedup Token
Id
7 v r p r A v r y q
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
34/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
35/68
8 u h r # ) V v t 9 h h R h y v s P h p y r T v r i r y V 8 H
&KDSWHU8VLQJ'DWD4XDOLW\IRU2UDFOHV6LHEHO8&0
Now that you have finished setting up BusinessObjects Data Quality
Management for Oracles Siebel UCM 8.0, you can use its capabilities. For
example, you can run a batch session to cleanse all of the records that exist in
your database already.
Data Quality for Oracles Siebel UCM also includes real-time, interactive
processing so you can be sure that new records are properly cleansed on their way
in to your Siebel database.
This section serves as a supplement to the information found in the Siebel
Data Quality Administration Guide, Version 8.0 about running interactive
and batch data quality jobs. For detailed, step-by-step instructions on thedata quality functionality and running jobs within your Siebel application,
see the Siebel documentation.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
36/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
,QWHUDFWLYHFOHDQVLQJZLWK'DWD4XDOLW\IRU2UDFOHV6LHEHO
8&0
Data Quality for Oracles Siebel UCMs interactive or real-time cleansing
capability lets your Siebel users cleanse the data at the point of entry into your
Siebel database. You can cleanse both name and address data in interactive mode.
8VLQJLQWHUDFWLYHFOHDQVLQJ
For interactive name and address cleansing, Siebel users need to take no further
action. The data is cleansed automatically when they save the record, select
another record, or attempt to exit the program. In this example, one of your users
adds information for a new account. The data isnt entered properly, and the ZIP
code is left blank.
After the user steps off the record or saves the record, the cleansing takes place.
When the user returns to the original record, the data is cleansed.
The actual cleansing that takes place varies based on the Siebel screen youre
working in and based on any customizations you performed to Data Quality forOracles Siebel UCM. In this example, the following items were cleansed.
The street name was corrected and properly cased.
The city was spelled properly and cased properly.
The state was cased properly.
The ZIP code was added.
The country was spelled out and properly cased.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
37/68
8 u h r # ) V v t 9 h h R h y v s P h p y r T v r i r y V 8 H
,QWHUDFWLYHPDWFKLQJDQGFRQVROLGDWLRQZLWK'DWD4XDOLW\IRU
2UDFOHV6LHEHO8&0
Data Quality for Oracles Siebel UCMs interactive (or real-time)
match/consolidate capability notifies your Siebel users when they enter a record
that might already exist in your Siebel database.
3RSXODWHWKHPDWFKNH\YDOXH
The match key is used during the matching process to help narrow the candidates
for potential matches. This makes for quicker matching. This field is
automatically populated on records you create after installing Data Quality for
Oracles Siebel UCM.
To populate the match key value for records in your database prior to installing
Data Quality for Oracles Siebel UCM, run an initial match key generation batch
job. For information on running an initial match key generation batch job, see the
Siebel Data Quality Administration Guide, Version 8.0.
,GHQWLI\GXSOLFDWHUHFRUGV
To identify potentially duplicate records, your Siebel users need to take no extra
steps. The potential matches are identified automatically when they save the
record, select another record, or attempt to exit the program. To resolve the
duplicate, however, your users take an active role.
The user can select a matching record to which the current entered record will be
merged.
5HPRYHGXSOLFDWHUHFRUGV
After you enter a potentially matching record, the Possible Matching Accounts
screen appears.
The match key value is used only during interactive processing.
U u r r p q w
r r r q v p v q r r q
u r h r h q u
u r r
Q v i y r h p u v t r p q h r
u u r r
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
38/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
To eliminate unwanted duplicate records:
1. To consolidate/merge the record you just created, click Pick.
2. To keep all records shown, click Ignore All.
3. If you keep all records, you can click the hyperlink of the record in the
Accounts List, and then click the Duplicate Accounts tab in the bottom
section. The potential matching records are shown there. Click Pick to merge
the records.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
39/68
8 u h r # ) V v t 9 h h R h y v s P h p y r T v r i r y V 8 H
%DWFKSURFHVVLQJ
Batch processing uses jobs to process records within a business component. You
can process all the records in a business component or you can select a subset of
the available records.
6HWWLQJWKH:KHUH&ODXVHThe Where Clause option allows you to selectively process records for DataQuality for Oracles Siebel UCM. For example, you can choose to process only
records that were updated on or after a certain day. This decision could save
processing time, because you wouldnt be processing records that you may have
already cleansed.
The Where Clause option is set up to operate the same way that the Where
Clauses within Siebel server Tasks operate. For more information on clauses and
running batch jobs in Siebel, see the Siebel Data Quality Administration Guide,
Version 8.0.
%DWFKRSWLRQ
FRPSRQHQWV
You can customize the Data Quality Manager batch option components by
entering values in the Administration - Server Management > Jobs screen forthe following job parameters:
Buscomp Name
Business Object Name
Data Quality Setting
Operation Type
Also, you can create a Where Clause, if necessary.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
40/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
The following table shows configuration settings for creating Data Quality
Manager batch option components for this product.
&UHDWLQJDQHZEDWFK
MRE
To create a new batch job:
1. From your Siebel application, navigate to Administration - Server
Management > Jobs.
From here you can create new batch jobs or view the results of a previous
batch run.
2. In the Jobs screen, click the New button to create a new job.
3. From the Component/Job field of your new job, select Data Quality
Manager.
7 p I h r h q
7 v r P i w r p
I h r
9 h h R h y v T r v t P r h v
U r
Accounts:
Account "",Yes,account_datacleanse.xml" Data Cleansing
Account "",Yes,account_match.xml" DeDuplication
Address datacleanse for horizontal applications:
Business Address "",Yes,business_address_datacleanse.xml" Data Cleansing
Personal Address "",Yes,business_address_datacleanse.xml" Data Cleansing
Address datacleanse for vertical applications:
CUT Address "",Yes,business_address_datacleanse.xml" Data Cleansing
Prospects:
List Mgmt Prospective
Contact
"",Yes,prospect_datacleanse.xml" Data Cleansing
List Mgmt Prospective
Contact
"",Yes,prospect_match.xml" DeDuplication
Contacts:
Contact "",Yes,contact_datacleanse.xml" Data Cleansing
Contact "",Yes,contact_match.xml" DeDuplication
Incremental match for Accounts, Prospects, and Contacts:
Account "",No,account_incremental_match.xml" DeDuplication
List Mgmt Prospective
Contact
"",No,prospect_incremental_match.xml" DeDuplication
Contact "",No,contact_incremental_match.xml" DeDuplication
The syntax of a Data Quality Setting must be precise. Any error in the syntax
could cause inaccurate results or cause a batch job to fail.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
41/68
8 u h r # ) V v t 9 h h R h y v s P h p y r T v r i r y V 8 H
4. In the Job Parameters frame, click New to create a new job parameter.
5. For the Name field, select the following parameters:
Buscomp Name
Business Object Name
Operation Type
Data Quality Setting
6. In the Value field for each Name field parameter, enter an appropriate
value for the component you want to create.
5XQQLQJDEDWFKMRE If you just created a new batch job and are already in the Jobs screen with the
current job is selected, click Submit Job to run your batch job.
If you are not currently in the Jobs screen, follow this procedure.
To run a batch job:
1. From your Siebel application, choose Administration - ServerConfiguration.
2. Access the Job Detail menu.
3. Select the job you want to run.
4. Click Submit Job to start the batch process.
You can refresh the view to check the jobs status.
5XQQLQJWKHEDWFKSURFHVVIURPWKH
FRPPDQGOLQH
You can also run a batch process request from the command line.
To run a batch process from the command line, enter the following commandsand enter information appropriate for your system in place of the italicized
items.
1. Go to the/bin subdirectory beneath the Siebel installation location on
your Siebel Server.
2. Enter the following command:
srvrmgr /ggateway server name/eenterprise server name/uusername
/ppassword/sSiebel Server name/llanguage (ENU for English)
3. For each batch task, type the following:
run task for comp DQMgr with BCName =Buscomp Name,BobjName = Business Object Name,
OpType =Operation Type,
ObjWhereClause=Object Where Clause,
ObjSortClause =Object Sorting Clause,
ConnectStr= Connect String,
DQSetting =Data Quality Value
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
42/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
,QFUHPHQWDO'DWD0DWFKLQJMREV
Incremental Data Matching jobs can be performed if you want to perform
matching for a subset of records in the database. For example, if you want to
perform matching on just the records that have been updated today, you could
include the Object Where Clause job parameter with the following value:
[Updated] = Today()
This job parameter requires all of the records that were updated today to be used
as master records. The job run then searches the entire database for potential
duplicates to the master records (including duplicates within the restrictions of
the Where Clause; in this instance, those updated today are compared against
each other as possible duplicates).
Because of this Object Where Clause, the job run does not check the records that
existed before today to find potential duplicates for them. It compares only pre-
existing records to find duplicates to the master records. Presumably, records that
existed before today have already been processed for duplicates, and in this job
you want to process only the new records, providing an efficiently smaller group
to be processed.
%DWFKMREVZLWKWKH8&0%DWFK0DQDJHU
Siebel UCM offers a Batch Manager for the execution of batch jobs. The
capability of Data Quality for Oracles Siebel UCM can be employed to provide
data quality operations on your UCM data management operations.
For example, through the UCM load process you might have incomplete or
inaccurate records to upload to a Siebel database. You can run the UCM Batch
Manager with the necessary UCM parameters to cleanse the incoming data and
perform a match against the existing data.
In this example, the UCM job is run for Account UCM on all the records that are
Queued-Insert.
In this example, the Data Quality setting would be different than those listed
in Batch option components on page 39. You would use a*_incremental_*.xml dataflow and the setting No instead of Yes as the
second value.
This section discusses the Batch Manager as used with Data Quality
functionality. For specific details in running jobs with the UCM Batch
Manager, see the documentation for Siebel Universal Customer Master at the
Siebel Bookshelf.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
43/68
8 u h r # ) V v t 9 h h R h y v s P h p y r T v r i r y V 8 H
When the UCM Batch Manager operation completes successfully, the data from
the SDH table is successfully cleansed and consolidated to give the best record, as
per the UCM process. Some records from the SDH table require manual
intervention to create the best version of the record.
To understand the consolidation of records that may be matches, see
Consolidation after batch match on page 45.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
44/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
%DWFKMREFRQVLGHUDWLRQV
When running batch jobs, you should consider the following issues.
&OHDQVLQJEXVLQHVVFRPSRQHQWVLQSURSHU
RUGHU
You should always perform address cleansing before parsing and standardization.
Before running batch match/consolidate for the first time, you must run batch
address cleansing and parsing and standardization.
If you plan to cleanse both the Contact and Account Business Components, you
must cleanse Account first.
Contact uses a calculated value to determine its internally stored Match
Candidate Token. This calculation uses data from the account that the contact is
associated with. Therefore, to keep this field up to date, Account must be
cleansed before Contact.
5XQQLQJEDWFKSURFHVVHVVLPXOWDQHRXVO\
You cannot run more than one batch process simultaneously.
$YRLGFOHDQVLQJWKHVLHEHODGPLQLVWUDWRUUHFRUG
The read-only siebel administrator record must not be subjected to cleansing.
Since this record is dated January 1, 1980, a simple method to exclude this record
from the batch process would be to set a Where Clause that allows only records
that take place after this date to be processed. For example:
[Created] >= 1/2/80
This syntax requires that only records with a creation date on or after 1/2/80 are
processed. Any date after 1/1/80 but before the earliest creation date of other
records would produce the same result.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
45/68
8 u h r # ) V v t 9 h h R h y v s P h p y r T v r i r y V 8 H
&RQVROLGDWLRQDIWHUEDWFKPDWFK
By consolidating records, you get to choose which master record to keep. This
section explains how to consolidate your records by viewing the records and
merging duplicate records.
9LHZLQJGXSOLFDWHUHFRUGVAfter running the batch matching process, you can view the records that wereidentified as matches. Choose Navigate > Site Map > Administration - Data
Quality.
0HUJHGXSOLFDWHUHFRUGV
To merge duplicate records in either the Duplicate Accounts, Duplicate Contacts,
or Duplicate Prospects screen:
1. Click the hyperlink of a record.
A Duplicate Resolution screen appears.
2. In the Sequence field, enter the sequence number for the record. Enter 1 for
the master record, or the record you want to keep. Enter 2 (or 3, 4, and so on)
for the subordinate records that will be merged into the main record.
3. Highlight all of the records in the group you want to merge.
4. Click Merge.
The master record (that is, the record you assigned 1 in the Sequence field) is
retained, with any missing fields in the record populated by data from the
other records in the order of sequence.
)RU8&0%DWFK0DQDJHU
During the UCM batch process, any records that require manual intervention are
queued in the Incoming Duplicates view in the Administration - Universal
Customer Master screen. You can manually review and resolve the duplicates that
are identified in the UCM batch process.
For details on this process, see the Siebel UCM documentation.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
46/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
47/68
8 u h r $ ) 8 p r s p v r q h y v p h v
&KDSWHU&RQFHSWVIRUFXVWRPL]HGDSSOLFDWLRQV
BusinessObjects Data Quality Management for Oracles Siebel UCM 8.0 is
designed to work with Siebels default configuration, but users who have custom
fields or business components may need to perform some individual
configuration.
If you have a Siebel application in which you have renamed or added a Business
Component or field, there are some concepts with which you should become
familiar.
%XVLQHVV2EMHFWV*OREDO
6HUYLFHV
Some customizations to the default configuration can be problematic. Before
proceeding on your own with far-reaching customizations, you should contact
Business Objects Global Services. Contact your Account Manager or BusinessObjects Customer Service to find out more about Business Objects Global
Services.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
48/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
0DVWHUFRQILJXUDWLRQ
The basic configuration of Data Quality for Oracles Siebel UCM is handled in
the BusinessObjects Data Quality XI Project Architect. In the Project Architect,
open configuration_rules\dataflow_objects\shared_options\
siebel_connector_base.
Once selected, siebel_connector_base appears in the Option Explorer and Option
Editor.
From here, you make the master configurations to Data Quality for OraclesSiebel UCM.
The major sections in these options group settings are the following:
configurations settings, Business Components, and substitution list settings.
The configuration settings are recorded in the file DQinstall\repository\
configuration_rules\dataflow_objects\shared_options\
siebel_connector_base.xml. You should back up the file before making any
changes.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
49/68
8 u h r $ ) 8 p r s p v r q h y v p h v
&RQILJXUDWLRQRSWLRQV Within the configuration options, you can make changes to the basic
configuration, business components, and substitution values. This section details
the configuration options available.
6,(%(/B&211(&725 This table lists the settings for the SIEBEL_CONNECTOR option.
P v W h y v q h y r 9 r p v v
VERSION_NUMBER 11.7.0 Version number of this product.
REVISION_NUMBER 1 Revision number of this product.
SIEBEL_MAJOR_VERSION 8 Siebel major version number.
SIEBEL_MINOR_VERSION 0 Siebel minor version number (reserved for future use).
LOG_LEVEL 1-5 Level of detail to be written to log files. A higher num-
ber gives a higher level of detail. Level 2 is the mini-
mum to log errors and warnings. The default is Level
3.
LOG_DIRECTORY Any valid directory Directory in which log files are created. Log files by
default are created in the siebsrvr\log directory.
LOGS_TO_KEEP Any valid integer The number of log files to keep before the oldest log
file is deleted.
LOG_SIZE Any valid integer (KB) Maximum number of KB for a single log file. After
maximum is reached, a new log file is created.
NUMBER_OF_INITIALIZATION_
LOG_MESSAGES_TO_KEEP
Any valid integer The number of initialization log files to keep before
the oldest log file is deleted.
CONNECTION_TIMEOUT Any valid integer (seconds) The number of seconds the connection to the
BusinessObjects Data Quality XI Server is kept open
with no data traffic.
BATCH_LOW_PORT A valid port number Range of ports the BusinessObjects Data Quality XIServer uses to communicate back to the portion of this
product integrated within your Siebel software. This is
the minimum range. If the port is busy it will look for
an open port until it reaches maximum range defined.
BATCH_HIGH_PORT A valid port number Range of ports the BusinessObjects Data Quality XI
Server uses to communicate back to the portion of this
product integrated within your Siebel software. This is
the maximum range. If the port is busy, the Siebel
application looks for an open port until it reaches max-
imum range defined.
BATCH_MAX_RECORDS_TO_
QUEUE
A valid integer The number of records that can be queued in memory
waiting for transmission over the network to the Busi-nessObjects Data Quality XI Server.
BATCH_CHECK_QUEUE_SIZE_
INTERVAL
A valid integer (seconds) The number of seconds to sleep before checking if the
number of records in memory has dwindled below the
BATCH_MATCH_RECORDS_TO_QUEUE limit.
MIN_INTERVAL_BETWEEN_
BATCHES
A valid integer (seconds) The minimum number of seconds between launching
batch jobs.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
50/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
%XVLQHVVFRPSRQHQW
RSWLRQV
The Business Component (BC) settings include details about each business
component you want to cleanse or deduplicate. These settings are primarily
useful in interactive data quality, because they indicate which dataflow is used for
the current business component.
Each BC entry has the following settings to define the name of the BC and the
Business Object to which the BC belongs.
BC_NAMEName of the Business Component.
BO_NAMEName of the Business Object (to which the BC belongs).
If you want to do interactive data cleansing on a given BC, then add the
section to the file. If you want to do
interactive matching on a given BC, then add the
section to the file. If you do not want to do these operations, then do not add the
relevant section (or remove it if it already exists). There are no configuration
options required to do batch processing on a given BC; therefore, no entries are
required here.
The options for each section are as follows.
INTERACTIVE_DATA_CLEANSEThis section sets the dataflow and
options used during an interactive data cleanse for the BC.
INTERACTIVE_MATCHThis section sets the dataflow and options used
during an interactive data matching for BC. The option used by this product is
listed in following table. Any other options visible in the interface are not used in
this product.
DISPLAY_ADDRESS_WARNING_
MESSAGES
True or False Determines if an address warning is returned to the
user when an address is unable to be thoroughly
cleansed. The behavior is different depending on
whether you run Siebel UCM or Siebel CRM.
On CRM systems, setting to True allows a message to
be displayed to the user when an invalid address is
entered transactionally. It does not affect CRM batchprocesses.
For UCM systems, this value must be set to False. Oth-
erwise, the UCM upload process fails, as Siebels
UCM upload process is unable to accept any warnings
and continue. Even if you are using the UCM upload
process in combination with Siebel CRM, this value
must be set to False.
In all cases, when the log level is set accordingly, users
still see any address fault code in the logs within the
tag, as the record is returned from
BusinessObjects Data Quality XI.
P v W h y v q h y r 9 r p v v
P v 9 r p v v
DATAFLOW_NAME Name of the dataflow with relative path from
the projects folder.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
51/68
8 u h r $ ) 8 p r s p v r q h y v p h v
6XEVWLWXWLRQOLVWRSWLRQV The substitution list allows you to substitute or translate the spaces and special
characters used in a BC Name or Field Name. This solution is required becauseSiebel allows spaces and special characters in BC names and Field names, but
XML and BusinessObjects Data Quality XI do not. BusinessObjects Data Quality
XI uses the INPUT_FIELD_NAME to define the BC Name and Field Name in
which a dataflow operates. Therefore, you must define any BC Name and Field
Name with spaces or special characters here with a substituted name.
BC_SUBSTITUTIONThis section has two options for business component
name substitutions.
FIELD_SUBSTITUTIONThis section has two options for business
component name substitutions.
P v 9 r p v v
DATAFLOW_NAME Name of the dataflow with relative path from
the projects folder.
P v 9 r p v v
SIEBEL_BC_NAME Actual BC name as it appears in Siebel Tools. Note that any
space character must be replaced by _spc.
IQ8_BC_NAME Substituted BC NAME that is be used in the Dataflows
INPUT_FIELD_NAME option instead of using the Actual
Siebel BC name. This allows BusinessObjects Data Quality
XI to avoid all special characters and spaces that are not per-
mitted in XML notation.
P v 9 r p v v
SIEBEL_FIELD_NAME Actual field name as it appears in Siebel Tools. Note that any
space character must be replaced by _spc.
IQ8_FIELD_NAME Substituted field name that is be used in the Dataflows
INPUT_FIELD_NAME option instead of using the Actual
Siebel field name. This allows BusinessObjects Data Quality
XI to avoid all special characters and spaces that are not per-
mitted in XML notation.
You need to create only one entry of field name, even though the field name
might appear in different Business component field names. You should add
substituted names only as they are needed.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
52/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
'DWDIORZLQSXWRXWSXWILHOGQDPHV
The BusinessObjects Data Quality XI Server uses input fields and output fields to
process data that it receives from or sends to Siebel. When you have Siebel fields
that youve customized, youll need to edit the input field names/output field
names, or add new ones.
$GGDQHZILHOG The procedure for adding a field is documented in the BusinessObjects Data
Quality XI Data Cleanse Modifiers Guide. This section describes issues unique
to adding a field for Data Quality for Oracles Siebel UCM.
A field name for Data Quality for Oracles Siebel UCM has the following naming
structure:
[BC_name].[field_name]
For example, an input for the account_datacleanse dataflow is Account.Name.
Here, Account is the Business Component name and Name is the field name.
When you add a new field, you must use this naming convention, as it
corresponds with the structure of field names in Siebel.
If you add a field name to BusinessObjects Data Quality XI that includes spaces
or special characters, you must also make an entry in the substitution list. For
more information on the substitution list, see Substitution list options on
page 51.
5HPRYHDILHOG To remove a field from a dataflow, simply delete the field within the
BusinessObjects Data Quality XI Project Architect.
If a field does not correspond to a Siebel Business Component name (that is,
it is used internally by BusinessObjects Data Quality XI, it is give the
BC_name DQ.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
53/68
8 u h r $ ) 8 p r s p v r q h y v p h v
([DPSOHDGGLQJQHZILHOGVIRUFOHDQVLQJPDWFKLQJ
This section provides a sample procedure for adding new fields for cleansing or
matching. This sample procedure adds a field for Email Address to a Contact
Business Component.
To add a field for Email Address to a Contact Business Component:
1. From your Siebel application, navigate to Administration - Data Quality >
Third Party Administration.
2. Highlight the Firstlogic/DQClient Vendor record.
3. Highlight the Contact/Data Cleansing record in the BC Vendor Field
Mapping section.
4. In the Field Mappings section, add a new record for Email Address.
5. Restart the Siebel server.
The Siebel server is now able to send the value of the Contacts Email
Address field to BusinessObjects Data Quality XI, where data quality
operations can be performed on the data. However, you must configure
BusinessObjects Data Quality XI to work with this data.
6. In BusinessObjects Data Quality XI, open the Project Architect and navigate
to projects > blueprints > siebel. Select the dataflow
transactional_contact_datacleanse.
This sample is for reference purposes only. Before adding new fields to your
Siebel application, consult the Siebel Data Quality Administration Guide,
Version 8.0.
For thorough procedures for configuring BusinessObjects Data Quality
XI, see the documentation that ships with that portion of this product.
For reference information about the dataflows installed with this
product, see Business component and dataflow reference on page 65.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
54/68
7 v r P i w r p 9 h h R h y v H h h t r r s P h p y r T v r i r y V 8 H ' V r B v q r
7. Add the email address field to the reader, writer, and datacleanse dataflows.
Whenever you use any spaces or special characters with added fields, you
must also update siebel_connector_base.xml. In this example, the field
Email Address uses a space. You must also make this change in the
substitutions list.
8. Add a substitution in siebel_connector_base.xml. (For details, see
Substitution list options on page 51.) Siebels naming convention requires
that you replace a space character with _spc.
The Siebel Contact Business Component and the BusinessObjects Data Quality
XI dataflow transactional_contact_datacleanse are now capable of working with
an Email Address field.
-
8/2/2019 Dq Xi Seiebel Ucm_user Guide
55/68
8 u h r $ ) 8 p r s p v r q h y v p h v
:RUNLQJZLWKDGGUHVVFOHDQVLQJHUURUV
With Data Quality for Oracles Siebel UCM, you have some flexibility for how
address-cleansing errors are handled. For example, you can return an error code
to a Siebel field or you can suppress which errors are returned in interactive
mode. This section explains how to handle these situations.
3RVWLQJDGGUHVVHUURUVWR\RXU6LHEHOGDWDEDVH
In batch mode, you can return address-cleans