---
title: "Custom Job Engine Setup"
slug: "custom-job-engine-setup-1"
description: "This involves installing a job engine to a machine within the users infrastructure. The job engine can connect to the cloud portal."
updated: 2025-03-11T10:53:46Z
published: 2025-03-11T10:53:46Z
canonical: "knowledge.curiositysoftware.ie/custom-job-engine-setup-1"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://knowledge.curiositysoftware.ie/llms.txt
> Use this file to discover all available pages before exploring further.

# Linux - Native Job Engine Setup

The Native job engine is utilised for connecting to local resources within an organisation’s infrastructure. This can be used from a Cloud or On-Premise Quality Modeller deployment.

This article covers installing the job engine to a Linux environment / native environment.

### **1. Prerequisites**

- Install .NET 6 - Below are commands for Ubuntu Linux. We recommend following the official Microsoft guide for other distributions.

```custom
sudo apt-get update

sudo apt-get install -y dotnet-sdk-8.0
```

Verify dotnet has installed correctly, and available on the system path.

```custom
verify – dotnet -version
```

- Download the Job server (request download link from Curiosity)

**(Optional) If running automation**

- Chrome web browser
- Install JDK - 21

```custom
sudo apt-get install openjdk-21-jdk
```

Verify Java is installed and available on the path.

```custom
java -version
```

We also recommend setting the JAVA_HOME environment variable.

```custom
sudo update-alternatives --config java

export JAVA_HOME=/path/to/java/home
```

- Install Maven

```custom
sudo apt-get update

sudo apt-get install maven
```

Verify maven is installed and available on the path.

```custom
mvn -version
```

### 2. **Installation**

Firstly, let’s install the job engine and configure connectivity to your Quality Modeller instance.

1 – Download the package and unzip it to your chosen location.

```custom
unzip modellerjobengine.zip
```

2 – Edit KafkaJobEngine.Net5.dll.config. This is an xml file which defines the configuration settings for the JobEngine service.

You will need to change the following values for your instance of modeller;

- APIEndpoint – The URL of the API endpoint
- TDMAPIEndpoint – The URL of the TDM API endpoint. Typically, this is the same as the APIEndpoint.
- MetaAPIEndpoint – The URL of the Meta API Endpoint. Typically, this is the same as the APIEndpoint.
- APIKey – The API Key to use for authentication against the selected workspace.
- KafkaEndpoint – The kafka URL.
- MavenLocation – Maven location
- DotNetLocation – Dotnet location
- MachineKey – A unique machine key for the workspace.

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1691599522689.png)

3 – Once configured head to the root folder and run the instance

```custom
dotnet KafkaJobEngine.Net5.dll
```

4 - On initial execution if all has been successful a command window will be displayed which shows the KafkaJobEngine running. If there are any errors, they will be displayed in the console window. Below shows a successful series of messages.

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1691595878988.png)

### **3. Verify Connectivity**

Next, we will verify the job engine has connectivity to the modeller instance. Navigate to Profile, and then select Automation Servers from the menu.

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1728293513110.png)

The job engine should be displayed under the Workspace Servers page.

![](https://cdn.document360.io/77f722a6-2d0a-49fa-8074-572515a6c4b8/Images/Documentation/image-1728293604781.png)

### **4. Install as a Service**

The job engine is now up and running whenever you run the executable. Next, we will install the job engine as a service. This will mean that you do not need to run the executable directly,

Head to the Linux folder, in the ServiceScripts package. Here you will need to edit the modeller_job_engine.service to match the installation location of the relevant packages. Once configured you can run the shell scripts to install, start, stop, and review the status of the service.

![](blob:https://portal.document360.io/016a5c52-e4be-4e67-b776-f47054c34bb8)

## Related

- [Automating Tests](/automating-and-executing-tests-in-test-modeller.md)