Skip to main content

Configuration File for EIM (CFG File)

 Configuring EIM with the EIM Configuration File:

To effectively utilize the EIM (Enterprise Integration Manager) for your data processing needs, you'll rely on the EIM Configuration File. This file serves as a critical blueprint, guiding EIM in executing various tasks such as importing, updating, merging, deleting, or exporting data while adhering to specific parameters.

This EIM configuration file is a plain text file identified by the IFB extension and typically resides in the Siebel Server/admin directory. Before you set the EIM process in motion, it's imperative to tailor the ifb file according to the specific requirements of your data load or manipulation task.

EIM possesses the capability to accept parameter values from three distinct sources:

Command Line: Users can provide parameters directly via the command line when invoking the EIM process.

GUI Interface: The Siebel Server Manager GUI offers a graphical means of inputting parameters.

Configuration File: Alternatively, parameters can be defined within the configuration file. If no specific file is designated, EIM defaults to default.ifb.

When EIM looks for parameter values, it adheres to a defined hierarchy: command line parameters take precedence over component parameters, and component parameters, in turn, override configuration file parameters.

To configure the EIM Configuration File effectively, consider its two primary sections:

Header Section: This section houses global parameters that apply universally to all process sections.

Process Section: At a minimum, one process section is required, and it defines the precise EIM operation to be executed. Whether it's data import, update, merge, delete, or export, this section holds the key to specifying your EIM process.

Header Section Parameters and Their Explanations:

1. LOG TRANSACTIONS TO FILE: This parameter is set to True by default. It determines whether EIM records transactions in a file or a table. When set to True, EIM logs transactions into files typically stored in the file system's EIM directory. If you wish to log transactions to a database table instead of files, set this parameter to FALSE.

2. USERNAME: Similar to the PASSWORD parameter, this represents the database or employee logon name. Typically, it is inherited by the EIM component from the Gateway Name Server, so it should already be configured. However, suppose you are running EIM from the Siebel application (not via the command line) and haven't previously set this value in the EIM Server Component parameters. In that case, you can specify it in the.IFB file.

3. PROCESS: This parameter serves to identify the specific EIM process to execute during the current invocation of EIM. The named process must be defined in the process section of the .IFB file.

4. [Siebel Interface Manager]: This is a reserved name that must be used for the header section when defining EIM parameters.

5. TABLEOWNER: This parameter designates the database logon name that owns the tables upon which EIM operations will be performed. It is typically used as a prefix for table names and is defined during installation, usually as 'SIEBEL'.

6. PASSWORD: This parameter represents the database password. Usually, this value is inherited by the EIM component from the Gateway Name Server, so it should already be configured. However, suppose you are running EIM from the Siebel application (not through the command line) and have not previously set this value in the EIM Server Component parameters. In that case, you can specify it in the .IFB file.

7. CONNECT: This parameter specifies the ODBC source name for establishing a database server connection.

Parameters in the Process Section and What They Do:

1. LOG TRANSACTIONS: This controls how changes are logged. If set to True, it records changes when mobile devices sync. If set to False, it doesn't log changes. True operates like a detailed record, while False is more general.

2. COMMIT EACH TABLE: Similar to the previous one, this determines whether to save changes after working on each table. By default, it's set to save after each table.

3. SKIP BU_ID DEFAULT: This determines if a particular value type should be skipped for the BU_ID column. The default is not to ignore it.

4. USE INDEX HINTS: This is specific to Oracle databases and determines whether certain performance improvements are suggested. By default, it's not used.

5. SESSION SQL: This allows you to send a custom SQL statement to the database before other actions. It's like sending a special message to the database.

6. BATCH: This required setting assigns a batch number to the process. It's like labelling the work being done and helps keep things organized. For example, you can set it as BATCH = 100-110 or BATCH = 100,103,106,110.

7. COMMIT EACH PASS: You can save changes after each process step. By default, it's set to save after each step.

8. TABLE: You need to specify which tables are involved in this process. You can list multiple tables if required.

9. ROLLBACK ON ERROR: You can decide whether the process should undo everything if it encounters an error. By default, it doesn't.

10. USING SYNONYMS: This controls how queries involving synonyms are handled during import. If set to False, it skips specific questions, saving time. By default, it's set to True.

11. TRANSACTION SQL: This lets you send a custom SQL statement to the database after each save or undo action during the process.

12. TYPE: You must specify the type of process you're defining, like import, export, delete, merge, or shell.

13. INCLUDE: You can include other processes within the current one. This is handy when you want several things to happen in a specific order.

14. ONLY BASE TABLES: If you only want to work on the primary tables, you can specify that here.

15. IGNORE BASE TABLES: If you don't want specific tables to be part of the process, specify them here.

16. USE ESSENTIAL INDEX HINTS: This enables a specific type of optimization for certain databases. It's turned on by default.

Critical Considerations for EIM IFB Parameters:

Comment Lines: Lines in the default.ifb files that start with a semicolon (;) are considered comments and disregarded. They are handy for adding notes but don't affect the EIM process.

Multiline Parameters: When defining parameters across multiple lines, ensure that the backslash character () is the last character on a string. This backslash signals that the parameter continues on the following line.

Combining Comments and New Lines: It's best not to mix comments (;) with new lines (/) because this format can make it tricky to locate a statement within the middle of a line. Keep comments separate for clarity.

Parameter Line Continuation: If you see multiple lines with a backslash character () at the end, this signifies they form a single parameter line. Suppose you place a semicolon (comment character) among these lines. In that case, EIM will disregard the line with the semicolon and all the lines linked by the continuation character.

PASSWORD and USERNAME: Generally, PASSWORD and USERNAME values aren't used for access authentication or security purposes. EIM obtains access authentication information from the component parameters typically set elsewhere.

Fallback to .IFB File Values: PASSWORD and USERNAME values in the .IFB file come into play when these parameters haven't been set at the enterprise or component level. They serve as fallbacks in case no other authentication information is available.