Installation Steps
This section describes all the necessary steps for the installation and configuration of LumisXP, as well as the information required for the proper configuration of supported application servers and database servers.
For the installation of LumisXP, there is only one distribution for Windows® and Linux:
LumisPortal_<release_number>.zip | Zip file to be unpacked in the Windows® and Linux environments. |
The distribution files have the following folder structure:
/lib/shared | Contains the libraries (jar) used by LumisXP, which should be installed on the application server in a shared area. |
/lumisdata/config | Contains configuration files for LumisXP. |
/lumisdata/def/lumis | Contains service definition files. |
/setup | Database setup files. |
/www | Application server installation files. The WAR file is created from this folder. |
/www/lumis/doc | Contains the LumisXP manual (Help HTML, XSD, and Javadoc of the public API). |
Installing LumisXP
- Select the distribution according to your environment and unpack the files into a local folder, on a client machine or on the server itself. For more information about the supported environments, see the document System Requirements;
- In the file www/WEB-INF/web.xml: alter the value of the LumisDataPath parameter to the path where the folder “lumisdata” will be located;
It is possible to use system properties to generate the path of the lumisdata folder. The Expression Language
${system.properties['propertyName']}
is replaced by the value of the specified property. Example:C:/${system.properties['LumisDirName']}/lumisData
will be replaced byC:/lumis/lumisData
if there is a system propertyLumisDirName
with the valuelumis
.System properties can be specified using the -D parameter of java.exe.
- In the file lumisdata/config/lumishibernate.cfg.xml: alter the database connection information. This file contains all the connection examples for Oracle, MS SQL Server, and MYSQL. To create the desired connection, select the corresponding item in the databases section of this manual;
- Deploy LumisXP on the Java™ application server. In the section Application Servers of this manual, check the instructions for the desired Java™ server;
- It is possible that at this point the portal is still not accessible, depending on the environment configurations. During installation, the portal creates a default website that accepts requests from
http://localhost:8080/portal
andhttps://localhost:8443/portal
. It is necessary to configure the correct websites that this portal will serve. To do this, access the portal in security mode (see Security Mode for more details), log in as the Administrator user (login "admin") as described below, access the Website Manager located in Configuration and make the appropriate settings for your environment. - The configuration of the Big Data repository to be used by the portal is required. This configuration can be made in Environment Configurations. If the repository to be used is Elasticsearch, LumisXP provides an embedded version of it. However, it is not recommended to use this version for production environments but rather install a separate version. For installation information of Elasticsearch, see Installing Elasticsearch.
From there, LumisXP is installed and running. It can be accessed via the URL configured in step 3.
To make the first logon to LumisXP, use the Administrator user. The login is "admin" and the password is blank. It is recommended to change the administrator password for security reasons. To change the password, refer to the section Users and Groups.
To manage LumisXP, see the section Configuration in this manual.
To build your portal or website, see the section Portal Studio in this manual.
For customizations or development of new services, see the section Customization and Development in this manual.