Académique Documents
Professionnel Documents
Culture Documents
60PA1-IT00-06300
JANUARY 2001
Siebel Systems, Inc., 2207 Bridgepointe Parkway, San Mateo, CA 94404
Copyright © 2001 Siebel Systems, Inc.
All rights reserved. Published 1998–2001
Printed in the United States of America
No part of this publication may be stored in a retrieval system, transmitted, or reproduced in any way, including
but not limited to photocopy, photographic, magnetic or other record, without the prior agreement and written
permission of Siebel Systems, Inc.
The full text search capabilities of Siebel eBusiness Applications include technology used under license from
Fulcrum Technologies, Inc. and are the copyright of Fulcrum Technologies, Inc. and/or its licensors.
Siebel, the Siebel logo, TrickleSync, TSQ, Universal Agent, and other Siebel product names referenced herein
are trademarks of Siebel Systems, Inc., and may be registered in certain jurisdictions.
All other product names, marks, logos, and symbols may be trademarks or registered trademarks of their
respective owners.
U.S. GOVERNMENT RESTRICTED RIGHTS. Programs, Ancillary Programs and Documentation, delivered
subject to the Department of Defense Federal Acquisition Regulation Supplement, are “commercial computer
software” as set forth in DFARS 227.7202, Commercial Computer Software and Commercial Computer Software
Documentation, and as such, any use, duplication and disclosure of the Programs, Ancillary Programs and
Documentation shall be subject to the restrictions contained in the applicable Siebel license agreement. All
other use, duplication and disclosure of the Programs, Ancillary Programs and Documentation by the U.S.
Government shall be subject to the applicable Siebel license agreement and the restrictions contained in
subsection (c) of FAR 52.227-19, Commercial Computer Software - Restricted Rights (June 1987), or
FAR 52.227-14, Rights in Data—General, including Alternate III (June 1987), as applicable. Contractor/licensor
is Siebel Systems, Inc., 2207 Bridgepointe Parkway, San Mateo, CA 94404.
Proprietary Information
Siebel Systems, Inc. considers information included in this documentation and
in Siebel Online Help to be Confidential Information. Your access to and use of
this Confidential Information are subject to the terms and conditions of: (1) the
applicable Siebel Systems software license agreement, which has been executed
and with which you agree to comply; and (2) the proprietary and restricted
rights notices included in this documentation.
Siebel Financial Services Interface Tables Reference
Contents
Introduction
How This Manual Is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . Intro-2
Who Should Use This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . Intro-3
What’s New in This Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Intro-4
Additional Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Intro-4
Contacting Siebel Technical Support . . . . . . . . . . . . . . . . . . . . . . . . Intro-6
Siebel Systems Welcomes Your Comments . . . . . . . . . . . . . . . . . . . Intro-7
Chapter 1. Overview
What Are Interface Tables? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Table Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Column Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Explicit Primary Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Introduction
Chapter 1, “Overview”
Chapter 2, “Interface Mapping Summary”
Appendix A, “Interface Table Transition Matrix”
Chapter 1, “Overview,” discusses interface tables and how they are used, explicit
primary mapping, and naming conventions.
This manual provides detailed information about each Siebel interface table. Use it
as a reference for importing data to and from the Siebel database.
This manual is not intended for the end user. The audience for this manual consists
of:
Version 6.0 (and above) of Siebel eBusiness Applications includes a new suite of
interface tables that use a naming convention of EIM_* (for example,
EIM_<table name>). For a complete list of all interface tables with detailed
descriptions, refer to Chapter 2, “Interface Mapping Summary.”
Siebel Financial Services Data Model Reference is a valuable tool in determining how
to integrate Siebel Financial Services applications with other applications in your
environment. It allows you to determine which parts of the data model you need to
extend to satisfy your specific business requirements. It also provides the table
naming conventions, system field names, and abbreviations used in the physical
data model tables of the Siebel Financial Services applications.
If you have not used Siebel Tools, you will want to become familiar with Siebel Tools
Guide. This guide provides a complete description of the Siebel application
development environment, of which the interface tables are a part. By using Siebel
Tools, you can access detailed information about each interface table.
If you are upgrading from a prior version, you’ll want to refer to Siebel Upgrade
Guide. This document explains how to upgrade your Siebel application on several
different database platforms, operating system platforms, and application server
platforms.
For information on the hardware and software platforms supported, refer to Siebel
Financial Services System Requirements and Supported Platforms on the Bookshelf
for Siebel Financial Services CD-ROM.
You will find information about Siebel Technical and Professional Services in Guide
to Siebel Global Services.
For copies of these documents, please use Siebel Books Online, accessible through
the Global Services tab on the Siebel Systems Web site (http://www.siebel.com).
Through Siebel Books Online, you can order additional Siebel documentation and
copies of the Bookshelf for Siebel Financial Services CD-ROM.
For the most current and accurate documentation, see the Documentation Updates
section of the Siebel SupportWeb site (http://supportweb.siebel.com). The
SupportWeb page contains changes that we have made to the documentation since
it was released.
For up-to-date information on changes and updates to the product, refer to Siebel
Financial Services Release Notes on the product CD-ROM.
Do you know how to access Siebel Technical Support? It is crucial that you
understand the requirements for getting support before you encounter technical
issues that require Siebel Technical Support’s assistance. This will facilitate smooth
resolution of your issues. If you have questions, please don’t hesitate to contact us.
To provide efficient, timely support and access to the Technical Support knowledge
base:
Outside of local support center hours, Gold and Rollout Support Option customers
can call +1 800 214 0400 or +1 650 295 5724.
doc@siebel.com
An interface table can be thought of as a staging area where you import and export
data to and from the Siebel database. Interface tables are designed to be simple and
straightforward so they are easy to load or read by way of external programs. Each
interface table usually supports a group of base tables that can be imported or
exported in a single batch.
Siebel Enterprise Integration Manager (EIM) is the engine that manages the
exchange of data between the Siebel database tables and the interface tables. EIM
can be used to perform bulk imports, exports, merges, or deletes. For more
information on EIM, refer to Siebel Enterprise Integration Manager Administration
Guide.
Detailed information about each Siebel interface table can be found in Chapter 2,
“Interface Mapping Summary.”
Naming Conventions 1
This section provides naming conventions for interface tables and columns as
follows:
Interface tables in the Siebel database use a three-part naming convention. The
syntax is PREFIX_NAME_SUFFIX.
The prefix indicates the family of interface table and some basic characteristics.
Table 1-1 provides the standard prefixes for tables and their descriptions.
Prefix Description
EIM_ This is a new family of EIM interface tables introduced with version 6.0 of Siebel eBusiness
Applications. Two of the important functional enhancements of EIM, explicit primary mappings and
full multiple-organization visibility support, were introduced with this version and are available only
by way of these interface tables. The EIM_ tables are the only interface tables that new customers
should use. Customers who are upgrading from prior versions should transition to this new family
of interface tables as soon as possible. This is the only family of interface tables that will be enhanced
in future versions.
S_ This was the principal set of interface tables provided in versions of Siebel eBusiness Applications
prior to version 6.0. These tables were not enhanced in version 6.0. Specifically:
They are not capable of supporting full multiple-organization visibility.
They do not provide support for explicit primary mappings.
They have not been extended to provide support for extensions to the base schema (neither new
tables, nor new columns in existing tables).
The S_ tables are distributed with version 6.0 and later for upward compatibility only and will be
removed in a future release. They should be used only by existing customers to provide support as
data interface scripts are transitioned to the new EIM_<tablename> interface tables.
EAI_ This family of interface tables was provided with versions 5.5 and 5.6 as part of the Enterprise
Application Interfaces (SAP Connector) capability (EAI). For customers that have version 5.5 and 5.6
and did not use EAI, these interface tables were inactive. These tables were activated for users of EAI
in versions 5.5 and 5.6 and were supported for that purpose only. Siebel eBusiness Applications 6.0
includes an entirely new infrastructure for EAI, and this structure does not use EIM interface tables.
Accordingly, the EAI_<tablename>_IF interface tables are inactive in version 6.0 and are not
supported for any purpose. These interface tables will be removed in a future release.
MIG_ This family of interface tables was delivered as part of version 5.0 of Siebel eBusiness Applications
to provide support for customers migrating from Series 3 or Series 5 applications. These tables were
supported for this specific migration, and the only supported migration path from Series 3 or Series 5
is to version 5.0. The MIG_ interface tables were deactivated in version 5.5 and remain inactive and
unsupported in version 6.0. These interface tables will be removed in a future release.
This section provides general conventions for naming interface table columns, and
briefly describes the explicit primary mapping capability. For more information
about interface table columns and how to manipulate data therein, refer to Siebel
Enterprise Integration Manager Administration Guide.
Table 1-2 describes conventions used for naming interface table columns.
Convention Description
Columns that are common to every interface table and are used to control EIM
batch processing as follows:
IF_ROW_BATCH_NUM This is a number to identify the batch.
IF_ROW_STAT EIM updates this column after processing a row to indicate the status of the record.
IF_ROW_MERGE_ID EIM uses the value in this row during merge processing.
ROW_ID Uniquely identifies the row within the batch. The combination of
IF_ROW_BATCH_NUM and ROW_ID must be unique.
T_ A prefix that identifies EIM processing columns. EIM uses temporary columns to
manipulate data during processing. For example, EIM might store the ROW_ID
value for a Siebel base table in a temporary column. These column names begin
with T_ and indicate the table or column for which they are used. Since EIM uses
these columns internally during processing, do not manipulate these columns in
the interface tables.
Other All other interface table columns that are not identified with the conventions above.
Each of these columns maps to one or more base table columns. For more detailed
information, refer to Chapter 2, “Interface Mapping Summary.”
Version 6.0 (and above) of Siebel eBusiness Applications provides support for
explicit primary mapping. With explicit primary mapping, you now have the option
to indicate the primary item within a list. Prior to version 6.0, these designations
were automatically assigned by EIM.
For example, Table 1-3 shows the primary business address (ACC_PR_ADDR) for
A. K. Parker Distribution to be in Menlo Park, whereas their billing address
(ACC_PR_BL_ADDR) is in San Francisco, another city. Note that columns for
explicit primary mapping use the PR_ naming convention.
A check mark in the Siebel application designates the primary value once the data
is imported using EIM. Figure 1-1 provides an example of this showing
1000 Industrial Way in Menlo Park as the primary account address for A. K. Parker
Distribution.
Figure 1-1. Explicit Primary Mapping for an Account Showing Primary Column
Base Table Base Column UK Req Base Column Description IF Source Column Data Type Length
LOC Varchar 50
1. Excerpt from Interface Mapping Summary showing explicit primary mapping for the EIM_ACCOUNT interface table.
This chapter documents the mapping of the EIM interface tables to the destination
(base) table columns. Destination tables are listed for each interface table column.
The target destination table, if any, is in the first column and appears with an
asterisk (*). If other, non-target destination tables exist, they are also shown in the
first column but do not appear with an asterisk.
Each destination table includes a list of all columns mapped in the interface table.
Listed first are the user primary key columns, followed by other base table columns.
Caution: If you have not used Siebel Tools, you should become
familiar with Siebel Tools Guide. This guide provides a complete
description of the Siebel application development environment, of
which the interface tables are a part. By using Siebel Tools, you can
access detailed information about each interface table.
The Interface Mapping Summary tables are listed here in the order they appear in
this chapter. An asterisk (*) indicates that the table is new in Version 6.3.
A new generation of interface tables has been added for Siebel eBusiness
Applications 6.0 and are easily identified by their EIM_ prefix (for example,
EIM_<table name>). This appendix provides a matrix by which you can transition
from existing tables to these new EIM_ tables and makes recommendations for new
installations and upgrades.
If this is your first purchase of a Siebel product, you should use only the new tables;
do not use any other tables. If upgrading, you should transition your EIM processes
to the EIM_ tables as soon as possible. The new EIM_ tables fully support the
multiple-organization visibility feature of Siebel eBusiness Applications 6.0 and
provide support for the new explicit primary mapping capability.
Transition Matrix A
Table A-1 provides a matrix mapping S_ interface tables to the new EIM_ interface
tables.