Skip to main content
Kinetic Community

Connect Request to Task

Before a Form submission can execute a Task Tree, Kinetic Request and Kinetic Task need to be configured to communicate with each other.

These instructions outline the most common configuration that is used in implementations.  In some cases, variation in this configuration may be necessary but this will meet the initial needs of most customers.

Create a Space

Before the two applications can be connected, a Space needs to be created in Kinetic Request. and a name needs to be selected for this Space.   It can be any descriptive name. 

Instructions on creating a Space can be found at  https://community.kineticdata.com/Kinetic_Request/Kinetic_Request_Core_Edition/Documentation/20_Management_Consoles/System_Consoles/Spaces

As the Space Name is typed, Request will suggest a "Space Slug" to use.  By design, it will copy the Name but convert to lower case letters and replace any spaces with dashes (-).  This Space will be referenced using the Slug in future steps and configurations.

Inside the Space, you will need to create a system account for Kinetic Task to use.  Instructions for this are also in the link above.  When creating the account make it a "Space Admin" by checking the appropriate box.

Create a Kapp inside the Space

Navigate inside of the Space.  (Under or next to the Space title is a link into the Space Management Console.  It can also be accessed via the URL <Your_Server>:<Port>/kinetic/<Your_Space_Slug>/app)

A login page will be displayed.  The account created for Kinetic Task in the above step can be used to log in.

Configuration inside of the Kinetic Request App is temporarily complete.  Please keep this page open while we configure Kinetic Task in a new tab or window for the next step.

Task Source

A Task Source allows Task to see the Requests in the Space created above.  This allows the Task Trees to be connected to the Requests.  

In this configuration step, the Space Slug and User created above will be needed for this configuration.

The Name given to the Task Source can be anything but should be meaningful. My suggestion would be to meaningfully link its name to the Space created above.  This Task Source Name will be needed in a future step, please save it or write it down someplace.

Here are some instructions on creating a Task Source

https://community.kineticdata.com/Kinetic_Task/Task_Handlers_and_Sources/Kinetic_Request_CE/Kinetic_Request_CE_Source

Now we can go back to Kinetic Request to complete its configuration.

Create the Webhook

The Webhook is used to send the Form submission to Kinetic Task and tell it which tree to execute.

When the Space was created a Kapp named Catalog should have been created and seen on the left navigation.

Each Kapp has its own connection to Task and this step configures the Webhook for the "CATALOG" Kapp.  Any additional Kapps created will also need to have a Webhook configured.  Back on the page left open, where Kinetic Request was last configured, the page should have been left inside the "CATALOG" Kapp, if not it will be listed in the left navigation pane.  Under the "CATALOG" Kapp title, the "Webhooks" link should be selected. 

Once inside of Webhooks, the "Add Webhook" button can be pressed to create a new Webhook.

Once inside the "New Webhook" page, it can be given any descriptive name.  "Submit Request" is a common name.  

The Type should be Submission, which will execute the Webhook when a Form is submitted.

The Filter field can be left empty.

 

The URL field defines the location of the Task Tree that will be triggered upon submission of Forms from inside the Kapp.  There are different ways to configure this URL.  This set of instructions is built around the most common configuration.  For now, the URL below can be used.  First, replace the <SERVER_NAME> and <PORT_NUMBER> with the configuration relevant to the Task Server in your environment.

http://<SERVER_NAME>:<PORT-NUMBER>/kinetic-task/app/api/v1/run-tree/${space('attribute:Task Source Name')}/${kapp('slug')}%20%3E%20${form('slug')}/Submitted

This configuration provides flexibility by leveraging configuration and parameters.  The reference to the configuration of the "Task Source Name" Attribute on the Space can be seen in the URL.  The next step will be to add this attribute to the Space.

Additional information on Webhooks, but not necessary for this configuration, can be found at https://community.kineticdata.com/Kinetic_Request/Kinetic_Request_Core_Edition/Documentation/20_Management_Consoles/Kapp_Consoles/70_Webhooks#Task_Webhook_URL

Configure Attributes

In the URL above the attribute of "Task Source Name" is referenced.   It looks at an attribute defined on the Space and uses it configured value to help build the URL.  This attribute needs to be created on the Space before it can be given a value.

Using the instructions at the link below create an Attribute with a Name of "Task Source Name" on the Space.   The Attribute of "Task Source Name" should be created.

https://community.kineticdata.com/Kinetic_Request/Kinetic_Request_Core_Edition/Documentation/20_Management_Consoles/Kapp_Consoles/50_Attribute_Definitions

Now the "Task Source Name" Attribute is available to be given a value in the Space.  Under the Settings link in the Left navigation bar and the Attributes tab in the body of the page, the Task Source Name attribute can be selected and then given a value.  Give the attribute the name which was given to the Task Source Name created in one of earlier steps.

Request and Task should now be configured and ready for testing.  To test the integration a Form should be created inside of the Kapp and a new Task Tree should be created and linked to this Form.