Skip to main content
Kinetic Community

Creating a Subtree

The process to create a subtree is very similar to creating a regular process tree.

Creation

A subtree is created from the Tree Management console by first selecting the Source Root where the subtree will be used, and then clicking the New Tree button:

addTree_01.png

 

A form will be displayed to collect additional information about the new tree:

addTreeForm.png

 

Source Group

The source group defines search criteria in the Tree Mangement console to easily find this tree.

 

Tree Name

The tree name is simply a descriptive label about what the process does.  The combination of the Source Group and Tree Name must be a unique value in the system.

 

Additional Subtree Properties

Additional properties will be displayed when the subtree checkbox is selected.  These properties only pertain to subtrees, so they are not displayed when the process tree is not defined as a subtree.

subtreeForm.png

 

Subtree Id

If the Subtree checkbox is selected a Subtree Id field will be displayed.  This value must be entered when the subtree is first created and cannot be changed.  It must be a unique value in the system that identifies this process tree.  A good naming convention is to use the process action, the process subject, a version, and concatenate them all with underscores.  An example of sending an email to a requester would be:  email_requester_v1, and the corresponding tree name would be Email Requester.

 

Inputs

Inputs define what information can be passed to the subtree.  These are similar to the input parameters for task handlers.

Inputs can be added by clicking the "Add Input" link, and giving the input a name, and an optional description that can be used as a tooltip in the Task Builder.  Another checkbox is present to indicate if that input parameter is required or not.

More inputs can be added by simply clicking the "Add Input" link for each input needed.  Inputs can be reordered by clicking on the drag handle located to the left of each input, and dropping it into the desired position.

inputs.png

 

When building the subtree in the Task Builder, these inputs will be available in the Pre-defined values drop-down list as Tree Input variables.

predefinedValues.png

 

Outputs

Outputs define the information will be passed back to the process tree that called this subtree in the same way that a task handler returns data to the process tree.

Outputs can be added by clicking the "Add Output" link, giving the output a name, and an optional description.

Additional outputs can be added by simply clicking the "Add Output" link for each output needed.  Outputs can be reordered by clicking on the drag handle located to the left of each output, and dropping it into the desired position.

outputs.png

 

The outputs will be displayed as the input parameters to the Tree Return handler parameters.  The Task Return handler is a special system control that is used to return subtree values back to the parent tree, and allow the parent to continue processing.

outputParameters.png

 

Categories

Categories define where the subtree will be displayed in the Task Builder under the Task List.  Categories must first be defined in the Task Administration console by a task administrator.

 

categories.png

 

When the subtree is added to a category, the subtree will be displayed under that category in the Task List of the Task Builder.  The subtree will appear like any other task handler both in the Task Listing and on the Task Builder after it is dragged in and dropped into the parent tree.

subtreeForm.png

 

 

Tree Table

In the table on the Tree Management console, subtrees can be identified by the presence of the Subtree Id  next to the Tree Name value.

taskTrees.png

 

Here you can see the Email Requester process tree is actually a subtree, with the subtree id set to email_requester_v1.