| Next Page
This section describes how to install and launch Lotus® Expeditor integrator onto client machines.
There are several installation methods available. Before you install Lotus Expeditor integrator, ensure that each machine on which you are installing meets the client prerequisites.
Before you install Lotus Expeditor integrator, ensure that each system meets the minimum hardware and software requirements.
The Expeditor integrator is installed on the remote server (e.g. in the retail supermarket). It needs physical and logical connectivity to the Backbone Service Bus (AI back-end, Message Broker) for message (data) exchange.
If remote enterprise monitoring by the Tivoli Enterprise Console® (TEC) is required, the Expeditor integrator will also need to be able to fire TEC Events (e.g. under reuse of the existing Tivoli® Endpoint on the remote server).
Many Expeditor integrator configuration settings can be adjusted to the target environment. Refer to Quick Start Configuration for configuration details.
Back-end connectivity should be checked before the integrator's back-end connection is tested.
The following check list can be used:
- Check that the remote server has access through the firewall by using an Internet Browser to access the AI back-end Server (Message Broker). By default, the configurable IBM® Lotus Expeditor micro broker Bridge used by the Expeditor integrator communicates through the following.
- MQ Server Port = 1414
- with MQ user name and password
- Check accessibility of the AI Message Broker(s) with the ping command, and accessibility of the port with the Telnet command.
- ping <msgBroker_address
- telnet <msgBroker_address
- Check that the AI Message Broker system is available and that the current remote location has an appropriate MQ user account (for reading and writing messages).
The default queue set-up is based on a point-to-point architecture. This can be individually adjusted to customer situations. Publish/Subscribe architectures are also supported.
The following figure shows the pre-configured default queues on the micro broker in the Lotus Expeditor integrator and the bridged connections to the back-end. For getting started quickly, this queue setup is recommended on the Messaging Back-end.
It is recommended to setup the Back-end messaging system prior the Expeditor integrator installation and configuration to allow for error free operation.
Figure 1. Default Expeditor integrator queue set-up
The suggested default configuration requires the following queues at the messaging back-end.
- 1 ReqOutQx, 1 ResInQx and 1 CtrlOutQx per location endpoint (remote server) x
- 1 LogQ and 1 EventQ commonly used by all endpoints
The suggested default configuration also requires the (Server)DeadletterQ which will contain all those messages that could not be delivered. An IBM MQSeries-typical SyncQ should also be available (see the table below). This architecture has already proven its feasibility since it is working in production of a large retail company.
Table 2. Back-end message queue default set-up
|Back-end Queue ||Bridged to local Expeditor integrator queue |
|ReqOutQx ||ReqInQ || |
- Queues for data messages sent from the back-end to Expeditor integrator (inbound), e.g. messages carrying files
- It is recommended to have one ReqOutQ per remote Expeditor integrator runtime (x stands for a unique ID of the Expeditor integrator runtime, e.g. the LocationId)
|ResInQx ||ResOutQ || |
- Queues for data messages sent from Expeditor integrator to the back-end (outbound), e.g. messages carrying files
- It is recommended to have one ResInQ per remote Expeditor integrator runtime (x stands for a unique ID of the Expeditor integrator runtime, e.g. the LocationId)
|CtrlQ || |
- Queues for control messages sent from the back-end to Expeditor integrator (inbound), e.g. messages carrying Expeditor integrator configuration updates and control commands
- It is recommended to have one CtlOutQ per remote Expeditor integrator runtime (x stands for a unique ID of the Expeditor integrator runtime, e.g. the LocationId)
|DeadletterQ ||ServerDeadletterQ || |
- Expeditor integrator places all messages with false message headers or values which are not supported into the local ServerDeadletterQ. These messages will be moved to the DeadletterQ at the back-end so that they are not lost.
- Messages with valid headers which can not be processed due to any reason might also be placed into this queue or may even be discarded. This behavior is configurable for the each use-case.
| ||Required system queue for Lotus Expeditor micro broker bridge operation |
|EventQ ||EventQ || |
- Queue for (business) events created by Expeditor integrator. If configured, filtered (business and application) events can be sent in data messages to the back-end through this queue (see configuration of Custom Event Service) e.g. Transaction Status events.
- Potential consumers of these events at the back-end would be flows which require status information about triggered defined use cases (e.g. whether the sent price update has been successfully transferred to the 4690 PoS controller; sometimes referred to as Business Monitoring).
|LogQ ||LogQ || |
- Queue for (technical) events created by Expeditor integrator. If configured, filtered (technical) Expeditor integrator specific log events can be sent in data messages to the back-end through this
queue (see configuration of Custom Log Service). e.g. Application component status events (errors, warnings etc.)
- Consumers for these events at the back-end would be systems management services which monitor the status and health of the Expeditor integrator runtimes.
All these queue settings must be also provided in the XPDinteg.xml file that contains the Expeditor integrator's configuration parameter (refer to Common Configuration Settings for more details about the integrator configuration).
The Expeditor integrator can be enabled to send events using the Tivoli Event Infrastructure Facility (EIF) either directly to the Tivoli Enterprise Console (TEC) or through locally installed Tivoli Endpoints.
To ensure connectivity to Tivoli Monitoring, discuss the following information with the TEC Administrator.
The following TEC event classes are used.
Check that the remote server hosting the integrator runtime has access through the firewall (ping and telnet), and if required that the Tivoli Endpoint is installed and configured on the remote server (e.g. Store Server).
A list of multiple TEC servers can be accessed. Make sure that the following values are available for each used TEC. (These parameters are required for the configuration in the XPDinteg.xml later in this document)
=IP address or IP hostname of the TEC server
=5529 (port of the TEC server; default = 5529)
= ON | OFF (ON to forward events during local Maintenance Mode, otherwise OFF)
=DISABLE | SOCKET | LCF (DISABLE to disable
sending TEC events, SOCKET to enable sending TEC events directly to the TEC, or LCF to enable sending TEC to a local Tivoli endpoint)
=4 (maximum size of the forwarded events in kB)
=true (true to switch on space replacement in events, otherwise false)
ERROR | WARNING | DEBUG | INFO (ERROR to forward only error logging events, WARNING to forward errors and warnings, DEBUG to forward errors, warnings and debugs, and INFO to forward all logging events)
- (specify which Expeditor integrator application events should be forwarded)
- (specify from which events Expeditor integrator application component should be forwarded)
- < status
- (specify INSTALLED to forward installed status of the monitored bundle to the TEC, otherwise STARTED or STOPPED)
If a locally installed Tivoli Endpoint is used on the remote server for sending events to the Tivoli Enterprise Console (TEC), make sure that the following DLLs are available.
These DLLs can be downloaded from the IBM Support Site with the Tivoli Endpoint Fixpack and can be simply copied to the remote server where the Expeditor integrator is located (see Tivoli Endpoint Installation and Configuration Example).
The Windows® PATH variable must also point to these DLLs.
The ports for the Endpoint communication are as follows.
- Endpoint Gateway communication default port: 9494
- Endpoint communication default port: 9495
These ports can be adjusted to the local environment in the <TIVOLI_HOME
\lcf\dat\1\last.cfg (lcfd_port and lcfd_preferred_port; <TIVOLI_HOME
is the installation path of the Tivoli Endpoint, e.g. C:\Program Files\Tivoli).
The configuration of the Expeditor integrator Tivoli Monitoring Service (ITMS) for sending application events to the TEC requires some more configuration steps. The TecLcfUtil utility supports the Administrator during these configuration steps.
Refer to Expeditor integrator Tivoli Monitoring Service Configuration - TECLCF utility for the description of the provided TecLcfUtil utility and to Tivoli Endpoint Installation and Configuration Example for more information about the Tivoli Endpoint installation and configuration.
There are different options for the remote Expeditor integrator runtime being centrally managed.
The three different options for centrally managing the remote Expeditor integrator runtime are as follows.
- Management through IBM Lotus Expeditor Server. The Expeditor Server offers remote management of the IBM Lotus Expeditor Clients through the standardized Eclipse RCP Installation Manager. The Eclipse RCP management allows for management of the Expeditor Client runtime and the Expeditor integrator RCP plug-ins. This includes installation, update, start and stop operations.
- Management through IBM WebSphere® RFID Premises Server. Since the Expeditor integrator uses the standard OSGi Configuration Admin Service interface to maintain its configuration similar to the IBM WebSphere Data Capture devices, the Expeditor integrator runtime's configuration can also be managed by the Premises
- Management using Expeditor integrator control facilities. Expeditor integrator provides control queues through which defined control messages can be received to kick off local control actions. For example, configuration changes can be applied, the Maintenance Mode can be toggled on / off and a Housekeeping Flow can be triggered.
Please, refer to your remote management architecture and determine which server-managed approach is taken. Depending on the chosen option, double check whether there is a server connection available from your Expeditor integrator runtime.
Make sure that the Back-end Management Server can be accessed through the configured port (firewall settings).
The Expeditor integrator is installed on a server in the remote location (e.g. a store server in the hypermarkets).
The remote server hosting the integrator runtime must provide the following pre-requisites.
The Expeditor integrator is based on the OSGi® Framework (provided with Eclipse® RCP; Equinox). The OSGi Framework is a Java™ Service Platform that runs as a Java executable.
The Expeditor integrator product is provided as zipped installation image that contains its own directory structure. This file needs to be unzipped in an installation directory (further referred to as <XPDINTEG_INSTALL
). After running the installation routine, the Expeditor integrator runtime is installed in the directory which was chosen during the installation procedure (referred to as Expeditor integrator home directory: <XPDINTEG_HOME
). Make sure that the user account under which the Expeditor integrator is running has appropriate (read/write) access rights to this directory.
Table 3. Expeditor integrator runtime prerequisites
|Prerequisite ||Value (save your values here) ||Comment |
|LocationId || ||Unique ID for the remote location/server (e.g. a store ID); this value is also set in the JMS Message headers |
|Domain name of the remote server || ||Full-qualified domain name |
|IP Address of the remote server |
| || |
|User account under which the Expeditor integrator is running || || |
|User account under which the Expeditor integrator is registered as Windows Service |
|Recommendation: system account (that is allowed to log to console) ||The registered Windows Service needs to be started with this user account. |
|Directory for the Expeditor integrator || ||The <XPDINTEG_HOME |
contains enough disk space
|For Runtime: 800 MB ||250 MB for pure Runtime plus 550 MB for temporary storage of messages in the File System and transaction logs. |
The above provided parameters will also be used during the Expeditor integrator installation (see int_install_install.dita).
IBM Lotus Expeditor integrator supports file transfer between the integrator runtime and connected file servers, which can be accessed through FTP and SSH.
For example, in retail environments, the Expeditor integrator can transfer files between the remote server and the 4690 PoS Controller (4690EL). The 4690 PoS Controller is a closed system that can only be accessed by using the built-in FTP Server.
If a file server is accessed using FTP/SSH, please, make sure that all access information is available (see following table).
Table 4. FTP Server information
|Parameter ||Value (save your values here) ||Comment |
|4690EL and/or FTP/SSH server name || ||As fully-qualified Domain Name |
|4690EL and/or FTP/SSH server IP address || || |
|FTP/SSH User / Password || ||This user needs read and write access to the appropriate directories |
|FTP Timeout value || ||Set high to minimize connection losses between the Expeditor integrator and the remote file server |
|List of FTP/SSH directories for READ access || ||These directories will be read by the Expeditor integrator |
|List of FTP/SSH directories for WRITE access || ||Expeditor integrator needs write access to these directories |
This information is also required for all other file servers (FTP/SSH, 4690EL Controllers in the store) that need to be accessed by the Expeditor integrator.
The Local File System is the file system of the computer on which the Expeditor integrator is installed (referred to as remote server). In retail environments, this would be the store server in the hypermarket.
The following settings must be considered to allow the Expeditor integrator to access the local file system.
Table 5. Local File System access information
|Parameter ||Value (save your values here) ||Comment |
|User account: File system access rights for the account under which the Expeditor integrator is running || ||Make sure that the Expeditor integrator user account has read and write access to the target and source directories for the file transfer |
|List of directories that need READ access || ||Directories that are read by the Expeditor integrator |
|List of directories that need WRITE access || ||Directories that are written by the Expeditor integrator |
This section provides the steps involved in installing Lotus Expeditor integrator from a CD.
Before you install the Lotus Expeditor integrator,
check that there is enough space in your operating system's temporary directory. In addition to the space required to install the product, your operating system's temporary directory must have at least 200 MB free.
Use the following steps to install Lotus Expeditor integrator on Windows from a CD.
- Insert the Lotus Expeditor integrator CD into the CD-ROM drive.
- Launch the setup.exe installer executable. The installer is located in the install/ directory on the CD.
- The Lotus Expeditor integrator Installer guides you through the rest of the installation:
- At the installer welcome page, click Next.
- Read the license. To accept the license, select I accept the terms in the license agreement and click Next.
- Enter the destination where you want to install the Lotus Expeditor integrator and click Next.
The default destination may not be accessible by the current user. In this case, change the location to a user-accessible destination.
C:\Documents and Settings\user99\IBM\Lotus\Expeditor
- Before the actual installation begins, verify the installation summary information is correct. Click Next to begin the installation.
- After the installation is complete, click Finish.
The following characters are not allowed in the install path: ;%#<
Follow the installation steps provided to create the Expeditor integrator runtime in its home directory (<XPDINTEG_HOME
). Package this home directory (e.g. as XPDinteg_v20.zip ZIP file) and provide it as an installation image for further distribution in your enterprise.
You might want to do some basic configuration before repackaging Expeditor integrator runtime. Refer to Quick Start Configuration for available configuration options.
Installation of the custom distribution package is as follows.
The custom distribution package (e.g. XPDinteg_v20.zip) can be extracted in any folder of the target system (remote server;
store server). It only must be assured that the user account that runs the application has appropriate Read and Write access rights to the installation folder (<XPDINTEG_HOME
The following steps are required for the installation.
- Copy the provided ZIP to the target location (<XPDINTEG_HOME
= installation folder of the Expeditor integrator)
- Extract the ZIP file within this folder
The Expeditor integrator must be configured according to the location endpoint's (e.g. retail store's) and back-end system's environment settings. Configure the Expeditor integrator manually or through one the available remote management server options.
- A custom distribution package might already contain a base configuration. Please, refer to your Administrator whether there are still manual
installation steps required.
- After configuration, ensure that your local computer has connectivity to all required external systems (e.g. the file server, the messaging back-end, the monitoring back-end).
- Start the Expeditor integrator in a console window: Start the Expeditor integrator by executing the XPDintegStart.bat. This will start up the Expeditor integrator. By default a console output window is shown.
- Start the Expeditor integrator as Windows Service: Please, refer to Installing Expeditor integrator to run as a Windows Service
The IBM Lotus Expeditor integrator can also be installed as a Windows Service. In this case, the integrator runtime can be started and stopped automatically or through remote Windows Services management tools.
Follow these steps to enable starting Expeditor integrator as a service.
- • Check that the IBM Lotus Expeditor integrator Service Package was installed. The package installation added the XPDintegSvc.exe file to <XPDINTEG_HOME
- Install the Expeditor integrator service by running XPDintegSvc.exe install manual where
- install installs the Windows Service
- manual or auto indicates the service type (accepted parameters are auto for starting this Windows Service automatically or manual for manual startup)
- Optional parameters:
- -console starts Expeditor integrator in console window (OSGi Console)
- -reset resets the Expeditor integrator (Use with care, because this deletes log files, OSGi config store and Lotus Expeditor micro broker queues and their content! See Launching the Lotus Expeditor Client on the desktop)
Recommendation for the service installation:
XPDintegSvc.exe install manual -console
This will create the Windows Service for Expeditor integrator. The service must be started manually and displays the Expeditor integrator OSGi Console window.
The Expeditor integrator Windows Service is installed under the service name IBM Lotus Expeditor integrator and service description IBM Lotus Expeditor integrator service.
Figure 2. Windows Service Panel
- Double check in the Windows Service Panel that the Expeditor integrator service was installed (see previous figure) .
- You may also want to set the service to be started automatically during
system start and open the Expeditor integrator console window. In this case, double click the Expeditor integrator service in the Windows Services Panel and make sure that the created service is set to the following.
- General tab: Startup type = Automatic
- Log on tab = Log on as Local System account and Allow service to interact with desktop
- Test the installation by starting the service.
If the Windows Service is installed, the Expeditor integrator runtime can not be moved out of its home directory. If it is moved, the Windows Service will not work. For uninstallation information, refer to Uninstalling the Expeditor integrator Windows Service
The XPDintegSvc.exe provides the following additional commands for controlling the installed service.
- start starts the service
- restart restarts the service
- stop stops the service
- uninstall uninstalls the service
For example, XPDintegSvc.exe start -console starts the installed Windows Service which opens the Expeditor integrator runtime in an OSGi Console window.
This section provides the steps involved in installing Lotus Expeditor integrator from a shared network location.
Use the following steps to install Lotus Expeditor integrator from a shared network location.
- Map to the shared folder.
- Continue with step 3 described in Installing from a CD.
Use the steps in this section to uninstall the Lotus Expeditor integrator.