Start a Graph

Start a Graph starts a specified graph from specified sandbox.

Table 20.8. Attributes of "Graph execution" task

Task type"Start a graph"
Start on Node(s) to process the task.
SandboxThis select box contains sandboxes which are readable for logger user. Select sandbox which contains graph to execute.
GraphThe graph to be executed.

This select box is filled with all graphs files accessible in selected sandbox. Type a graph name or path to filter available items.

Save run recordSaves run record to database.

If the task runs too often (once in several seconds), you can increase the database performance by disabling this.

Parameters List of parameters passed to the graph.

Event parameters like "EVENT_RUN_RESULT", "EVENT_RUN_ID" etc. are passed to the executed job without limitations. Parameters EVENT_RUN_RESULT and EVENT_RUN_ID are used in context of event listeners. They are not used in context of scheduling.


Web GUI - Graph execution task

Figure 20.3. Web GUI - Graph execution task


Please note that behaviour of this task type is almost the same as Start a Jobflow.

Parameters

You can start a graph with parameters.

To start a graph with parameter choose an existing parameter from a list, set its value, and click the plus sign button at the end of line.

Web GUI - Graph execution task

Figure 20.4. Web GUI - Graph execution task


If the graph is started by event listener, it receives some additional parameters from the triggering job.

Parameters passed to graph by Event Listeners

Table 20.9. Additional parameters available in Event Listeners

EVENT_USERNAMEUsername of the user who caused the event
EVENT_USER_IDNumeric ID of the user who caused the event.
EVENT_RUN_SANDBOXCode of the sandbox containing the graph/jobflow
EVENT_RUN_JOB_FILESandbox-relative path to the graph/jobflow file.
EVENT_RUN_RESULTCurrent status of the graph/jobflow execution (N_A, READY, RUNNING, WAITING, FINISHED_OK, ERROR, ABORTED, TIMEOUT or UNKNOWN).
EVENT_RUN_IDNumeric ID of the run record representing graph/jobflow execution.
EVENT_JOB_EVENT_TYPEGraph/Jobflow event type that triggered the task.
EVENT_TIMEOUTSpecified timeout (in milliseconds) for the TIMEOUT event to occur