Skip to main content
Kinetic Community

Importing and Configuring a Task Handler

Kinetic Task handlers are registered integration points. Registration makes them available to the Task Builder and creates one time connection information. Task Handlers have pre-defined inputs and outputs which makes them highly reusable. This page details the process for importing and configuring a Task Handler in the Task Handler Configuration Console.

Importing a Task Handler

To begin the import process, click on the Import Task Handler link toward the upper right of the console page. Then you will be presented with a new section of the screen.

importingHandler.png

Use the browse button to select the correct handler zip file and click the import button. This will attempt to import the provided file. If the zip file is damage (or you indicate a file that is not a zip) you may see this error:

taskImportBadZip.png

If your zip file doesn't contain all the necessary/expected files, the error will tell you which files are missing:

taskImportMissingFiles.png

And there are other errors you may receive if your handler zip is incomplete, incorrect, or damaged. The error text should provide a guide to what is wrong with the provided file.

If your file is correct and complete, you will receive a message about successful import.

handlerImportSuccess.png

Note that this does not mean that the handler is available for use. Depending on the handler, it may require configuration before use, but even handlers that don't need configuration won't be loaded until the Task Engine is stopped and restarted.

Editting/Configuring a Task Handler

Task Handlers that reach out and touch another system (most do) need to be configured with information about that remote system. To edit a handler, click on it to select it from the list of loaded Task Handlers. The task handler's details will appear below the list. This image shows a newly loaded handler that needs initial configuration:

taskHandlerView.png

To edit/update the configuration, click on the edit iconeditIcon.png. Then the page will be updated to show a view that allows modification of the Editable Attributes, Associated Categories, and Associated Task Infos. 

taskHandlerModify.png

In this case we will be adding a category and setting up the Associated Task Infos. This is a new handler that we want Active.

Modifying a Task's Categories

To add a the Task Handler to a new category (used for display in the tree builder), select the category in the right window (Available Categories) and click the right arrow to move it to the Selected Categories window.

taskHandlerEditCategories.png

To remove a category, the category would be selected in the Selected Categories window and the left arrow would be clicked to move the item back to the Available Categories window. 

Holding down the crtl key while clicking on the categories allows for selection/movement of multiple categories at once.

Modifying a Task's Associated Task Infos

What Associated Task Infos are available/necessary will depend on the system the handler is communicating with. The description of each item should be provided by the handler. In this example, the handler will be communicating with Remedy.

Note that this information is loaded when the task engine is started and that all work by the task handler is done with the login provided here. It is recommended that, if possible, this user have a non-expiring password. If this is not possible, password updates will need to be very carefully planned and synced to avoid downtime. It is also critical that the user provided have the access in the remote system to do the actions the handler will be expected to perform.

taskHandlerEditTaskInfos.png

Completing/Validating Modifications

saveIcon.pngClick the save icon to save the changes made, and then the details for the Task Handler will be displayed in read only view again, this time with the updates in place.

taskHandlerConfigured.png