Skip to main content
Pentaho Documentation

Start and Stop the Data Integration Server

To work with Pentaho Data Integration you must have the DI server running. There may be times when you need to manage Pentaho Data Integration components, stopping the DI server to perform system maintenance and restarting it after you are done. As part of the Installation Wizard and Archive Installation, Pentaho provides different ways to help you start and stop the components depending on the operating system you use and the method you used for installation.

For Microsoft Windows, these are your options for starting and stopping the components.

For Linux and Macintosh OS, these are your options for starting and stopping the components.

Windows Pentaho Installation Wizard

When you ran the Installation Wizard on Windows, the BA Server installed in a Tomcat Application server. You can manage the Tomcat and DI servers by clicking Start > Pentaho Enterprise Edition > Server Management and then selecting from these menu items.

  • Start the DI Server
  • Stop the DI Server

The wizard also registered the DI Server and the PostgreSQL solution repository as services. These services are set to run automatically, enabling them to start and stop when the computer running them boots or shuts down. You can use the Windows Services applet found in the Control Panel to start and stop the Pentaho servers and the solution repository.

  1. Click Start > Control Panel > Administrative Tools > Services.
  2. In the Services window, right-click one of these services in the list and choose Start or Stop from the menu that appears.
    • Data Integration
    • Pentaho Solution Repository

Windows Pentaho Archive Installation

If you used the Archive Installation, we provide individual control scripts to start and stop the Pentaho Repository and DI Server. Here is where you can find the individual control scripts.

Pentaho Repository

  • The Archive Installation enables you to install PostgreSQL, MySQL, or Oracle as the solution repository. Consult the third-party documentation for the RDBMS to find more information about starting and stopping.

    The solution repository must be started before the DI Server.

DI Server

  • /pentaho/server/data-integration-server

Linux and Macintosh OS Pentaho Installation Wizard

When you ran the Installation Wizard on Linux, the DI Server was deployed in an included Apache Tomcat application server. You can control the Tomcat server using the start and stop scripts that come with the Pentaho installation. This script is also used as an easy way to start and stop the DI Server and the PostgreSQL repository. You can find this script at /pentaho/ctlscript.sh.

Here is a list of the script arguments you can use with the data-integration-server service.

Arguments

  • start
  • stop
  • restart
  • status
  • help
./ctlscript.sh start data-integration-server
./ctlscript.sh status data-integration-server
./ctlscript.sh help

Linux and Macintosh OS Pentaho Archive Installation

If you used the Archive Installation, Pentaho provides individual control scripts to start and stop the Pentaho Tomcat application server, the DI Server, and the PostgreSQL server. Here is where you can find the individual control scripts.

Pentaho Repository

  • The Archive Installation enables you to install either PostgreSQL, MySQL, or Oracle as the solution repository. Consult the documentation for the RDBMS you selected for information about starting and stopping.

    The solution repository must be started before the DI Server.

DI Server

  • pentaho/server/data-integration-server/start-pentaho.sh and stop-pentaho.sh

Linux and Macintosh OS Pentaho Installation—Starting on Boot

The Linux and Macintosh OS installation process does not initially set up a way to start the Pentaho Repository and DI Server automatically on boot or stop on shutdown. If you want to automatically start the repository and server on boot or stop on shutdown, you must create a script for this procedure.

The example in this section shows how to create a pentaho script for this procedure. 

The following assumptions apply to this pentaho script:

  • You are running the DI Server under the pentaho local user account. If you are using a different account to start these services, substitute it in the script shown in Step 2.
  • You are using the PostgreSQL solution repository. Where postgresql appears in this script, change it to reflect the RDBMS you are using as a solution repository, either MySQL or Oracle.
  • The example script used in the following steps was tested on Red Hat Enterprise Linux. You may have to modify the details of the script if you use a different distribution of Linux or other Unix-like operating system, different shells, or different init systems.

The following example shows how to create an automatic boot/shutdown script named pentaho:

  1. With root permissions, create a file in /etc/init.d/ named pentaho.
  2. Using a text editor, copy the following content into your new pentaho script:
    #!/bin/sh
    ### BEGIN INIT INFO
    # Provides: start-data-integration-server stop-data-integration-server
    # Required-Start: networking postgresql
    # Required-Stop: postgresql
    # Default-Start: 2 3 4 5
    # Default-Stop: 0 1 6
    # Description: Pentaho DI Server
    ### END INIT INFO
    
    case "$1" in
    "start")
    su - pentaho -c "/home/pentaho/pentaho/server/data-integration-server/start-pentaho.sh"
    ;;
    "stop")
    su - pentaho -c "/home/pentaho/pentaho/server/data-integration-server/stop-pentaho.sh"
    ;;
    *)
    echo "Usage: $0 { start | stop }"
    ;;
    esac
    exit 0

 You may have to adjust the paths to the DI Server scripts to match your situation.

  1. If you are running the repository on the same machine as the server, change postgresql to the name of the init script for your database. If you are running the repository on a remote machine, remove postgresql entirely.

  2. Save the file and close the text editor.

  3. Open /home/pentaho/pentaho/server/data-integration-server/start-pentaho.sh with a text editor.
  4. Change the last if statement to match the following sample lines of code:
    if [ "$?" = 0 ]; then
      cd "$DIR/tomcat/bin"
      export CATALINA_OPTS="-Xms2048m -Xmx2048m -XX:MaxPermSize=2048m -Dsun.rmi.dgc.client.gcInterval=3600000 -Dsun.rmi.dgc.server.gcInterval=3600000"
      env JAVA_HOME=$_PENTAHO_JAVA_HOME sh ./startup.sh
    fi
  5. Save the file and close the text editor.
  6. Make the pentaho script executable.
    chmod +x /etc/init.d/pentaho
  7. Add the pentaho script to the standard run levels by using the following update-rc.d  command so that it runs when the system starts and stops when the system is shut down or reboots.
    update-rc.d pentaho defaults
    

This command may not exist on your computer if it is not Debian-based. If that is the case, consult your distribution documentation or contact your distribution's support department to determine how to add init scripts to the default run levels.