Setup Axelor BI

Axelor BI is an enterprise module, that can be installed and used from Axelor’s nexus repository.

Nexus Configuration

settings.gradle

In settings.gradle file, inside dependencyResolutionManagement, declare a new repository to let gradle install axelor-bi module from the dedicated Nexus repository.

dependencyResolutionManagement {
  repositories {
    // keep the declaration of your other repositories there
    maven {
      name 'maven-enterprise'
      url 'https://repository.axelor.com/nexus/repository/maven-enterprise/'
      credentials {
        username axelorMavenUsername
        password axelorMavenPassword
      }
    }
  }
}

gradle.properties

Create the file ~/.gradle/gradle.properties (if it doesn’t exist yet). Copy the following lines and use your own nexus credentials:

axelorMavenUsername=MyNexusUsername
axelorMavenPassword=MyNexusPassword

Notice: Nexus credentials should be provided by Axelor.

build.gradle

In the file build.gradle of your custom module, add axelor-bi dependency:

dependencies {
  // keep your other dependencies there
  implementation 'com.axelor.addons:axelor-bi:2.0.0'

  // or
  implementation 'com.axelor.addons:axelor-bi:2.1.0'
}

Application configuration

Axelor BI depends on two other modules, Axelor BI Studio and Axelor Library. You need to add a set of parameters to configure the application.

Axelor BI Studio configuration

The configuration of Axelor BI Studio can be done in two ways:

  • License

  • Locally

License

In that case, no configuration is required. Instead, your license integrator would set up all the requirements to use BI module properly.

Local configuration

When Axelor BI module configuration is set locally, then it requires adding the following parameters to the axelor-config.properties file:

  • bi.local: should be set to true in case of BI testing

  • bi.client.code: client code provided by axelor or any unique code for testing

  • bi.studio.url: the url of studio server

  • bi.studio.admin.user: studio admin username

  • bi.studio.admin.password: studio admin password (request it to BI module team)

Sample of axelor BI Studio configuration:

# BI settings
bi.local = true
bi.client.code = XXX
bi.studio.url = https://axelor-bi-studio.saas.axelor.com
bi.studio.admin.user = BiStudioAdmin
bi.studio.admin.password = password

Axelor Library configuration

The configuration of Axelor Library can be done in three ways in the following priority:

  • AppBi

  • Local configuration

  • License

AppBi

The high level priority configuration is the configuration page of the module, the library credentials defined in the configuration page will override the ones defined in axelor-config.properties and license metadata.

BI configuration page

Local configuration

When Axelor Library configuration is set locally, then it requires adding the following parameters to the axelor-config.properties file:

  • bi.library.url: the url of library server

  • bi.library.user: library admin username

  • bi.library.password: library admin password (request it to BI module team)

Sample of axelor library configuration:

# Library settings
bi.library.url = https://aos-library.axelor.com
bi.library.user = biUser
bi.library.password = password

License

The license provider will set up all the required configuration for library

Notice: BI Studio and Library credentials should be provided by Axelor.

Installation

To install axelor BI:

  • Go to the menu Apps management

  • Search for Axelor BI

  • In BI app card, click Install

Axelor BI install

The BI module is now available on the sidebar menu with the following menus:

BI menu

  • Dashboard: List all the dashboards created on studio

  • Snapshots: List all snapshots of dashboards user has access to.

  • Studio: Redirect to BI Studio server

  • Library: The library of dashboards provided by Axelor. It allows you to install dashboards from the library.