Skip to main content
Kinetic Community

Creating a Tree

A tree is how we define processes in Kinetic Task. This guide will walk you through creating your first task tree, running the tree, and examining its output.

Creating a New Tree

Start by selecting the Build tab on the top of the page. This will take you to the trees list page which displays all of the trees in your system. Note that on a fresh install there may be some trees already present, these are trees that Kinetic Task itself calls to perform some actions.

initial_trees_index.png

To create a new tree click the Add New Tree button. This will take you to the New Tree form.

new_tree.png

Filling out the new tree form:

  • Source* -- Select the Playground option for now (for more information about Sources see Sources in Task)
  • Source Group* -- Enter your name
  • Name* -- Name the tree whatever you would like
  • Status* -- Leave Active
  • Process Owner Email -- Leave empty

When the tree has been successfully saved, you will be redirected to the Tree Builder. Here you can define your process.

tree_builder_empty.png

The area on the left contains the process. A new tree will contain a single Start node as shown above. The gray sidebar on the right contains the Handlers and Routines installed on this system.

For this exercise we will simply add one node to the tree. Start by clicking the System Controls category in the sidebar. This will expand the category, revealing its Handlers and Routines. Click and hold the Echo handler and drag it into the empty space.

node_configuration.png

 

Now we will configure the node by double-clicking it, which opens a configuration dialog box.  

Name the Node by clicking the current name in the dark gray header. Then enter some text in the Input* field. Clicking Apply will save the Node configuration and close the dialog box.

saved_tree.png

 

 

To make sure this Node gets processed we need to add a Connector that points from the Start node to the new one.  

Click the Start Node, then click and hold the triangle that appears at the bottom. Drag the Connector to the new Node and release. Now when this tree is processed we will process this new Node.

 

 

Finally, save the tree by pressing the blue Save button in the top right corner.

Running a Tree

tree_builder_run.png

Now that we have created a tree we can run it.

When the Task Engine runs a tree it begins at the Start Node and processes each of its children (defined by Connectors). Then it processes their children. And so on, until there are no more Nodes to process.

 

To run the tree click the Actions menu and then click run. This will take you to the Run Tree form.

tree_run_form.png

For now we can ignore the Source Data field (for more information about this see Sources in Task).

Simply clicking the Run Tree button will tell the Task Engine to run the tree. After clicking Run Tree a message will appear containing a link with the Id of the Run that was created.

initial_trees_index.png

Note that the Task Engine processes trees asynchronously. Meaning that in this step we have simply told the Task Engine to do some work and we get a response immediately, before the tree has been processed completely. The actual processing of the tree is happening in the background.

To view the status of a run and see its results click the link in the success message.  This will take you to the Run Details page, once there click the Tasks tab.  Each of the Tasks in the table shown represent a processed node from the tree (sorted in the order they were processed).

run_tasks.png

We can see more details of a Task by clicking on its row.

run_tasks_details.png

 

 

The Details section contains some troubleshooting information.

The Results section contains the data returned from the Handler. In this case the Echo handler simply returned its configured input as the result.