Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated to Pentaho 9.2 and yajsw-stable-12.16

...

  1. Download YAJSW (Yet Another Java Service Wrapper) from Sourceforge: http://sourceforge.net/projects/yajsw/files/ (these instructions were written and tested against YAJSW version 1112.0316)
  2. Unzip the file into a suitable folder, e.g. C:\Pentaho\CarteService.
    Note: This should not be created below any other Pentaho Kettle folder since it is independent of the Pentaho Kettle Version and makes it easy to upgrade to future Kettle versions (see also chapter "Upgrade Instructions").
  3. When you unzipped YAJSW, you have e.g. a folder C:\Pentaho\CarteService\yajsw-stable-1112.0316. We recommend to rename this folder to C:\Pentaho\CarteService\default. The reason for this is the possibility of having multiple configurations on one machine, see chapter "Multiple Instances of Carte on one Machine". Another reason is that you do not need to change any references to this folder in case you upgrade to a later YAJSW version.
    Note: We will reference the YAJSW directory in the following instructions as <CarteServiceFolder>.
  4. Download the prepared wrapper.conf configuration file (attachment to this Page).
  5. Copy the downloaded wrapper.conf to <CarteServiceFolder>\conf\wrapper.conf (replace the existing one).
  6. Edit the wrapper.conf with a text editor and change the following entries manually (you can search for your convenience for the markers ###InstallerOrModify### within the file):

Parameter

Sample

Description / Notes

wrapper.working.dir

C:/Pentaho/pdi-ee-4.3.0-GA/data-integration\\\\pentaho\\\\design-tools\\\\data-integration\\\\

The working directory of Carte. Please mind to change back slashes to forward slashes or double back slashes in the file path!
Note: If you defined OS environment variables you may access these directly within the configuration and use for this parameter. Windows environment variables are converted to lower case. Therefore even if you use e.g. PATH on your computer you have to
call ${path}  in the configuration file.

wrapper.app.account


The user account the Carte service will run. When nothing is given here, it starts as the Local System account. Please check with your system administrator about the right user settings. Please mind to remove the leading '#' in case you enter a property here.

wrapper.app.password


Password for the given account. Please mind to remove the leading '#' in case you enter a property here.

wrapper.java.app.jar

.
launcher
pentaho-application-launcher-VERSIONlauncher\\\\launcher.jar

You need to replace the version of this jar file.

wrapper.java.commandC:/Pentaho/BA-4.5.0-GA/java/bin/java.exe or

${pentahoPENTAHO_javaJAVA_home}/bin/HOME}\\\\bin\\\\java.exe

The Path to your java.exe. Please mind to change back slashes to forward slashes or double back slashes in the file path!
Note: When you used the installer, a PENTAHO_JAVA_HOME system environment variable has been set. This variable can be used in this context but needs to be given in lower case.

wrapper.app.parameter.3

127.0.0.1

The Carte listening IP Address (or dynamic configuration file), see Carte User Documentation for more details.
Note: In the case of a Dynamic cluster configuration, please replace wrapper.app.parameter.3 with the location of the cluster configuration file (e.g. wrapper.app.parameter.3 = C:
Pentaho
Kettle
slave_dyn_8083.xml) and remove wrapper.app.parameter.4.

wrapper.app.parameter.4

8081

The Carte listening port, see Carte User Documentation for more details.

wrapper.java.additional.1

-Xmx512mDorg.mortbay.util.URI.charset=UTF-8

URL Encoding.

wrapper.java.additional.2-Xmx4gThis may vary depending on your needed memory.
wrapper.java.additional.3-Xms1gThis may vary depending on your needed memory.
wrapper.java.additional.4-Dhttps.protocols=TLSv1,TLSv1.1,TLSv1.2Support for HTTPs TLS
wrapper.java.additional.5-DKETTLE_HOME=/some/pathThis PATH is used to read the kettle home. If not defined, it will user the %USER_HOME% and will create or use existing .kettle folder. This folder is where kettle.properties file, shared.xml and other settings files are used by PDI.
wrapper.java.additional.6-XX:+AggressiveOptsUsed to have a better GC memory management. However, we are currently recommending the use of -XX:+UseG1GC
wrapper.java.additional.7-XX:+ExitOnOutOfMemoryErrorIn case of an Out Of Memory, we recommend the CARTE to exit. If used in combination with Windows Services auto-restart in case of failure, will make the service to be back in few minutes.

Test your Configuration

  1. Execute <CarteServiceFolder>\bat\runConsole.bat
  2. When everything is configured correct, Carte starts up as usual.
  3. Check if you can login to Carte from your Browser on your local machine, e.g. http://localhost:8081
  4. When the test went successfully, you can stop Carte with selecting "Stop" in the new yajsw system tray or with Ctrl-C in the console window.

...