Start a Graph

CloverDX Server > Using Graphs > Tasks > Start a Graph

Start a Graph starts a specified graph from a specified sandbox.

Table 28.5. Attributes of "Graph execution" task

Name	Description
Task type	"Start a graph"
Start on	Node(s) to process the task. This attribute is accessible only in Cluster environment. If there are nodes specified, the task will be processed on the first node which is online and ready.
Sandbox	This select box contains sandboxes which are readable for the logged user. Select the sandbox which contains the graph to execute.
Graph	The graph to be executed. This select box is filled with all graphs files accessible in the selected sandbox. Type a graph name or path to filter available items.
Save run record	Saves run record to database. If the task runs too often (once in several seconds), you can increase the database performance by disabling this attribute.
Parameters	A 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. The `EVENT_RUN_RESULT` and `EVENT_RUN_ID` parameters are used in context of event listeners. They are not used in context of scheduling.

Figure 28.3. Web GUI - Graph execution task

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

You can start a graph with parameters.

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

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

Table 28.6. Additional parameters available in Event Listeners

Name	Description
EVENT_USERNAME	The name of the user who caused the event
EVENT_USER_ID	A numeric ID of the user who caused the event.
EVENT_RUN_SANDBOX	A code of the sandbox containing the graph/jobflow
EVENT_RUN_JOB_FILE	A sandbox-relative path to the graph/jobflow file.
EVENT_RUN_RESULT	The current status of the graph/jobflow execution (N_A, READY, RUNNING, WAITING, FINISHED_OK, ERROR, ABORTED, TIMEOUT or UNKNOWN).
EVENT_RUN_ID	A numeric ID of the run record representing graph/jobflow execution.
EVENT_JOB_EVENT_TYPE	A graph/jobflow event type that triggered the task.
EVENT_TIMEOUT	A specified timeout (in milliseconds) for the TIMEOUT event to occur