The IntelliPortal server application runs in a Solaris environment. It manages the transmitter, the datafeeds and adapters, and includes a database for persistent storage. There may be multiple servers but each server is associated with one transmitter. They are a pair.
All server software is installed using the pkgadd command on Solaris. The installation requires a Solaris user account that will be the owner of the IntelliPortal server and tools; when the server runs, it runs as that user. This user must have the ability to access the database of choice and run SQL against it, and to access to the JVM of choice. The JAVA_HOME environment variable must also be set.
For a successful installation, there are several preliminary tasks that you must perform in advance. See Before You Begin for a description of these tasks. |
If desired, the IntelliPortal server can automatically start and stop when the computer is booted up or shutdown. IntelliPortal transmitters start or stop depending on how they are configured during installation. The installation process creates the tables needed for operation in the selected database, as well as a new database user.
The following list of topics shows the sequence of steps you must perform in order to install a complete IntelliPortal server. These topics are discussed in order and provide detailed instructions on each step.
___________________________________
To install the server, you simply insert the installation CD-ROM into your Solaris computer and add the IntelliPortal package as explained below. However, before you install the package, you should think through the installation process and decide how you will be configuring the server (e.g. whether it will be secure, who has publish rights, what database you are using, etc.). This section explains some of the information that you will need to provide. During the installation, you should be ready with this information when prompted.
If you are connecting to a previously installed Oracle database, you should have a working knowledge of Oracle database administration. Also, during the installation you will be asked whether or not to restrict channel publishing to specific hosts. If you restrict publishing, the specified hostnames must be resolvable using nslookup (or you can add them later using the Marimba utility). As explained below, you will also need to select a database, configure transmitter security, and choose installation directories for the server application files.
IntelliPortal needs a database to store server data. You can use an existing Oracle7 or Oracle8 database, or you can use the flat file database that is included with IntelliPortal. The flat file database is a lightweight JDBC database that comes with the server. It supports all IntelliPortal features but has certain limitations (chiefly performance, scalability, and unsupported SQL commands) that make it unsuitable for a standard production system. With minor adjustments, you can change to an Oracle database later and export your data.
During the installation you are asked if you want to use the local, flat file database (the QuickStart database). If yes, the flat file database is installed and no further configuration is required. If no, you are prompted for JDBC connectivity information (i.e. database driver name and URL string) for your Oracle database. This data is provided by the vendor when installing the database and/or JDBC connectivity to the database. Note that if you elect to use an existing Oracle database, it must be installed and running before you install IntelliPortal.
An IntelliPortal server can support multiple secure and non-secure transmitters. Since a client can subscribe to channels from more than one transmitter, it can receive a mix of secure and non-secure channels from different transmitters. Both secure and non-secure transmitters can reside on the same server and secure and non-secure channels are displayed in the same client shell.
Transmitter security is configured during installation. A transmitter configured for SSL provides secure communication between client and server; a transmitter configured without SSL does not. To configure a secure transmitter you need to get a digital certificate in advance and install it after the server; otherwise, the transmitter will not run. See Getting a Digital Certificate for details.
During the installation process, you must specify two Solaris directories (not to be confused with client file directories) for system files; they can use the same root path. These are the IntelliPortal home directory and the IntelliPortal transmitter directory. (See What Gets Installed for a complete list of the files.) The IntelliPortal home directory is always the user's home directory.
The following installation dialog shows a sample installation of a server (and transmitter) on a Sun Microsystems workstation using the Unix pkgadd command. Each server is associated with one transmitter. You must be logged in as root and you need to change to the directory where the package is located. You also need an operating system user account configured with the JDK and Oracle environments. A Sun workstation configured with Solaris 2.6, the latest Sun patch cluster, and JDK 1.1.6 or higher is required.
If you are using an existing Oracle database, Oracle7 or Oracle8 must be installed and running before you install IntelliPortal. During the pkgadd, the install procedure checks for database connectivity. If you successfully connect to an Oracle database using this vendor-supplied data, the message Successfully connected to database! is displayed during the installation.
|
To install the server |
# su - <os_user_name> where <os_user_name> is the operating system user name.
The following script creates two required tablespaces and an Oracle database user.
$ ./ConfigDB.sh Enter the database software owner who is a member of the DBA group. Enter the database software owner [Oracle]: Enter the value of the system identifier (sid) of the database instance. Enter the database system identifier [$ORACLE_SID]: Enter the database user name for the IntelliPortal Server. This name will need to be entered as the Administrator Name for the IntelliPortal Server Administrator tool during the package installation. Enter the database user name: Enter the database password for the IntelliPortal Server. This password will need to be entered as the Administrator Password for the IntelliPortal Server Administrator tool during the package installation. Enter the database password: Specify a mount point with at least 75 Megabytes of free disk space to be used for the IntelliPortal database files. Enter the mount point for database files [/opt/oracle]:
The following installation dialog is displayed on the screen. All items in the dialog require a response; the items within square brackets generally show the default (if any). Press Return each time you enter data, or press Return without an entry to accept the default. Note that the <os_user_name> shown in the dialog refers to the Unix user account name for the server.
$ pkgadd -d .
The following packages are available:
1 IPORTAL IntelliPortal Server
(sun4) 1.1
Select package(s) you wish to process (or 'all' to process
all packages). (default: all) [?,??,q]:
Processing package instance <IPORTAL> from </cdrom/intelliportal/server>
Intelliportal Server
(sun4) 1.1
Copyright 1999, MECA Software, L.L.C., All rights reserved.
This software is the confidential and proprietary information of MECA Software,
L.L.C. ("Confidential Information"). You shall not disclose such Confidential
Information and shall use it only in accordance with the terms of the license
agreement you entered into with MECA.
Copyright 1996-1997 Marimba, Inc., All rights reserved.
Contains Castanet (tm) technology from Marimba, Inc.
Do you agree to the terms of this agreement? [y,n,?]
Enter the previously created Unix user account name that will be the owner of
the Intelliportal server.
Enter a valid Unix user account name for the server:
Specify the Intelliportal home directory path of the Unix user account name
above. This will be used as the directory that stores channels. There must be
adequate free disk space to store the data for all channels.
Enter the Intelliportal home directory [/export/home/<os_user_name>]:
Verify java home directory[/usr/java]:
Specify the Intelliportal transmitter directory. There must be at least 20 MB of
free disk space.
Enter the Intelliportal transmitter directory [/opt/IPORTAL/<os_user_name>]:
Specify the port number that will be used for publishing and subscribing.
Enter the publishing port number [6322]:
Specify a password that will be used for publishing.
Enter the publishing password or <ENTER> for no password:
Enter the hostnames from which you can publish to this transmitter. If no hosts
are specified, any host can publish channels to this transmitter. To restrict
access to this host only, specify this hostname. The hostnames must either be
resolvable using nslookup or you can add them later using the Marimba utility.
Enter the hostname(s) for publishing or <ENTER> for all hosts:
Will this transmitter be configured securely with SSL-enabled? If so it will
need the certificate password each time it runs.
Will this transmitter be SSL-enabled? [y,n,?]
Enter a firewall proxy host IP address for URL adapters that need an external
http connection.
Enter a valid firewall proxy host IP address or <ENTER> for no firewall proxy:
Enter the firewall proxy port number for this host IP address.
Enter the firewall proxy port number [8080]:
Specify the authentication server hostname for Intelliportal administration.
Enter the authentication server hostname (e.g. HOSTNAME.DOMAIN)
[server.domain_name]:
Enter the authentication server port number for Intelliportal administration.
Enter the authentication server port number {1099]:
Enter the Administrator Name for the Server Administrator tool. If the
ConfigDB.sh database configuration script was previously run, this is the
database user name that was created.
Enter the administrator name [<os_user_name>]:
Enter the Administrator Password for the Server Administrator tool. If the
ConfigDB.sh database configuration script was previously run, this is the
database user password that was created.
Enter the administrator password:
Do you want to use a local flat file database to store IntelliPortal data?
[y,n?]
Please specify the following JDBC database connectivity information:
** JDBC Driver name, i.e. oracle.jdbc.driver.OracleDriver
** JDBC URL database identification string, i.e. jdbc:oracle:oci7:$ORACLE_SID
Enter the database JDBC Driver name:
Enter the database JDBC URL string:
JDBC Driver = oracle.jdbc.driver.OracleDriver
JDBC URL = jdbc:oracle:oci7:$ORACLE_SID
Attempting to connect to database...
Connected to database successfully!
Specify whether you want to start the transmitter automatically at system
bootup.
Start the transmitter automatically at system bootup? [y,n,?]
You have completed the Intelliportal Server setup.
Using </home_dir> as the package base directory.
## Processing package information.
## Processing system information.
## Verifying disk space requirements.
## Checking for conflicts with packages already installed.
## Checking for setuid/setgid programs.
This package contains scripts which will be executed with super-user permission
during the process of installing this package.
Do you want to continue with the installation of <IPORTAL> [y,n,?]
Messages will now scroll across the screen as the package is being installed.
You will see the following message when the package installation completes
successfully:
Installation of <IPORTAL> was successful.
This completes the pkgadd and the installation will run to completion. If you are installing IntelliPortal from a 2X CD-ROM, this may take 15-30 minutes.
The files added to your system with the pkgadd program are listed and explained below. As noted, these files are stored in the IntelliPortal home directory [/export/home/<os_user_name>] and in the IntelliPortal transmitter directory [/opt/IPORTAL/os_user_name>] respectively. Note that many of these files are not actually visible until you run a transmitter.
| IntelliPortal Transmitter Directory [/opt/IPORTAL/os_user_name>] | |
|---|---|
| Marimba Castanet bundle | The Sun JDK and all files used by the Marimba transmitter. |
If you want to remove the server software, or if you want to upgrade to a newer version, you must first run pkgrm to remove the previous package. Be aware that pkgrm does not remove all installation files; some residual files must still be removed manually. Note also that if you are running multiple IntelliPortal servers, a pkgrm will remove them all.
|
To remove a package |
The following package is currently installed:
IPORTAL Intelliportal Server
(sun4) 1.1, RC2
Do you want to remove this package?
You should be performing a full system backup (including all IntelliPortal files) according to the backup schedule in place at your site. A backup of these file systems includes the Oracle database that is installed with IntelliPortal. For specific recommendations and detailed procedures about backing up the Oracle database, see the Oracle documentation.
You must install a transmitter license, supplied by MECA, for each transmitter. Before server installation, contact your account representative at MECA for a license. MECA will e-mail you a license.dat file within 48 hours that you copy to the home directory of the transmitter user. This file is read when the server starts.
|
To install a transmitter license |
Skip this section and go to Starting the Server and Transmitter if you did not configure the server for SSL during installation. Digital certificates are only required for secure transmitters. |
Digital certificates provide security protection for the client/server connection. Currently, VeriSign, Inc. is the only certificate authority used by Marimba products. A digital certificate remains valid for a limited time and takes 3-5 days to obtain. As a convenience, Marimba and VeriSign have created a test certificate that provides channel signing and SSL certification in one certificate. A test certificate is free and it expires two weeks after it is issued. See the FAQs for more information. Contact VeriSign for more information.
|
To install a digital certificate |
opt/IPORTAL/transname/castanet/transmitter/bin/transmitter
Remember the password that you are asked for when installing the digital certificate. You will need this same password to start a transmitter configured for SSL. |
If the host being used to install the IntelliPortal server already has a SSL Certificate for a different application (e.g. Netscape), there is usually a facility in the application that lets you export the certificate. After export, you can import it into IntelliPortal as follows.
|
To import an existing certificate |
At this point you need to start the server and the transmitter in order to continue with the installation of other IntelliPortal components.
|
To start the server and the transmitter |
After the IntelliPortal tools are installed, you can start a transmitter from Solaris or from Windows using the Server Administrator tool.
|
To stop the server |
The Developer Workstation includes the tools, sample channels, documentation, and client files that are used by channel developers. As explained below, you can install these components on Windows or Solaris machines.
A "Typical" installation includes all of the above (except the Adobe Acrobat files or the IntelliPortal PDF documents). A "Custom" installation includes only the items you select. The installation dialog varies depending on whether you are running in Windows or Solaris. When you install the Developer Workstation in Windows, you are prompted for an installation directory, and the type of installation: Custom or Typical. If you select Custom, you can select specific IntelliPortal components. In Solaris, only those components that you specify are installed.
|
To install the Developer Workstation in Windows |
In Solaris, you are prompted for an installation directory, and must select individual components; there is no typical installation. Use standard Unix techniques to select components: use the arrow keys to navigate, the spacebar to select, and the Enter key to drill down. Note that you must be logged in as root to install Adobe Acrobat in Solaris.
|
To install the Developer Workstation in Solaris |
You generally install the tools on the system from which IntelliPortal channels will be published. The tools are briefly explained below. The Server Administrator is described in the Server Administrator Guide; the other tools are explained in the Channel Developer Guide.
In Windows, you can launch the IntelliPortal tools from the Start menu. In Solaris, change to the directory where the tools are installed and type the appropriate script.
The System and Sample channels must be installed and published to a running transmitter as part of the IntelliPortal installation. They are both installed during a Typical installation. This section only explains how to install the channels; to publish the channels, see Publishing the System and Sample Channels.
You can install the system and sample channels in Windows or in Solaris depending on where you will be publishing them from. Note that the System and Sample channels must be in a writable directory on disk; you can't publish these channels from the installation CD-ROM.
You can install IntelliPortal documentation on a Solaris server or in Windows. The documentation is available in HTML and Adobe PDF format. The HTML documents run in a browser; the PDF files require an Adobe Acrobat Reader. If you need to install an Acrobat Reader, be sure to check the appropriate box and the Reader installation will launch automatically.
For easier hard-copy reading, you can print the PDF files from the CD-ROM or from wherever you install the files. For best results, be sure you print to a device that is configured for PostScript printing.
The client application only runs in Windows and the files can only be selected and installed in Windows. The sample client files are used to customize the look and feel of the client. For example, if you change the background image in the properties.txt file, your own logo can be displayed when you subsequently run the client. For a complete description of how to customize the client shell, see the Client Customization Guide.
The sample client files are installed in homedir/lib and include the following.
Before you publish the system and sample channels, you must set the default transmitter on the server to the machine name (not the transmitter name) and port number or the IP address and port number of the transmitter you just installed.
|
To set the default transmitter |
If you configured the transmitter for SSL during installation, you must use the fully qualified hostname; an IP address is invalid. |
The System and Sample channels must be installed and published as part of the IntelliPortal installation. (You don't have to install or publish these channels if you are simply installing the Developer Workstation or the Sample Client.) They must be installed in a writable directory on disk because you can't publish these channels directly from the CD-ROM.
When you run the Publisher, the window is automatically populated with the system and sample channels that you installed. Publish these channels as explained in the Channel Developer Guide; don't change any fields. You can start the Publisher from Solaris or from Windows. From Solaris, change to the directory where the tools are installed and type publish.sh. From Windows, navigate to the Publisher from the Start menu.
Before you can run the IntelliPortal client, you need to install and publish a startup channel. The client won't run otherwise. If you installed the Sample channels you can publish the StartupChannel, the EnrollmentStub, or both. They are both startup channels.
The StartupChannel displays a typical client enrollment dialog that prompts for a User ID and Password. When the client initially runs, it defaults to this channel. This demonstrates a typical client enrollment procedure that uses IntelliPortal security features and can be customized as appropriate. The acceptable values for User Authentication are userid1-9 and password1-9.
Also included in the Sample Channels is the EnrollmentStub channel. This startup channel is used for development purposes only and bypasses the userid and password dialog entirely. For security purposes, never publish the EnrollmentStub to a production transmitter. If you want to use the EnrollmentStub, set the enrollchan=EnrollmentStub in Intelliportal\lib\properties.txt.
To verify a successful installation, open your favorite browser (in Windows or Solaris) and type in the server IP address followed by a colon and the transmitter port number. For example,
http://192.168.3.20:3030 for a non-secure transmitter. https://192.168.3.20:4040 for a secure transmitter.
If a window similar to the one shown below is displayed, it means that the transmitter is running and the channels have been published. The server installation has been successful and you are done. In Solaris, you can also type the following command to verify that the installed channels are running.
ls $HOME/channels
The sample client application only runs in Windows. By default, the sample client is installed in C:\Program Files\Intelliportal.
|
To install the IntelliPortal client |
|
To select a default transmitter. |
defaulttrans0=your.transmitter.spec.goes:here
Once you have set the default transmitter, you only need to select "IntelliPortal" from the Start Menu Programs to run the sample client. When prompted, click Go Online, and then enter a User ID and Password; the acceptable values are userid1-9 and password1-9. When the application starts, click on the Help channel and choose the IntelliPortal Tutorial. This explains how to set preferences, subscribe to channels, etc.
|
To install the IntelliPortal client |
