Collaborating with PDI
Use repositories and projects to collaborate in Pentaho Data Integration (PDI).
In this article
Use a Pentaho Repository in PDI
The PDI client (Spoon) supports several storage options. A Pentaho Repository stores content on Pentaho Server.
Use a Pentaho Repository for team collaboration. You get version history, content locking, and enterprise security.
Create a connection in the PDI client
To access repository items in Spoon, create a connection first.
Verify Pentaho Server is running.
Start the PDI client.
Click Connect in the upper-right corner of the toolbar.
The Repository Manager dialog box opens.
Note: If Connect is replaced, you are already connected.
Click Add.
Select a repository type:
Pentaho Repository. Recommended for production use.
File Repository. Uses your local file system.
Database Repository. Uses a relational database.
Note: File and database repositories are not supported for production use.
Enter or update Display Name.
Update the repository URL if needed.
(Optional) Enter a Description.
Click Save.
The repository appears in the Repository Manager list.
Connect to a Pentaho Repository
After you create a repository, connect to it from the Connect menu.
Select a repository from the Connect menu.
Note: If this is your first repository, select it after creation.
Enter your User Name and Password.
Example: User Name =
admin, Password =password.Click Login.
If login fails, check the repository URL and port.
To show the connection dialog at startup, go to Tools > Options. Select Show repository dialog at startup.
Manage repositories in the PDI client
After you create a repository, a menu appears next to Connect. Use this menu to switch repositories, open Repository Manager, or disconnect.
Repository Manager
Use Repository Manager to add, edit, or delete repository definitions.
If you set a default repository at startup, clear it in the same dialog. Select Launch connection on startup again to remove the setting.
Connection details
Use Connection Details to configure a repository connection.
Display Name
Identifies the repository within the PDI client.
URL
Defines the repository web address. Default: http://localhost:8080/pentaho.
Description
Describes the repository, such as its purpose.
Launch connection on startup
Connects automatically when the PDI client starts.
Unsupported repositories
You can also create database or file repositories. Use Other Repositories in the welcome dialog.
Note: File and database repositories are not supported for production use.
Database repository
Database repositories store metadata in a relational database.
Enter a Display Name.
Select a Database Connection.
Create, edit, or delete the database connection.
Click Test and then click OK.
Click Finish to test the repository connection.
File repository
File repositories store metadata on your local file system.
Enter a Display Name.
Set Location for the repository.
Click Finish to test the repository connection.
When you connect, the toolbar shows only the repository display name.
Use the Repository Explorer
Use Repository Explorer to manage repository content. Most tasks are in the Browse tab.
Access the Repository Explorer window
Connect to a repository.
Select Tools > Repository > Explore.
The Repository Explorer window opens. Your permissions control what you can view and do.
If Repository Explorer is empty with LDAP, update your LDAP settings. See With LDAP authentication, the PDI Repository Explorer is empty.
Create a new folder in the repository
In the Browse tab, right-click the parent folder.
Example: right-click
publicto create a subfolder.Select New Folder.
Enter the folder name.
Click OK.
Open a folder, job, or transformation
Right-click the folder, job, or transformation.
Select Open.
To open multiple files, hold Ctrl or Shift while selecting.
Rename a folder, job, or transformation
In the Browse tab, right-click the item and select Rename.
Enter the new name.
Click OK.
Enter a comment when prompted.
Click OK.
The Version History tab records the rename with your comment.
Move objects
Select the object in the repository.
Drag the object to the destination folder.
You can move content into another user’s folder.
To move multiple items, hold Ctrl or Shift while selecting. Then right-click and select Move.
Delete a folder, job, or transformation
In the Browse tab, right-click the item and select Delete.
Click Yes in the warning message.
Click OK.
To delete multiple items, hold Ctrl or Shift while selecting.
Restore objects
Double-click the Trash icon.
Right-click the object and select Restore.
Controlling access to Pentaho Repository
You can control repository access with locking and permissions. You can also manage users, roles, connections, and cluster metadata.
Lock and unlock jobs and transformations
Locking prevents other users from editing the file.
Lock a job or transformation
In the Browse tab, right-click the job or transformation.
Select Lock.
Enter lock notes.
Click OK.
The icon shows a padlock.
Lock status refreshes when you reopen Repository Explorer. Exit and reopen the window to refresh icons.
View lock notes
Right-click the job or transformation.
Select Lock Notes.
Click OK.
Unlock a job or transformation
Right-click the job or transformation.
Select Lock.
The padlock icon disappears.
Access connection, security, and cluster information
Use the Connections tab to manage database connections. See Manage connections for transformations and jobs.
Use the Security tab to manage users and roles. You need administrative privileges for security tasks.
Use the Slaves tab to manage slave servers. See Initialize Slave Servers.
Use the Partitions and Cluster tabs for partitioning and clusters. See Create a cluster schema.
Set folder-level permissions
These permissions apply to repository files and folders:
Read. View content and execute it.
Manage Access Control. Change permissions.
Write. Read and write the content.
Delete. Delete the content.
Note: Assign Write and Manage Access Control to allow new subfolders.
To set folder permissions:
Open Repository Explorer (Tools > Repository > Explore).
Select the folder in the right pane.
In the lower pane, select Permissions.
Clear Inherit security settings from parent.
Click Add and select a user or role.
In Access Control, select the permissions to grant.
Click Apply.
Using version history
Version history lets you compare versions and restore earlier versions. By default, each save creates a new version.
Use version history
Select Tools > Repository > Explore.
In Browse, select the folder with the file.
Select the file in the upper-right pane.
Versions appear under the Version History tab.
Open a version of a file
Right-click a version under Version History.
Select Open.
The version opens in the PDI client as a separate item. The tab title includes the version number.
Restore a version of a file
You need administrative privileges to restore a version.
Right-click a version under Version History.
Select Restore.
Follow the prompts and click OK.
The restored version becomes the latest version.
Enable or disable tracking of version history and comments
You can toggle version tracking for all users in this file: server/pentaho-server/pentaho-solutions/system/repository.spring.properties
Set
versioningEnabled=true|false.Set
versionCommentsEnabled=true|false.
To apply changes:
Exit the PDI client.
Stop Pentaho Server.
Update the properties file.
Start Pentaho Server.
Start the PDI client.
Advanced topics
For advanced repository administration, see the Administer Pentaho Data Integration and Analytics documentation.
Share PDI projects
In Pentaho Data Integration (PDI), you can use a project folder to store ETL workflow files, settings, and related content all in one, self-contained container. You can share that project folder with one or many users that can access it, regardless of the PDI client configuration or project path they use.
Share a project
Use one of the following options to share your project with other users:
Create the project in the Pentaho Repository or a shared VFS.
Move an existing project into a Pentaho Repository or shared VFS.
Check the project folder into your organization’s version control system.
Outside of the PDI client, save the project folder as a ZIP file and share it directly with another user. Projects shared as ZIP files can be opened in the recipient's chosen location. After the recipient saves the project to their chosen location, they can open it and then refresh the project by clicking Project > Refresh Project.
To learn more about projects and their benefits, see Organizing ETL with projects.
Last updated
Was this helpful?