Jedox Integrator: First Steps


Jedox Integrator is Jedox’s Extract, Transform, and Load software. This module is designed specifically to tackle the considerable challenges of importing and exporting large quantities of data from Jedox databases. It allows the extraction of data from heterogeneous sources, as well as the transformation and loading of master and transaction data into Jedox models. With the help of the Jedox Integrator, flexible data imports can be carried out easily and fully automatically. All established relational databases can be connected as data sources via a standardized interface. Furthermore, complex transformations and aggregations can be modeled.

Jedox Integrator is a client-server based application, which means that the modeling of Integrator processes takes place in a user-friendly web interface. Furthermore, the Integrator tool can also be easily integrated into other applications with the SOAP-based (Simple Object Access Protocol) web service interface.

Jedox Integrator can be operated both from the command-line level and, more conveniently, using the web-based component Integrator of Jedox Web.

Hovering over any project in the Integrator enables the card functionality of that project. You can then navigate to one of the options in the card functionality, or simply enter that project by clicking on the card.

The dots icon on the upper-right corner of the card provides you with further actions.

If you have carried out a Jedox Integrator update installation, clear your browser’s cache and your cookies to ensure that you are working with the most up-to-date Integrator.

Creating a new Integrator project

At the start of a new Integration process, a new project must be created. Alternatively, you can use an existing example or you can import a provided sample project.

When you open the Integrator component, you will see the Integrator task buttons and the existing examples:

Task buttons (from left to right):

New Project

Save all changes


Monitor: displays an overview of the performed jobs and loads, detailed information about individual projects, execution types and logs, data preview and test. You can see running executions and logs, as well as stop them.

Import: imports Integrator projects.

Note: when an Integrator project is imported from one environment to another, all connection passwords must be manually re-entered.

Collapse all: collapses all opened substructures in the Jedox Integrator projects list.


Sort by type: if set, then components are grouped by type and then by connection type (left picture below). If not set, then the components are not grouped by type (right picture below).

Grouped by type:

Not grouped by type:

Create a new project and name it “Test1”. It is created initially with an empty module structure.

Click on Test1 in the project list. Now you can enter a description of the project in the right window:

Click on the Save button in the toolbar when you have completed your description.

Note: Renaming an integrator project leads to error messages in the scheduler if parts of this project are scheduled.


Creating a new component

By right-clicking on a module you can create a new corresponding element,
or you can display an overview of the elements that exist in the selected component group.
In the screenshot on the right you can see the possibilities.

As an example, we will create a new connection.

In next step you can select the connection type and give it a name. Select “CSV File” and click OK.

At the next screen, you can enter a description and make selections
for main settings and advanced settings.


Right-clicking on a component group (Variables, Connections, Extracts…)
under the project name, you can see an overview of the elements:

Here you can sort the elements by name, type, and description. 
Furthermore, you can resize this window and all displayed columns.

Double-clicking a component opens this component and closes the overview window.


Creating a new linked component

It is possible to create new components which directly link to an existing component. For example, you can create a new “FieldTransform” directly from an existing extract. The new transform will automatically use the extract as a data source.

Basically, this button can create all implemented transforms and loads, but only the ones that make sense for the current component are displayed in the list.

Flow Graph

Jedox Integrator projects can become complex if a lot of data sources, extracts, and transformations are necessary. A FlowGraph can help to give you a better overview of the whole Jedox Integrator process flow. It displays all preceding and all following components for the focused component.

To generate a FlowGraph, click on the Layout button in the component Integrator (see screenshot below). Here you have several options for displaying your FlowGraph within the component Integrator.

Note: the FlowGraph is only displayed in recent browser versions, e.g. in Firefox 50+ or higher or Microsoft Edge. See Platform Support Guide for supported browsers.

Navigation in Integrator

The Jedox Integrator makes it very easy to navigate step-by-step through an Integrator project. To show how this works, we will refer to the demo project “sampleBiker”. Navigate to the connection called “CustomerRegions_file”, using the screenshot below as a guide. Click on the “Layout” button and select “FlowGraph Right” from the drop-downlist of “Layout”.

You can click on each element of the modules “Connections”, “Extracts”, etc. in the tree on the left side to change your view, or you can select an element in the FlowGraph on the right side to go to that step.

Testing a component

Each component of a Jedox Integrator project can be tested individually. To do so, select a connection in the tree on the left side and click Test.

Preview data of an extract

For each Extract or Transform, the first lines of data can be displayed to check the accuracy of the data during the Modeling. Click on the FlowGraph component “Extract: File: CustomerRegions” in the sampleBiker project and click the Data Preview button.

Executing a job

The final stage of the execution of a Jedox Integrator process is carried out via a Job. To see a demonstration of an Integrator process, navigate to “Jobs – Standard – Cubedata” in “sampleBiker” (refer to the screenshot below). The following screen will appear:

Click Run. The result appears in the Monitor tab, as shown below.

This job shows an error, because it requires execution of the Initdata and Masterdata jobs to create the necessary dimensions.

Stopping the execution of a job

To stop the execution of a running job (Status “Running”) click on the Stop button (which is no longer active in the screenshot above) in the Integrator’s Monitor. Jedox Integrator will then try to terminate the execution of this job. After termination, the status is set to “Interrupted”.

Note: in some cases, stopping an execution may take a longer time (e.g. if a long-running request has been send to a source or target system). In this case, the status “Stopping” is displayed in the monitor. By clicking the Stop button a second time, an interrupt signal is sent to the thread of this execution. In most cases the execution will then be interrupted.

Scheduling a job

With the availability of the Scheduler component, Integrator jobs can be scheduled directly in Jedox Web without the use of a third-party tool. Select a job on the job overview page and then click the Schedule button:

The Task Wizard appears:

All previously settings can be changed later using the Scheduler component.

Integrator sample projects

A good way to get familiar with the Jedox Integrator functionality is to try out the sample projects. After the software installation, you will find two sample projects in the Integrator:

  • sampleBiker project: this project is helpful for getting a first impression of how to use Jedox Integrator for loading data to an OLAP database.
  • ETLTasks project: this is a rather complex project that includes jobs for some often-recurring general tasks, like DatabaseCopy, CubeAnonymize, etc.

Furthermore, there are other instructive samples that you can manually import into Jedox Integrator with the Import button. These sample projects can be found in <Install_path>\tomcat\webapps\etlserver\data\samples.

Backing up an Integrator project

Make sure you export your projects as XML files to create regular backups.

To export a project, right-click it in the Integrator Project list and select Export:

This allows you to restore your integrator project from backup in case it gets damaged.