Setting Up Workflow Building Block

Return to Workflow Building Block Overview

The Workflow building block is a tool that, with a few manual steps, brings workflow functionality into your custom application. Workflow optimizes the collection of planning data by restricting report write access to certain time frames. The Workflow building block is available in the Jedox Marketplace.

Installing the Workflow Building Block from the Jedox Marketplace

  1. In Jedox Web, open the Marketplace panel. Select "Install" for the Workflow building block.
    Note: for models that are already installed locally, the user will be shown an “Open” button, which will open the model’s reports.
  2. The Install Package wizard shows the mandatory and optional packages for the Workflow building block:

    The Workflow building block comes with the extension package Workflow - Sample Data, which is selected for installation by default. This package contains dimension elements and figures for demonstration and education purposes. This sample data extension package is optional and can be turned off. Without the sample data, the model is ready to be configured to customer-specific needs, but before configuration, most cubes and reports will appear empty and may display errors.
    Click “Next >>”.
  3. The next page shows the license agreement for this package. The acceptance of the license agreement is mandatory to continue with the installation. Select “I accept the agreement” and click “Next >>”.
  4. The last wizard page shows a summary of the packages selected for installation and the chosen action (install, upgrade, or uninstall). Click “Finish” to start the installation procedure
  5. During installation, the wizard prompts for the custom in-memory database name:



    Accept the default database name or enter any other database name. If the database does not exist prior to the installation, it will be automatically created and populated with all database objects (such as dimensions, cubes, rules, etc.) that come with the installed packages. If the database does already exist, any missing database objects will be automatically created. If any of these objects already exist (e.g. because the same or another model sharing the same objects has been installed previously on that database), the creation of that object is skipped without any error. Multiple models installed on the same OLAP database can share their configuration and benefit from integration between cubes.

    The name of the in-memory database for a model is saved in the model setting system.database. For more information, see Models (Platform).

Repairing an installed model

An installed model that has been damaged can be repaired with the Repair Package wizard, which essentially performs an uninstallation followed by an installation on the same database.

  1. Export all added or modified files in the Models file group in Report Designer. The update will completely remove and replace the file group. Repeat for added or modified elements in Scheduler and Integrator. Added database objects and data in the in-memory database will remain unless they are part of the packages being updated.
  2. In Jedox Web, open the My Models panel. Right-click on the Workflow building block and select “Repair”.
  3. The Repair Package wizard shows the packages to be repaired with status “Repair”. Click “Next >>”.
  4. The last wizard page shows a summary of the packages selected for repair and the action "Repair". Click “Finish”.
  5. Restore the files, tasks, and projects saved in step 1. For modified web reports, such as /Models/Workflow/WorkflowAdministration.wss, restore only a single file at a time using import or drag-and-drop. Do not restore multiple files or import a *.pb file, because this procedure would recreate the restored files with a new internal ID, thus breaking the links between multiple web reports.

Uninstalling the Workflow Building Block

  1. In Jedox Web open the My Models panel. Right-click on the Workflow building block and select “Uninstall”.
  2. The Change Package wizard shows the packages to be removed with status “Uninstall”. Click “Next >>”.
  3. The last wizard page shows a summary of the packages selected for uninstallation and the action "Uninstall". Click “Finish”.
  4. The above procedure removes the model from Reports, Report Designer, Scheduler, Integrator, and Administration Settings. However, the in-memory database is not removed. If the database is not used anymore by the custom application and its data can be removed, this must be done manually. To do so, open the Modeler panel, right-click on the database, and select “Delete …”.

Updated September 25, 2024