Rapidminer Monarch extension
Currently, the Rapidminer® Monarch™ extension is only compatible with
- Microsoft Windows and
- Rapidminer® AI Studio software.
The extension will not work together with Rapidminer® AI Hub software, nor with other operating systems.
This document provides a tutorial for using the Rapidminer Monarch extension in Rapidminer AI Studio.
Rapidminer Monarch is a market-leading, desktop-based, self-service data preparation solution. It helps you connect to multiple data sources, including cloud-based and big data. It helps you to cleanse and manipulate your data, both structured and unstructured. No coding is required.
The Rapidminer Monarch extension for Rapidminer AI Studio provides three operators:
- Execute Monarch,
- Monarch settings, and
- Open Monarch Workspace.
For installation instructions, see Adding Extensions.
Read more:
- For more documentation, see Rapidminer Monarch
- Via the Siemens Xcelerator Academy you can learn how to use Rapidminer Monarch Data Prep Studio.
System requirements
The system requirements are the following:
- Microsoft Windows OS
- Rapidminer AI Studio version 2024.0+
- Units license
Notes on Units
The Rapidminer Monarch extension runs the Rapidminer Monarch command-line tool on the back-end. The command-line tools check out the Units and release them once the execution is completed.
If you are using Rapidminer AI Studio together with an Units license, you should be able to use the same license configuration.
Tutorial
The following tutorial demonstrates how to use Rapidminer Monarch operators for loading, configuring, and running a Rapidminer Monarch Workspace.
Look at the process below. A PDF file containing semi-structured data is loaded. The data is extracted into a table and exported into an Excel file. Finally, the resulting Excel file is imported via the Read Excel operator, and the data is shown in the Results view.
Let’s look at the process and the operators involved. The Open File operator loads a Rapidminer Monarch workspace file and pipes it into the Open Monarch Workspace operator. To function, all other Rapidminer Monarch operators must be nested inside an Open Monarch Workspace operator. Double-click this operator to access its subprocess.
The actual call to Rapidminer Monarch Data Prep Studio happens via the Execute Monarch operator, which is configured by the Set Monarch Options operators.
The first Set Monarch Options operator overwrites the file path of the input PDF file in the workspace. This is useful, for example, if you have a workspace that you want to apply to different inputs on the fly. In our example, we want to apply the workspace to the current month's data, which we hardcoded to February.
The second Set Monarch Options operator tells Monarch that we want to export the "CurrentMonth" table to table "table1" of an Excel File called CurrentMonth.xlsx. Monarch looks at the file ending (".xlsx") of our file path and infers that we want Excel as the output file type. To export to other supported file formats, change the file ending.
After running the process, change to the log view to see the Rapidminer Monarch Data Prep Studio command line call that has been executed based on the process configuration.
Here, you can see the absolute paths of the files involved in this process. Open the Monarch Workspace dpwx file and the pdf input file to get an overview of how the Monarch workspace is configured.
Additional information
Other Monarch options are available from the "type" dropdown of the Set Monarch Options operator. The operator description provides details on all the possible options.
You can add as many options to a Monarch run as appropriate. For one run, you can define multiple input file paths and exports.
The Execute Monarch operator will provide additional ports as needed. Alternatively, the options ports also accept collections. Therefore, you can group your parameters to clean up your processes or even use loop operators and macros to create collections of options automatically.
The Open Monarch Workspace operator extracts metadata from the workspace and provides it to the inner operators to suggest table names, named exports, and runtime parameter names. Therefore, it is recommended that you connect its workspace port before configuring the subprocess. Please note that it can take some time to extract the metadata. You can inspect the progress at the bottom right of the Rapidminer AI Studio window.
For advanced users: The "command line argument" option type lets you directly specify one of the many command-line arguments the Rapidminer Monarch Data Prep Studio Command Line Interface accepts.