Install and upgrade DataMart

Before installing or updating DataMart, review the prerequisites and system requirements.

Prerequisites

Review the information in this section before installing or updating DataMart.

Row and column size limitations

The standard column quantity and row size limitations imposed by SQL server are 8,060 Bytes per row in memory-optimized tables and 1,024 columns per table. Review Maximum capacity specifications for SQL Server on Microsoft's website.

DataMart URL

The DataMart service and SQL database are stand-alone applications that reside on a network server. The DataMart URL you enter in the browser address bar depends on whether you sign into the network server directly:

If you sign in to the network server with local credentials on that server enter http://localhost:8080
If you access DataMart from a browser on your computer, enter the Fully Qualified Domain Name (FQDN) of the network server, for example http://dm.mycompany.domain:8080

Port 8080 or the port that your organization chooses must be opened in the remote system firewall used with the DataMart host.

Audit log

Audit Log must be enabled in your environment to do a successful soft brush. Contact your Accruent representative to enable audit log.

Firewall restrictions

If your IT department has a corporate firewall that only allows network traffic to specific IP addresses that they define, contact Accruent Support to obtain the IP addresses that your IT department needs to whitelist.

Here is an example network for a typical DataMart implementation. Lucernex data is pulled from an https connection through your firewall to your DataMart hosting server. This data is then sent to the SQL server.

System requirements

Minimum system requirements for the DataMart server and your Lucernex firm:

Operating system: Windows OS (64-bit required)
Disk space: 20 GB free disk space for small customers, and up to 100+ GB for large customers.

Reserved disk space size can be re-evaluated over time, as the initial runs can generate large error files.
System RAM: 8 GB for large databases we recommend between 10GB and 12GB. As the Database grows, periodically reevaluate the allocated memory.
Java Development Kit (JDK): JDK software, such as:
- Java JDK version 21 (64-bit required)
- Open JDK 21
SQL Server Database:
- DataMart 7.0.176 or later: Microsoft SQL Server version between 2019 and 2022 (64-bit versions)
- DataMart 7.0.126 and 7.0.147: Microsoft SQL Server version between 2014 and 2022 (64-bit versions)
Cloud-hosted SQL Servers are supported, but you must have the login credentials of the database owner.
Internet: An internet connection and browser is required. We recommend Google Chrome. Internet Explorer 11 is no longer supported.
Lucernex firm: Auditing Enabled. Ask your Accruent representative to set this parameter on the Manage Company page for your firm.
Sleep mode: Disable sleep mode on the machine hosting the DataMart service.
Virtual machines: We recommend using virtual machines and two separate installation instances: a production environment and a test environment for troubleshooting. Only one DataMart instance is allowed per host network server. Installations on laptops / PCs is not supported. To test new versions, you need a separate instance.

Fresh Install

You must have Administrator permissions on the server where you want to install DataMart.

If your organization has purchased DataMart or has a license, contact your Lucernex Support representative to obtain:

Download instructions
A custom URL for DataMart if your organization uses one for Lucernex.

For example, if your organization uses yourcompany.lxretail.com

Download the installer to the machine where you want to install DataMart.

The download link is normally sent to you in an email.
Double-click the Installer EXE file that you downloaded.
Click I Agree to accept the license agreement.
Select the folder where you want to install DataMart then click Next.
Click Install.

If JDK 21 is not found on the machine, a web page opens with a recommended version. You must install a version of JDK 21 to use DataMart.
Click Finish.
Create a new mapping and Data Database in SQL Server.
Using a text editor, edit these files in the folder where DataMart is installed. For example, C:\Program Files\DataMart\bat:

db.properties

Add a mapping database and credentials:
- db.host: SQL Server Host.
- db.port: SQL Server Port.
- db.name: SQL Server database.
- db.instance: SQL Server instance. Leave blank if you do not have one.
- db.username: SQL Server username.
- db.password: SQL Server password.
datamart.bat

Enter values for these settings after =:
- spring_profile: We recommend using SQL Server for mapping database . To do so, enter sqlserver.
- datamart_port: The port where you want to access DataMart. The default value is 8080.
- datamart_memory: The maximum heap that DataMart is permitted to use. The default value is 15g, or 15 GB of memory. You can increase this value; however, be careful not to exceed your machine's available memory. If you do, you run the risk of a crash of the Java Virtual Machine (JVM) which will interrupt your mapping runs.
datamart.properties

Change the default values to ones that are appropriate for your system. For example:
- datamart.error.limit: Maximum number of permitted errors for a given error type before the mapping run fails. 1 is too low, but 100 might be more appropriate.
- datamart.batch.size: Batch size for database operations. Example value 100.
- datamart.parallel.queries: Maximum number of concurrent IWMS queries DataMart can perform. Example value 10.
- datamart.parallel.persistence: Number of parallel runs of target database persistence. Example value 10.
In the folder where you installed DataMart, open the bat subfolder, right-click installService and select Run as Administrator.
Click Yes in the User Account Control window that opens.
Navigate to Start > Windows Administrative Tools > Services, then right-click LxDatamart and select Start Service.

Allow a few minutes for the application to start.
In Lucernex, create a new DataMart member with the System Administrator job function in your Firm's Lucernex production environment to use when you create mappings. For example, lxretail.lucernex.com and dm.lucernex.com.

You can add a person to create a new Lucernex member. We recommend that you create the member with the name DataMart so that you can easily identify the DataMart scheduled tasks in the Job Log.

When you create a new member, you must sign in to that Lucernex Production environment with the user name and password you created and accept the EULA before creating mappings.
Open your browser and enter http://localhost:8080/ in the address bar to view the DataMart application.

If you want to change the port, you can configure the DataMart batch file.
Create a mapping.

The mapping verifies your passwords and connectivity to the website.

If the mapping fails to connect, check that the credentials and URLs you entered are correct.
Start a full brush rebuild of the target database from scratch or delta incremental update of target database.

Upgrade

Before upgrading to a later version of DataMart:

Check which version of DataMart you are currently running in the footer of the Mapping Schedule page.
Create Database backups for Mapping and Data.
Create a backup of the DataMart installation folder.
Download your new version of DataMart to the instance where you want to install it.
Test the new version of DataMart with your existing reports. We recommend that you test the new version on a different server so that you do not disrupt operation of your current DataMart instance.

Review the sections that follow and complete the steps required for the version you are upgrading from.

We no longer provide a war file for upgrade after version 7.0.55. Use the instructions that follow to upgrade version 7.0.55 to a later version.

Upgrade 7.0.55 to 7.0.176

Navigate to Start > Windows Administrative Tools > Services.

A Services window opens. Leave this window open, you will need it in the subsequent steps.
In the Services window, stop the Lx DataMart service.

Double-click the Installer EXE file that you downloaded.
Click I Agree to accept the license agreement.
Select the folder where you want to install DataMart then click Next.
Click Install.

If JDK 21 is not found on the machine, a web page opens with a recommended version. You must install a version of JDK 21 to use DataMart.
Click Finish.

To reuse your existing mapping database in db.properties and smtp.properties, copy those files from your old DataMart folder to your new one. For example:
- copy "C:\Program Files\Lucernex\Datamart-old\db.properties" "C:\Program Files\Lucernex\Datamart-new"
- copy "C:\Program Files\Lucernex\Datamart-old\smtp.properties" "C:\Program Files\Lucernex\Datamart-new"
Copy all files from the old xml subfolder to your new one. For example:
- copy "C:\Program Files\Lucernex\Datamart-old\xml\*.hbm.xml" "C:\Program Files\Lucernex\Datamart-new\xml"
Using a text editor, edit these files in the folder where DataMart is installed. For example, C:\Program Files\DataMart-new\bat:

datamart.bat: Verify datamart_memory is set to the value in the previous version. Enter values for these settings after =:
- spring_profile: We recommend using SQL Server for mapping database . To do so, enter sqlserver. Previous versions used sqlServer. Ensure the value is set to sqlserver.
- datamart_port: The port where you want to access DataMart. The default value is 8080.
- datamart_memory: The maximum heap that DataMart is permitted to use. Verify the value from your previous version of DataMart.
  
  The default value is 15g, or 15 GB of memory. You can increase this value; however, be careful not to exceed your machine's available memory. If you do, you run the risk of a crash of the Java Virtual Machine (JVM) which will interrupt your mapping runs.
datamart.properties

Change the default values to ones that are appropriate for your system. For example:
- datamart.error.limit: Maximum number of permitted errors for a given error type before the mapping run fails. 1 is too low, but 100 might be more appropriate.
- datamart.batch.size: Batch size for database operations. Example value 100.
- datamart.parallel.queries: Maximum number of concurrent IWMS queries DataMart can perform. Example value 10.
- datamart.parallel.persistence: Number of parallel runs of target database persistence. Example value 10.
Navigate to Start > Windows Administrative Tools > Services, then right-click LxDatamart and select Start Service.
Start a full brush or delta.

Upgrade 7.0.147 to 7.0.176 with 7.0.55 or earlier backup available

Navigate to Start > Windows Administrative Tools > Services.

A Services window opens. Leave this window open, you will need it in the subsequent steps.
In the Services window, stop the Lx DataMart service.

Double-click the Installer EXE file that you downloaded.
Click I Agree to accept the license agreement.
Select the folder where you want to install DataMart then click Next.
Click Install.

If JDK 21 is not found on the machine, a web page opens with a recommended version. You must install a version of JDK 21 to use DataMart.
Click Finish.

To restore your existing mapping database from 7.0.55, copy db.properties and smtp.properties from your 7.0.55 DataMart folder to your new one. For example:
- copy "C:\Program Files\Lucernex\Datamart-old\db.properties" "C:\Program Files\Lucernex\Datamart-new"
- copy "C:\Program Files\Lucernex\Datamart-old\smtp.properties" "C:\Program Files\Lucernex\Datamart-new"
Copy all files from the old xml subfolder to your new one. For example:
- copy "C:\Program Files\Lucernex\Datamart-old\xml\*.hbm.xml" "C:\Program Files\Lucernex\Datamart-new\xml"
Using a text editor, edit datamart.bat. Verify datamart_memory is set to the value in the previous version.

Enter values for these settings after =:
- spring_profile: We recommend using SQL Server for mapping database . To do so, enter sqlserver. Previous versions used sqlServer. Ensure the value is set to sqlserver.
- datamart_port: The port where you want to access DataMart. The default value is 8080.
- datamart_memory: The maximum heap that DataMart is permitted to use. Verify the value from your previous version of DataMart.
  
  The default value is 15g, or 15 GB of memory. You can increase this value; however, be careful not to exceed your machine's available memory. If you do, you run the risk of a crash of the Java Virtual Machine (JVM) which will interrupt your mapping runs.
Navigate to Start > Windows Administrative Tools > Services, then right-click LxDatamart and select Start Service.
Start a full brush or delta.

Upgrade 7.0.147 to 7.0.176 without 7.0.55 or earlier backup available

Version 7.0.147 rearranges partition map to existing data schema and schema of data for partition tables may change. We therefore recommend that you start a full brush after upgrading.

Navigate to Start > Windows Administrative Tools > Services.

A Services window opens. Leave this window open, you will need it in the subsequent steps.
In the Services window, stop the Lx DataMart service.

Double-click the Installer EXE file that you downloaded.
Click I Agree to accept the license agreement.
Select the folder where you want to install DataMart then click Next.
Click Install.

If JDK 21 is not found on the machine, a web page opens with a recommended version. You must install a version of JDK 21 to use DataMart.
Click Finish.

Create a new mapping and Data Database in SQL Server.
Using a text editor, edit these files in the folder where DataMart is installed. For example, C:\Program Files\DataMart-new\bat

datamart.bat: Verify datamart_memory is set to the value in the previous version. Enter values for these settings after =:
- spring_profile: We recommend using SQL Server for mapping database . To do so, enter sqlserver. Previous versions used sqlServer. Ensure the value is set to sqlserver.
- datamart_port: The port where you want to access DataMart. The default value is 8080.
- datamart_memory: The maximum heap that DataMart is permitted to use. Verify the value from your previous version of DataMart.
  
  The default value is 15g, or 15 GB of memory. You can increase this value; however, be careful not to exceed your machine's available memory. If you do, you run the risk of a crash of the Java Virtual Machine (JVM) which will interrupt your mapping runs.
datamart.properties

Change the default values to ones that are appropriate for your system. For example:
- datamart.error.limit: Maximum number of permitted errors for a given error type before the mapping run fails. 1 is too low, but 100 might be more appropriate.
- datamart.batch.size: Batch size for database operations. Example value 100.
- datamart.parallel.queries: Maximum number of concurrent IWMS queries DataMart can perform. Example value 10.
- datamart.parallel.persistence: Number of parallel runs of target database persistence. Example value 10.
Navigate to Start > Windows Administrative Tools > Services, then right-click LxDatamart and select Start Service.
Start a full brush.