Manual Install
Contelligent - a J2EE compliant application - is installable on different architectures that all come with different vendor-specific procedures to deploy applications. In consequence you have to consider the contelligent install as a two-step procedure. The first step is the mere install of contelligent, which is standardized for most architectures. The second step is the the actual deployment of contelligent, whose actual procedure heavily depends on the j2ee container you are going to use. This document is dedicated to step one - the install of contelligent. For instructions on how to deploy contelligent on various j2ee plattforms please consult deployment tutorials section.
Since deploying contelligent the manual way - as mentioned above - might be overkill in some scenarios, we provide a bundled version that makes the install procedure of contelligent nearly trivial for basic setups. The bundle includes the JBoss(TM) application server and a generic embedded database. Using a bundle is always the safe choice if you want evaluate contelligent without the need to setup a j2ee environment on your own. Currently the bundle is available as a windows installer only. We are in a process of producing such a bundle for *nix plattforms too. If you are looking for help on the install of our windows bundle, please consult our windows install instructions instead of this document.
Prerequisites
In order to install contelligent you need the following components installed on your system:
- a working java sdk install
- a working j2ee container installation - we recommend JBoss (TM)
- a running and supported RDBMS - consult the deployment tutorials to check whether your database vendor is currently supported and documented
Download and unpack the Distribution
In order to install contelligent you need to download the current contelligent version available from our download section. Use the not-bundled version in .tgz format (approximately size: 5M). After you unpacked the distribution package to some temporary directory you can go on with the next section that will tell you on howto setup the install parameters.
Setup the install parameters
Before you perform the install you have to edit the install-properties.xml file that includes all relevant parameters by the install. The switches available in that file are explained below:
<?xml version="1.0" encoding="UTF-8"?>
<contelligent manager="de.finix.contelligent.core.LRUMapComponentManager"
mode="PRODUCTION" role="edit">
<home>/opt/contelligent</home>
<root-email></root-email>
<deploy-dir>/opt/JBoss-2.4.4_Tomcat-3.2.3/jboss/deploy/</deploy-dir>
<rootmanager-name>Production</rootmanager-name>
<!-- maximum number of components in cache -->
<cache-size>10000</cache-size>
<webapp>
<system>
<root>/contell</root>
</system>
</webapp>
<!-- the default transaction timeout: -->
<!-- (package import uses 10 times this value as timeout) -->
<tx-timeout>120</tx-timeout>
<supportSecureComponents>false</supportSecureComponents>
<!-- this encoding is used in the content-type and content-encoding
header for any text content except for channels XML and Flash
(always UTF-8); must be a valid Java encoding. -->
<default-encoding>UTF-8</default-encoding>
<!-- this encoding is used to recode URL parameters received from
the servlet-engine. This is necessary because most HTTP clients
do not send any header specifying the encoding, but most use the
encoding specified by the page they received. Since the engine does
not know which encoding we are sending to clients it must either
guess or use a fixed encoding. But we do know which encoding we
are using ('default-encoding') and hence we can recode the parameters
if we know which one the engine uses. And this is specified by this
property.
- Tomcat 3.2 has a bug, it simply casts the bytes to char, set this to
ISO-8859-1
- Orionserver seems to use platform encoding, so insert your platform
encoding here
-->
<parameter-encoding>ISO-8859-15</parameter-encoding>
<httpPort>8080</httpPort>
<httpsPort>8443</httpsPort>
<system-index enabled="false" />
<workflow enabled="false" />
<revision enabled="false">
<cvs-host>localhost</cvs-host>
<cvs-user>user</cvs-user>
<cvs-password>password</cvs-password>
<cvs-repository>/cvsrepository</cvs-repository>
<cvs-module>contelligent</cvs-module>
<interval>200</interval>
</revision>
<!-- configuration of invoker servlet
- url-pattern has to correspond to the url-pattern the Main Servlet is
mapped to in web.xml if the url-pattern in web.xml is /cms/* the the
url-pattern element has to be /cms
- load-on-startup defines the startup order of the servlet
-->
<servlet>
<url-pattern>/cms</url-pattern>
<sso-pattern>/scms</sso-pattern>
<load-on-startup>1</load-on-startup>
</servlet>
<!-- configuration of invoker servlet
the mapping has to correspond to the url-pattern the Main Servlet is
mapped in web.xml if the url-pattern is web.xml is /cms/* the
servlet-mapping element has to be cms
-->
<servlet-mapping>cms</servlet-mapping>
<!-- import mode
- strict: checks for dead relations at import and stops import if dead
releations are found
- weak: checks for dead relations at import but only shows a warning
-->
<import-mode>strict</import-mode>
<client>
<requireSecure>false</requireSecure>
<allowPush>true</allowPush>
</client>
</contelligent>
- home - the directory you want your contelligent to be installed to. This directory can be overwritten by passing a system property contelligent.home to the VM.
- deploy-dir - the directory where want the preconfigured contelligent.ear enterprise application to be copied to. The actual folder depends on your application server in use. JBoss has a deploy directory that you can use here (e.g. jboss-3.x.x/server/default/deploy). Note: this is only a convenience option. The configured contelligent.ear will be placed inside your contelligent home directory. You can use that one to process deployment procedures specific to your application server. For more specific information on different deployment procedures consult our deployment tutorials.
- cache-size - the default component cache size to use. This value sets the maximum hard cached components in contelligent. It is safe to keep the default value, unless you have specific sizing needs. The performance of large contelligent installs can be improved by increasing this value.
- default-encoding - the default encoding explicitly sets the encoding content type used when streaming text resources to some channel. Usually keeping UTF-8 here is a safe choice.
- parameter-encoding - the parameter encoding option is used to explicitly force some weird parameter recognition procedures of you container. The parameter-encoding is used to convert parameters encoded by the servlet container to the default-encoding. Choose UTF-8 here, if you have a modern servlet container and tweak with this setting as soon as you encounter weird parameter encoding effects.
- system-index - turn this on if you want advanced search features in the contelligent client. The system-index will be updated on demand if you set this parameter to true. Unless you have a reason to turn this off, just set this to true.
Install Contelligent (Phase 1)
After adapting the install-properties.xml to your needs you just need to run install.sh in order to finish the first stage of your contelligent install. After the install ran successfully, you will have a preconfigured contelligent install in the home directory you configured as mentioned above. Next you have to take care that contelligent is installed.
Setup Contelligent Database Infrastructure
Contelligent needs access to a database system. Since contelligent uses the j2ee way of accessing database systems you have to configure datasources by means of your j2ee container. A growing number of examples on how to do it can be found in our section.
Deploy Contelligent
If you are using JBoss, setting the deploy-dir when configuring the install-properties.xml will make this step obsolete. Deployment procedures for different kind of j2ee containers can be found in our deployment tutorials.
Install Contelligent (Phase 2)
After deployment of Contelligent you have to restart your j2ee container or whatever is needed to to start the deployed contelligent.ear application. Contelligent will then import all default contelligent packages that are placed inside the home/deploy directory. This might take some time, so please be patient.
Done!
Congratulations. You have a running Contelligent instance. Now you can do whatever you want. Have fun!
