Sie sind auf Seite 1von 11

Configuration File:

or

IFB File

Any EIM process reads a configuration file, where different kinds of parameters are set for an EIM process. The configuration file, in short IFB file, defines the type of process, EIM table in ol ed, batch number, and lots of other parameters. An IFB file has two sections ! "eader and #rocess sections. The header section defines the parameters that are common to all the processes defined in the file. The process section defines parameters which are specific to that particular section. This file is stored in the $%IEB%&'&()A*MI+ path, from where the EIM task reads. If this file is not stored in this directory prior running EIM task, the absolute path of the file has to be specified in the task. If not, an error will be thrown. These EIM parameters are classified as follows, General header parameters General process parameters Import process parameters Export process parameters Delete process parameters Merge process parameters

1. General Header

arameters:

This section describes the parameters that will be used by all the processes defined in the configuration file. !"ie#el Interface Manager$ This is a special and mandator% keyword that needs to be specified, which tells the EIM task, that this particular file contains the parameters for EIM. &"E' ()ME %pecifies the logon name of the user for running the process. If you ha e not specified this in -omponent #arameters, this needs to be specified in the IFB file. E.ample, /%E& +AME 0 %A*MI+ )""*+'D %pecifies the password that needs to be alidated for running the EIM process. If you ha e not specified this in -omponent #arameters, this needs to be specified in the IFB file. E.ample, #A%%12&* 0 %A*MI+ '+CE"" Identifies the process section that has to be e.ecuted defined in the IFB file. E.ample, #&2-E%% 0 Import 2rgani3ations C+((EC, %pecifies the 2*B- source name of the database to be used

-+G ,')(")C,I+(" ,+ FI-E This parameter specifies whether the transactions to be logged to a file or docking transaction table. 'alid alues are T&/E or FA4%E. If set to T&/E, the transaction details are logged into the directory $%IEBE45FI4E5%6%TEM(EIM. If set to FA4%E, the transaction details are logged into the %5*2-75T8+5429 table. This parameter doesn:t make sense, if *2-7I+9, T&A+%A-TI2+ 4299I+9 parameter in %ystem #references is set to FA4%E. ,)B-E+*(E' This parameter specifies name of the user who owns the %iebel database tables.

.. General

rocess

arameters:

This section describes the parameters that are generic to all EIM processes. The parameters defined in this section ha e a scope limited to this process only.

,/ E
'e0uired parameter that specifies the type of EIM process. Typical process ,%pes are IM +',1 E2 +',1 ME'GE1 DE-E,E and "HE--. "HE-- process defines that this process has other sub;processes that needs to be e.ecuted.

,)B-E
'e0uired parameter that specifies the EIM table to be used for the process. Example: ,)B-E 3 EIM4)CC+&(, For performance reasons, the number of tables should be limited to fewer than fi e for a merge or e.port process.

B),CH
'e0uired field that specifies the batch number, which is used to identify the set of records that should be considered for this EIM process. This batch number corresponds to the number specified in the IF5&215BAT-"5+/M column of the EIM table. 'alid alues are < to =>?@?ABC?@ D=B> ! >E. Batch numbers can be specified in ranges or as a comma delimited format. Example: B),CH 3 155 6 115 or B),CH 3 1551 1571 1.5. If batch number is specified wrongly in IFB file, the EIM throws an error stating, no records found for the stated batch number.

C+MMI, E)CH

)""

2ptional parameter that specifies whether the process needs to do a commit after e ery EIM passes. #ass is defined as one %F4 *M4 statement that got e.ecuted. 'alid alues are ,'&E or F)-"E. Default 8alue of this parameter is ,'&E.

This parameter should be set to FA4%E while using in delete or merge process. %ince it commits after each pass, and in case of any failures, the database is left corrupted with dangling foreign key references, etcG Example: C+MMI, E)CH )"" 3 F)-"E

C+MMI, E)CH ,)B-E


2ptional parameter that specifies whether the process needs to do a commit after processing each base table. 'alid alues are ,'&E or F)-"E. *efault alue of this parameter is T&/E. This parameter should be set to FA4%E while using in delete or merge process. The reason behind this is, since it commits after each pass, and in case of any failures, the database will be left corrupted with dangling foreign key references, etcG Example: C+MMI, E)CH ,)B-E 3 F)-"E

IG(+'E B)"E ,)B-E"


2ptional parameter that specifies which base tables has to be ignored for the process for the particular EIM table. This parameter impro es the EIM performance. Example: IG(+'E B)"E ,)B-E" 3 "4 )',/4 E'1 "4+'G4B&

I(C-&DE
2ptional parameter that specifies which other sub;process needs to be included in the process in Huestion. Example: I(C-&DE 3 Import Contacts

-+G ,')(")C,I+("
2ptional parameter that tells whether to log transactions or not. 'alid alues are ,'&E or F)-"E. *efault alue depends on the *2-7I+9, T&A+%A-TI2+ parameter defined in the %ystem #references. Example: -+G ,')(")C,I+(" 3 F)-"E 4299I+9

+(-/ B)"E ,)B-E"


2ptional parameter that specifies which base tables has to be considered for the process for the particular EIM table. This parameter impro es the EIM performance. Example: +(-/ B)"E ,)B-E" 3 "4 )',/1 "4+'G4E2,1 "4)DD'4+'G1 "4+'G4B&1 "4)CC(,4 +",(

'+--B)C9 +( E''+'
2ptional parameter that specifies whether a rollback has to be made if any failure occurs during the EIM process. 'alid alues are ,'&E or F)-"E. *efault alue is FA4%E. This parameter should be set to T&/E while using in delete or merge process. In case of any failure, the database will be roll backed to the last commit point and thus a oiding the database corruption. E.ample, &244BA-7 2+ E&&2& 0 T&/E

"E""I+( ": 2ptional parameter that specifies a user defined %F4 statement to be sent to database for e.ecution before any other %F4 statements. This parameter can be used to set tracing for performance analysis. 2nly one %E%%I2+ %F4 parameter is allowed per process section. This parameter cannot be used to insert or update any data in %iebel tables. E.ample, %E%%I2+ %F4 0 I/#*ATE EIM5-2+TA-T %ET ##5%TA&T5*T 0 %6%*ATE 1"E&E IF5&215BAT-"5+/M 0 =<<J

"9I

B&4ID DEF)&-,

2ptional parameter that specifies whether to use the default B/5I* defined in the repository. 'alid alues are T&/E or FA4%E. *efault alue is FA4%E. If set to FA4%E, the B/5I* defined in the repository is used for B/5I* columns in the base tables. If set to T&/E, the alues set in the interface table is used. This parameter is only limited to insert, delete and merge process, because the foreign key must be resol ed for these processes. E.ample, %7I# B/5I* *EFA/4T 0 T&/E

,')(")C,I+( ": 2ptional parameter that specifies a user defined %F4 statement to be sent to database before other %F4 statements are processed and immediately after e ery commit or rollback operation. If both %E%%I2+ %F4 and T&A+%A-TI2+ %F4 parameters are specified, the latter gets e.ecuted immediately after the former. 2nly one T&A+%A-TI2+ %F4 parameter can be defined per process section.

&"E E""E(,I)- I(DE2 HI(,"


2ptional parameter specified for M% %F4 %er er and 2racle databases. 'alid alues are T&/E or FA4%E. 1hen set to T&/E, it enables a subset of inde. hints for M% %F4 ser er. *efault alue is T&/E.

&"E I(DE2 HI(,"


2ptional parameter specified for 2racle databases only. 'alid alues are T&/E or FA4%E. 1hen set to T&/E, EIM issues optimi3er hints to the database in order to impro e the performance. *efault alue is FA4%E. E.ample, /%E I+*E8 "I+T% 0 T&/E

&"I(G "/(+(/M"
2ptional parameter that specifies whether to use the account synonyms during the import process. 'alid alues are T&/E or FA4%E. *efault alue is T&/E. In order to impro e the performance, set this parameter alue to FA4%E, but care must be taken while specifying this parameter. &efer F):s for further e.planation on Account %ynonyms.

7. Import

rocess

arameters:

This section describes the parameters that are specific to EIM import processes. The parameters defined in this section ha e a scope limited to this process only. C+MMI, + E'),I+(" 2ptional parameter that specifies the commit freHuency while logging the transactions. 'alue specifies the number of records processed before a commit is done. Applicable only if *2-7I+9, T&A+%A-TI2+ 4299I+9 is set in %ystem #references. *efault alue is <, which means commit has to be made at the end of EIM process. Example: C+MMI, + E'),I+(" 3 155 FI-,E' :&E'/ 2ptional parameter that lets the user to specify an %F4 statement which filters the records that needs to be processed. This Huery runs before the import process starts. The IF5&215%TAT column of those records that fails this Huery for the particular batch as specified in the process section will be set as KIM#2&T5&ELE-TE*J. Example: FI-,E' :&E'/ 3 ;IF4'+*4",), <= >IM +',ED?@ IG(+'E B)"E C+-&M(" 2ptional parameter that specifies which base columns has to be ignored for the particular EIM process. This parameter impro es the EIM performance. 6ou should not ignore the user key columns or reHuired columns. Example: IG(+'E B)"E C+-&M(" 3 "4+'G4E2,.H+ME4 H4(&M +(-/ B)"E C+-&M(" 2ptional parameter that specifies which base columns has to be considered for the particular EIM process. This parameter impro es the EIM performance. 6ou should include all the user key columns and reHuired columns. Example:+(-/B)"EC+-&M(" 3 "4+'G4E2,.()ME1 "4+'G4E2,.-+C & D),E '+*" 2ptional parameter that specifies whether to update the column the base table with that of in EIM table. 'alid alues are T&/E or FA4%E. *efault alue is T&/E. Example: & D),E '+*" 3 "4+'G4E2,1 F)-"E

alues in

),,)CHME(, DI'EC,+'/ 2ptional parameter that specifies the directory path containing the attachments to be imported. This directory path should e.ist on one of the %iebel ser er machine. In case of remote machine, map the path to a dri e and specify the dri e name to this parameter.

*efault alue is $%IEBE45"2ME()I+#/T Example: ),,)CHME(, DI'EC,+'/ 3 2: 1here 8, is mapped to ))-&M*E'<=)siebsr r)I+#/T DEF)&-, C+-&M( 2ptional parameter that lets you to specify a alue for the EIM table column. This parameter applies only to Import process. This alue will be only used if the EIM table column is null. Example: DEF)&-, C+-&M( 3 )CC(,4B&1 >H )mericas? FI2ED C+-&M( 2ptional parameter that lets you to specify a alue for the EIM table column. This parameter applies only to Import process. This alue will be used o erriding the alue in the EIM table column if any. Example: FI2ED C+-&M( 3 )CC(,4B&1 >H )mericas? I("E', '+*" 2ptional parameter that specifies whether to insert records into the particular base table or not. 'alid alues are T&/E or FA4%E. *efault alue is T&/E. Example: I("E', '+*" 3 "4+'G4E2,1 F)-"E I("E', '+*" 3 EIM4)CC+&(,1 F)-"E If the specified table is an EIM table, the alue applies to all the base tables that were mapped to this EIM table. MI"C ": This parameter is used to specify the type of primary need to be set while updating the primary child. Types of primaries are e.plicit primary and implicit primary. If set as e.plicit primary, EIM will consider the record where the primary child column in the EIM table is set. E.ample, MI%- %F4 0 E8#&5%5#2%T+5#&5EM#5I* If set as implicit primary, the first child record of the parent as specified in the EIM table will be considered as child record. Example: MI"C ":- 3 IM '4"4 +",(4 '4EM 4ID In cases, we might tell EIM to use e.plicit primary whene er specified and implicit primary if not. This can be set as shown below. MI%-%F4 0 E8#&5%5#2%T+5#&5EM#5I*, IM#&5%5#2%T+5#&5EM#5I*

(E, CH)(GE 2ptional parameter that specifies how to handle the non user key null columns in the EIM table. 'alid alues are T&/E or FA4%E. *efault alue is T&/E.

If set to T&/E, the null alues in the non user key null columns will be ignored. If set to FA4%E, the null alues in the non user key null columns will be applied to the base tables also. Example: (E, CH)(GE 3 F)-"E This parameter applies only to Import process. ,'IM " )CE" 2ptional parameter that specifies whether to remo e the trailing spaces from the column alues before importing. This parameter applies only to Import process. 'alid alues are T&/E or FA4%E. *efault alue is T&/E. Example: ,'IM " )CE" 3 F)-"E

A. Export

rocess

arameters :

This section describes the parameters that are specific to EIM e.port processes. The parameters defined in this section ha e a scope limited to this process only. ),,)CHME(, DI'EC,+'/ 2ptional parameter that specifies the directory path to where the attachments ha e to be e.ported. This directory path should e.ist on one of the %iebel ser er machine. In case of remote machine, map the path to a dri e and specify the dri e name to this parameter. *efault alue is $%IEBE45"2ME()2/T#/T Example: ),,)CHME(, DI'EC,+'/ 3 2: 1here 8, is mapped to ))-&M*E'<=)siebsr r)2/T#/T C-E)' I(,E'F)CE ,)B-E 2ptional parameter that specifies whether to remo e the old records from the EIM table whose batch number corresponds to, as defined in the IFB file. 'alid alues are T&/E or FA4%E. *efault alue is T&/E. Example: C-E)' I(,E'F)CE ,)B-E 3 F)-"E If this parameter is set to false, and some rows already e.ist in the EIM table for the specified batch, EIM will throw a warning. E2 +', )-- '+*" This parameter specifies whether to e.port all rows from the %iebel base tables that were mapped to the particular EIM table specified in the IFB file. 'alid alues are T&/E or FA4%E. *efault alue is FA4%E. Example: E2 +', )-- '+*" 3 F)-"E 1hen you do an e.port on party EIM tables, set this parameter to FA4%E. If not EIM will e.port all party records. E2 +', M),CHE" This parameter optionally specifies criteria that need to be satisfied before e.porting the data from the base tables. Example: E2 +', M),CHE" 3 "4+'G4E2,1 ;()ME -I9E >H B?@

The literal specified, is the condition that occurs after the 1"E&E clause in an %F4 statement.

C. Delete

rocess

arameters:

This section describes the parameters that are specific to EIM *elete process only. C)"C)DE DE-E,E +(-/ 2ptional parameter that tells whether to delete the child records when a parent record is deleted. 'alid alues are ,'&E or F)-"E. *efault alue is FA4%E. If set to FA4%E, EIM deletes the parent record and sets the foreign key column in the child records to +/44. Example: C)"C)DE DE-E,E +(-/ 3 ,'&E C-E)' I(,E'F)CE ,)B-E 2ptional parameter that specifies whether the e.isting rows for the particular batch number should be deleted. 'alid alues are ,'&E or F)-"E. *efault alue depends upon the type of delete being done. For *E4ETE E8A-T, default alue is FA4%E, for others, it is T&/E. Example: C-E)' I(,E'F)CE ,)B-E 3 F)-"E DE-E,E )-- '+*" 2ptional parameter that specifies whether to delete all the rows from the base table. 'alid alues are ,'&E or F)-"E. *efault alue is FA4%E. -are should be taken while setting this parameter to T&/E in case of party EIM tables. In case of party EIM tables, always use *E4ETE MAT-"E% when deleting records of particular party type. Example: DE-E,E )-- '+*" 3 ,'&E DE-E,E E2)C, This parameter tells the EIM to use user key matching algorithm with rows in the EIM table to perform deletion. 'alid alues are ,'&E or F)-"E. *efault alue is FA4%E. Example: DE-E,E E2)C, 3 ,'&E Always use this parameter to delete records from the non target base tables.

DE-E,E "9I 'IM)'/ This parameter tells whether to do a cascade update on the primary child column in the parent table.

If the primary address record is deleted, then the primary address column in the parent table is set to +/44, when this parameter is set to T&/E. If set to FA4%E, (+4M),CH4'+*4ID gets stored in the primary child column of the parent table. 'alid alues are T&/E or FA4%E. *efault alue is T&/E. E.ample, *E4ETE %7I# #&IMA&6 0 FA4%E DE-E,E M),CHE" 2ptional parameter that specifies a conditional e.pression to select the records which has to be considered for deletion. E.ample, *E4ETE MAT-"E% 0 %52&95E8T, D+AME 4I7E K"#MJE The literal specified inside the parentheses is the condition that occurs after the 1"E&E clause in any %F4 statement. This parameter can be used only to delete records from the target base table. DE-E,E '+*" This parameter specifies whether rows from the particular table should be deleted. E.ample, *E4ETE &21% 0 %5A**&52&9, FA4%E This e.ample restricts the deletion of records from the %5A**&52&9 table. -are should be taken while setting FA4%E alue, because it might result in dangling foreign key references. & D),E '+*" This parameter specifies whether foreign references should be updated. 'alid alues are T&/E or FA4%E. *efault alue is T&/E. E.ample, /#*ATE &21% 0 %5-2+TA-T, FA4%E This abo e e.ample restricts any update including the updating of foreign key references in the %5-2+TA-T table while performing the EIM *elete. -are should be taken while setting FA4%E alue, because it might result in dangling foreign key references.

D. Merge

rocess

arameters:

This section describes the parameters that are specific to EIM Merge process only. "E, B)"ED -+GGI(G This parameter specifies whether to enable the set based logging. 1hen enabled, a separate log entry will be generated for all the rows in each table that were processed by EIM. This allows greater performance. 1hen disabled, each and e ery row processed by EIM will ha e an entry in the transaction table. 'alid alues are T&/E or FA4%E. *efault alue is T&/E. E.ample, %ET BA%E* 4299I+9 0 T&/E & D),E '+*"

This parameter specifies whether foreign references in the named table should be updated. 'alid alues are T&/E or FA4%E. *efault alue is T&/E. E.ample, /#*ATE &21% 0 %5-2+TA-T, FA4%E This abo e e.ample restricts any update including the updating of foreign key references in the %5-2+TA-T table while performing the EIM Merge. -are should be taken while setting FA4%E alue, because it might result in dangling foreign key references.

E. Extended

arameters:

Apart from the parameters defined at the component le el and IFB file, it is also possible to define dynamic parameters at task le el. These parameters are called as e.tended parameters. E.tended parameters are of two types namely, /ser;*efined E.tended #arameters #redefined E.tended #arameters arameters:

E.1 &serFDefined Extended

/ser can define dynamic parameters and alues either through the 9/I or command line interface. -ommon uses of this type of parameters include setting EIM batch number dynamically, setting alues to the ariables defined in the %F4 Huery used in the IFB file. To define the parameters through 9/I, follow the steps, -lick on site map, select %er er Administration. %elect Enterprise 2perations -omponent &eHuests iew tab. -reate new record and select KEnterprise Integration ManagerJ in the component reHuest form. In the -omponent &eHuest #arameter list applet, create new record and click on the select button in name field. %elect E.tended #arameters in the Lob #arameters window and click 27, which will return to the -omponent &eHuest #arameter list applet. In alue field, type parameter and alue in the following format, name1=value1,name2=value2name_n=value_n E.ample, FI&%T5+AME0"ary

To define the parameters through command line interface, follow the steps, In the command line, use the keyword E.tended#arams to define the name=value format. E.ample,E.tended#arams0)IBatch+um>0=<<<<>,Batch+um=0=<<<<=;=<<<<B)I

E..

redefined Extended

arameters:

%ome e.tended parameters are predefined in %iebel applications which follows the same name=value format. Below is a list of predefined e.tended parameters, -/&&E+T5/%E& ! 4ogon name of the current user. #A%%12&* ! #assword of current user. -/&&E+T5*ATETIME ! -urrent date N time information. &22T5*I& ! "ome directory of %iebel ser er. %IEBE45FI4E5*I& ! %iebel File %ystem directory. 4A+9/A9E ! 4anguage of %iebel ser er installation. TAB4E521+E& ! +ame of the table owner. 2*B-5*ATA5%2/&-E ! -onnect string for the 2*B- data source. MA85+E%T5%/B%T ! Ma.imum le el of nesting in parameter substitution. +/M5IFTAB4E542A*5-/T2FF IfbFile+ame TraceFlags

The parameter +/M5IFTAB4E542A*5-/T2FF is used to tell EIM whether to load all the schema mappings. The feature is disabled by default in which the alue is set to ;>. 1hen enabled, EIM loads all schema mappings. To enable this parameter, set the alue to a positi e number that is one less than the number of EIM tables used in the process. If the parameter alue is set to the number eHual to the number of EIM tables used in the process, it effecti ely disables this feature. E.ample, E.tended#arams0)J+/M5IFTAB4E542A*5-/T2FF0;>J