Set PDI version control and comment tracking options

Pentaho Data Integration (PDI) can track versions and comments for jobs, transformations, and connection information when you save them. You can turn version control and comment tracking on or off by modifying their related statements in the repository.spring.properties text file.

Note: By default, version control and comment tracking are disabled (set to false).

Editing the version control statement

1. Exit from the PDI client (also called Spoon).

2. Stop the Pentaho Server.

   See the Install Pentaho Data Integration and Analytics document for instructions on starting and stopping the Pentaho Server..

3. Open the pentaho-server/pentaho-solution/system/repository.spring.properties file in a text editor.

   • To enable version control: Edit the versioningEnabled statement and set it to: true

     versioningEnabled=true

   • To disable version control: Edit the versioningEnabled statement and set it to: false

     versioningEnabled=false

     Note: If you disable version control, comment tracking is also disabled.

4. Save and close the file.

5. Start the Pentaho Server.

   See the Install Pentaho Data Integration and Analytics document for instructions on starting and stopping the Pentaho Server..

6. Start the PDI client.

7. Verify that version control is set as you intended.

Verifying the version control option

1. Connect to the Pentaho Repository.

2. In the PDI client, click Tools > Explore.

3. In the Repository Explorer window, click on the Browse tab, then click on a file name.

4. Verify that version control is enabled or disabled:

   • Enabled

     You can see the Access Control tab, and the Version History tab is visible.

     

     Version History tab in the PDI client
   • Disabled

     You can see the Access Control tab, but the Version History tab is hidden.

     

     Access Control tab in the PDI client

Editing the comment tracking statement

1. Exit from the PDI client (also called Spoon).

2. Stop the Pentaho Server.

3. Open the pentaho-server/pentaho-solution/system/repository.spring.properties file in a text editor.

   • To enable comment tracking: Edit the versionCommentsEnabled statement and set it to true.

     versionCommentsEnabled=true

   • To disable comment tracking: If you want version control, but not comment tracking:

     • Edit the versioningEnabled statement and set it to true.

     • Edit the versionCommentsEnabled statement and set it to false.

     versioningEnabled=true
     versionCommentsEnabled=false

4. Save and close the file.

5. Start the Pentaho Server.

6. Start the PDI client.

7. Verify that Version Control and Comment Tracking are set as you intended.

Verifying the comment tracking option

1. Connect to the Pentaho Repository.

2. In the PDI client, click Tools > Explore.

3. In the Repository Explorer window, click on the Browse tab, then click on a file name.

4. Verify that comment tracking is enabled or disabled:

   • Enabled

     The Version History tab appears with the Comments field. When you save a transformation, job, or connection information, you are prompted to enter a comment.

     

     Version History tab showing the Comments column in the PDI client
   • Disabled

     The Version History tab appears and the Comment field is hidden. When you save a transformation, job, or connection information, you are no longer prompted to enter a comment.

     

     Version History tab with the Comments column hidden in the PDI client