User: Query parameters for File open (Deprecated) - HiromuHota/pentaho-kettle GitHub Wiki

This API has been updated without backward compatibility. The following information is vaild only for version 0.6.1.5 and 0.6.1.6. Please refer to [here](Query-parameters-for-File-open) for version 0.6.1.7 and higher.

Starting from version 0.6.1.5, webSpoon takes query parameters to open a Kettle file. More specifically, when a browser accesses the endpoint with query parameters, it will launch webSpoon with the specified Kettle file opened. This feature enables webSpoon to be embedded in other web-based GUIs. For example, editting Kettle queries in CDE and Kettle endpoints in App Builder would become possible.

Definition

Please remember to URL encode strings.

Parameter Description
fileType Trans or Job
filename File name to open (full-path for local files)
directory Directory holding the file (empty for local files)
sourceRepository true for a file in a repository or false for a local file
repositoryName Repository name (empty for local files)

The order of parameters is not important, but all the params should be present.

Examples

Not open a file

http://localhost:8080/spoon/

Open a file in a repository

http://localhost:8080/spoon/?fileType=Trans&filename=Transformation%201&directory=%2Fhome%2Fadmin&sourceRepository=true&repositoryName=pentaho-ee

This opens a transformation file Transformation<space>1 under a directory /home/admin in a repository pentaho-ee.

Open a local file

http://localhost:8080/spoon/?fileType=Job&filename=%2Fhome%2Fuser%2FJob%202.kjb&directory=&sourceRepository=false&repositoryName=

This opens a local job file /home/user/Job<space>2.kjb.

⚠️ **GitHub.com Fallback** ⚠️