Command-Line-Client Parameters

Option

Alternative Option

Parameter

Description

-a

--add

<projectfile>

Add the specified project to the server. The path to the project file can be set globally or locally.

-c

--context

<variables>

Context variables to use for execution of jobs, loads, and sources and for flow graph.

-cf

--contextfile

<filename>

Set the name of XML file that contains the context variables values.

-co

--componentoutput

<locator>

Get a component output structure of an extract/transform. The locator can be of type sampleBiker.sources.extract/transform-name or sampleBiker.extracts.extractName/ sampleBiker.transforms.transformName

-d

--data

<sourcename>

Get the data from the specified source (extract or transform). Number of lines and start line can be defined with -n option. Valid only in combination with -p option.

-df

--dataformat

<arg>

Transfer data from a source to csv or xml. Valid only in combination with the -d option.

-dr

--drillthrough

<db.cube>

Get detailed drillthrough data of a datastore.

-dri

--drillthroughinfo

Get storage information for all drillthrough operations.

-e

--execdisplay

<fromid toid>

Get history of executions in interval of execution IDs. Filter on project, job, and load with -p, -j, -l options.

-ed

--execdetails

<executionid>

Display the runtime details of an execution.

-eg

--execgraph

<executionid>

Display the runtime details of an execution as an SVG graph.

-el

--execlog

<executionid>

Display the log of an execution.

-er

--execremove

<fromid toid>

Remove executions from the history in interval of execution IDs. Filter on project, job, and load with -p, -j, -l options.

-f

--format

<arg>

Set the output format of a tree source. Valid only in combination with -d option.

-g

--get

<projectname>

Get project configuration from server.

-gr

--graph

<locator>

Get flow graph of a component as SVG definition. Set graph properties with -c option. Write output to a file with -o option.

-h

--help

Show help message.

-i

--info

Get info about the server status and the jobs running.

-j

--job

<jobname>

Execute the specified job of the project. Multiple jobs are separated with '.'. Valid only in combination with -p option.

-k

--kill

<executionid>

Terminate a running execution by its id, or "ALL" for all running or queued executions. Use -i option to get info about running executions.

-l

--load

<loadname>

Execute the specified load of the project. Multiple loads are separated with '.'. Valid only in combination with -p option.

-ll

--loglevel

<level>

Set the log level of this client. Possible values are: OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL. Valid only with -el option. Note: the logs are displayed from history; so, for example, if the debug level was not set when an execution was run, then "-ll DEBUG" will not show any debug logs.

-ls

--list

List all projects on the server with no argument given, or project details of the project given with -p option.

-m

--migrate

<projectfile>

Migrate project configuration to actual definition standard.

-n

--sample

<format>

Limitation of data output to sample of n lines. Valid only in combination with -d, -dr, and -e options. A second parameter can be given for the start line that is only valid with -d.

-o

--output

<filename>

Write output to a file.

-p

--project

<projectname>

Specify the Integrator project. If no further option is set, the default job of the project is executed. The project has to be added to the server with option -a before.

-pd

--documentation

<projectname>

Get the documentation of a project. Add the flow graph of jobs with -j option. Write output to file system by giving its target directory with -o option.

-pg

--prototype

<arg>

Generate a prototype project.

-pw

--password

<password>

Give the password. Should be used with combination –u.

-r

--remove

<projectname>

Remove the specified project from server.

-rn

--rename

<locator newName>

Rename a component to a new name and updates its dependencies.

-s

--server

<name[:port]>

Use this Integrator server: name[:port].

-sp

--serverprofile

<profilename>

Use an existing server profile.

-spc

--createserverprofile

<profilename>

Create/update a server profile.

-t

--test

<locator>

Validate and test a project or a project component in runtime without actually writing data. A component is specified in the form
<projectName>.{connections|extracts| transforms|loads|jobs}.<componentName>

-u

--user

<user>

Give the username. Should be used with combination –pw.

-up

--update

<projectfile>

Update the specified project to the server. The path to the project file can be set globally or locally.

-v

--validate

<projectfile>

Validate existing project configuration without executing.

-w

--wait

<wait>

Wait for the specified job/load of the project to finish. Takes value true/false. Valid only in combination with -j/-l options.