You are previewing Implementing IBM Lotus Enterprise Integrator 6.
O'Reilly logo
Implementing IBM Lotus Enterprise Integrator 6

Book Description

This IBM Redbooks publication helps you to implement Lotus Enterprise Integrator (LEI) 6. It is targeted for system administrators who plan to implement or upgrade to LEI 6 in their organization. This book provides tips and techniques to help you successfully deploy and administer LEI 6.

We begin by providing a brief introduction to what’s new with LEI 6 and cover some architectural scenarios of how LEI 6 infrastructure could be implemented in a customer’s environment. We then provide detailed information on how to install and administer LEI 6, as well as how to migrate or upgrade from LEI 3.x to LEI 6. Tools, techniques and utilities for debugging activities are described in depth, for testing connectivity to relational databases and testing connection documents in the LEI Administrator. Working examples are provided to illustrate how to use the Advanced RealTime activities that are new in LEI 6. It also provides examples of some of the batch activities previously available in LEI 3.x such as a scripted activity and a replication activity. Finally, the book concludes with a discussion of the LC LSX, the LotusScript programming interface to the Lotus Connectors which lets you program any functionality you need that isn’t available through the LEI forms.

Please note that the additional material referenced in the text is not available from IBM.

Table of Contents

  1. Notices
    1. Trademarks
  2. Preface
    1. The team that wrote this redbook
    2. Become a published author
    3. Comments welcome
  3. Chapter 1: Introduction to IBM Lotus Enterprise Integrator (LEI) 6 for Domino
    1. A business case for LEI
    2. Which tools come with Domino?
      1. DECS
      2. DCRs
      3. LC LSX
    3. LEI defined
      1. The LEI Administrator
      2. Connection documents
      3. Activity documents
      4. Current limitations with using LEI 6
    4. A comparison of DECS, DCRs, and LEI
      1. Advanced RealTime feature - virtual attachments
      2. Advanced RealTime feature - integrated credentials
    5. What’s new with LEI 6.0 through 6.0.2
      1. What’s new in LEI 6
    6. Terminology
    7. Data type conversions/mappings
  4. Chapter 2: Architectural scenarios and considerations
    1. Architectural scenarios
      1. Scenario 1: Single Domino/LEI server
      2. Scenario 2: Remote database servers
      3. Scenario 3: LEI access to multiple relational back-ends
      4. Scenario 4: LEI 6 Advanced Realtime plus Notes replication
      5. Scenario 5: Decentralized Advanced RealTime access
    2. Security considerations
      1. Generic user ID and password
      2. Integrated credentials
      3. Fields and public key encryption
    3. Performance considerations
      1. LEI considerations
      2. Performance spectrum scenarios
      3. RDB performance considerations
      4. Persistent connections
  5. Chapter 3: Installing and configuring the LEI Administrator
    1. Where to find the install documentation
    2. Pre-installation activities
      1. Domino server document changes
      2. ID modifications
      3. Other preparations
    3. Installation of LEI
      1. Installation Checklist
      2. Process of installation
    4. Administration of LEI
      1. LEI Administrator database
      2. Configuration
      3. Starting and stopping the LEI server
  6. Chapter 4: Migrating from Lotus Enterprise Integrator 3.x
    1. Migration considerations
      1. Migrating scripted documents
      2. Migrating metaconnection documents
      3. LEI clustering and remote administration
    2. Pre-migration activities
    3. Process of migration
    4. Troubleshooting
      1. Migration log file
  7. Chapter 5: Diagnostic tools and techniques
    1. Test Connectivity using database vendor tools
    2. Test connectivity using the DCTEST utility
    3. Test the Connection Document using CONTEST
    4. Activity debugging techniques
  8. Chapter 6: Connection documents
    1. DB2 connection documents
      1. Connectivity section
      2. Table selection section
      3. Other section
    2. Test your connection
    3. Notes connection document
      1. Connectivity section
      2. General Options section
      3. Document Selection section
      4. Field Selection section
      5. Data Transformation section
      6. Data Creation section
      7. Other section
    4. File connection document
      1. Connectivity section
      2. Subdirectory Selection section
      3. Other section
    5. Text connection document
      1. Connectivity section
      2. Text specifications section
      3. Other section
    6. Metaconnectors
      1. Collapse/Expand Metaconnector
      2. Meter MetaConnector
      3. Order MetaConnector
      4. Trace MetaConnector
  9. Chapter 7: Batch activities
    1. Command Activity
    2. Example 1: Setting up a Command Activity
      1. Create a connection document to the RDB
      2. Create the Command Activity
      3. Execute the Command Activity
      4. Create the AGENTEQUIP table
    3. Direct Transfer Activity
    4. Example 2: Using Direct Transfer
      1. Create a connection document to Notes
      2. Create the main Direct Transfer activity
      3. Create a Notes connection document by copying
      4. Copy the RDB Connection
      5. Collapse/Expand Metaconnection
      6. Create the secondary Direct Transfer activity
      7. Establishing a chain of activities
    5. Scripted activity
    6. Example: Creating a scripted activity
    7. Replication activity
      1. Primary key replication
      2. Timestamp replication
    8. Example: Primary key replication, RDB to Domino
      1. Create Notes connection to Agent records with view selection
      2. Create Notes Connection to Agent Equipment with view selection
      3. Create Order metaconnections for Notes connections
      4. Create a Collapse/Expand Metaconnection for the RDB
      5. Create the main Replication activity
      6. Test the main replication activity
      7. Update the relational data
      8. Retest the main Replication activity
      9. Create a secondary Replication activity
      10. Test the Secondary replication activity
    9. Other data moving activities
      1. Archive
      2. Java
      3. Polling
      4. Admin Backup
      5. Admin Purge Log
  10. Chapter 8: Advanced RealTime activities
    1. Virtual fields activity
      1. Usage notes
      2. Setting up the virtual fields activity
      3. Event options for virtual fields activity
      4. Keeping Virtual Field key documents up to date
    2. Virtual Attachments
      1. How file attachments work in Notes
      2. Virtual Attachment “Resync” for Virtual Documents
    3. Example 1: Virtual Fields activity
      1. Populate the data in the relational tables
      2. Create a Connection Document
      3. Create the Activity Document
    4. Example 2: Adjust Virtual Fields to Store Additional Fields
      1. Stop Activity and update Activity document
      2. Update documents to contain the new fields
      3. Considerations in storing copies of fields
    5. Example 3: Virtual Fields activity with multi-value fields
      1. Create a connection document to the AGENTEQUIP table
      2. Create a secondary Virtual Fields Activity
      3. Test the new activity
    6. Virtual documents activity
      1. How does the virtual documents activity work?
      2. Differences between a regular Notes document and a virtual document
      3. External system metadata for virtual documents activities
      4. Virtualizing and revirtualizing
      5. Indexing
      6. Deletion involving virtual documents
      7. Domino replication involving virtual documents
      8. Event options for virtual documents activity
    7. Differences between virtual documents and virtual fields
      1. Advantages of virtual documents activity
      2. Limitations of virtual documents activity
      3. Using virtual fields with virtual documents
    8. Virtual agents
    9. Example 4: Using a virtual documents activity
      1. Create a connection document to your relational database
      2. Create the data tables
      3. Create the Virtual Documents activity
      4. Create a new Virtual Fields activity
      5. Test the new activities
      6. Note IDs of Virtual Documents
  11. Chapter 9: Getting Started with the LC LSX
    1. History of the LC LSX
      1. Migrating LEI LSX code from Previous LEI Versions
    2. The LSX Classes
      1. LCSession Class
      2. LCConnection Class
      3. LCField Class
      4. LCFieldlist Class
      5. LCStream Class
      6. LCDateTime, LCNumeric, LCCurrency Classes
    3. Basic database operations
      1. Connect to a database
      2. Handle LC errors
      3. Select and fetch all the records in a table
      4. Select records that meet certain criteria
      5. Insert a new record
      6. Delete records that meet certain criteria
      7. Update a record using writeback
      8. Update a record using a selection key
      9. Control Commit and Rollback
      10. Call a stored procedure
      11. Using database timestamps
      12. Execute SQL that you create in your program
      13. Work with binary data
    4. Using the Notes Connector
    5. Connection pooling
    6. Performance tips
      1. Performance code samples
    7. Tips and tricks
      1. Using the Trace metaconnector
      2. Map by Name
      3. Sorting data
      4. Updating key fields
      5. Offload database access to server
    8. LEI power programming
      1. LEI Programming 1: Transfer data from profile documents
      2. LC LSX Example 2: Update Virtual Fields in Notes views
      3. LC LSX Example 3: Fix unvirtualized documents
    9. Notes client coding considerations
    10. Other APIs
      1. LS:DO
      2. JDBC
      3. @DbLookup and @DbColumn functions
    11. Additional information about the LC LSX
  12. Appendix A: Removing Lotus Enterprise Integrator (LEI)
    1. Considerations prior to removing LEI
      1. Access to data
      2. LEI clustered environment
      3. Domino Enterprise Connection Services (DECS)
    2. Process of removing LEI
  13. Appendix B: Troubleshooting
    1. Using the LEI log (leilog.nsf)
    2. Using the Domino log (log.nsf)
    3. Enabling log conflicts in replication activities
    4. Logging SQL statements
    5. Using the trace metaconnector
    6. Using Notes Server Diagnostic (NSD)
  14. Appendix C: Additional material
    1. Locating the Web material
    2. Using the Web material
      1. How to use the Web material
    3. Further useful downloads
  15. Glossary
  16. Related publications
    1. IBM Redbooks
    2. Other publications
    3. Online resources
    4. How to get IBM Redbooks
  17. Index
  18. Back cover