Skip to main content
Kinetic Community

Using Handlers with Encrypted Task Info Values in Kinetic Task 1.0

Downloads
info.xsd
Kinetic Task 2.0 implemented a feature for specifying that task info values should be encrypted.  In order to import Task Handlers that are configured to utilize this feature into Kinetic Task 1.0, a schema definition file needs to be updated in the Kinetic Task web application.

Description

Starting in version 2.0, Kinetic Task automatically encrypts task info items (which are specified in the process/info.xml file of a handler) that have an attribute of type="encrypted", and displayes the value as a password field in the Configuration Console. If a handler that is configured to use this feature is imported into Kinetic Task 1.0, the Configure Console will display the following error:

 

TypeEncryptedError.png

Task deployment file has invalid XML file (check log for details): info.xml

 
This error is raised during the validation that runs before importing a handler, because the Kinetic Task 1.0 task info XML schema definition does not allow the type="encrypted" attribute.  In order to import handlers that use this value, the XML schema file for the task handler info.xml format needs to be updated.

See the Examples section below for an example info.xml file with and without the encrypted type set.

Instructions

Following the steps below does not implement task info encryption on Kinetic Task 1.0, it only allows handlers that are configured to utilize this feature in Kinetic Task 2.0 to be imported into a Kinetic Task 1.0 system.

  1. Download the info.xsd file attached to this solution article.
  2. Rename the info.xsd file located in %TOMCAT_HOME%/webapps/kineticTask/WEB-INF to info.xsd.backup.
  3. Copy the downloaded info.xsd file to %TOMCAT_HOME%/webapps/kineticTask/WEB-INF.

These steps do not require a restart and do not effect the task engine itself.  The only functionality affected is the Task Configuration console import process.

Examples

Task Handler process/info.xml file without an encrypted password task info configuration value:

<?xml version="1.0" encoding="UTF-8"?>

<taskInfo version="1.0">
    <info name="email" description="The Google account email, including the domain name"/>
    <info name="password" description="The password of the Google account"/>
    <info name="enable_debug_logging" description="Enable debug logging if the value is set to 'Yes'.">No</info>
</taskInfo>

Task Handler process/info.xml file with an encrypted password task info configuration value:

<?xml version="1.0" encoding="UTF-8"?>

<taskInfo version="1.0">
    <info name="email" description="The Google account email, including the domain name"/>
    <info name="password" type="encrypted" description="The password of the Google account"/>
    <info name="enable_debug_logging" description="Enable debug logging if the value is set to 'Yes'.">No</info>
</taskInfo>