BIM Documentation


Before to install the module you need to ensure that system requirements are met and R is installed on your Linux server.

It is recommended also to make backup of your system prior to installing new extension packages. 

The following actions should be performed in order to install the BIM extension for Magento:

1. Download the extension package.
2. Install the package on your Magento store:

  • Option 1: using Magento Connect Manager;
  • Option 2: manually using FTP/SSH access;
  • Option 3: using pear installer.

3. Run installation of R packages.

These steps are described below.

Download the extension package

After purchase of BIM license, you can download the module package from your account page.

The package can be installed using Magento Connect Manager or manually using FTP/SSH access.

Option 1. Installation of extension package using Magento Connect Manager

In order to install extension package you need Magento Admin account with access to Magento Connect Manager. Log into your stores admin console and navigate to System → Magento Connect → Magento Connect Manager. At this point you will be prompted to re-enter your administrator credentials. Once you are logged into the manager you will see form for uploading the package archive file under the section "Direct package file upload". Simply choose the downloaded package file from your file system and press "Upload" to start the installation process.

Direct package file upload

Sometimes if some error occurs during the installation process, your system may stay locked in maintenance mode. In order to turn off the maintenance mode you can remove maintenance file from core directory of your Magento store.

Option 2. Installation of extension package manually

Extract downloaded extension package archive file on some temporary folder on your local machine or on the remote server with Magento store. Using your ftp client or ssh (scp) drag all of the extracted files onto the store root of the Magento instance. 

After copying the files go to the admin page System → Cache Management and click on "Flush Cache Storage".

Option 3. Using PEAR installer

Move/Upload the [extension].tar.gz file to your Magento application root. If you haven't done so already, run the following command from the root of your application:

./pear mage-setup .


./pear install Bim_Core-x.x.x.tar.gz

where Bim_Core-x.x.x.tar.gz is the name of the downloaded extension file.

Configure HTTPS connection

At this moment you might want to configure secure connection for R. By default BIM module is using HTTP protocol for installing R packages. This is due to the fact that usage of HTTPS requires libcurl to be installed and working on Linux machine.

If security is not essential at this moment, you might skip this step, but it is recommended to use HTTPS protocol. 

First, you might want to check if libcurl is installed and will work with R. Try to execute the following command on your server with Magento installation:

> curl-config --version

libcurl 7.35.0

If should see version of libcurl after execution of this command. 

In order to turn on HTTPS protocol, open configuration of your Magento store (System -> Configuration) and navigate to GENERAL -> Reports -> BIM Module and set option Use Secure Protocol to "Yes". If you have libcurl properly installed on your Linux server, R packages installation should run without errors.

Run installation of R Packages

Open page Reports → BIM Module → Installation, press "Run Packages Installation" and wait till all R packages will be installed. 

Some extra information about the BIM Installation page

Installation page display R packages that have to be installed and required version, R packages that are already installed. It is also possible to run installation of particular package. If the package is already installed, it will be updated.

After running the installation, page will be refreshed and user will be able to see output of installation process on the page. This information is periodically updated. There is no indication that allows user to define if installation is complete at the moment. It is only possible by reading last information in installation output.

Post installation process 

After installation of the extension package, you can run first data export, then data preprocessing on Reports → BIM Module → Data actualization page and you will be able to see your data on BI dashboards page.

Go to Reports → BIM Module → BI Dashboards and check if data analysis is working.

If you face some problems with rendering of statistical analysis, first of all you can turn on Debug mode: System → Configuration, GENERAL → Reports → BIM Module → Debug Mode.

In order to get periodical update of exported data, you need to configure cron job of the BIM extension for Magento. This could be done on the configuration page: System -> Configuration, GENERAL → Reports → BIM Module.

Set Enable Scheduled Data Actualization to Yes and configure desired time when you want to run periodic data export and preprocessing:

Data actualization cron configuration