Skip to main content
Pentaho Documentation

Build Model (job entry)


Quisque mattis rutrum ligula et pellentesque. Pellentesque massa enim, pulvinar quis quam quis, aliquet dapibus augue. Aliquam feugiat suscipit turpis, nec ultrices dolor adipiscing ut.

The Build Model job entry can be used to create Data Source Wizard data sources, which includes both a Metadata and a Mondrian model. It works by searching upstream for a output step to base the model on, or you can select an existing DSW or Analysis model from the BA Server to base your model on. 

After you have run this job entry, a data model is created and can be published to the BA Server for the creation of Analysis reports in the Pentaho User Console. Business users will also be able to refine the data model with the Data Model Editor. If you selected an Analysis model to build from, the Build Model step will only create an Analysis model.

These are the operations that happen during the Build Model job entry.

  1. Builds the model.
  2. Sets variables into the job that can be modified or picked up by the Publish Model job entry.

Here is an example workflow.


After the Build Model job runs successfully, you can publish the data source to the BA Server.

Creating a Build Model Job Entry

This section describes how to set up the Build Model job entry.


  1. Locate the Build Model entry from the Design pane in PDI.
  2. Drag and drop the Build Model icon onto the transformation canvas.
    You can also double-click on icons in the Design pane to add them to the canvas.
  3. Double-click the Build Model icon to open the dialog box.
  4. Fill out the information in the dialog box:
    1. Entry Name - type a name for your entry in this field.
    2. Output Step - choose an output step from the drop-down menu, or use CTRL + Space to select a variable.
    3. Model Name - type a name for your data model in this field.
  5. Choose either Auto Model or Use Existing in the Modeling Method panel.
  6. Click OK to continue or Cancel to close the dialog box.

This is an example of the Build Model dialog box, along with a table that has more details about each field.


Options Description
Entry Name Type to enter the name of the job entry here.
Note: The following characters are not allowed in Data Source Wizard source names: %/:[]*|\t\r\n
Output Step Enter the output step here. You can use the drop-down menu to select the output step that you want to use.
Note: If there is no data written in the table by the output step, the Build Model entry won’t be able to build a model.
Model Name Enter the name for the model here. You can click in this field and enter CTRL-Space to get a list of variables for this.
The model name will appear in the BA Server in the list of data sources.
Modeling Method: Auto Model or Use Existing Select the Auto Model option if you want to build a new model. Select the Use Existing option if you want to base your model on one that already exists in the BA Server. If you select Use Existing, there must be a model name in the field.
Help Provides a link to the Help documentation.
OK Click OK to save.
Cancel Click Cancel to close the window.

Selecting Existing Model Options

If you selected to use an existing model to build upon, you will need to be connected to the BA Server. Once you are connected, you can select an existing model with the same physical schema to base your new model on.

  1. If the BA Server Connection information is not populated, fill in these fields to make the connection.
    1. Enter the URL for the BA Server.
    2. Enter the User Name and Password for the BA Server.
    3. Click the Connect button. If the connection was successful, the Existing Models menu will populate with a list of models to choose from.
  2. Select a model from the drop-down menu. If no models are listed, verify that you are connected to the BA Server.
  3. Click OK to save the changes, or Cancel to exit.

This is an example of the Select Existing Model dialog box, along with a table that has more details about each field.


Options Description
URL Enter the URL to the BA Server.
User Name Type the user name for the BA Server.
Password Enter the password.
Connect Establishes a connection to the BA Server to retrieve a list of available data models.
Existing Models Populates with a list of available models.
Create model if not found Generates an auto model, if unable to find an existing model with the entered name.
Help Provides a link to the Help documentation.
OK Click OK to save.
Cancel Click Cancel to discard entries and close the window.

Variables for Build Model Job Entry

You can only see these specific variables for the Build Model job entry if you press CTRL + Space after the first run.

Variable Definition
JobEntryBuildModel.DatabaseConnection.<Model Name> Name of database connection to deploy from PDI into BA Server.
JobEntryBuildModel.XMI.<Model Name> XMI contents of model to publish (may or may not contain the OLAP components).
JobEntryBuildModel.XMI.DSW.<Model Name> Shows that XMI should be deployed as a Data Source Wizard data source instead of a Metadata data source.