Integrator Variables


Job execution can be parameterized with variables. The following example is a typical application: you want to import data for particular years independent of each other, such as all data for the year 2016 and then all monthly data for the year 2017.

Without the variable concept, you would have to create extracts, transforms, loads, and jobs separately for each year, or edit these manually each time. With the variable concept, however, only an extract that supports the year as a variable is necessary. To implement the Jedox Integrator process for a particular year, the variable for the job is changed, or a separate job is defined.

All variables are defined for the project globally with a name and a default value. The variables are replaced with the defined variable values during the execution of the job. In the case of non-defined variables, the default value of the variable is used.

Variables can be used anywhere during the modeling, such as in the SQL statement of a relational extract or in the filter of a cube extract.

Defining variables

In order to create a new variable, in the Navigation pane under the project name, right-click on Variables and select New. You will be prompted to give the variable a name. Click OK.

Now you can enter a description and a default value. Once the variable has been created, it can be edited like other components.

You can also enter a variable for a Jedox Integrator job that has been started via a web service call or a batch file. The command line would then look like this:

This value takes precedence over the default value. It also takes precedence over a variable value already defined in the job definition.

Below is the order of precedence for variables:

  1. Individual values that are set in Jedox Integrator Script Job (type Groovy or JavaScript) with API.setProperty method, or via loop sources in transform TableLoop and job Loop.
  2. Variables set in a subjob in the surrounding job.
  3. SOAP interface of the Jedox Integrator with addExecution  and runExecution methods, e.g.
    • from Jedox Web via PHP script in the Macro Engine.
    • Context variables in the command line client with option –c
  4. Fixed values of variables set in a Jedox Integrator job definition.
  5. Default values of variables in a Jedox Integrator project.

An example of how variables are used in the Jedox Integrator process can be found in the sample Jedox Integrator projects “sampleVariables” and “sampleLoopJob”.

Was this post helpful?
NoYes (-3 rating, 3 votes)