Siebel Data Quality Administration Guide > Data Quality Configuration Options >

Configuring Business Components to Support Data Cleansing

You use Siebel Tools to define which fields for the Account, Contact, Prospect, or Business Address business components should be enabled for data cleansing. The installed product includes default settings for these business components to support integration to Firstlogic applications, but the fields can be configured according to your requirements or to support integration to other vendors. This section explains how to configure these business components for data cleansing. For more information about the default data quality configuration for these business components, see Preconfigured SDQ Universal Connector Properties for Firstlogic Applications.

NOTE:  For Siebel Industry Applications, the CUT Address business component is enabled for data cleansing rather than the Business Address business component.

In real-time mode, data cleansing is triggered when a record is saved after a field that is defined as an active data cleansing field is updated. An example of an active data cleansing field for the Contact business component is Last Name. For more information about real-time mode, see Working with Data Cleansing and Data Matching in Real-Time and Batch Modes.

TIP:   Modifying an inactive field does not trigger data cleansing. Only fields that are indicated as data cleansing fields in the business component user properties trigger real-time data cleansing.

The data cleansing functionality is implemented in a Data Cleansing business service. Use the following procedure to use the Data Cleansing business service with a new Siebel business component.

To configure a business component to support data cleansing

1. Base the business component on the CSSBCBase class property to support real-time data cleansing.

   NOTE:  The CSSBCBase class includes the specific logic to invoke the data cleansing business services.

2. Associate the business component to a connector using user properties for the business component.

   For example, add a new user property to the business component called DataCleansing Connector - VendorName. For more information, see Configuring the SDQ Universal Connector.

3. Create the field mappings between the Siebel fields that you want to cleanse and the field names recognized by the external vendor.

   For more information, see Configuring the SDQ Universal Connector.

4. (Optional) If you want to prevent data cleansing on a selected record, perform the following:
   1. Add an extension column to the base table and map it to a business component field called Disable DataCleansing.

      For example, the fields used in the Business Address business component are:

      Field Name:	Disable DataCleansing
      Column:	DISA_CLEANSE_FLG
      Predefault value:	N
      Text Length:	1
      Type:	DTYPE_BOOL

   2. Map this field to your applet to disable data cleansing for certain records from the user interface.
5. (Optional) Configure a field called Last Clnse Date so that the Data Cleansing business service can mark the current date and time for the records.

   After a record is cleansed, the Data Cleansing business service attempts to update the Last Clnse Date business component field to the current date and time. This field is useful for future batch data cleansing, because the administrator can apply an Object WHERE Clause to cleanse only records that have changed since the last cleanse date. For example, the following values appear in the Account business component:

   Field Name:	Last Clnse Date:
   Join:	S_ORG_EXT
   Object Name. Column:	OBJ_NAME
   Column:	DEDUP_DATACLNSD_DT
   Type:	DTYPE_UTCDATETIME

6. (Optional) Use the DataCleansing Conflict Id Field user property to specify the conflict Id field for a business component.

   In most implementations, user keys are defined in the database schema for each table. These user keys make sure that no more than one record has the same set of values in specific fields. For example, the S_ORG_EXT table used by the Account business component uses columns NAME, LOC (Location), and BU_ID (organization id) in the user keys. Before you run data cleansing against your database, you may have similar, but not exactly the same records, in your database.

   After these records are cleansed, they may cause user key violations because the cleansed values become exactly the same value. You can use the Conflict Id field to resolve this issue. Add the CONFLICT_ID system column (given this table column exists in the database schema) to the user keys and then configure a user property called DataCleansing Conflict Id Field in that business component. The following example is for the Account business component:

   User Property: DataCleansing Conflict Id Field
   Property Value: S_ORG_EXT.Conflict Id

   If a user key violation occurs when the Siebel application writes the cleansed records to the database, the application tries to update the Conflict Id field to the record's row Id to make the record unique and bypass the user key violation. After the entire database is cleansed, you can perform data matching to catch these records and resolve them.

   CAUTION:  Before modifying user keys, contact Siebel Technical Support.