Skip to main content
Kinetic Community

Build

Provides access to build and maintain Trees, Routines, and Handlers.

Trees

Trees define a process using nodes and connectors. The Trees console includes a list of trees along with links to Import and Add New Tree. Along the right hand side are options to filter the list based on Source, Group, Tree, and Status.

tree_list_basic.png

Tree list filtered to Kinetic Request

The tree list can be sorted by any of the columns. Clicking on the Tree.Routine Id XXX brings you to the Edit Tree/New Tree dialog.

Missing Routines

If there are any missing routines, a banner with a link to the Missing Routines will display at the top of the page.

Missing Routine list displays each Routine Id with the number of nodes and trees it is missing from. Clicking on the Routine Id shows a list of the individual trees that are missing the routine. Clicking on the tree name will open the builder for modifications.

Tree Actions

Available actions are accessed by clicking on the chevron on the right side of each trees listing.

Build. Opens the Tree Builder. See the following article for more details

Run. Allows you to create a single Execution for the tree. Specify a Source Id and add a message for the execution. XXX link to Executions

Clone. Create a copy of the selected tree. There is a unique index of Source, Group and Name. One of these values must be changed before you can submit.

Export. Tree is exported in XML format with a timestamp. Task v4 trees may not be imported into earlier versions.

Create Trees

The Add New Trees link opens a dialog to define the background information for a tree.

tree_create_new.png

 

Source. Defined on the Admin console. Relates to the application that uses the tree

Source Group. Defined on the Permissions console. can be used to bind the tree to specific items of the source.

Name. Descriptive name (must be unique when combined with Source Group)

Status. Three options:

  • Active - Executions processed normally.
  • Inactive - Current executions (already in process) will be completed. No new executions allowed.
  • Paused - All current executions stopped, no new executions allowed.

Once the Submit button is clicked and the tree is added to the list of Trees you can click the Build button to open the builder.

Tree Details

Clicking on the name of the tree brings up the Tree Details console. This console shows the runs and errors for the tree for the past thirty days.

build_tree_details.png

Tree Edit

Clicking on the Edit link brings up the same dialog as clicking on the Create New Tree button, except that the data is filled with the trees details. This is the one place to Delete a tree. There is an Actions menu with the same options as the Tree Actions menu.

Import Tree

Clicking on the Import Tree button opens a panel to search and import. Task trees from version 3.x on are available to import. You cannot export to earlier versions of Kinetic Task.

tree_import.png

Source of the exported tree must exist in the system before you can import.

Filter Trees

Filtering is available on any of the three options, Source, Group, or Tree or any combination. Clicking on Clear will restore the default list.

Routines

There are two types of Routines, Global and Local. Global is meant to be shared across many Trees, and Local is meant to only be used by the same Source/Group of Trees.

Add New Global Routine

Because it can be used by any number of trees (and other Routines), the definition of the Global Routine is very sparse. Select the Global link and then click on the Add New Routine button.

routine_add_new_global.png

All fields are required, Categories are optional.

Name. Descriptive name for the routine.

Definition. Unique identifier for the routine.

Status. Defines whether the routine is available.

  • Active - available for use by the engine
  • Inactive - not available for use to be added to trees or routines. In process runs will be completed.
  • Paused - All runs are started, but paused. See the Staging console on Activity.

Categories. Select the category that the routine is displayed in on the tree builder.

Add New Local Routine

Local routines are constrained to specic sources and groups, so require more definition when created. Select the Local link and then click on the Add New Routine button.

routine_add_new_local.png

Source. Specific source to define the use of the local routine.

Source Group. Specific source group to further define local routine.

Name. Descriptive name.

Definition Id. Unique name for the routine.

Status. Defines whether the routine is available.

  • Active - available for use by the engine
  • Inactive - not available for use to be added to trees or routines. In process runs will be completed.
  • Paused - All runs are started, but paused. See the Staging console on Activity.

Inputs & Outputs

For both global and local, inputs and outputs are available for routines. Think of them like the parameters and results of nodes on a task tree. Each input or output needs a unique name (for that routine) and you have the option of adding a description and making inputs (not outputs) required. Inputs are accesible within the routine, and outputs are accesible in the tree or routine that called the it.

routine_inputs_outputs.png

Details

Selecting a routine brings you to the Details page. It shows graphs of the runs and errors associated to that routine.

Usage

Clicking on the Usage link from the routine details dialog shows the trees and routines that the selected routine is used in. The table is sortable by column header. A summary of trees, routines, and nodes is at the bottom of the table.

Edit

Clicking on the Edit link opens the same dialog as creating a new routine. Edit any data for the routine from this dialog. This is also where you can delete a routine.

WARNING. Deleting a routine removes it from all trees and routines it has been used in. This could cause established trees or routines to break.

Handlers

Handlers are the actions behind individual nodes on task trees. They must be imported intonthe indivdual task engine and then are available for use in trees. If you import a tree and handlers are not present for your engine the tree and the handlers consoles will report these errors.

Handlers List

List of all installed handlers for the specific task engine. Button available to import new handlers. Ability to sort by all columns of the list.

handlers_list.png

Import Handler

Selecting Import Handler opens a dialog across the top of the list console. Handlers can be downloaded from Kinetic Community, or downloaded and imported from other environments. Files must be in a zip format.

tree_import.png

After importing you are taken directly to the Handlers Edit console (see below) to complete the properties for the handler.

Handler_import_details.png

Properties are determined per individual handler. At the bottom of the console are available Categories that the handler can be placed in.

Handler Details

Clicking on the name of the handler brings up three sub consoles, Details, Usage, and Edit. You can download the handler from any of these consoles.

Details shows the time that it has taken the handler to run over the last 20 tasks.

handler_details.png

Handlers Usage

The Usage subconsole shows what trees the handlers is being used in.

handlers_usage.png

Clicking on the name of the tree opens the tree details console. Clicking on the node for that tree opens the builder and sets focus on that node.

Handlers Edit

The Edit subconsole contains all the properties and the category(s) of the handler. It is also the only spot where you can delete the handler.

handler_edit.png

Download Handlers

To download a specific handler, click on the "Download Handler" button when looking at a specific handler (see image above). After clicking on the button, you will be asked to save the handler in a location specific to you. Handlers are downloaded as zip files.

See section above for importing the handler. After importing, the handler needs to be configured for the new environment.