Chapter 19. Graph/Jobflow Parameters

The CloverETL Server passes a set of parameters to each graph or jobflow execution.

Keep in mind that ${paramName} placeholders (parameters) are resolved only during the initialization (loading of XML definition file), so if you need the parameters to be resolved for each job execution, you cannot set the job to be pooled. However, current parameter values are always accessible by inline Java code like this:

String runId = getGraph().getGraphProperties().getProperty("RUN_ID");

Properties may be added or replaced like this:

getGraph().getGraphProperties().setProperty("new_property", value );

This is set of parameters which are always set by CloverETL Server:

Table 19.1. Defaults for graph execution configuration - see section Graph config properties for details

keydescription
SANDBOX_CODEAn identifier of a sandbox which contains executed graph.
JOB_FILEA path to the file (graph, subgraph, jobflow). The path relative to sandbox root path.
SANDBOX_ROOTAn absolute path sandbox root.
RUN_IDID of the graph execution. In standalone mode or in cluster mode, it is always unique. It may be lower then 0 value, if the run record isn't persistent. See Launch Services for details.
PARENT_RUN_IDRun ID of the graph execution which is a parent to the current one. Useful when the execution is subgraph, child-job of some jobflow or worker for distributed transformation in cluster. When the execution doesn't have a parent, the PARENT_RUN_ID is the same as RUN_ID.
ROOT_RUN_IDRun ID of the graph execution which is root execution to the current one (the one which doesn't have parent). Useful when the execution is a subgraph, child-job of some jobflow or worker for distributed transformation in cluster. When the execution doesn't have a parent, the ROOT_RUN_ID is the same as RUN_ID.
CLOVER_USERNAMEUsername of user who launched the graph or jobflow.
NODE_IDId of node running the graph or jobflow.