This section describes the process of installing Content Integrator, including information on system requirements and configuration issues. The following chapter explains how to test your installation by running a sample application.
The remaining sections describe additional configuration options, how to get acquainted with Content Integrator by exploring sample applications, and how to migrate an existing Content Integrator installation from one computer to another.
Type of Installation
Procedures for installing Content Integrator may vary, depending on whether you are installing Content Integrator for the first time, upgrading a previous version of Content Integrator, re-installing the current version of Content Integrator on the same computer, or moving an existing Content Integrator system to a different computer. Special instructions for each scenario are listed below.
- First-time installation
- If this is a first-time installation of Content Integrator, follow the procedures described in the section "Installation Process".
- Upgrading from a prior version of Content Integrator
- If you are upgrading from a prior version of Content Integrator, follow the same installation procedures as for a first-time installation. Before you
- begin the upgrade process, you may wish to make a backup copy of your System Catalog, Log, and the Examples folder containing Content Integrator sample applications. You do not need to un-install the previous version of Content Integrator prior to the upgrade. The install wizard will recognize and keep your previous Content Integrator license key. It will also ask if you want to overwrite or save your previous Content Integrator System Catalog and Examples. (See also the Warning below regarding Windows Add/Remove programs.)WARNING: If you use the Windows Add/Remove Programs function to un-install your old version of Content Integrator before you upgrade, be sure to save a backup copy of your previous System Catalog, Log, Examples folder, and any other critical files before you un-install Content Integrator. If you un-install Content Integrator first, the install wizard will overwrite any previous System Catalog and Examples files as part of the upgrade process - without asking if you wish to save them first.
- Re-installing Content Integrator on the same computer
- If it becomes necessary to re-install Content Integrator on the same computer, follow the same instructions as for an upgrade.
- Moving ("migrating") Content Integrator to a different computer
- If you are moving (or "migrating") an existing Content Integrator Server to a different computer, whether or not you are upgrading to a new version of Content Integrator, please read the instructions in "Migrating an Content Integrator Server to a New Computer" before you install or un-install
- Content Integrator on either machine.
The installation process involves these steps:
1. Determine which connectors you'll need to install.
2. Confirm that your system meets the system requirements for the Content Integrator features you want to use.
3. Plan the installation.
4. Run the installation program.
5. Grant "Log On As Service" right, if not already granted.
6. Start the Content Integrator components and test the Content Integrator Server.
The remainder of this section describes Steps 1 - 5 in detail. Section 2, "Testing the Installation", describes Step 6.
After you have tested the basic installation, you may modify the configuration, if needed, as follows:
- To sel
ect a different database for the system catalog or log file, refer to Section 3, "Configuring the System Catalog and Log Files".
- To install additional copies of the Content Integrator Composer, Server, or Server Manager, refer to Section 4, "Installing Additional Copies of
- Content Integrator Components".
- To configure your system for Content Integrator real-time applications, refer to Section 5, "Configuring and Distributing Real-Time Components".
Once you have configured and tested your installation, you can familiarize yourself with Content Integrator features by reading the Content Integrator Developer's Guide and examining the sample applications that ship with the product. For more information, refer to Section 6, "Getting Started: Content Integrator Sample Applications".
Lotus Quickr Content Integrator Connectors
Lotus Quickr Content Integrator is based on a connector architecture. For any given data source, you will need to purchase the necessary software connector. For example, to connect to an Oracle database, you will need an Oracle connector; to connect
to SAP R/3, you will need an SAP R/3 connector. The only exception to the data source/connector parity is ODBC. The generic ODBC connector can connect with any ODBC data source. The maximum number of ODBC connectors you will need is two (one for the Source and one for the Target) if you wish to exchange information between two ODBC data sources.
The list of Lotus Quickr Content Integrator connectors (at publication time) is as follows:
• IBM Lotus Notes/Domino
• Microsoft SharePoint (supports WSS 2003/2007, SPS 2003, and MOSS)
• IBM Lotus Quickr services for Lotus Domino
• Microsoft Exchange
• IBM Lotus QuickPlace
• IBM Lotus Domino.Doc
During the installation, you will have the option to select the connectors you wish to install.
The Lotus Quickr Content Integrator Composer and the Lotus Quickr Content Integrator Server Manager require the following minimum hardware:
• Processor: 1.3 GHz
• Memory: 1 GB RAM
• Disk space: 350 MB (recommended: 500 MB or above)
The Lotus Quickr Content Integrator Server requires the following minimum hardware:
• Processor: 1.3 GHz (recommended: 1.6 GHz or above)
• Memory: 1 GB RAM (recommended: 2 GB or above)
• Disk space: 500 MB (recommended: 1 GB or above)
Additional disk storage space may be needed, depending on the type of data and Content Integrator applications you will be working with.
The Lotus Quickr Content Integrator Composer, Server, and Server Manager all run on Microsoft Windows operating system software. You will need some or all of the following software installed on the computer where you install the Content Integrator components:
- Microsoft Windows 2000, Windows XP, Windows 2003 Server with Service Pack 1 (or above), or Windows Vista operating system.
- Client software with connectivity to your data sources is required for most data sources drivers used in connection with ecKnowledge. For details,
- see "Client Software" on page 1-9.
- You will need ODBC drivers for your data sources if you wish to use the ODBC connector.
- The Content Integrator ODBC connector ships with many ODBC drivers. To determine if the driver for your data source is provided, check the "ODBC Driver Setup Help" file, located in the ecKnowledge Program group. For information on vendors for other drivers, consult the "ODBC Drivers - Additional Info" Help file, also in the ecKnowledge Program group.
- The Windows Messaging subsystem component (MAPI), Lotus Notes/Domino, or SMTP server must be av
a ilable to handle email notifications.Note: If you are using Microsoft Exchange or Outlook, the Windows Messaging subsystem will be available automatically.
- Additional software and connectivity may be required, depending on the ecKnowledge connectors you will be using. For details, see "Additional Software and Connectivity Requirements".
Additional Software and Connectivity Requirements
These Content Integrator connectors and special features have additional software and connectivity requirements:
• "IBM Lotus Notes/Domino Connector"
• "IBM Lotus QuickPlace Connector"
• "IBM Lotus Domino.Doc Connector"
• "IBM Lotus Quickr Connector"
• "Microsoft SharePoint Connector"
• "Microsoft Exchange Connector"
The sections that follow give detailed requirements for each item listed.
IBM Lotus Notes/Domino Connector
To work with the Content Integrator Lotus Notes/Domino connector, before you install Content Integrator on a given computer:
• IBM Lotus Notes/Domino version R5 (or above) must already be installed on the same computer.
• The Lotus Notes/Domino executable directory must appear in the Windows System PATH environment variable.
• The Lotus Notes User ID that Content Integrator will use to work with Lotus Notes/Domino databases must have Designer access privileges.
IBM Lotus Domino.Doc Connector Note:
The terms "Domino.Doc" and "Domino Document Manager" refer to different releases of the same IBM Lotus product. Unless specifically noted otherwise, these terms are used interchangeably within this manual.
To work with the Content Integrator Lotus Domino.Doc connector, before you install Content Integrator on a given computer:
- IBM Lotus Notes/Domino version R5 (or above) must already be installed on the same computer.
- The Lotus Notes/Domino executable directory must appear in the Windows System PATH environment variable.
- Lotus Domino.Doc 3.1 (or above) must be installed and running on a Lotus Domino server in your environment.
- The Lotus Notes client on your system must be configured to interact with the Domino server that is running Domino.Doc.
- The Lotus Notes User ID that Content Integrator will use to work with Domino.Doc libraries must have Designer access privileges.
- Lotus Domino.Doc Desktop Enabler must be installed and configured on the Domino server that is running Domino.Doc. The same Desktop Enabler software must be installed and configured on the computer(s) where Content Integrator components will be running. The version of Desktop Enabler software should match the version of the Domino.Doc server.
Microsoft SharePoint Connector
The Content Integrator SharePoint connector can work with Microsoft Windows SharePoint Services (WSS 2003/2007), SharePoint Portal Server (SPS 2003), and Microsoft Office SharePoint Server (MOSS 2007).
Unless explicitly stated otherwise, the terms SharePoint, Windows SharePoint Services, SharePoint Portal Services, and Microsoft Office SharePoint Services are used interchangeably to refer to various versions of Microsoft SharePoint products and technologies.
To work with the Content Integrator SharePoint connector, you need to update certain SharePoint read-only system fields, which involves installing an additional Content Integrator plug-in (a custom Web service) on the SharePoint host computer (or all front-end computers where SharePoint is running). Usually, the plug-in is installed on a separate computer from Content Integrator after you complete the basic installation procedures to install the Content Integrator Composer, the Content Integrator Server, and the Content Integrator Server Manager. For details, see "In
st alling Content Integrator Plug-In for SharePoint Server".
Microsoft Exchange Connector
- To work with the Content Integrator Exchange/Outlook connector, before you install Content Integrator on a given computer:
- Microsoft Outlook 2000 (or above) must be installed and configured on the same computer as ecKnowledge, and Outlook must be running in conjunction with Microsoft Exchange 5.5 (or above) server.
- Note: You must use Outlook, not Outlook Express, for this purpose.
- If you will be working with Exchange server folders, then Outlook must be configured to connect to the Exchange server.
Planning the Installation
Determining Where To Install Lotus Quickr Content Integrator Components
In planning the installation, you need to determine where you want to install the Composer, the Server, and the Server Manager. You can install them all on the same machine, but you do not need to do so. Content Integrator stores all object information, such as information exchange job definitions, in system catalogs. As long as the Composer and the Server point to the same system catalog, they can share information about Content Integrator objects across the network. See "System Catalog" on page 3-2 for more information about the system catalog. The main considerations in deciding where to install the Content Integrator components are performance and load balancing. For instance, you might want to install the Content Integrator Server on a separate machine from another server (such as a Lotus Domino server, Microsoft Exchange server, or other database server) so that the two servers are not competing for resources.
You can also install multiple copies of ecKnowledge components for reasons of scalability and performance. For instance, you might want to run several ecKnowledge Servers in a production environment to increase information exchange speed if you will be executing numerous jobs simultaneously. You can add additional Servers at any time. A single Server Manager can manage all the ecKnowledge Servers on a network. In addition, you can install several copies of the ecKnowledge Composer. The Composer is the ecKnowledge development environment. If you have several developers creating ecKnowledge objects, it would be useful to put a copy of the Composer on each of their workstations.
The ecKnowledge installation program gives you the option of installing as few or as many of the components on a computer as you would like. To install the components on several computers, you run the installation once for each machine, each time specifying the component(s) that you want to install on that machine.
Although it's possible to run multiple Composers on the same computer, only one Content Integrator Server may reside on a given computer. This is because the Server name must be the same as the computer name.
See "Installing Additional Copies of Content Integrator Components". for complete details on installing Content Integrator components individually. For your first installation of Content Integrator, it is recommended that you install all the components on a single computer.
It is recommended that you not install ecKnowledge on the same machine as a Microsoft Exchange server, due to the resourceintensive nature of the Exchange server. Content Integrator Server performance will degrade significantly if the Content Integrator Server is sharing resources with an Exchange server.
Checking for Required Hardware and Software
Confirm that the computers you are planning to use for Content Integrator satisfy the hardware requirements as described in "Hardware Requirements". On each machine where you will be installing Content Integrator components, determine that al
l n ecessary third-party software has been installed, as described in "Software Requirements" . Be sure to note the additional software and pre-installation requirements that apply to certain Content Integrator connectors or functionality, as described in "Additional Software and Connectivity Requirements" .
Running the IBM Lotus Quickr Content Integrator Installation Program
Launching the Installation Program
As with any software installation, it is recommended that you exit and close all other software (including any anti-virus software) before running the Content Integrator installation program. If you are installing Content Integrator from a CD, insert the CD on your machine and run:LQCI_Install.exe
The installation wizard will guide you through a series of decisions.
Welcome and License Agreement
The first screen the install wizard displays is the Welcome screen, followed by the License Agreement screen. Read the License Agreement, and click Yes
to agree and continue.
The next screen, Product Registration, will look something like this:
Enter your user name and company information on the Product Registration screen. When you have finished entering the information on this screen, click on Next to display the next screen. Verify the product registration information you entered then click Yes
Selecting a Destination Folder
The wizard will ask you to select the path and directory where Content Integrator should be installed:
Click on Next to accept the default. Otherwise, click on Browse to find and select the directory of your choice.
Selecting the Program Folder Name
Next, the install wizard displays the Select Program Folder screen. This screen, and the ones that follow, are displayed for both Typical and Custom installations.
On this screen, Content Integrator displays the default Program folder name and path and allows you to keep or change it.
Specifying the Windows Login Account
Next, the install wizard will display the Service Logon Information screen. On this screen, you specify the account that the Content Integrator Server will use to log into your system:
When working with Microsoft Exchange/Outlook, SharePoint, and other applications which use Microsoft Windows integrated authentication, it is very important that you specify the correct logon information during Content Integrator installation. This will ensure that the Content Integrator Windows service is configured to use the login account for which Windows integrated authentication is properly set up.
To specify the account as a Windows service, you must log on as an administrator or as a user with administrative privileges. Complete the Service Login Information screen as described below. A manual override will be needed to change any information on this screen at a later time.
If Windows validates your login at a domain controller, enter that domain name in the Domain Name field. If you are not sure, or if you log in to a local account, leave the Domain Name field blank.
Log On As
If you are accessing data from a Microsoft Exchange server or using MAPI to deliver mail, complete the "Log On As" field by entering the account that has "inbox profile" access to your Exchange folders. A common mistake is to specify an account that has not been configured to access your account's folders. Therefore, it is recommended that
you specify the account that you use with Microsoft Exchange or Outlook. The account you specify here can be changed later through "Services" in the Control Panel (see "Granting 'Log On As Service' Right"). If you are not using Microsoft Exchange, you may enter any user ID with administrator rights.
Enter the password associated with the user specified in the "Log On As" field.
Checking Setup Information
Before installing the Content Integrator files, the install wizard will ask you to verify the settings you have chosen:
After you verify the settings, the install wizard will begin installing the Content Integrator files.
Selecting System Catalog Install Options
If you are upgrading from a previous version of Content Integrator, you will have a number of pre-existing example files. The install wizard will ask you if you wish to back up your old example files before it overwrites them:
It is recommended that you click on Yes
to back up your existing example files.
Content Integrator installs empty system catalog and log databases in three formats: Access, Lotus Notes, and Microsoft Exchange. It also installs a Microsoft Access system catalog and log containing example ecKnowledge applications. See "File Locations" for the specific names and locations of the empty template files and the system catalog files.Note:
It is recommended that you save the set of empty system catalogs to another directory immediately following the install, so that they may be used later as system catalog templates, if needed. You may also want to save a copy of the new Examples system catalog. For more information, see "File Locations".
After all the Content Integrator files have been installed, the install wizard will prompt you to select which system catalog you would like Content Integrator to point to initially:
• an empty ("BLANK") system catalog, in Microsoft Access format
• the examples ("SAMPLES") system catalog, in Microsoft Access format
• the current ("existing") system catalog
The option to continue the "existing" configuration is shown only if you are upgrading from a previous version of ecKnowledge or reinstalling your current version, as shown in the following screenshot.
The "SAMPLES" option is selected by default, as shown in the following screenshot:
If you are new to Content Integrator, it is recommended that you select the examples ("SAMPLES") system catalog, as shown above. That way, you can use the sample applications in it as a learning tool. (For more information, see "Getting Started: ecKnowledge Sample Applications".) Content Integrator uses Microsoft Access as the default database type for the empty and examples system catalog and log. If you wish, you can change the type of database used for this after the installation is completed. (For details, see "Configuring the System Catalog and Log Files".)
At this point, the install wizard will ask whether you want to view the README file now, or whether you will read it later. Note:
If you choose to view the Readme file now, you must close the file before the wizard will continue with the installation process.
The basic installation procedure is now complete. You will need to reboot your computer in order for it to take effect. The install wizard will give you a choice of whether to reboot now or at a later time.
Completing the Installation
At this point, the install wizard will ins tall the remaining Content Integrat
or files, and you will see a number of informational status messages as the install wizard performs its tasks.
Depending on the options you have selected, you may get a warning message similar to the following that the Microsoft .NET Framework cannot be found:
This message appears if you do not have the Microsoft .NET Framework installed on your computer and you selected the SharePoint connector (which is selected by default) when installing Content Integrator. You can disregard this message if you are not interested in either of this connector. Otherwise, you will need to install the Microsoft .NET Framework and then re-install Content Integrator. For more information, refer to the sections on "System Requirements" in the Lotus Quickr Content Integrator Developer's Guide sections related to these connectors.
Either way, you must click on OK
to close the warning message before the wizard will continue with the installation process.
Installing interim fixes
Go to Fix Central to download fixes.
Additional Component Required for SharePoint Connector
After you complete the basic installation procedure, if you will be using the SharePoint connector, you will need to install an additional Content Integrator component. The Content Integrator Plug-in for Microsoft SharePoint Server is a custom Web service used exclusively by Content Integrator. For more information, see "Installing Content Integrator Plug-In for SharePoint Server".
The Content Integrator installation program places files in the following locations.
Content Integrator Files
All Content Integrator program files, including the empty template system catalog and log files, are placed in the top-level ecKnowledge directory. Unless you specified a different directory during installation, the Content Integrator top-level directory will be:
Content Integrator installs empty system catalog and log databases in three formats (Access, Lotus Notes, Microsoft Exchange), with these file names:
|RASSysCat.mdb ||Microsoft Access ||system catalog |
|RASLog.mdb ||Microsoft Access ||log |
It is recommended that you save the set of empty system catalogs to another directory immediately following the install, so that they may be used later as system catalog templates, if needed.
The system catalog, log, and data files associated with the Content Integrator example applications — that is, Microsoft Access, Microsoft Exchange, Lotus Notes/Domino, and other files — are placed in the \EXAMPLES subdirectory
within the Content Integrator directory.
If you installed the Microsoft Exchange connector, the Content Integrator installation program adds a Content Integrator examples message store to the existing information services for the default inbox profile. If you installed the Lotus Notes/Domin
o connector, the Content Integrator installation program will add Lotus Notes/Domino real-time related files to the Lotus Notes program directory.
All ODBC program files, ODBC drivers and driver managers, and Help files are located in the Windows System32 directory.
Granting 'Log On As Service' Right
The Content Integrator Server runs as a service. The account the Content Integrator Server uses to log on to Windows must have the "Log On As Service" right. This right can be granted from within the User Manager utility or from the Windows Control Panel, as follows:
1. Log on as an administrator or as a user with administrative privileges.
2. Go to the Control Panel and select Administrative Tools | Services
The system will display the Services screen:
3. Right-click on "Content Integrator Engine", select Properties
to display the Properties window, and then select the Log On
tab within the Properties window.
4. The field "This Account" will list the account that was specified during the Server's installation. Enter the password for the account, and then reenter it on the next line. Then click on OK to apply the change and exit the Properties window.
If you do not re-enter the password, the "Log On As Service" right will not be granted, and Content Integrator will not run.
If the account is granted the "Log On As Service" right, a dialog box will appear confirming so.
Installing Content Integrator Plug-In for SharePoint Server
Overview of the ecKnowledge Plug-In for SharePoint Server Note:
Unless explicitly stated otherwise, the terms SharePoint, Windows SharePoint Services (WSS), SharePoint Portal Services (SPS), and Microsoft Office SharePoint Server (MOSS) are used interchangeably to refer to the various versions of Microsoft SharePoint products and technologies.
The Content Integrator SharePoint connector can work with Microsoft Windows SharePoint Services (WSS 2003/2007), SharePoint Portal Server (SPS 2003), and Microsoft Office SharePoint Server (MOSS 2007).
The Content Integrator Plug-in for SharePoint Server is a custom SharePoint Web service used exclusively by Content Integrator. The plug-in extends the functionality of the Content Integrator SharePoint connector and is required for certain operations, such as updating certain SharePoint 2003 system fields, working with SharePoint 2007 discussion boards and document libraries, or setting item level security.
Using a "Custom" installation procedure to install the ecKnowledge Plug-in for SharePoint Server is recommended. For details, see "Recommended Procedure for Installing ecKnowledge Plug-In for SharePoint Server". If extenuating circumstances prevent you from using the recommended procedure to install the plug-in, it can also be installed manually by an Content Integrator administrator or user.
Recommended Procedure for Installing Content Integrator Plug-In for SharePoint Server
Typically, you install the Content Integrator Plug-in for SharePoint Server on the computer where SharePoint is running. The following instructions assume that the SharePoint host computer is a separate machine from the ecKnowledge Server and thus requires only the SharePoint plug-in portion of ecKnowledge to be installed.
To install the Content Integrator Plug-in for SharePoint Server:
1. Launch the Content Integrator installation program on the SharePoint host machine, and select the Custom installation option. Select "Programs" in the list of Custom installation options. De-select all the other inst
2. With "Programs" highlighted to select it, click on the Change
button to display a list of program choices.
3. Select (check) the box for "Content Integrator Plug-in for SharePoint Server".
4. De-select all other program installation options.
5. Click on OK
to close the list of programs, then click Continue
to display the next screen.
6. Follow the procedures documented earlier in this chapter to step through the remaining installation wizard screens (starting with the "Connectors Screen" ).
Content Integrator Plug-In Component Files Installed
Content Integrator installs a different set of files, depending on whether you are running SharePoint 2003 or SharePoint 2007.
Plug-In Components for SharePoint 2003
The Content Integrator plug-in installs the following files for SharePoint 2003 implementations:
The first three files will be installed into the same directory that stores IIS web server extension files. Typically, for SharePoint 2003 implementations, this is:\Common Files\Microsoft Shared\web server extensions\60\ISAPI
where: designates the path and directory name of the Program Files directory on the SharePoint host machine, for example:C:\Program Files\Common Files\Microsoft Shared\web server extensions\60\ISAPI
The fourth file will be installed into the BIN directory located under the ISAPI directory that contains the first three files (i.e., ... \ISAPI\BIN).
In addition, ecKnowledge will append several lines of code to the file named "spdisco.aspx" file (also located in the ISAPI directory) to register the newly installed components.
Plug-In Components for SharePoint 2007
The Content Integrator plug-in installs the following files for SharePoint 2007 implementations:
The first three files will be installed into the same directory that stores IIS web server extension files. Typically, for SharePoint 2007 implementations, this is: \Common Files\Microsoft Shared\web server extensions\12\ISAPI
where: designates the path and directory name of the Program Files directory on the SharePoint host machine, for example:C:\Program Files\Common Files\Microsoft Shared\web server extensions\12\ISAPI
The fourth file will be installed into the directory associated with the SharePoint site. For example, if the SharePoint site is configured to use port 80, then (in most cases) the associated directory will be:C:\Inetpub\wwwroot\wss\VirtualDirectories\80_app_bin
Once you have installed and configured Lotus Quickr Content Integrator, you must test the installation. The next section explains how to test the installation by running a sample application.
Back to the Lotus Quickr Content Integrator Installation and Configuration Guide