Getting Started with the Workflow Building Block


The Workflow Wizard guide the key user through the steps for create and maintain workflow. Return to Workflow Building Block Overview

The Workflow building block allows you to use Workflow in a custom application. This takes a few manual steps, but also brings pre-built Workflow functionality into your customized work environment. Workflow helps collect planning data (see article for more information).

To get familiar with the Workflow building block, you can install it with a sample configuration which includes sample data. You can find directions on how to configure the model with sample data in Setting Up the Workflow Building Block.

The model can also be set up without sample data. Follow the steps below to configure the workflow building block into your own custom application. Please note: this article assumes you, as a report designer, have already established your own custom application with a custom database and a custom root folder. Once you configure the workflow, a key user will take over daily operations.


1. Set up Building Block

Install the model without sample data. For directions, see Setting up Workflow Building Block.

Note: The Workflow Building Block needs a custom database and custom root folder to function. See Set Up Workflow Building Block.

2. Set up Languages

  1. Remove unnecessary languages from the model by going to Modeler > [Database Name] > Internationalization and selecting the language(s) you would like to remove and then Delete (-). Once the languages are removed from the model, attributes in the workbook using that language can be ignored. Columns that have been localized will have the attribute name followed by an @ symbol with the country code for the language in the format xx_XX. For example, attribute Label in the Version worksheet has localized columns Label@de_DE, Label@fr_FR, and Label@es_ES for translations in German, French, and Spanish respectively.
  2. To add a language go to Modeler > [Database Name] > Internationalization and then New (+) to select the language you would like to add from the menu. Once the new language has been added, go to the worksheet of the dimensions and cubes you would like to update with the translations for the new language. For example, to add a new column to the worksheet for the Version dimension of the Name attribute in Portuguese (Brazil), you’d add Name@pt_BR.

3. Copy Workflow Integrator to Global Projects

Copy Workflow Integrator from the Workflow building block and paste it in Global Projects.

4. Add Keys to Settings

Add the system.connection and system.database keys to your custom application Settings, see article.

5. Copy Reports from Workflow Building Block to Custom Application

Workflow reports must be manually transported to the custom root folder. Unnecessary folders can then be deleted, see full article.

6. Implement Workflow in Planning Reports

The Workflow building block offers workflow features to any arbitrary custom planning report implemented in the Jedox Report Designer. This article shows you how to implement it.

7. Publish Workflow Links

You publish Workflow links manually in Reports. First switch from the user view to design view. This allow you to create a new report hierarchy, into which you can move the following links: Administration Reports, Workflow Wizard, and My Workflow Activities.

8. Email Configuration


  1. Email notification for any workflow steps is required for you to contact your users about the workflow tasks they must complete. Below are a few points for you to remember when setting up email notification.
  2. Set up SMTP Mailer: to set up the SMTP mailer go to Administration > Settings > Global > Tasks >Smtp to update the values for the mailer. See Adjust Email Notification Settings for details.
  3. Configure User data: in Administration > Users, add the e-mail addresses and user groups for every member of the workflow. See Administration Component for details. Note: users should be set up with-in groups, see Assigning Activities to User Groups for details.
  4. Configure e-mail notifications: the Workflow Wizard will guide you through this process. Find out how in the Email notification section of the Workflow Wizard article.

9. Add Logo

Replace the Jedox logo within the web reports to your company logo. See full article.

10. Change Cell Styles

Modify the default cell styles within the web reports to your company style. See full article.

At this point basic configuration is complete!  The key user now takes over the daily operations of assigning workflow activities to user groups. The end users, who comprise these groups, advance these activities towards completion.

The following reports aid workflow management at the user level:

11. Workflow Wizard
The Workflow Wizard guides the key user through the steps to define the workflow, including both the creation and maintenance of tasks and activities. See full article.
12. Workflow Administration Report
The purpose of the Workflow Administration report is to set up, administrate, and monitor the workflow process. It is intended for the key user. See full article.
13. My Workflow Activities Report

The My Workflow Activities report guides end users through workflow progression. See full article