### GET /kettle/startTrans - Start Transformation

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Starts execution of a registered transformation.

```APIDOC
## GET /kettle/startTrans

### Description
Starts execution of a registered transformation.

### Method
GET

### Endpoint
/kettle/startTrans

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **id** (string) - Optional - Transformation ID.
- **xml** (boolean) - Optional - Output format.
```

--------------------------------

### GET /kettle/startExec - Start Transformation Execution

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Starts execution of a prepared transformation.

```APIDOC
## GET /kettle/startExec

### Description
Starts execution of a prepared transformation.

### Method
GET

### Endpoint
/kettle/startExec

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **id** (string) - Optional - Transformation ID.
- **xml** (boolean) - Optional - Output format.
```

--------------------------------

### Start Carte with Configuration

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Start the Carte server using a specified configuration file. This command initiates the server with the defined settings.

```bash
./carte.sh carte-config.xml
```

--------------------------------

### Install libwebkitgtk on Ubuntu

Source: https://github.com/pentaho/pentaho-kettle/blob/master/assemblies/static/src/main/resources/README.txt

Run this command on Ubuntu 16.04 and later to install the necessary libwebkitgtk package for Spoon.

```bash
apt-get install libwebkitgtk-1.0.0
```

--------------------------------

### Install libwebkitgtk on CentOS

Source: https://github.com/pentaho/pentaho-kettle/blob/master/assemblies/static/src/main/resources/README.txt

Run this command on CentOS 6 Desktop to install the required libwebkitgtk package.

```bash
yum install libwebkitgtk
```

--------------------------------

### Install Metaverse Core Integration Tests

Source: https://github.com/pentaho/pentaho-kettle/blob/master/plugins/kafka/README.md

Before running integration tests for this project, install the necessary integration test artifacts from the pentaho-metaverse-core project. Navigate to the core directory and run 'mvn install -DrunITs'.

```bash
cd <parentDir>/pentaho-metaverse/core
mvn install -DrunITs
```

--------------------------------

### GET /kettle/prepareExec - Prepare Transformation Execution

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Prepares a transformation for execution without starting it.

```APIDOC
## GET /kettle/prepareExec

### Description
Prepares a transformation for execution without starting it.

### Method
GET

### Endpoint
/kettle/prepareExec

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **id** (string) - Optional - Transformation ID.
- **xml** (boolean) - Optional - Output format.
```

--------------------------------

### Incomplete Get String Call

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

An example of an incomplete call to NotToBeDetectedMessages.get_String. This snippet is not functional and serves as a placeholder or an example of a syntax error.

```java
ypto( NotToBeDetectedMessages.get_String( PKG,
```

--------------------------------

### Build Pentaho Data Integration with Maven

Source: https://github.com/pentaho/pentaho-kettle/blob/master/README.md

Use this command to clean and install the project. The build result will be a Pentaho package located in the target directory.

```bash
$ mvn clean install
```

--------------------------------

### XML Serialization Example

Source: https://github.com/pentaho/pentaho-kettle/blob/master/engine/src/main/java/org/pentaho/di/core/util/serialization/README.md

Illustrates the structure of XML output generated by the MetaXmlSerializer for step properties. This format is used for saving and loading step configurations.

```xml
<step-props>
      <group name="some_group">
        <property name="Prop1">
          <value xsi:type="xs:string">value</value>
        </property>
        <property name="isLarge">
          <value xsi:type="xs:boolean">false</value>
        </property>
      </group>
    </step-props>
```

--------------------------------

### Run Integration Tests with Maven

Source: https://github.com/pentaho/pentaho-kettle/blob/master/plugins/kafka/README.md

This command runs integration tests. Ensure integration test artifacts from pentaho-metaverse-core are installed first.

```bash
mvn verify -DrunITs
```

--------------------------------

### BaseMessages Incomplete Source Example

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

An example of an incomplete BaseMessages.getString call, showing a malformed method name and missing arguments. This snippet highlights potential errors.

```java
BaseMessages Incomplete source: + ypto( BaseMessages.get_String( PKG,


```

--------------------------------

### Sample Carte Configuration

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

A sample carte configuration file demonstrating server settings, including authentication credentials and object timeouts. This file is used to start the Carte server.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<slave_config>
  <slaveserver>
    <name>Carte-Server</name>
    <hostname>localhost</hostname>
    <port>8080</port>
    <username>admin</username>
    <password>password</password>
    <master>N</master>
  </slaveserver>
  <max_log_lines>10000</max_log_lines>
  <max_log_timeout_minutes>1440</max_log_timeout_minutes>
  <object_timeout_minutes>1440</object_timeout_minutes>
</slave_config>
```

--------------------------------

### getString with Varied Spacing (Five Lines)

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Examples of SomeOtherMessages.getString calls spanning five lines, showcasing extreme variations in formatting. These examples test the limits of whitespace tolerance.

```java
SomeOtherMessages Five lines  1: + ypto( SomeOtherMessages
.
 	 	 getString
 	 	      (
  	 PKG, "someothermessages_getstring_pkg.lines.05.scenario.01" ) );
```

```java
SomeOtherMessages Five lines  2: + ypto( SomeOtherMessages.	
 	 	 getString	
 	 	      (  	 
	PKG
	, "someothermessages_getstring_pkg.lines.05.scenario.02" ) );
```

--------------------------------

### Enable Debug Logging

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Start Carte with debug logging enabled to aid in troubleshooting. Use the '-l DEBUG' flag for verbose logging output.

```bash
./carte.sh carte-config.xml -l DEBUG
```

--------------------------------

### GET /kettle/runTrans - Run Transformation

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Runs a transformation asynchronously.

```APIDOC
## GET /kettle/runTrans

### Description
Runs a transformation asynchronously.

### Method
GET

### Endpoint
/kettle/runTrans

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **id** (string) - Optional - Transformation ID.
- **xml** (boolean) - Optional - Output format.
```

--------------------------------

### Run Integration Tests in Pentaho Data Integration

Source: https://github.com/pentaho/pentaho-kettle/blob/master/README.md

This command executes integration tests that verify cross-module operations. Ensure you have the necessary prerequisites installed.

```bash
$ mvn verify -DrunITs
```

--------------------------------

### Skip Tests During Build

Source: https://github.com/pentaho/pentaho-kettle/blob/master/README.md

Use the `-DskipTests` flag to bypass test execution during the clean and install process.

```bash
$ mvn clean install -DskipTests
```

--------------------------------

### GET /kettle/status - Get Server Status

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Retrieves comprehensive server status including system information, running transformations, and jobs.

```APIDOC
## GET /kettle/status

### Description
Retrieves comprehensive server status including system information, running transformations, and jobs.

### Method
GET

### Endpoint
/kettle/status

### Parameters
#### Query Parameters
- **xml** (boolean) - Optional - Output format. `Y` for XML, HTML otherwise.

### Response
#### Success Response (200)
- **status** (object) - Server status including memory usage, CPU information, running transformations and jobs, and system information.

### Request Example
```bash
curl "http://localhost:8080/kettle/status?xml=Y"
```
```

--------------------------------

### GET /kettle/transImage - Get Transformation Image

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Retrieves a visual representation (image) of the transformation.

```APIDOC
## GET /kettle/transImage

### Description
Retrieves a visual representation (image) of the transformation.

### Method
GET

### Endpoint
/kettle/transImage

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **id** (string) - Optional - Transformation ID.

### Response
#### Success Response (200)
- **image** (binary) - PNG image of the transformation flow.
```

--------------------------------

### Get String - Three Lines

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Retrieves a string message using a three-line call to NotToBeDetectedMessages.getString. This formatting can be used for complex code structures or specific style guides.

```java
ypto( NotToBeDetectedMessages
 	 .getString(
  	 PKG, "nottobedetectedmessages_getstring_pkg.lines.03.scenario.01" ) );
```

```java
ypto( NotToBeDetectedMessages
    .
 	       getString(  	 PKG, "nottobedetectedmessages_getstring_pkg.lines.03.scenario.02" ) );
```

```java
ypto( NotToBeDetectedMessages. 	 getString
  (  PKG, "nottobedetectedmessages_getstring_pkg.lines.03.scenario.03" ) );
```

--------------------------------

### GET /kettle/cleanupTrans - Cleanup Transformation

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Cleans up resources used by a transformation.

```APIDOC
## GET /kettle/cleanupTrans

### Description
Cleans up resources used by a transformation.

### Method
GET

### Endpoint
/kettle/cleanupTrans

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **id** (string) - Optional - Transformation ID.
- **xml** (boolean) - Optional - Output format.
```

--------------------------------

### Unit Test with RestorePDIEnvironment Rule

Source: https://github.com/pentaho/pentaho-kettle/blob/master/README.md

Example of a unit test using the `RestorePDIEnvironment` ClassRule for maintaining a healthy test environment. Ensure the rule is correctly applied.

```java
public class MyTest {
  @ClassRule public static RestorePDIEnvironment env = new RestorePDIEnvironment();
  #setUp()...
  @Test public void testSomething() { 
    assertTrue( myMethod() ); 
  }
}
```

--------------------------------

### GET /kettle/executeTrans - Execute Transformation

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Executes a transformation synchronously and returns results.

```APIDOC
## GET /kettle/executeTrans

### Description
Executes a transformation synchronously and returns results.

### Method
GET

### Endpoint
/kettle/executeTrans

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **id** (string) - Optional - Transformation ID.
- **xml** (boolean) - Optional - Output format.
```

--------------------------------

### GET /kettle/transStatus - Get Transformation Status

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Retrieves status of a specific transformation.

```APIDOC
## GET /kettle/transStatus

### Description
Retrieves status of a specific transformation.

### Method
GET

### Endpoint
/kettle/transStatus

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **id** (string) - Optional - Transformation ID.
- **xml** (boolean) - Optional - Output format.
- **from** (integer) - Optional - Starting log line number.
- **sendResult** (boolean) - Optional - Include execution results.

### Response
#### Success Response (200)
- **status** (object) - Transformation status including execution status, step statuses, log information, and performance metrics.

### Request Example
```bash
curl "http://localhost:8080/kettle/transStatus?name=my-transformation&xml=Y"
```
```

--------------------------------

### GET /kettle/registerTrans - Register Transformation

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Registers a transformation from repository or file system.

```APIDOC
## GET /kettle/registerTrans

### Description
Registers a transformation from repository or file system.

### Method
GET

### Endpoint
/kettle/registerTrans

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **xml** (boolean) - Optional - Output format.
```

--------------------------------

### Incomplete getString Call

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

An example of an incomplete call to SomeOtherMessages.get_String, indicating a potential syntax error or unfinished code. This snippet is not functional as presented.

```java
SomeOtherMessages Incomplete source: + ypto( SomeOtherMessages.get_String( PKG,



```

--------------------------------

### BaseMessages getString Three Line Scenarios

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Shows examples of BaseMessages.getString calls spanning three lines with different formatting. Ensure the package and message key are accurate.

```java
BaseMessages Three lines  1: + ypto( BaseMessages
 			 .getString(
  	 PKG, "basemessages_getstring_pkg.lines.03.scenario.01" ) );
```

```java
BaseMessages Three lines  2: + ypto( BaseMessages
    .
 			 getString(  	 PKG, "basemessages_getstring_pkg.lines.03.scenario.02" ) );
```

```java
BaseMessages Three lines  3: + ypto( BaseMessages. 	 getString
  ( 	 PKG, "basemessages_getstring_pkg.lines.03.scenario.03" ) );
```

--------------------------------

### Execute a Job with curl

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Manage jobs using curl commands. This includes starting, checking status, and stopping jobs. Ensure the job name is correct.

```bash
# Start a job
curl "http://localhost:8080/kettle/startJob?name=my-job&xml=Y"
```

```bash
# Check job status
curl "http://localhost:8080/kettle/jobStatus?name=my-job&xml=Y"
```

```bash
# Stop the job
curl "http://localhost:8080/kettle/stopJob?name=my-job&xml=Y"
```

--------------------------------

### Execute a Transformation with curl

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Manage transformations using curl commands. This includes starting, checking status, and stopping transformations. Ensure the transformation name is correct.

```bash
# Start a transformation
curl "http://localhost:8080/kettle/startTrans?name=my-transformation&xml=Y"
```

```bash
# Check transformation status
curl "http://localhost:8080/kettle/transStatus?name=my-transformation&xml=Y"
```

```bash
# Stop the transformation
curl "http://localhost:8080/kettle/stopTrans?name=my-transformation&xml=Y"
```

--------------------------------

### BaseMessages getString Five Line Scenarios

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Examples of BaseMessages.getString calls spread across five lines with extensive whitespace. Ensure the package and message key are accurate.

```java
BaseMessages Five lines  1: + ypto( BaseMessages
.
 			 getString
 			      (
  	 PKG, "basemessages_getstring_pkg.lines.05.scenario.01" ) );
```

```java
BaseMessages Five lines  2: + ypto( BaseMessages.	
 			 getString	
 			      (  	 
	PKG
	, "basemessages_getstring_pkg.lines.05.scenario.02" ) );
```

--------------------------------

### getString with Varied Spacing (Seven Lines)

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Shows SomeOtherMessages.getString calls spanning seven lines, representing the most complex formatting variations. These examples highlight the flexibility in method invocation syntax.

```java
SomeOtherMessages Seven lines  1: + ypto( SomeOtherMessages
.
 	 	 getString
 	 	      (
  	 PKG
  ,
"someothermessages_getstring_pkg.lines.07.scenario.01" ) );
```

--------------------------------

### GET /kettle/pauseTrans - Pause Transformation

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Pauses execution of a running transformation.

```APIDOC
## GET /kettle/pauseTrans

### Description
Pauses execution of a running transformation.

### Method
GET

### Endpoint
/kettle/pauseTrans

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **id** (string) - Optional - Transformation ID.
- **xml** (boolean) - Optional - Output format.
```

--------------------------------

### GET /kettle/stopCarte - Stop Carte Server

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Gracefully shuts down the Carte server.

```APIDOC
## GET /kettle/stopCarte

### Description
Gracefully shuts down the Carte server.

### Method
GET

### Endpoint
/kettle/stopCarte

### Parameters
#### Query Parameters
- **xml** (boolean) - Optional - Output format.

### Response
#### Success Response (200)
- **message** (string) - Confirmation of shutdown request.
```

--------------------------------

### GET /kettle/removeTrans - Remove Transformation

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Removes a transformation from the server.

```APIDOC
## GET /kettle/removeTrans

### Description
Removes a transformation from the server.

### Method
GET

### Endpoint
/kettle/removeTrans

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **id** (string) - Optional - Transformation ID.
- **xml** (boolean) - Optional - Output format.
```

--------------------------------

### GET /kettle/stopTrans - Stop Transformation

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Stops execution of a running transformation.

```APIDOC
## GET /kettle/stopTrans

### Description
Stops execution of a running transformation.

### Method
GET

### Endpoint
/kettle/stopTrans

### Parameters
#### Query Parameters
- **name** (string) - Required - Transformation name.
- **id** (string) - Optional - Transformation ID.
- **xml** (boolean) - Optional - Output format.
```

--------------------------------

### Get Server Status with curl

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Retrieve the server status using curl. Supports both XML and HTML formats. Ensure the server is running and accessible.

```bash
# Get status in XML format
curl "http://localhost:8080/kettle/status?xml=Y"
```

```bash
# Get status in HTML format
curl "http://localhost:8080/kettle/status"
```

--------------------------------

### Get String - Five Lines

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Retrieves a string message using a five-line call to NotToBeDetectedMessages.getString. This demonstrates extreme line breaks for method arguments.

```java
ypto( NotToBeDetectedMessages
.
 	       getString
 	            (
  	 PKG, "nottobedetectedmessages_getstring_pkg.lines.05.scenario.01" ) );
```

```java
ypto( NotToBeDetectedMessages.	
 	       getString	
 	            (  	 
	PKG
	, "nottobedetectedmessages_getstring_pkg.lines.05.scenario.02" ) );
```

--------------------------------

### Get String - One Line

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Retrieves a string message using a single-line call to NotToBeDetectedMessages.getString. Ensure PKG and the message key are correctly provided.

```java
ypto( NotToBeDetectedMessages.getString  	 ( PKG, "nottobedetectedmessages_getstring_pkg.lines.01.scenario.01" ) );
```

```java
ypto( NotToBeDetectedMessages.getString  	 ( PKG, "nottobedetectedmessages_getstring_pkg.lines.01.scenario.02" ) );
```

```java
ypto( NotToBeDetectedMessages.getString(    PKG, "nottobedetectedmessages_getstring_pkg.lines.01.scenario.03" ) );
```

```java
ypto( NotToBeDetectedMessages.getString(  	  PKG, "nottobedetectedmessages_getstring_pkg.lines.01.scenario.04" ) );
```

```java
ypto( NotToBeDetectedMessages.getString  	 ( PKG, "nottobedetectedmessages_getstring_pkg.lines.01.scenario.05" ) );
```

```java
ypto( NotToBeDetectedMessages.getString( PKG, "nottobedetectedmessages_getstring_pkg.lines.01.scenario.06" ) );
```

```java
ypto( NotToBeDetectedMessages.getString(  	  PKG, "nottobedetectedmessages_getstring_pkg.lines.01.scenario.07" ) );
```

--------------------------------

### Get Server Status with XML Output

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Use this cURL command to retrieve comprehensive server status information in XML format. This includes system details, memory usage, CPU information, and lists of running transformations and jobs.

```bash
curl "http://localhost:8080/kettle/status?xml=Y"
```

--------------------------------

### Job Management API

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Endpoints for managing and interacting with Kettle jobs, including adding, registering, starting, stopping, removing, executing, and retrieving job status and images.

```APIDOC
## POST /kettle/addJob

### Description
Uploads and registers a job for execution.

### Method
POST

### Endpoint
/kettle/addJob

### Request Body
- Job XML content (required) - The XML definition of the job to be uploaded.

### Response
- Job ID and status
```

```APIDOC
## GET /kettle/registerJob

### Description
Registers a job from the repository or file system.

### Method
GET

### Endpoint
/kettle/registerJob

### Query Parameters
- **name** (string) - Required - The name of the job to register.
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.
```

```APIDOC
## GET /kettle/jobStatus

### Description
Retrieves the status of a specific job.

### Method
GET

### Endpoint
/kettle/jobStatus

### Query Parameters
- **name** (string) - Required - The name of the job.
- **id** (string) - Optional - The ID of the job execution.
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.
- **from** (integer) - Optional - The starting log line number to retrieve.

### Response
- Job status including execution status, job entry statuses, log information, and performance metrics.

### Request Example
```bash
curl "http://localhost:8080/kettle/jobStatus?name=my-job&xml=Y"
```
```

```APIDOC
## GET /kettle/startJob

### Description
Starts the execution of a registered job.

### Method
GET

### Endpoint
/kettle/startJob

### Query Parameters
- **name** (string) - Required - The name of the job to start.
- **id** (string) - Optional - The ID of the job execution.
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.
```

```APIDOC
## GET /kettle/stopJob

### Description
Stops the execution of a running job.

### Method
GET

### Endpoint
/kettle/stopJob

### Query Parameters
- **name** (string) - Required - The name of the job to stop.
- **id** (string) - Optional - The ID of the job execution.
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.
```

```APIDOC
## GET /kettle/removeJob

### Description
Removes a job from the server.

### Method
GET

### Endpoint
/kettle/removeJob

### Query Parameters
- **name** (string) - Required - The name of the job to remove.
- **id** (string) - Optional - The ID of the job execution.
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.
```

```APIDOC
## GET /kettle/executeJob

### Description
Executes a job synchronously and returns results.

### Method
GET

### Endpoint
/kettle/executeJob

### Query Parameters
- **name** (string) - Required - The name of the job to execute.
- **id** (string) - Optional - The ID of the job execution.
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.
```

```APIDOC
## GET /kettle/runJob

### Description
Runs a job asynchronously.

### Method
GET

### Endpoint
/kettle/runJob

### Query Parameters
- **name** (string) - Required - The name of the job to run.
- **id** (string) - Optional - The ID of the job execution.
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.
```

```APIDOC
## GET /kettle/jobImage

### Description
Retrieves a visual representation (image) of the job.

### Method
GET

### Endpoint
/kettle/jobImage

### Query Parameters
- **name** (string) - Required - The name of the job.
- **id** (string) - Optional - The ID of the job execution.

### Response
- PNG image of the job flow.
```

--------------------------------

### Get String - Six Lines

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Retrieves a string message using a six-line call to NotToBeDetectedMessages.getString. This showcases extensive line breaks for method arguments.

```java
ypto( NotToBeDetectedMessages
.
 	       getString
 	            (
  	 PKG
  	 ,         "nottobedetectedmessages_getstring_pkg.lines.06.scenario.01" ) );
```

```java
ypto( NotToBeDetectedMessages

.
 	       getString
 	            (
  	 PKG  	 ,		 "nottobedetectedmessages_getstring_pkg.lines.06.scenario.02" ) );
```

```java
ypto( NotToBeDetectedMessages


. 	 getString
 	            (
  	 PKG  	 ,		 "nottobedetectedmessages_getstring_pkg.lines.06.scenario.03" ) );
```

--------------------------------

### Get String - Seven Lines

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Retrieves a string message using a seven-line call to NotToBeDetectedMessages.getString. This demonstrates the maximum line break usage for method arguments shown.

```java
ypto( NotToBeDetectedMessages
.
 	       getString
 	            (
  	 PKG
  ,
"nottobedetectedmessages_getstring_pkg.lines.07.scenario.01" ) );
```

--------------------------------

### Get String - Four Lines

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Retrieves a string message using a four-line call to NotToBeDetectedMessages.getString. This extended formatting is typically for very specific code layout requirements.

```java
ypto( NotToBeDetectedMessages
.
 	       getString(
  	 PKG, "nottobedetectedmessages_getstring_pkg.lines.04.scenario.01" ) );
```

```java
ypto( NotToBeDetectedMessages	.		
 	       getString
			 (
  	 PKG, "nottobedetectedmessages_getstring_pkg.lines.04.scenario.02" ) );
```

```java
ypto( NotToBeDetectedMessages .
 	       getString
			 (  	 PKG
			 , "nottobedetectedmessages_getstring_pkg.lines.04.scenario.03" ) );
```

--------------------------------

### Get String - Two Lines

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Retrieves a string message using a two-line call to NotToBeDetectedMessages.getString. This format is useful for improving readability with longer message keys or when code formatting requires it.

```java
ypto( NotToBeDetectedMessages 	 
       . getString	( PKG, "nottobedetectedmessages_getstring_pkg.lines.02.scenario.01" ) );
```

```java
ypto( NotToBeDetectedMessages.
           getString( PKG, "nottobedetectedmessages_getstring_pkg.lines.02.scenario.02" ) );
```

```java
ypto( NotToBeDetectedMessages.getString
     ( PKG, "nottobedetectedmessages_getstring_pkg.lines.02.scenario.03" ) );
```

```java
ypto( NotToBeDetectedMessages.getString(
 	 PKG, "nottobedetectedmessages_getstring_pkg.lines.02.scenario.04" ) );
```

```java
ypto( NotToBeDetectedMessages.getString( PKG
,  "nottobedetectedmessages_getstring_pkg.lines.02.scenario.05" ) );
```

```java
ypto( NotToBeDetectedMessages.getString( PKG,
			"nottobedetectedmessages_getstring_pkg.lines.02.scenario.06" ) );
```

--------------------------------

### Get Transformation Status with XML Output

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

This cURL command fetches the status of a specific transformation, identified by its name, and requests the output in XML format. You can optionally provide a transformation ID.

```bash
curl "http://localhost:8080/kettle/transStatus?name=my-transformation&xml=Y"
```

--------------------------------

### Typical Maven Build

Source: https://github.com/pentaho/pentaho-kettle/blob/master/plugins/kafka/README.md

Run this command for a standard build process that includes compilation, testing, and packaging.

```bash
mvn install
```

--------------------------------

### Build for Nightly/Release

Source: https://github.com/pentaho/pentaho-kettle/blob/master/plugins/file-stream/README.md

Use this command to build, unit test, and package the entire project for release. The 'release' property activates required profiles.

```bash
mvn clean install -Drelease
```

--------------------------------

### Capture Build Log to Text File

Source: https://github.com/pentaho/pentaho-kettle/blob/master/README.md

Redirect the output of the build and test process to a log file named 'log.txt'.

```bash
$ mvn clean install test >log.txt
```

--------------------------------

### Package Pentaho Data Integration for Distribution

Source: https://github.com/pentaho/pentaho-kettle/blob/master/README.md

Execute this command to create distribution packages. The packaged results will be in the `target/` sub-folders of `assemblies/*`.

```bash
$ mvn clean package
```

--------------------------------

### Run Unit Tests with Maven

Source: https://github.com/pentaho/pentaho-kettle/blob/master/plugins/kafka/README.md

Execute this command to run all unit tests defined for the project.

```bash
mvn test
```

--------------------------------

### Infobright JNI DLL for Windows 64-bit

Source: https://github.com/pentaho/pentaho-kettle/blob/master/assemblies/static/src/main/resources/README.txt

Copy this file to your Windows system path (e.g., %WINDIR%/System32/) for the Infobright Bulk Loader on a 64-bit system. Rename it to infobright_jni.dll.

```text
libswt/win32/infobright_jni_64bit.dll
```

--------------------------------

### Infobright JNI DLL for Windows 32-bit

Source: https://github.com/pentaho/pentaho-kettle/blob/master/assemblies/static/src/main/resources/README.txt

Copy this file to your Windows system path (e.g., %WINDIR%/System32/) for the Infobright Bulk Loader on a 32-bit system. Rename it to infobright_jni.dll.

```text
libswt/win32/infobright_jni.dll
```

--------------------------------

### Build for CI/Dev

Source: https://github.com/pentaho/pentaho-kettle/blob/master/plugins/file-stream/README.md

Build the project without production-specific optimizations like obfuscation or uglification by omitting the 'release' property.

```bash
mvn clean install
```

--------------------------------

### BaseMessages getString One Line Scenarios

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Demonstrates various ways to call BaseMessages.getString with different spacing and line breaks for single-line calls. Ensure correct package and key are provided.

```java
BaseMessages One line  1: + ypto( BaseMessages.getString( PKG, "basemessages_getstring_pkg.lines.01.scenario.01" ) );
```

```java
BaseMessages One line  2: + ypto( BaseMessages.  getString( PKG, "basemessages_getstring_pkg.lines.01.scenario.02" ) );
```

```java
BaseMessages One line  3: + ypto( BaseMessages. <seg_45> getString( PKG, "basemessages_getstring_pkg.lines.01.scenario.03" ) );
```

```java
BaseMessages One line  4: + ypto( BaseMessages.getString   ( PKG, "basemessages_getstring_pkg.lines.01.scenario.04" ) );
```

```java
BaseMessages One line  5: + ypto( BaseMessages.getString  	 ( PKG, "basemessages_getstring_pkg.lines.01.scenario.05" ) );
```

```java
BaseMessages One line  6: + ypto( BaseMessages.getString(    PKG, "basemessages_getstring_pkg.lines.01.scenario.06" ) );
```

```java
BaseMessages One line  7: + ypto( BaseMessages.getString(  	  PKG, "basemessages_getstring_pkg.lines.01.scenario.07" ) );
```

--------------------------------

### Run Unit Tests in Pentaho Data Integration

Source: https://github.com/pentaho/pentaho-kettle/blob/master/README.md

This command runs all unit tests in the project. To include integration tests, use the `verify -DrunITs` command.

```bash
$ mvn test
```

--------------------------------

### Run a Single Integration Test

Source: https://github.com/pentaho/pentaho-kettle/blob/master/README.md

Specify a particular integration test to run using the `-Dit.test` parameter.

```bash
$ mvn verify -DrunITs -Dit.test=<<YourIT>>
```

--------------------------------

### BaseMessages getString Six Line Scenarios

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Demonstrates BaseMessages.getString calls spanning six lines with significant whitespace. Verify the package and message key are correctly provided.

```java
BaseMessages Six lines  1: + ypto( BaseMessages
.
 			 getString
 			      (
  	 PKG
  	 ,         "basemessages_getstring_pkg.lines.06.scenario.01" ) );
```

```java
BaseMessages Six lines  2: + ypto( BaseMessages

.
 			 getString
 			      (
  	 PKG  	 ,         "basemessages_getstring_pkg.lines.06.scenario.02" ) );
```

```java
BaseMessages Six lines  3: + ypto( BaseMessages


. 	 getString
 			      (
  	 PKG  	 ,         "basemessages_getstring_pkg.lines.06.scenario.03" ) );
```

--------------------------------

### Maven Compile Only

Source: https://github.com/pentaho/pentaho-kettle/blob/master/plugins/kafka/README.md

Use this command to compile the project's source code without running tests or packaging.

```bash
mvn compile
```

--------------------------------

### BaseMessages getString Two Line Scenarios

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Illustrates calling BaseMessages.getString across two lines with varied indentation and spacing. Verify the package and message key are correctly specified.

```java
BaseMessages Two lines  1: + ypto( BaseMessages 	
 			 . getString	( PKG, "basemessages_getstring_pkg.lines.02.scenario.01" ) );
```

```java
BaseMessages Two lines  2: + ypto( BaseMessages.
 			 getString( PKG, "basemessages_getstring_pkg.lines.02.scenario.02" ) );
```

```java
BaseMessages Two lines  3: + ypto( BaseMessages.getString
 		( PKG, "basemessages_getstring_pkg.lines.02.scenario.03" ) );
```

```java
BaseMessages Two lines  4: + ypto( BaseMessages.getString(
 	 PKG, "basemessages_getstring_pkg.lines.02.scenario.04" ) );
```

```java
BaseMessages Two lines  5: + ypto( BaseMessages.getString( PKG
,  "basemessages_getstring_pkg.lines.02.scenario.05" ) );
```

```java
BaseMessages Two lines  6: + ypto( BaseMessages.getString( PKG,
				"basemessages_getstring_pkg.lines.02.scenario.06" ) );
```

--------------------------------

### Use HTTP Basic Authentication with curl

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Use HTTP Basic Authentication with curl by providing the username and password in the command. This is a common way to authenticate API requests.

```bash
curl -u username:password "http://localhost:8080/kettle/status?xml=Y"
```

--------------------------------

### POST /kettle/addTrans - Add Transformation

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Uploads and registers a transformation for execution.

```APIDOC
## POST /kettle/addTrans

### Description
Uploads and registers a transformation for execution.

### Method
POST

### Endpoint
/kettle/addTrans

### Parameters
#### Request Body
- **transformation_xml** (string) - Required - Transformation XML content.

### Response
#### Success Response (200)
- **transformation_id** (string) - The ID of the registered transformation.
- **status** (string) - The status of the registration.
```

--------------------------------

### getString with Varied Spacing (Six Lines)

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Illustrates SomeOtherMessages.getString calls extending over six lines with significant whitespace and line breaks. These demonstrate robust parsing of complex formatting.

```java
SomeOtherMessages Six lines  1: + ypto( SomeOtherMessages
.
 	 	 getString
 	 	      (
  	 PKG
  	 ,         "someothermessages_getstring_pkg.lines.06.scenario.01" ) );
```

```java
SomeOtherMessages Six lines  2: + ypto( SomeOtherMessages

.
 	 	 getString
 	 	      (
  	 PKG  	 ,         "someothermessages_getstring_pkg.lines.06.scenario.02" ) );
```

```java
SomeOtherMessages Six lines  3: + ypto( SomeOtherMessages


. 	 getString
 	 	      (
  	 PKG  	 ,         "someothermessages_getstring_pkg.lines.06.scenario.03" ) );
```

--------------------------------

### getString with Varied Spacing (One Line)

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Demonstrates calling SomeOtherMessages.getString with inconsistent spacing on a single line. Ensure correct key names for retrieval.

```java
SomeOtherMessages One line  1: + ypto( SomeOtherMessages.getString( PKG, "someothermessages_getstring_pkg.lines.01.scenario.01" ) );
```

```java
SomeOtherMessages One line  2: + ypto( SomeOtherMessages.  getString( PKG, "someothermessages_getstring_pkg.lines.01.scenario.02" ) );
```

```java
SomeOtherMessages One line  3: + ypto( SomeOtherMessages. 	 getString( PKG, "someothermessages_getstring_pkg.lines.01.scenario.03" ) );
```

```java
SomeOtherMessages One line  4: + ypto( SomeOtherMessages.getString   ( PKG, "someothermessages_getstring_pkg.lines.01.scenario.04" ) );
```

```java
SomeOtherMessages One line  5: + ypto( SomeOtherMessages.getString  	 ( PKG, "someothermessages_getstring_pkg.lines.01.scenario.05" ) );
```

```java
SomeOtherMessages One line  6: + ypto( SomeOtherMessages.getString(    PKG, "someothermessages_getstring_pkg.lines.01.scenario.06" ) );
```

```java
SomeOtherMessages One line  7: + ypto( SomeOtherMessages.getString(  	  PKG, "someothermessages_getstring_pkg.lines.01.scenario.07" ) );
```

--------------------------------

### BaseMessages getString Four Line Scenarios

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Presents BaseMessages.getString calls distributed over four lines with varied spacing. Confirm the package and message key are correctly set.

```java
BaseMessages Four lines  1: + ypto( BaseMessages
.
 			 getString(
  	 PKG, "basemessages_getstring_pkg.lines.04.scenario.01" ) );
```

```java
BaseMessages Four lines  2: + ypto( BaseMessages	.		
 			 getString
			 (
  	 PKG, "basemessages_getstring_pkg.lines.04.scenario.02" ) );
```

```java
BaseMessages Four lines  3: + ypto( BaseMessages .
 			 getString
			 (  	 PKG
			 , "basemessages_getstring_pkg.lines.04.scenario.03" ) );
```

--------------------------------

### getString with Varied Spacing (Four Lines)

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Demonstrates SomeOtherMessages.getString calls spread across four lines with significant variations in whitespace and line breaks. This highlights the parser's robustness.

```java
SomeOtherMessages Four lines  1: + ypto( SomeOtherMessages
.
 	 	 getString(
  	 PKG, "someothermessages_getstring_pkg.lines.04.scenario.01" ) );
```

```java
SomeOtherMessages Four lines  2: + ypto( SomeOtherMessages	.		
 	 	 getString
			 (
  	 PKG, "someothermessages_getstring_pkg.lines.04.scenario.02" ) );
```

```java
SomeOtherMessages Four lines  3: + ypto( SomeOtherMessages .
 	 	 getString
			 (  	 PKG
			 , "someothermessages_getstring_pkg.lines.04.scenario.03" ) );
```

--------------------------------

### Serialize StepMetaInterface to Repository

Source: https://github.com/pentaho/pentaho-kettle/blob/master/engine/src/main/java/org/pentaho/di/core/util/serialization/README.md

This builder pattern is used to serialize a StepMetaInterface object to the repository. It requires the repository object, step metadata, and associated IDs.

```java
RepoSerializer
         .builder()
         .repo( repo )
         .stepMeta( stepMeta )
         .stepId( stepId )
         .transId( transId )
         .serialize()
```

--------------------------------

### Remote Debug a Single Unit Test

Source: https://github.com/pentaho/pentaho-kettle/blob/master/README.md

Navigate to the 'core' directory and use this command to remotely debug a specific Java unit test on the default port 5005.

```bash
$ cd core
$ mvn test -Dtest=<<YourTest>> -Dmaven.surefire.debug
```

--------------------------------

### Serialize StepMetaInterface to XML

Source: https://github.com/pentaho/pentaho-kettle/blob/master/engine/src/main/java/org/pentaho/di/core/util/serialization/README.md

Use this method to serialize a StepMetaInterface object into an XML representation. Ensure the StepMetaInterface object is properly prepared using StepMetaProps.from().

```java
MetaXmlSerializer.serialize( StepMetaProps.from( myMeta ) )
```

--------------------------------

### BaseMessages getString Seven Line Scenarios

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Illustrates BaseMessages.getString calls over seven lines with substantial whitespace. Ensure the package and message key are accurate.

```java
BaseMessages Seven lines  1: + ypto( BaseMessages
.
 			 getString
 			      (
  	 PKG
  ,
"basemessages_getstring_pkg.lines.07.scenario.01" ) );
```

--------------------------------

### Cluster Management API

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Endpoints for managing slave servers and deployment packages within a Kettle cluster.

```APIDOC
## GET /kettle/registerSlave

### Description
Registers a slave server in the cluster.

### Method
GET

### Endpoint
/kettle/registerSlave

### Query Parameters
- Slave server configuration (required) - Details of the slave server to register.
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.
```

```APIDOC
## GET /kettle/getSlaves

### Description
Retrieves a list of registered slave servers.

### Method
GET

### Endpoint
/kettle/getSlaves

### Query Parameters
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.
```

```APIDOC
## POST /kettle/registerPackage

### Description
Registers a deployment package.

### Method
POST

### Endpoint
/kettle/registerPackage

### Request Body
- Package content (required) - The content of the deployment package.
```

--------------------------------

### Utility Endpoints API

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Utility endpoints for retrieving server properties, sequence values, sniffing step data, and exporting resources.

```APIDOC
## GET /kettle/properties

### Description
Retrieves server configuration properties.

### Method
GET

### Endpoint
/kettle/properties

### Query Parameters
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.

### Response
- Server properties and configuration.
```

```APIDOC
## GET /kettle/nextSequence

### Description
Gets the next value from a named sequence.

### Method
GET

### Endpoint
/kettle/nextSequence

### Query Parameters
- **name** (string) - Required - The name of the sequence.
- **increment** (integer) - Optional - The amount to increment the sequence by.
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.
```

```APIDOC
## GET /kettle/sniffStep

### Description
Sniffs data output from a transformation step for analysis.

### Method
GET

### Endpoint
/kettle/sniffStep

### Query Parameters
- **trans** (string) - Required - The name of the transformation.
- **step** (string) - Required - The name of the step.
- **copynr** (integer) - Optional - The copy number of the step.
- **type** (string) - Optional - The data type to sniff.
- **xml** (string) - Optional - Specifies the output format as XML. Typically 'Y' for true.
```

```APIDOC
## POST /kettle/addExport

### Description
Exports transformation or job resources.

### Method
POST

### Endpoint
/kettle/addExport

### Request Body
- Export configuration (required) - The configuration details for the export.
```

--------------------------------

### getString with Varied Spacing (Two Lines)

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Illustrates calling SomeOtherMessages.getString across two lines with inconsistent spacing and line breaks. Pay attention to the placement of arguments.

```java
SomeOtherMessages Two lines  1: + ypto( SomeOtherMessages 	 
 	 	 . getString	( PKG, "someothermessages_getstring_pkg.lines.02.scenario.01" ) );
```

```java
SomeOtherMessages Two lines  2: + ypto( SomeOtherMessages.
 	 	 	 getString( PKG, "someothermessages_getstring_pkg.lines.02.scenario.02" ) );
```

```java
SomeOtherMessages Two lines  3: + ypto( SomeOtherMessages.getString
 	 	 ( PKG, "someothermessages_getstring_pkg.lines.02.scenario.03" ) );
```

```java
SomeOtherMessages Two lines  4: + ypto( SomeOtherMessages.getString(
 	 PKG, "someothermessages_getstring_pkg.lines.02.scenario.04" ) );
```

```java
SomeOtherMessages Two lines  5: + ypto( SomeOtherMessages.getString( PKG
,  "someothermessages_getstring_pkg.lines.02.scenario.05" ) );
```

```java
SomeOtherMessages Two lines  6: + ypto( SomeOtherMessages.getString( PKG,
			"someothermessages_getstring_pkg.lines.02.scenario.06" ) );
```

--------------------------------

### NotToBeDetectedMessages getString with Varied Spacing (One Line)

Source: https://github.com/pentaho/pentaho-kettle/blob/master/ui/src/test/resources/org/pentaho/di/ui/i18n/split_lines_scenarios.txt

Demonstrates calling NotToBeDetectedMessages.getString with inconsistent spacing on a single line. This class is distinct from SomeOtherMessages.

```java
NotToBeDetectedMessages One line  1: + ypto( NotToBeDetectedMessages.getString( PKG, "nottobedetectedmessages_getstring_pkg.lines.01.scenario.01" ) );
```

```java
NotToBeDetectedMessages One line  2: + ypto( NotToBeDetectedMessages.  getString( PKG, "nottobedetectedmessages_getstring_pkg.lines.01.scenario.02" ) );
```

```java
NotToBeDetectedMessages One line  3: + ypto( NotToBeDetectedMessages. 	 getString( PKG, "nottobedetectedmessages_getstring_pkg.lines.01.scenario.03" ) );
```

```java
NotToBeDetectedMessages One line  4: + ypto( NotToBeDetectedMessages.getString   ( PKG, "nottobedetectedmessages_getstring_pkg.lines.01.scenario.04" ) );
```

--------------------------------

### Configure Carte Authentication

Source: https://github.com/pentaho/pentaho-kettle/blob/master/CarteAPIDocumentation.md

Configure authentication by setting username and password in the carte configuration XML. This is essential for securing your Carte server.

```xml
<slaveserver>
  <name>slave-server-name</name>
  <hostname>localhost</hostname>
  <port>8080</port>
  <username>admin</username>
  <password>password</password>
</slaveserver>
```