Using the Admin Tools Extension
Introduction
The extension connects Rapidminer® AI Studio software with a Rapidminer® AI Hub and allows you to deploy, run, and schedule processes on distant Rapidminer AI Hubs without writing any code.
Please note that this extension is meant to interact with a Rapidminer AI Hub via the provided API in a programmatic way. To learn how to directly work with projects and remote repositories, check the documentation or the Rapidminer® software Academy for an introduction video.
Install the Extension
To install the extension, go to the Extensions menu, open the 
Marketplace (Updates and Extensions), and search for Admin Tools. For more detail, see Adding extensions.
Connect to a Rapidminer AI Hub
To connect to a Rapidminer AI Hub, create a new Rapidminer AI Hub Connection Object in the repository. This allows you to manage connections centrally and reuse them between operators. The connection requires the following information:
- Rapidminer AI Hub URL
- Client Secret
- Refresh Token
Server URL
The Rapidminer AI Hub is reachable via this URL—it should be the same as the one used to connect to projects or the web interface. For example www.aihub.com
Client Secret and Refresh Token
These two tokens are required to connect to the Rapidminer AI Hub via the API. The two values can be found on a special page of the Rapidminer AI Hub that's simply called /get-token, so for example https://aihub.com/get-token/.
There are two fields called OFFLINE_TOKEN and SSO_CLIENT_SECRET. These values go into the connection object.
Note: The quotation marks are not needed.
Examples
The extension currently supports the following API methods via operators:
- Edit Acess Rights
- Get Jobs (Rapidminer AI Hub)
- Get Schedules (Rapidminer AI Hub)
- Schedule Job (Rapidminer AI Hub)
- Read Log (Rapidminer AI Hub)
- Kill Job (Rapidminer AI Hub)
- Get JWT (Rapidminer AI Hub)
- Get Metrics (Rapidminer AI Hub)
- Deploy Project (Rapidminer AI Hub)
Deploy Project
The operator Deploy Project (Rapidminer AI Hub) allows you to move an entire project from one Rapidminer AI Hub to another. This is very useful in a scenario where you run two different Rapidminer AI Hubs -- one for development and one for production. You can now move the project over with just a single operator. As you know, projects are backed by Git and Git LFS, so you can of course roll back to previous versions as you like.
Run Job
The Run Job operator allows you to use one central Rapidminer AI Hub which executes the same process on other Hubs, even remote Rapidminer AI Hubs located in different production sites or geographies. As usual, the operator is using the connection framework which is integrated in the central access control mechanisms and can use technologies like LDAP and Active Directory.
Get Jobs
The Get Jobs operator retrieves a list of all jobs that have been executed on a Rapidminer AI Hub. This is exactly the same information that is viewed on the Executions page within the Rapidminer AI Hub web interface. For each job, the resulting ExampleSet shows its job id, queue, location, state, owner id, duration (in milliseconds), used memory (in kb), max memory of the container (in kb), an error flag, and the dates and times of when the job was created, dequeued, started in the job container, and finished. This is very helpful when creating logs and monitoring multiple Rapidminer AI Hub instances.
