Technical Document

Enterprise Integration Manager

Document Objective Siebel EIM is a process provided by the Siebel CRM package, in order to import the legacy data, export, delete or merge existing data. This document explains the basics o EIM, di erent unctions o EIM, con iguring the I!" ile, EIM task tracing techni#ues and debugging di erent kinds o errors. This document re#uires the users to have prior Siebel CRM and $racle S%& kno'ledge.

1/22/2014

Con i!ential

"age i

Technical Document

Enterprise Integration Manager

#evision $istor% &ersion

(.) (.,

Date
)*+Sep+,((* (.+/ov+,((*

Description o #evisions
Creation o -ocument. 0pdated the comments o sel revie'.

1/22/2014

Con i!ential

"age ii

Technical Document

Enterprise Integration Manager

Table o Contents
1'0 I(T#OD)CTIO(*''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''1 2'0 EIM +)(CTIO(,*'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''2 ,.) ,., ,.. ,.* ,.6 IM1$RTI/2 -3T34..............................................................................................., E51$RTI/2 -3T34..............................................................................................., -E&ETI/2 -3T34................................................................................................., MER2I/2 -3T34................................................................................................., 1R$CESS !&$7 "ET7EE/ EIM 8 -3T3"3SE4...............................................................,

-'0 ,IE.E/ I(TE#+0CE T0./E,*''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''..) C$&0M/ M311I/24..............................................................................................* 4'0 CO(+I1)#0TIO( +I/E*''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''2 *.) 2E/ER3& 9E3-ER 13R3METERS4...............................................................................6 *., 2E/ER3& 1R$CESS 13R3METERS4.............................................................................: *.. IM1$RT 1R$CESS 13R3METERS4...............................................................................; *.* E51$RT 1R$CESS 13R3METERS4.............................................................................)) *.6 -E&ETE 1R$CESS 13R3METERS4..............................................................................)) *.: MER2E 1R$CESS 13R3METERS4..............................................................................). *.< E5TE/-E- 13R3METERS4......................................................................................). 4.7.1 User-Defined Extended Parameters:............................................................14 4.7.2 Predefined Extended Parameters:................................................................14 2'0 IM"O#T "#OCE,,*'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''13 6.) 6., 6.. 6.* IM1$RT 1R$CESS STE1S4.....................................................................................): M3/03& IM1$RTI/2 1R$CE-0RE4...........................................................................); -I!!ERE/T I!=R$7=ST3T >3&0ES4......................................................................)? REC$MME/-E- IM1$RTI/2 $R-ER4.........................................................................)?

3'0 E4"O#T "#OCE,,*'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''21 :.) E51$RT 1R$CESS STE14 .....................................................................................,) :., M3/03& E51$RTI/2 1R$CE-0RE4...........................................................................,) 5'0 DE/ETE "#OCE,,*'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''2<.) -E&ETE T@1ES4.................................................................................................,. <., -E&ETE 1R$CESS STE1S4.....................................................................................,. <.. M3/03& -E&ETI/2 1R$CE-0RE4.............................................................................,* 6'0 ME#1E "#OCE,,*''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''22 ;.) MER2E 1R$CESS STE1S4......................................................................................,6 ;., M3/03& MER2I/2 1R$CE-0RE4.............................................................................,: 7'0 #)((I(1 EIM*''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''25 ?.) ?., ?.. ?.* ?.6 R0//I/2 EIM T9R$029 20I4...............................................................................,< R0//I/2 EIM T9R$029 C$MM3/- &I/E I/TER!3CE4....................................................,< ERR$R !&32S4..................................................................................................,; S%& TR3CE !&32S4............................................................................................,; TR3CE !&32S4..................................................................................................,;

10'0 DE.)11I(1 EIM*''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''-0 11'0 +08,*''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''-2

1/22/2014

Con i!ential

"age iii

Technical Document

Enterprise Integration Manager

3CR$/@MS4............................................................................................................*

1/22/2014

Con i!ential

"age iv

Technical Document

Enterprise Integration Manager

1'0 Intro!uction*
Siebel EIM AEnterprise Integration ManagerB is server task that deals 'ith the exchange o data bet'een intermediary tables called inter ace tables and Siebel base tables.

Siebel Interface Table

External Database

EIM
External Flat Files

External Data Sources

Siebel Base Tables

1/22/2014

Con i!ential

"age 1

Technical Document

Enterprise Integration Manager

2'0 EIM +unctions*

Siebel EIM can be used to achieve our kinds o 'ith the data directly. The unctions are viC. unctionality in 'hich all the unctions deal

Import ne' and revised data into Siebel "ase Tables Export existing data rom Siebel "ase Tables -elete existing data rom Siebel "ase Tables Merge existing data in Siebel "ase Tables

2'1 Importing Data* -ata importing comes into picture under ollo'ing business re#uirements4 Initial implementation o Siebel application A&oading product data rom the legacy databaseB Maintaining the Siebel database in long run AImporting archived dataB 1eriodical updating o data into Siebel database rom a non Siebel database

2'2 E9porting Data* -ata exporting is done under the ollo'ing business re#uirements4 Trans erring Siebel data to a non Siebel applications 3rchival o data

2'- Deleting Data* In the process o maintaining Siebel database, you 'ill land up on certain re#uirements 'here you need to delete the existing data like removal o obsolete data. Ex4 $bsolete products. 2'4 Merging Data* Merging o data arises in situations 'here you need to de+duplicate Aremoval o duplicatesB the data. 2'2 "rocess +lo: bet:een EIM ; Database* -ata has to be loaded into EIM tables AInter ace tablesB. This is applicable or import, delete or merge operation. !or export unction, this step is not re#uired. Edit the EIM Con iguration ile. In short called as I!" ile, this ile de ines the parameters like type o EIM, the EIM table used, the batch number, etcD Run the EIM task either through 20I or command line. >eri y the results. EIM generates log ile or every task and you can use this log ile or debugging.

1/22/2014

Con i!ential

"age 2

Technical Document

Enterprise Integration Manager

-'0 ,iebel Inter ace Tables*

Inter ace tables act as staging area 'hich holds the data that has to be imported, data exported rom the Siebel base tables, data to be deleted and that to be merged. EIM process operates upon these tables and does the speci ied operation. Every inter ace table has columns that get mapped to base tables, e' mandatory columns and many temporary columns. The mandatory columns are R$7=I-, I!=R$7=ST3T and I!=R$7="3TC9=/0M. The temporary columns are those that are used by EIM task to manipulate data values at run times. These temporary columns store the R$7 I-s o records, status o the record, uni#ueness o the records, 'hether the record already exists in the database. Some temporary columns store the R$7 I- values o deleted, merged, exported ro's. Every inter ace table, 'hile loading data into, has to satis y certain prere#uisites as stated belo'4 Mandatory columns needs to be populated 3ll the re#uired columns has to be populated 1opulate the I!=R$7="3TC9=/0M 'ith appropriate batch number Set the I!=R$7=ST3T column 'ith meaning ul values

Every Siebel inter ace table has * types o temporary columns as de ined belo'4 0/% column E5S column RI- column ST3 column

Each o the temporary columns has a naming ormat as ollo's4 T=Ebase table 'ithout pre ix S=F==Etemporary column typeF Example4 T=$R2=E5T==0/%, T=$R2=E5T==E5S, T=$R2=E5T==ST3, T=$R2=E5T==RIThere are e' exceptions or this naming rule. Examples4 T=3CC/T1$ST==ST3, T=$1T@1$ST/==RI-, T=1R$-&/1$ST/==RIThe temporary columns that have su ix 0/%, stores @ or / values i the inter ace recordGs user keys are not same as another inter ace recordGs user keys in the same batch. The temporary columns that have su ix E5S, stores @ or / values i the inter ace record can be mapped to an existing base record Ai.e. base record exists or the same user keysB. The temporary columns that have su ix RI-, stores the R$7=I- o the record already existing in the base table or generated R$7=I- or ne' records in the inter ace table. The temporary columns that have su ix ST3, stores the pass number o the EIM process 'here it ailed. Example4 I the EIM process ailed 'hile processing a record in the S=$R2=E5T table, the temporary column T=$R2=E5T==ST3 is set the EIM pass number at that point o time.

1/22/2014

Con i!ential

"age -

Technical Document

Enterprise Integration Manager

-'1 Column Mapping* 1rior to loading data into the EIM table, itGs essential to ind out 'hat data goes into 'hich column in the base table, 'hich inter ace table need to be used to achieve this and 'hat is the mapping among these columns. This column mapping can be achieved in , 'ays4 0sing 0sing bookshel AESiebel "ookshel 1athFHITR.pd B Siebel Tools Siebel Tools !lat Tab EIM Table Mapping In obIect list editor, #uery or the base table in J-estination TableK Column &ist o EIM tables are listed !ind out the appropriate EIM table

ItGs a best practice, Siebel suggests, you should document the mapping among the source data, EIM table and base table. @ou can use the mapping ormat as sho'n in the excel sheet embedded belo'.

EIM Mapping Format.xls

Steps in column mapping can be brie ed as ollo'4 Identi y the kind o data in #uestion and Siebel base table Identi y the EIM table to achieve the unctionality Identi y mapping bet'een Siebel base table and EIM table columns

1/22/2014

Con i!ential

"age 4

Technical Document

Enterprise Integration Manager

4'0 Con iguration +ile*

3ny EIM process reads a con iguration ile, 'here di erent kinds o parameters are set or an EIM process. The con iguration ile, in short I!" ile, de ines the type o process, EIM table involved, batch number, and lots o other parameters. 3n I!" ile has t'o sections L 9eader and 1rocess sections. The header section de ines the parameters that are common to all the processes de ined in the ile. The process section de ines parameters 'hich are speci ic to that particular section. This ile is stored in the ESIE"SR>RFH3-MI/ path, rom 'here the EIM task reads. I this ile is not stored in this directory prior running EIM task, the absolute path o the ile has to be speci ied in the task. I not, an error 'ill be thro'n. These EIM parameters are classi ied as ollo's4 2eneral 9eader 1arameters 2eneral 1rocess 1arameters Import 1rocess 1arameters Export 1rocess 1arameters -elete 1rocess 1arameters Merge 1rocess 1arameters

4'1 1eneral $ea!er "arameters* This section describes the parameters that 'ill be used by all the processes de ined in the con iguration ile. CO((ECT Speci ies the $-"C source name o the database to be used /O1 T#0(,0CTIO(, TO +I/E This parameter speci ies 'hether the transactions to be logged to a ile or docking transaction table. >alid values are TR0E or !3&SE. I set to TR0E, the transaction details are logged into the directory ESIE"E&=!I&E=S@STEMFEIM. I set to !3&SE, the transaction details are logged into the S=-$CM=T5/=&$2 table. This parameter doesnGt make sense, i -$CMI/24 TR3/S3CTI$/ &$22I/2 parameter in System 1re erences is set to !3&SE. "0,,<O#D Speci ies the pass'ord that needs to be validated or running the EIM process. I you have not speci ied this in Component 1arameters, this needs to be speci ied in the I!" ile. Example4 13SS7$R- N S3-MI/ "#OCE,, Identi ies the process section that has to be executed de ined in the I!" ile. Example4 1R$CESS N Import $rganiCations

1/22/2014

Con i!ential

"age 2

Technical Document

Enterprise Integration Manager

=,iebel Inter ace Manager> This is a special and man!ator% key'ord that needs to be speci ied, 'hich tells the EIM task, that this particular ile contains the parameters or EIM. T0./EO<(E# This parameter speci ies name o the user 'ho o'ns the Siebel database tables. ),E# (0ME Speci ies the logon name o the user or running the process. I you have not speci ied this in Component 1arameters, this needs to be speci ied in the I!" ile. Example4 0SER /3ME N S3-MI/

4'2 1eneral "rocess "arameters* This section describes the parameters that are generic to all EIM processes. The parameters de ined in this section have a scope limited to this process only. .0TC$ #e?uire! ield that speci ies the batch number, 'hich is used to identi y the set o records that should be considered or this EIM process. This batch number corresponds to the number speci ied in the I!=R$7="3TC9=/0M column o the EIM table. >alid values are ( to ,)*<*;.:*< A,.) L )B. "atch numbers can be speci ied in ranges or as a comma delimited ormat. Example4 "3TC9 N )(( L ))(, "3TC9 N )((, )(., ),(. I batch number is speci ied 'rongly in I!" ile, the EIM thro's an error stating, no records ound or the stated batch number. COMMIT E0C$ "0,, $ptional parameter that speci ies 'hether the process needs to do a commit a ter every EIM passes. 1ass is de ined as one S%& -M& statement that got executed. >alid values are TR0E or !3&SE. -e ault value o this parameter is TR0E. This parameter should be set to !3&SE 'hile using in delete or merge process. Since it commits a ter each pass, and in case o any ailures, the database is le t corrupted 'ith dangling oreign key re erences, etcD Example4 C$MMIT E3C9 13SS N !3&SE COMMIT E0C$ T0./E $ptional parameter that speci ies 'hether the process needs to do a commit a ter processing each base table. >alid values are TR0E or !3&SE. -e ault value o this parameter is TR0E. This parameter should be set to !3&SE 'hile using in delete or merge process. The reason behind this is, since it commits a ter each pass, and in case o any ailures, the database 'ill be le t corrupted 'ith dangling oreign key re erences, etcD

1/22/2014

Con i!ential

"age 3

Technical Document

Enterprise Integration Manager

Example4 C$MMIT E3C9 T3"&E N !3&SE I1(O#E .0,E T0./E, $ptional parameter that speci ies 'hich base tables has to be ignored or the process or the particular EIM table. This parameter improves the EIM per ormance. Example4 I2/$RE "3SE T3"&ES N S=13RT@=1ER, S=$R2="0 I(C/)DE $ptional parameter that speci ies 'hich other sub+process needs to be included in the process in #uestion. Example4 I/C&0-E N Import Contacts /O1 T#0(,0CTIO(, $ptional parameter that tells 'hether to log transactions or not. >alid values are TR0E or !3&SE. -e ault value depends on the -$CMI/24 TR3/S3CTI$/ &$22I/2 parameter de ined in the System 1re erences. Example4 &$2 TR3/S3CTI$/S N !3&SE O(/@ .0,E T0./E, $ptional parameter that speci ies 'hich base tables has to be considered or the process or the particular EIM table. This parameter improves the EIM per ormance. Example4 $/&@ "3SE T3"&ES N S=13RT@, S=$R2=E5T, S=3--R=$R2, S=$R2="0, S=3CC/T=1$ST/ #O//.0CA O( E##O# $ptional parameter that speci ies 'hether a rollback has to be made i any ailure occurs during the EIM process. >alid values are TR0E or !3&SE. -e ault value is !3&SE. This parameter should be set to TR0E 'hile using in delete or merge process. In case o any ailure, the database 'ill be roll backed to the last commit point and thus avoiding the database corruption. Example4 R$&&"3CM $/ ERR$R N TR0E ,E,,IO( ,8/ $ptional parameter that speci ies a user de ined S%& statement to be sent to database or execution be ore any other S%& statements. This parameter can be used to set tracing or per ormance analysis. $nly one SESSI$/ S%& parameter is allo'ed per process section. This parameter cannot be used to insert or update any data in Siebel tables. Example4 SESSI$/ S%& N O01-3TE EIM=C$/T3CT SET 11=ST3RT=-T N S@S-3TE 79ERE I!=R$7="3TC9=/0M N ,((K ,AI" .)BID DE+0)/T $ptional parameter that speci ies 'hether to use the de ault "0=I- de ined in the repository. >alid values are TR0E or !3&SE. -e ault value is !3&SE.

1/22/2014

Con i!ential

"age 5

Technical Document

Enterprise Integration Manager

I set to !3&SE, the "0=I- de ined in the repository is used or "0=Icolumns in the base tables. I set to TR0E, the values set in the inter ace table is used. This parameter is only limited to insert, delete and merge process, because the oreign key must be resolved or these processes. Example4 SMI1 "0=I- -E!30&T N TR0E T0./E #e?uire! parameter that speci ies the EIM table to be used or the process. Example4 T3"&E N EIM=3CC$0/T !or per ormance reasons, the number o tables should be limited to e'er than ive or a merge or export process. T#0(,0CTIO( ,8/ $ptional parameter that speci ies a user de ined S%& statement to be sent to database be ore other S%& statements are processed and immediately a ter every commit or rollback operation. I both SESSI$/ S%& and TR3/S3CTI$/ S%& parameters are speci ied, the latter gets executed immediately a ter the ormer. $nly one TR3/S3CTI$/ S%& parameter can be de ined per process section. T@"E #e?uire! parameter that speci ies the type o EIM process. Typical process types are IM1$RT, E51$RT, MER2E, -E&ETE and S9E&&. S9E&& process de ines that this process has other sub+processes that needs to be executed. ),E E,,E(TI0/ I(DE4 $I(T, $ptional parameter speci ied or MS S%& Server and $racle databases. >alid values are TR0E or !3&SE. 7hen set to TR0E, it enables a subset o index hints or MS S%& server. -e ault value is TR0E. ),E I(DE4 $I(T, $ptional parameter speci ied or $racle databases only. >alid values are TR0E or !3&SE. 7hen set to TR0E, EIM issues optimiCer hints to the database in order to improve the per ormance. -e ault value is !3&SE. Example4 0SE I/-E5 9I/TS N TR0E ),I(1 ,@(O(@M, $ptional parameter that speci ies 'hether to use the account synonyms during the import process. >alid values are TR0E or !3&E. -e ault value is TR0E. In order to improve the per ormance, set this parameter value to !3&SE, but care must be taken 'hile speci ying this parameter. Re er +08s or urther explanation on 3ccount Synonyms.

4'- Import "rocess "arameters*

1/22/2014

Con i!ential

"age 6

Technical Document

Enterprise Integration Manager

This section describes the parameters that are speci ic to EIM import processes. The parameters de ined in this section have a scope limited to this process only. COMMIT O"E#0TIO(, $ptional parameter that speci ies the commit re#uency 'hile logging the transactions. >alue speci ies the number o records processed be ore a commit is done. 3pplicable only i -$CMI/24 TR3/S3CTI$/ &$22I/2 is set in System 1re erences. -e ault value is (, 'hich means commit has to be made at the end o EIM process. Example4 C$MMIT $1ER3TI$/S N )(( +I/TE# 8)E#@ $ptional parameter that lets the user to speci y an S%& statement 'hich ilters the records that needs to be processed. This #uery runs be ore the import process starts. The I!=R$7=ST3T column o those records that ails this #uery or the particular batch as speci ied in the process section 'ill be set as JIM1$RT=REPECTE-K. Example4 !I&TER %0ER@ N AI!=R$7=ST3T EF JIM1$RTE-KB I1(O#E .0,E CO/)M(, $ptional parameter that speci ies 'hich base columns has to be ignored or the particular EIM process. This parameter improves the EIM per ormance. @ou should not ignore the user key columns or re#uired columns. Example4 I2/$RE "3SE C$&0M/S N S=$R2=E5T.9$ME=19=/0M O(/@ .0,E CO/)M(, $ptional parameter that speci ies 'hich base columns has to be considered or the particular EIM process. This parameter improves the EIM per ormance. @ou should include all the user key columns and re#uired columns. Example4 $/&@ "3SE C$&0M/S N S=$R2=E5T./3ME, S=$R2=E5T.&$C )"D0TE #O<, $ptional parameter that speci ies 'hether to update the column values in the base table 'ith that o in EIM table. >alid values are TR0E or !3&SE. -e ault value is TR0E. Example4 01-3TE R$7S N S=$R2=E5T, !3&SE 0TT0C$ME(T DI#ECTO#@ $ptional parameter that speci ies the directory path containing the attachments to be imported. This directory path should exist on one o the Siebel server machine. In case o remote machine, map the path to a drive and speci y the drive name to this parameter. -e ault value is ESIE"E&=9$MEFHI/10T Example4 3TT3C9ME/T -IRECT$R@ N 54

1/22/2014

Con i!ential

"age 7

Technical Document

Enterprise Integration Manager

7here 54 is mapped to HHCRM-E>(,HsiebsrvrHI/10T

DE+0)/T CO/)M( $ptional parameter that lets you to speci y a value or the EIM table column. This parameter applies only to Import process. This value 'ill be only used i the EIM table column is null. Example4 -E!30&T C$&0M/ N 3CC/T="0, J91 3mericasK +I4ED CO/)M( $ptional parameter that lets you to speci y a value or the EIM table column. This parameter applies only to Import process. This value 'ill be used overriding the value in the EIM table column i any. Example4 !I5E- C$&0M/ N 3CC/T="0, J91 3mericasK I(,E#T #O<, $ptional parameter that speci ies 'hether to insert records into the particular base table or not. >alid values are TR0E or !3&SE. -e ault value is TR0E. Example4 I/SERT R$7S N S=$R2=E5T, !3&SE I/SERT R$7S N EIM=3CC$0/T, !3&SE I the speci ied table is an EIM table, the value applies to all the base tables that 'ere mapped to this EIM table. MI,C ,8/ This parameter is used to speci y the type o primary need to be set 'hile updating the primary child. Types o primaries are explicit primary and implicit primary. I set as explicit primary, EIM 'ill consider the record 'here the primary child column in the EIM table is set. Example4 MISC S%& N E51R=S=1$ST/=1R=EM1=I I set as implicit primary, the irst child record o the parent as speci ied in the EIM table 'ill be considered as child record. Example4 MISC S%& N IM1R=S=1$ST/=1R=EM1=I In cases, 'e might tell EIM to use explicit primary 'henever speci ied and implicit primary i not. This can be set as sho'n belo'. MISC S%& N E51R=S=1$ST/=1R=EM1=I-, IM1R=S=1$ST/=1R=EM1=I(ET C$0(1E $ptional parameter that speci ies ho' to handle the non user key null columns in the EIM table. >alid values are TR0E or !3&SE. -e ault value is TR0E. I set to TR0E, the null values in the non user key null columns 'ill be ignored. I set to !3&SE, the null values in the non user key null columns 'ill be applied to the base tables also. Example4 /ET C93/2E N !3&SE This parameter applies only to Import process. T#IM ,"0CE,

1/22/2014

Con i!ential

"age 10

Technical Document

Enterprise Integration Manager

$ptional parameter that speci ies 'hether to remove the trailing spaces rom the column values be ore importing. This parameter applies only to Import process. >alid values are TR0E or !3&SE. -e ault value is TR0E. Example4 TRIM S13CES N !3&SE 4'4 E9port "rocess "arameters* This section describes the parameters that are speci ic to EIM export processes. The parameters de ined in this section have a scope limited to this process only. 0TT0C$ME(T DI#ECTO#@ $ptional parameter that speci ies the directory path to 'here the attachments have to be exported. This directory path should exist on one o the Siebel server machine. In case o remote machine, map the path to a drive and speci y the drive name to this parameter. -e ault value is ESIE"E&=9$MEFH$0T10T Example4 3TT3C9ME/T -IRECT$R@ N 54 7here 54 is mapped to HHCRM-E>(,HsiebsrvrH$0T10T C/E0# I(TE#+0CE T0./E $ptional parameter that speci ies 'hether to remove the old records rom the EIM table 'hose batch number corresponds to, as de ined in the I!" ile. >alid values are TR0E or !3&SE. -e ault value is TR0E. Example4 C&E3R I/TER!3CE T3"&E N !3&SE I this parameter is set to alse, and some ro's already exist in the EIM table or the speci ied batch, EIM 'ill thro' a 'arning. E4"O#T 0// #O<, This parameter speci ies 'hether to export all ro's rom the Siebel base tables that 'ere mapped to the particular EIM table speci ied in the I!" ile. >alid values are TR0E or !3&SE. -e ault value is !3&SE. Example4 E51$RT 3&& R$7S N !3&SE 7hen you do an export on party EIM tables, set this parameter to !3&SE. I not EIM 'ill export all party records. E4"O#T M0TC$E, This parameter optionally speci ies criteria that need to be satis ied be ore exporting the data rom the base tables. Example4 E51$RT M3TC9ES N S=$R2=E5T, A/3ME &IME J91QKB The literal speci ied, is the condition that occurs a ter the 79ERE clause in an S%& statement.

4'2 Delete "rocess "arameters* This section describes the parameters that are speci ic to EIM -elete process only. C0,C0DE DE/ETE O(/@

1/22/2014

Con i!ential

"age 11

Technical Document

Enterprise Integration Manager

$ptional parameter that tells 'hether to delete the child records 'hen a parent record is deleted. >alid values are TR0E or !3&SE. -e ault value is !3&SE. I set to !3&SE, EIM deletes the parent record and sets the oreign key column in the child records to /0&&. Example4 C3SC3-E -E&ETE $/&@ N TR0E C/E0# I(TE#+0CE T0./E $ptional parameter that speci ies 'hether the existing ro's or the particular batch number should be deleted. >alid values are TR0E or !3&SE. -e ault value depends upon the type o delete being done. !or -E&ETE E53CT, de ault value is !3&SE, or others, it is TR0E. Example4 C&E3R I/TER!3CE T3"&E N !3&SE DE/ETE 0// #O<, $ptional parameter that speci ies 'hether to delete all the ro's rom the base table. >alid values are TR0E or !3&SE. -e ault value is !3&SE. Care should be taken 'hile setting this parameter to TR0E in case o party EIM tables. In case o party EIM tables, al'ays use -E&ETE M3TC9ES 'hen deleting records o particular party type. Example4 -E&ETE 3&& R$7S N TR0E DE/ETE E40CT This parameter tells the EIM to use user key matching algorithm 'ith ro's in the EIM table to per orm deletion. >alid values are TR0E or !3&SE. -e ault value is !3&SE. Example4 -E&ETE E53CT N TR0E 3l'ays use this parameter to delete records rom the non target base tables. DE/ETE ,AI" "#IM0#@ This parameter tells 'hether to do a cascade update on the primary child column in the parent table. I the primary address record is deleted, then the primary address column in the parent table is set to /0&&, 'hen this parameter is set to TR0E. I set to !3&SE, (OBM0TC$B#O<BID gets stored in the primary child column o the parent table. >alid values are TR0E or !3&SE. -e ault value is TR0E. Example4 -E&ETE SMI1 1RIM3R@ N !3&SE DE/ETE M0TC$E, $ptional parameter that speci ies a conditional expression to select the records 'hich has to be considered or deletion. Example4 -E&ETE M3TC9ES N S=$R2=E5T, A/3ME &IME J91QKB The literal speci ied inside the parentheses is the condition that occurs a ter the 79ERE clause in any S%& statement.

1/22/2014

Con i!ential

"age 12

Technical Document

Enterprise Integration Manager

This parameter can be used only to delete records rom the target base table. DE/ETE #O<, This parameter speci ies 'hether ro's rom the particular table should be deleted. Example4 -E&ETE R$7S N S=3--R=$R2, !3&SE This example restricts the deletion o records rom the S=3--R=$R2 table. Care should be taken 'hile setting !3&SE value, because it might result in dangling oreign key re erences. )"D0TE #O<, This parameter speci ies 'hether oreign re erences should be updated. >alid values are TR0E or !3&SE. -e ault value is TR0E. Example4 01-3TE R$7S N S=C$/T3CT, !3&SE This above example restricts any update including the updating o oreign key re erences in the S=C$/T3CT table 'hile per orming the EIM -elete. Care should be taken 'hile setting !3&SE value, because it might result in dangling oreign key re erences.

4'3 Merge "rocess "arameters* This section describes the parameters that are speci ic to EIM Merge process only. ,ET .0,ED /O11I(1 This parameter speci ies 'hether to enable the set based logging. 7hen enabled, a separate log entry 'ill be generated or all the ro's in each table that 'ere processed by EIM. This allo's greater per ormance. 7hen disabled, each and every ro' processed by EIM 'ill have an entry in the transaction table. >alid values are TR0E or !3&SE. -e ault value is TR0E. Example4 SET "3SE- &$22I/2 N TR0E )"D0TE #O<, This parameter speci ies 'hether oreign re erences in the named table should be updated. >alid values are TR0E or !3&SE. -e ault value is TR0E. Example4 01-3TE R$7S N S=C$/T3CT, !3&SE This above example restricts any update including the updating o oreign key re erences in the S=C$/T3CT table 'hile per orming the EIM Merge. Care should be taken 'hile setting !3&SE value, because it might result in dangling oreign key re erences.

4'5 E9ten!e! "arameters* 3part rom the parameters de ined at the component level and I!" ile, it is also possible to de ine dynamic parameters at task level. These parameters are called as extended parameters. Extended parameters are o t'o types namely4

1/22/2014

Con i!ential

"age 1-

Technical Document

Enterprise Integration Manager

0ser+-e ined Extended 1arameters 1rede ined Extended 1arameters

4.7.1 User-Defined Extended Parameters: 0ser can de ine dynamic parameters and values either through the 20I or command line inter ace. Common uses o this type o parameters include setting EIM batch number dynamically, setting values to the variables de ined in the S%& #uery used in the I!" ile. To de ine the parameters through 20I, ollo' the steps4 Click on site map, select Server 3dministration. Select Enterprise $perations Component Re#uests vie' tab. Create ne' record and select JEnterprise Integration ManagerK in the component re#uest orm. In the Component Re#uest 1arameter list applet, create ne' record and click on the select button in name ield. Select Extended 1arameters in the Pob 1arameters 'indo' and click $M, 'hich 'ill return to the Component Re#uest 1arameter list applet. In value ield, type parameter and value in the ollo'ing ormat4 name1=value1 name2=value2!!name"n=value"n Example4 !IRST=/3MEN9ary

To de ine the parameters through command line inter ace, ollo' the steps4 In the command line, use the key'ord Extended1arams to de ine the name=value ormat. Example4 Extended1aramsNHO"atch/um)N,((((),"atch/um,N,((((,+,((((.HO

4.7.2 Predefined Extended Parameters: Some extended parameters are prede ined in Siebel applications 'hich ollo's the same name=value ormat. "elo' is a list o prede ined extended parameters4 C0RRE/T=0SER L &ogon name o the current user. 13SS7$R- L 1ass'ord o current user. C0RRE/T=-3TETIME L Current date 8 time in ormation. R$$T=-IR L 9ome directory o Siebel server. SIE"E&=!I&E=-IR L Siebel !ile System directory. &3/2032E L &anguage o Siebel server installation. T3"&E=$7/ER L /ame o the table o'ner. $-"C=-3T3=S$0RCE L Connect string or the $-"C data source. M35=/EST=S0"ST L Maximum level o nesting in parameter substitution. /0M=I!T3"&E=&$3-=C0T$!! I b!ile/ame Trace!lags

The parameter /0M=I!T3"&E=&$3-=C0T$!! is used to tell EIM 'hether to load all the schema mappings. The eature is disabled by de ault in 'hich the value is set to +). 7hen enabled, EIM loads all schema mappings. To enable this parameter, set the value to a

1/22/2014

Con i!ential

"age 14

Technical Document

Enterprise Integration Manager

positive number that is one less than the number o EIM tables used in the process. I the parameter value is set to the number e#ual to the number o EIM tables used in the process, it e ectively disables this eature. Example4 Extended1aramsNHK/0M=I!T3"&E=&$3-=C0T$!!N+)K

1/22/2014

Con i!ential

"age 12

Technical Document

Enterprise Integration Manager

2'0 Import "rocess*

This section describes the steps involved in an import process, manual procedure to be ollo'ed to accomplish an EIM import, di erent values o I!=R$7=ST3T column and recommended EIM importing order or di erent entities. 2'1 Import "rocess ,teps* 7henever an EIM import process runs, it internally per orms a se#uence o tasks. Each task involves multiple passes 'here one pass is de ined as an execution o one S%& statement to achieve a certain internal operation. ,tep1* This step is the initialiCation step 'here EIM compares the I!=R$7="3TC9=/0M 'ith the batch number speci ied in the con iguration ile. I no records are ound or the particular batch number, EIM gets terminated. It also sets all the temporary columns to /0&&. 7hen EIM starts at this step, the I!=R$7=ST3T column value is set to JI/=1R$2RESSK. In addition, it also checks 'hether re#uired columns are null. I any o the re#uired columns 'as ound null, the 'hole EIM process stops at this point. ,tep2* EIM applies any -E!30&T C$&0M/S andRor !I5E- C$&0M/S values de ined in the con iguration AI!"B ile. ,tep-* EIM applies the ilter #ueries de ined or this import process. Those records 'hich 'ere eliminated are set 'ith value JIM1$RT=REPECTE-K in the I!=R$7=ST3T column. The I!=R$7=ST3T=/0M and ==ST3 columns or these records are set 'ith a value o current EIM pass number. ,tep4* EIM resolves and generates the oreign key re erences or the ro's that already exist in the Siebel base tables. $nce resolved, it 'rites these oreign key values into the temporary columns o the inter ace table. I the oreign key ails or any re#uired columns, then EIM eliminates those records rom urther processing and sets their I!=R$7=ST3T to J!$REI2/=ME@K and I!=R$7=ST3T=/0M 8 =ST3 columns 'ith the corresponding EIM pass number. In addition to oreign key generation, EIM also validates or the list o values or the bounded pick lists. The ailed ro's are eliminated rom urther processing and their I!=R$7=ST3T column is set to J1ICM&IST=>3&0ESK. "esides the EIM pass number is stored in the I!=R$7=ST3T=/0M and =ST3 columns. ,tep2* EIM etches the appropriate R$7=I- o the records 'hich already exist in the base table and 'rites those values into the corresponding =RI- temporary column o those records. -uring this step, it also sets =E5S temporary column o these records to @.

1/22/2014

Con i!ential

"age 13

Technical Document

Enterprise Integration Manager

,tep3* EIM generates R$7=I- or ne' records. These records are those 'hose =E5S temporary column is set to /. $nce R$7=I- is generated, these values are stored in the corresponding =RI- temporary column o the records. ,tep5* EIM eliminates ro's 'hose user keys contain invalid values. 3 scenario like missing value in one o the user key columns comes under this classi ication. EIM eliminates those ailed records and set their I!=R$7=ST3T value to JRE%0IRE-=C$&SK and I!=R$7=ST3T=/0M 8 =ST3 temporary columns to the current EIM pass number. EIM also resolves and generates oreign key re erences or the ne' ro's that do not exist in the base table. $nce resolved, it 'rites these oreign key values into the temporary columns o the inter ace table. I the oreign key ails or any re#uired columns, then EIM eliminates those records rom urther processing and sets their I!=R$7=ST3T to J!$REI2/=ME@K and I!=R$7=ST3T=/0M 8 =ST3 columns to the corresponding EIM pass number. ,tep6* EIM updates the contents o existing base table ro's 'ith the values rom the inter ace table that have success ully passed all the previous steps. In case o any update done, EIM 'rites the transaction detail to the master transaction log i and only -ocking Transaction &ogging parameter is enabled in the System 1re erences. I duplicates 'ere ound in the EIM table, then the ro' 'hich EIM encounter irst 'ill be considered or updating and rest other duplicate ro's are ignored. These duplicate ro's 'ere set value J-01=REC$R-=E5ISTK in I!=R$7=ST3T column and the current EIM pass number in I!=R$7=ST3T=/0M and =ST3 temporary columns. ,tep7* EIM inserts the ne' records rom the inter ace table into base tables. It 'rites these ne' ro's to the master transaction log i and only -ocking Transaction &ogging parameter is enabled in the System 1re erences. I duplicates 'ere ound in the EIM table, then the ro' 'hich EIM encounter irst 'ill be considered or updating and rest other duplicate ro's are ignored. These duplicate ro's 'ere set value J-01=REC$R-=E5ISTK in I!=R$7=ST3T column and the current EIM pass number in I!=R$7=ST3T=/0M and =ST3 temporary columns. ,tep10* EIM updates the primary child columns in this step. 3n example4 Setting the primary address or an account. To achieve this, the column 3CC=1R=3--R should be set to @ or the particular record in the EIM table. ,tep11* EIM runs MISC S%& parameters as last step o import process. There are certain primary child columns 'hich should be set using both MISC S%& and primary child column in the EIM table.

1/22/2014

Con i!ential

"age 15

Technical Document

Enterprise Integration Manager

Those columns are4 S=C$/T3CT.1R=$0=3--R=IS=C$/T3CT.1R=9E&-=1$ST/=IS=$R2=E5T.1R="&=1ER=IS=$R2=E5T.1R=S9I1=1ER=IS=1$ST/.1R=1$ST/=3--R=IS=1$ST/.1R=EM1=I-

These are the only six columns in Siebel 9oriContals, 'here MISC S%& has to be speci ied, in order to update the primaries. I MISC S%& is not set, though the EIM import succeeds, the primary child 'onGt be set in the Siebel base table. !or urther in ormation on MISC S%&, check the Import process parameters section de ined in the previous pages. 2'2 Manual Importing "roce!ure* EIM import is a substantial e ort 'here many things should be planned, many prere#uisites to be met be ore per orming the process itsel . I!enti % an! &ali!ate Data* -etermine 'hether the data to be imported already exist in the database. Check or the completeness o the data. I re#uired, do some data massaging be ore importing. -etermine the count o entities so that it might help in estimating the time and resources needed. I!enti % column mapping an! )ser Ae%s* -etermine the base table 'here the data 'ill get stored inally. /o' identi y the mapping bet'een the data and Siebel base columns. Identi y the EIM table to achieve this process and the mapping bet'een the data and EIM table columns. Identi y the user keys and re#uired columns that need to be populated. $ar!:are an! ,o t:are Environment* Check 'hether the Siebel application is properly installed and all the re#uired components or EIM are in running state. Check 'hether ample memory resources are available. Check 'hether the currently available disk space 'ill be able to store the data a ter import process. Speak to your -"3 regarding the uture database siCe. .acCup e9isting !atabase* "e ore per orming any signi icant change to the underlying database, it is recommended to take a backup o database. This 'ill ease the recovery in case o any maIor ailure. Cop% +ile attachments to ,erver !irector%* Copy all the attachments to be imported to the input directory under the Siebel server root directory. $ptionally you can set di erent directory path, by speci ying it in the 3TT3C9ME/T -IRECT$R@ parameter in the I!" ile. The de ault ile attachment path is ESIE"E&=9$MEFHI/10T, 'hich can be changed using the above parameter. /oa! an! veri % EIM tables* 0se any data loading tools like S%& &oader, -TS, etcD to load the legacy data into the EIM tables. $nce the data is loaded veri y check the number o loaded ro's against the legacy database. 3lso check the contents o data loaded into the EIM table.

1/22/2014

Con i!ential

"age 16

Technical Document

Enterprise Integration Manager

EIM Con iguration +ile* Create the con iguration ile or this import process. 0se de ault.i b in the ESIE"E&=9$MEFH3-MI/ directory as a template. Test the Import "rocess* Test your EIM import process or a small batch o )(( records. I re#uired, change the parameter settings in the con iguration ile. #un the Import "rocess* In case o huge volumes o data, split the data into multiple batches 'ith approximately )((( to 6((( records per batch. Smaller the batch it is easier to identi y the problems. Run the EIM process either through 20I or command line inter ace. &eri % #esults* There are di erent types o error that might occur during an import process. Identi y these errors, debug them and run EIM once again as a separate batch, by changing the batch number or the ailed ro's. 2'- Di erent I+B#O<B,T0T &alues* -epending upon the type o ailure, the I!=R$7=ST3T column o the inter ace table records are set 'ith di erent kinds o values. 0M.I1)O),* T'o ro's in the base table have same user key but di erent con lict I-s. D)"B#ECO#DBE4I,T,* $ne or more ro's that exist in the inter ace table exactly matches 'ith base table record. D)"B#ECO#DBI(BEIMBT./* $ne or more ro's have the same user key o another ro' 'ithin the inter ace table. +O#EI1(BAE@* 7hen a re#uired oreign key column in the target table could not be resolved. IM"O#TED* The ro's got success ully imported or both target and not+target base tables. IM"O#TB#EDECTED* Ro's 'hich 'ere eliminated as a result o !I&TER=%0ER@. I(B"#O1#E,,* This value is set in the irst step, the initialiCation step, o the import process. (OTB0//O<ED* This value is set 'hen a particular operation is not permitted. "0#TI0//@BIM"O#TED* The ro's got success ully imported or target table but ailed or one or more non+target tables. "ICA/I,TB&0/)E,* Re#uired bounded pick list value could not be resolved. #E8)I#EDBCO/,* $ne or more re#uired columns 'ere ound /0&&. #O//.0CA* 7hen EIM encounters an error during a roll back operation, this value is set. ,8/BE##O#* This value is set, 'hen EIM ails importing, 'hen the transaction logging is enabled. 2'4 #ecommen!e! Importing Or!er*

1/22/2014

Con i!ential

"age 17

Technical Document

Enterprise Integration Manager

7henever an import process is done, you should make sure that any re erence data needed must already exist in the Siebel database. I this is not ollo'ed errors like !$REI2/=ME@, 1ICM&IST=>3&0ES might occur. So, any administrative or re erential data should be imported irst, ollo'ed by other data. The recommended order is as ollo's4 3dministrative -ata AEx4 &ist o >aluesB "usiness 0nits A$rganiCationsB 1ositions 3ccounts Contacts Employees 1roducts $pportunities 1ersonal 3ccounts %uotes -ocuments !orecasts !ul illment Marketing Campaigns C12 1romotion Management C12 1roduct Movement Service Re#uests 1roduct -e ects 3ctivities and 3ppointments /otes !ile 3ttachments

In some cases, the import order might change slightly depending upon the business re#uirements.

1/22/2014

Con i!ential

"age 20

Technical Document

Enterprise Integration Manager

3'0 E9port "rocess*

This section describes the steps involved in an export process, manual procedure to be ollo'ed to accomplish an EIM export process. 3'1 E9port "rocess ,tep* 7henever an EIM export process runs, it internally per orms a se#uence o tasks. Each task involves multiple passes 'here one pass is de ined as an execution o one S%& statement. ,tep1* EIM per orms parameter de the EIM table ro's exist or ,tep2* In this step, EIM uses the export parameter settings to select the records. It checks i E51$RT 3&& R$7S parameter is set to TR0E. I so, it ignores any E51$RT M3TC9ES parameters de ined in the I!" ile and exports all the ro's. I E51$RT 3&& R$7S is set to !3&SE, it uses the E51$RT M3TC9ES parameters to locate those speci ic ro's. $nce the ro's to be exported 'ere identi ied, it exports all the data into the particular EIM table and sets the I!=R$7=ST3T value to E51$RTE- or ro's that 'ere success ully exported. ,tep-* In case o parent tables, EIM locates and exports the child data to their respective EIM tables. 3'2 Manual E9porting "roce!ure* "e ore you start the export process, it is necessary to take care o the ollo'ing things. "repare EIM Tables* Check 'hether your inter ace table doesnGt have any records 'ith I!=R$7="3TC9=/0M value e#uivalent to the batch number speci ied in the I!" ile. I it exists EIM behaves in the ollo'ing 'ays depending upon the setting o the C&E3R I/TER!3CE T3"&E parameter. I the parameter is set to TR0E, EIM deletes all those existing ro's or the speci ied batch number. I the parameter is set to !3&ES, EIM issues a 'arning. an initialiCation process on EIM tables. It checks the C&E3R I/TER!3CE T3"&E ined in the I!" ile. I this parameter is set to TR0E, it deletes all the ro's in or the speci ied batch number. I this parameter is set to !3&SE and i some the speci ic batch number, a 'arning is issued.

E!it Con iguration +ile* Create your con iguration ile by de ining your re#uirements. The modi ications that should be made in the I!" ile depend on di erent scenarios as sho'n belo'. Exporting all data ro's Exporting selected data ro's Exporting all columns or selected columns

1/22/2014

Con i!ential

"age 21

Technical Document

Enterprise Integration Manager

7hen you need to export all the ro's set the value o E51$RT 3&& R$7S parameter as TR0E. I you 'ant to export speci ic ro's, speci y the E51$RT M3TC9ES parameter 'ith appropriate condition expression. I you 'ant to export particular columns use the $/&@ "3SE C$&0M/S or I2/$RE "3SE C$&0M/S parameter in the I!" ile. .) (ame "ulling* EIM export process, exports only the R$7=I- o the "0 into ="I columns o the EIM table. In order to etch the values o the "0 names, ollo' the steps4 In the 3-MI/ directory, open the ile named eim=export=lookup=bu=name.s#l. &ocate the appropriate S%& statement or the base table that you are exporting. I necessary, modi y the S%& statement as re#uired and run it.

&eri % E9port #esults* Check the count o records in the EIM table 'ith I!=R$7=ST3T value e#uivalent to E51$RTE- against the count o the records you need to export.

1/22/2014

Con i!ential

"age 22

Technical Document

Enterprise Integration Manager

5'0 Delete "rocess*

This section explains di erent types o deletes, the steps involved in a delete process, manual procedure to be ollo'ed to accomplish an EIM delete process. 5'1 Delete T%pes* There are three 'ays in 'hich you can achieve the deletion o records through EIM. They are as ollo's4 -E&ETE E53CT L 7here EIM uses a user key matching algorithm to identi y the ro's that needs to be deleted. This is done by matching the user key o the record in the inter ace table 'ith that o the records in the base table. $nce a match occurs, EIM deletes this record. -E&ETE M3TC9ES L 7here EIM deletes those records that match the conditional expression set in the I!" ile using the parameter J-E&ETE M3TC9ESK. -E&ETE 3&& R$7S L 7here EIM deletes all the ro's rom the base table irrespective o any conditions or user key matching.

5'2 Delete "rocess ,teps* 7henever an EIM delete process runs, it internally per orms a se#uence o tasks. Each task involves multiple passes 'here one pass is de ined as an execution o one S%& statement. ,tep1* EIM per orms an initialiCation process on EIM tables. It checks the C&E3R I/TER!3CE T3"&E parameter de ined in the I!" ile. I this parameter is set to TR0E, it deletes all the ro's in the EIM table or the speci ied batch number. The de ault value o the parameter depends on the type o delete Aas explained in previous sectionB being per ormed. ,tep2* In this step EIM per orms the actual deletion o the records. I the -E&ETE E53CT parameter is set to TR0E in the I!" ile, EIM per orms a user key matching process to identi y those records that need to be deleted and deletes the same. I the -E&ETE M3TC9ES parameter is de ined in the I!" ile, EIM uses this conditional expression and selects those records rom the target base table and deletes them. I the -E&ETE 3&& R$7S parameter is set to TR0E in the I!" ile, EIM deletes all the ro's rom the target base table. ,tep-* 3s a inal step, EIM sets the I!=R$7=ST3T o those records to J-E&ETE-K in the EIM table. 3lso, 'hen thereGs a re erence to this record in some other table, that record is deleted i the re erenced column is a mandatory, other'ise the re erence column is cleared. 7henever a parent record is deleted, the child records are also deleted, i the oreign key column in the child table is mandatory, other'ise the oreign column is cleared.

1/22/2014

Con i!ential

"age 2-

Technical Document

Enterprise Integration Manager

The deletion o child record is decided based on the C3SC3-E -E&ETE $/&@ parameter de ined in the I!" ile. 5'- Manual Deleting "roce!ure* "e ore you start the export process, it is necessary to take care o the ollo'ing things. I!enti % the Data* 3s a irst step, identi y the data you 'ant to delete rom the base table. /o' check once or t'ice, 'hether you have selected the right data or deleting. $nce the data is identi ied, decide 'hat type o delete Aexplained in previous sectionB needs to be used. "repare EIM Table* -epending upon the type o delete, decide 'hat data should be loaded into your EIM table. I you are achieving a delete through -E&ETE E53CT, you must load the data into EIM table in the mandatory columns 'ith I!=R$7=ST3T set to J!$R=-E&ETEK, the user key columns o the corresponding target and non+target table. E!it Con iguration +ile* -epending upon the type o -E&ETE you use, make changes in the con iguration ile. The con iguration parameters are explained in the previous section. 3l'ays set the C$MMIT E3C9 13SS 8 C$MMIT E3C9 T3"&E parameter to !3&SE and R$&&"3CM $/ ERR$R to TR0E, to avoid dangling re erences in case i a ailure occurs during an EIM delete. &eri % #esults* 3 ter executing the EIM task, veri y the results by examining the EIM table. EIM stores the R$7=I- o the deleted ro's in the EIM table, in T=-E&ETE-=R$7=Icolumn. %uery or the count o records 'hose I!=R$7=ST3T N J-E&ETE-K. >eri y this count is e#ual to the count o records considered or deletion earlier.

1/22/2014

Con i!ential

"age 24

Technical Document

Enterprise Integration Manager

6'0 Merge "rocess*

EIM Merge uses the ro's in the EIM table and the I!" ile parameter settings to achieve the merge process. 3pparently, EIM merge is a combination o deleting one or more ro's and updating o oreign key re erences 'herever re#uired. This section explains the steps involved in the merge process, manual procedure to achieve merging. 6'1 Merge "rocess ,teps* ,tep1* EIM per orms an initialiCation process on EIM tables. 3s in any EIM process, this steps checks 'hether the mandatory columns are loaded. ,tep2* EIM selects the records rom base tables, 'hose user key match that o in the EIM table. ,tep-* EIM deletes the records rom the target base table that are speci ied in the EIM table. It also updates the oreign key re erences in the child entities o the deleted records to point to the survived record. !or deleted ro's, EIM sets the T=-E&ETE-=R$7=I- to the R$7=I- o the deleted ro' in the base table. EIM also sets the T=MER2E-=R$7=I- o the deleted ro's 'ith the R$7=I- o the survived record. 7hile merging, 'hen duplicate child entities are ound among the parents being merged, the child records o the deleted ro' is made to point to the survived record and C$/!&ICT=I- is set or those duplicate child records. "elo' example portrays the 3ccount and Contact relationship be ore and a ter merge.
.e ore Merge <inner #ecor! 91 Regional /oser #ecor! 91 77

9ary 1otter 0 ter Merge 91 Regional

1eter 1arker

9ary 1otter

$liver T'ist

9ary 1otter

1eter 1arker

9ary 1otter CO(+/ICTBID ,et

$liver T'ist

1/22/2014

Con i!ential

"age 22

Technical Document

Enterprise Integration Manager

6'2 Manual Merging "roce!ure* I!enti % the Data* 3s a irst step, identi y the data you 'ant to merge rom the base table. 7ithin, identi y the survivor records and loser records. "repare EIM Table* &oad the user key o both the survivor records and loser records into the EIM table. Set the I!=R$7=MER2E=I- or the loser records 'ith a value o the R$7=Io survivor record in the EIM table. The ollo'ing example explains the above statement4 I+B#O<B.0TC$B()M )(( )(( )(( 0CCO)(T (0ME 91 India 91 Regional 91 7orld7ide #O<BID ,() ,(, ,(. I+B#O<BME#1EBID /0&& ,() ,()

&eri % #esults* 3 ter running the EIM process, test your results by examining the EIM table. %uery or the records 'ith I!=R$7=ST3T N JMER2E-K, 'hich gives the count o the merged records. %uery or the records 'ith I!=R$7=ST3T N JMER2E-=I/T$K, 'hich gives the count o the survivor records.

1/22/2014

Con i!ential

"age 23

Technical Document

Enterprise Integration Manager

7'0 #unning EIM*

"e ore running an EIM process, make sure all the components re#uired or EIM task are up and running, the con iguration ile is stored in the ESIE"E&=9$MEFH3-MI/ directory and the data is loaded into the EIM table. EIM can be run in t'o 'ays4 Through 20I and Command &ine inter ace. 7'1 #unning EIM through 1)I* $pen Siebel Client. 2o to Server 3dministration Screen. Select Enterprise $perations Component Re#uest vie' tab. In the Component Re#uest list applet, create a ne' record. In the ComponentRPob ield select Enterprise Integration Manager. In the Component Re#uest 1arameter list applet, add ne' record or setting the EIM parameter. $nce all the parameters are added, click the menu button in the Component Re#uest orm applet, and click Submit.

7'2 #unning EIM through Comman! /ine inter ace* Start the srvrmgr program in the command line inter ace. 0se the belo' syntax to connect to the server manager. srvrmgr Lg Egate'ayF +e EenterpriseF +s ESiebel serverF +u E0ser nameF +p Epass'ordF $nce connected to server manager, execute the start task command as sho'n belo'. start tasC or component EIM :ith con igE EI!" ile nameF I re#uired give the parameter AnameNvalueB pair separated by commas.

The excel sheet embedded belo' gives all the parameters o the EIM component. It also gives the parameter alias to be used 'hile speci ying the parameters through the command line inter ace, description o those parameters. The other detail like Current >alue, >alue on Restart and E ective Immediately sho's the out o box values o these parameters a ter a resh installation.

EIM Parameters.xls

In order to trace the EIM task in terms o S%& statements, $-"C calls and other errors you can set the appropriate parameters to do this. The three important parameters responsible or this are4 Error !lags S%& Trace !lags Trace !lags

3ctivating or setting these lags 'ill have a direct e ect on per ormance. Care must be taken, so that these lags are not used 'hile running EIM task in production environment. Typically, these lags should be used in a testing or development environment only.

1/22/2014

Con i!ential

"age 25

Technical Document

Enterprise Integration Manager

7'- Error +lags* These lags are set to log the details 'hen some error occurs during the EIM process. Typical values used or setting this lag are ( and ). 7ith a setting o Error !lag N ), EIM records detailed explanation o ro's that 'ere not processed success ully during the EIM process. 7'4 ,8/ Trace +lags* Setting this lag 'ill create a log o S%& statement shot during the EIM. Typical values are ), , and *. 3 value o ;, 'ill record all S%& statements that make up the EIM process. 7'2 Trace +lags* These lags are used to trace various EIM operations like component tracing, S%& summary, task con iguration, 'orst #ueries that took lots o time, summary o 'hole EIM process, etc... To use this lag, itGs necessary to con igure the component event level as ollo's4 Server 3dministration Component Component Event Con iguration vie' tab. Select the event type and set the appropriate log level.

&og level value ranges rom ( L 6. The table listed belo' gives more detail about the logging level. /evel ( ) , . * 6 Description !atal Errors 7arnings In ormational -etails -iagnostic

To set the event logging or EIM component, you should set the levels or the ollo'ing event types as sho'n belo'4 Event T%pe S%& Tracing S%& Summary Task Con iguration Component Tracing /og /evel * * * .

$nce you con igure the event levels according to your re#uirement, you can set the appropriate value or the Trace !lags and run the EIM. Typical values o trace lags are ), ,, *, ; and .,. To activate multiple trace lags, set the value 'hich is e#uivalent to sum o the trace lag values. -i erent trace lag values and their descriptions are given sho'n belo'4 Trace +lag 1* Setting a value o ) 'ill create step+oriented log o the task. The log created thus can be used to determine the amount o time EIM spends on each step o the 'hole process or each EIM table processed.

1/22/2014

Con i!ential

"age 26

Technical Document

Enterprise Integration Manager

Trace +lag 2* Setting a value o , 'ill record traces o all substitutions o user parameters. Trace +lag 4* Setting a value o * 'ill record traces o all the user key overrides. Trace +lag 6* Setting a value o ; 'ill record traces o all inter ace mapping 'arnings. Trace +lag -2* Setting a value o ., 'ill record traces o all ile attachment status. This trace log has * kinds o labels depending upon the ile attachment process. 0ttachment Importe! L Indicates 'hether the ile attachment 'as encoded, compressed and copied to the Siebel ile server 'ith the ne' name. 0ttachment FOl!G Delete! L Indicates 'hether an existing ile 'as replaced and deleted. 0ttachment (ot +oun! L Indicates that the ile cannot be ound in the I/10T directory. 0ttachment I!entical L Indicates the attachment ound in the I/10T directory is same as that o in the Siebel ile server.

1/22/2014

Con i!ential

"age 27

Technical Document

Enterprise Integration Manager

10'0 Debugging EIM*

$nce an EIM process has run, there might be lots o surprises 'aiting or the Siebel 3dministrator in the orm o errors. These errors might occur due to record ailure, database ailure, not enough tablespace in the database, etcD This section explains ho' to debug di erent kinds o errors that occurs in EIM. -ebugging style di ers rom environment to environment, database to database, and the kind o error. 2eneral EIM errors like 3M"I20$0S to RE%0IRE-=C$&S can be resolved as sho'n in belo' steps4 Check the I!=R$7=ST3T column o the EIM table and understand 'hat the problem actually is. Check the I!=R$7=ST3T=/0M and identi y the number in this column. This number is the EIM pass number 'here the ailure occurred. Check the =ST3 temporary columns o the EIM table that has the same number value as in I!=R$7=ST3T=/0M. $nce this is done, you can identi y the base table 'here the ailure occurred. In EIM=3CC$0/T table, you have < =ST3 columns or each base table catered by this EIM table. ,iebel .ase Table S=13RT@ S=3CC/T=1$ST/ S=3--R=$R2 S=CT&2=C3T=$R2 S=$R2="0 S=$R2=E5T S=$R2=RE& S=13RT@=1ER Temporar% B,T0 Column (ame T=13RT@==ST3 T=3CC/T1$ST==ST3 T=3--R=$R2==ST3 T=CT&2=C3T$R2==ST3 T=$R2="0==ST3 T=$R2=E5T==ST3 T=$R2=RE&==ST3 T=13RT@=1ER==ST3

I I!=R$7=ST3T=/0M and any o =ST3 column matches, then you can conclude the error has occurred in that particular table. $nce you have ound out the error and the table in 'hich it occurred, you need to identi y the tableGs column 'here it ailed. To identi y the column either you should inspect the EIM table ro's or set the trace lags, error lags and S%& lags as explained in the previous section. $nce you run EIM by setting these lags, it 'ill generate a detailed log ile using 'hich you can identi y the ailed column. $nce the column is identi ied, make necessary changes. The changes might be in the data in EIM tables or in the I!" ile.

Sometimes you can see your EIM task staying the 8ueue! state. This is because, the component Server Re#uest 1rocess is in unavailable state. To make this component in running state, you should make sure that you have applied all the patches or your Siebel server. Then shutdo'n the component and startup again as sho'n belo'4 Server 3dministration Server Server Components. %uery or Server Re#uest 1rocessor in the Server Component 3pplet. Click on the Shutdo'n button and then Startup again.

1/22/2014

Con i!ential

"age -0

Technical Document

Enterprise Integration Manager

$nce this is done, restart your Siebel 2ate'ay and Siebel Server 'here the Server Re#uest 1rocessor component resides.

/o' you 'ill ind your Server Re#uest 1rocessor up and running. The 'orkaround or this scenario 'ill be running your EIM task through Command &ine inter ace. There might be some scenarios 'here your EIM 'ill stay in the 0ctive state or long time and i you #uery your EIM table, you 'ill ind the I!=R$7=ST3T value o the records set to I/=1R$2RESS. This happens 'hen a lock 'as ac#uired on the particular EIM table by some other applications. Common examples are, not committing the table once inserting the records into the EIM table. I you get any errors like invalid con iguration ile, then check the I!" ile 'hether you have speci ied all the re#uired con iguration parameters. Most o the EIM errors can be able to resolve immediately like con iguration ile not ound, invalid con iguration ile parameters, 'hile there might be errors like insu icient space. This means not only enough space available in the disk, but also in the database. @ou should check 'hether enough space is available in the Siebel -ata tablespace and also check 'hether auto extent option is enabled or this tablespace. This kind o error, sometimes, might be very di icult to Iudge and conclude. I your database gets shut do'n automatically, 'hen your EIM is running, then itGs a problem 'ith the database. Check 'hether your database is applied all the re#uired patches, 'hether the 'indo's service is con igured properly or the database.

1/22/2014

Con i!ential

"age -1

Technical Document

Enterprise Integration Manager

11'0 +08s*
1' <hen I trie! to set the primar% emplo%ee or the position through EIMH it is not getting up!ate!' <h%I 7hile updating the primary employee or position, apart rom setting the 1$ST/=1R=EM1 column in the EIM table, you should also de ine the MISC S%& parameter in your I!" ile. !or urther in ormation on 9o' to set MISC S%&, MISC S%& or other 1rimary Childs, re er previous section. 2' 0lthough setting the trace lagsH IJm not able to see log in ormation in the log ile' <h%I @ou should con igure your component event levels as described in the previous section Trace !lags. -' <hat !oes I+. stan!s orI I!" stands or Inter+ace .uilder. 4' Can I use more than one I+. ile or an EIM processI /o, itGs not possible. @ou can use shell process in case i you 'ant to do more than one operation in a single EIM task. 2' <hat is the e ect o setting DocCing Transaction /ogging parameter to T#)E in case o EIM e9portI 3ny transaction logging 'onGt take place, since export process doesnGt change any data values. 3lso any parameter setting or transaction logging is ignored. 3' <hat is the use o DE/ETE ,AI" "#IM0#@ parameter in EIM DE/ETE operationI The de ault value o this parameter is TR0E 'hich doesnGt update the primary child column in the parent record 'hen the primary child record is deleted. I set to !3&SE, the primary child column is set to J/o Match Ro' IdK. 5' $o: :ill I get the position !etails :hen I nee! to populate these values in the EIM tableI The #uery listed belo' 'ill etch all the positions and their details in the underlying Siebel database. SE&ECT 3./3ME O1osition /ameO, "./3ME O1osition -ivisionO, ".&$C O1osition &$CO, C./3ME O1osition "0 /ameO !R$M SIE"E&.S=1$ST/ 3, SIE"E&.S=$R2=E5T ", SIE"E&.S="0 C 79ERE 3.$0=I- N ".R$7=I- 3/- "."0=I- N C.R$7=I6' Is it vali! to set the con iguration ile in such a :a% to restrict inserts or up!ates in the target base tableI @es. @ou can disable the inserts or updates done to the target base table and still it 'onGt thro' any error, provided the user keys and re#uired columnGs values are available. 7' <h% am I getting K(OTB0//O<EDL in the I+B#O<B,T0T column a ter EIM importI 1ossible reason could be the misuse o the I/SERT R$7S or 01-3TE R$7S parameter. 7hen you set the I/SERT R$7S parameter to alse and you try to import ne' record, you 'ill get this error. 7hen you set the 01-3TE R$7S parameter to alse and you try to make changes to this particular record, you get this error. 10' M% EIM Delete ails b% setting the I+B#O<B,T0T column to 0M.I1)O),' <h%I

1/22/2014

Con i!ential

"age -2

Technical Document

Enterprise Integration Manager

7henever EIM encounters more than one record 'ith same user key values but di erent C$/!&ICT=I- values, EIM cannot proceed 'ith the delete operation and hence it sets the value J3M"I20$0SK in the I!=R$7=ST3T column. 11' <hat is an 0ccount ,%non%mI $o: it a ects m% EIMI 3 synonym is nothing but an alias name given or any account. These synonyms can be entered by the Siebel 3dministrator through Synonym >ie's. 7henever you do an EIM Import on accounts, EIM not only checks the user key in the base table but also checks the associated Synonyms or that account to ind a match. This makes EIM time consuming. To suppress this behavior, you must set the 0SI/2 S@/$/@MS parameter to !3&SE.

1/22/2014

Con i!ential

"age --

Technical Document

Enterprise Integration Manager

0ppen!i9 0*
0cron%ms* C12 L C 1 2 CRM L Customer Relationship Management -M& L -ata Manipulation &anguage EIM L Enterprise Integration Manager 20I L 2raphical 0ser Inter ace I!" L Inter!ace "uilder $-"C L $pen -ata"ase Connectivity S%& L Structured %uery &anguage

1/22/2014

Con i!ential

"age -4