Skip to main content
Kinetic Community

Data Management Console

Summary

The Data Management Console uses Kinetic Request and Task functionality to allow display and easy editing of data.  The “data” can consist of items that support Kinetic Request processes, or can be data that just needs a better way of being edited/reviewed.  The data is accessed via a Bridge, so it really can reside anywhere.Data Management Console 1.png

Data Management Console.png

The package and supporting data structures are designed to completely support data stored within the KS_SRV_Helper form (the Kinetic form to hold data that has no other home), but can be easily extended, using standard Kinetic Request/Task functionality to support data stored elsewhere.

The Data Management Console is a “package” that comes with its own theme and catalog, which can be modified and/or integrated into any existing catalog or theme if desired.  It is designed for one implementation per Kinetic Request implementation; not designed for one implementation per catalog.

Basic Details

Create data type definitions

Data type definitions are required for each set of data to be displayed.  The data type structure is defined using a Kinetic Service Item, and the resulting details are stored within the KS_SRV_Helper form.  The data type definition service item defines

  • where the data comes from,
  • the criteria used to retrieve the data,
  • the service item used to manage the data (add/update data rows),
  • what fields from the data source should be displayed and related details.

Data display

After data types are defined, they are used to display data within the console.  When a data type is selected on the main console page, the data type definition is retrieved and used to access the data source and obtain the necessary records.

The data type definition is also used to create a table that displays the returned results, and enables appropriate functionality.

  • Export/print data
  • Toggle status
  • Edit full record
  • Upload data

Data editing

When a data type is defined, the service item to use for editing is defined. For the included items, this is KS_SRV_Helper. This service item uses the data type definition to display the appropriate information for that data set when a row is edited/added.

The service item uses the defined column names for the question labels, displays any configured help text, displays only the fields used in this data set, and, if the item is indicated to be a selection list, displays the appropriate list. This can help guide someone into entering the data correctly.

Form Features

Console

  • Displaying data
  • Exporting data
  • Toggling data (one or more records)
  • Editing a row
  • Uploading data

Data Definition Page

  • Create new dataset definition
  • Update existing dataset

Editing

  • Update the data in a row in a specific dataset (including status)

Uploading data

  • Replace dataset’s data
  • Append to dataset’s data

Data Management Console Links

The link to the Data Management Console would look like:
http://<webserver><:port>/kinetic/DisplayPage?name=datamanagement
​Example: 
http://demo.kineticdata.com/kinetic/DisplayPage?name=datamanagement

Extending Functionality

The Data Management Console can be extended to access just about any data, and allow editing and updating of the data.  Extend the functionality using bridges, service items, bundle models, task trees and task handlers. Note that functionality does not have to be extended to all of the listed areas. If a  data set to be read-only, that’s fine. If a data set also allows editing, but does not allow/build toggling of status, that’s fine. Extending functionality can include only the functionality wanted/needed for that dataset.

  • Retrieve Data from other data sources
    • Add Bridges and create appropriate mappings to access data from other sources. See the Getting Started with Bridges documentation on the Community for details of how to do this.
    • Add text element(s) with a custom event on the ‘Data Management Console’ in the Bridge Access Section to expose the bridge and qualification. This provides the necessary permission to access the bridge. See any of the existing text elements in the Bridge Access Section as an example. Note that one element/event for each qualification on the bridge being added is necessary.
  • Expanded editing
    • If the data is stored in the KS_SRV_Helper form, but has more extensive editing needs than simple free text/list values (i.e., the standard KS_SRV_Helper data editor form doesn’t provide enough functionality)
      • Create a service item that performs the necessary functions.
      • Use the existing ‘KS_SRV_Helper Add Update Data form’ and related JavaScript functions as a starting point.
      • Add that new form as an entry to the ‘Data Management Console – Service Item Names for Editing Data’ data type, using the Data Management Console to add a row to that dataset.
    • If the data is stored elsewhere in Remedy
      • Create a service item that performs the necessary functions.
      • Use the existing ‘KS_SRV_Helper Add Update Data form’ and related JavaScript functions as a starting point.
      • Add that new form as an entry to the ‘Data Management Console – Service Item Names for Editing Data’ data type, using the Data Management Console to add a row to that dataset.
      • Create the necessary bundle models and callbacks to support creating and updating data in that Remedy from.
        • The themes\datamanagement\packages\datamanagement\framework\models\helper.jspf can be used as an example of a bundle model
        • The callbacks in themes\datamanagement\packages\datamanagement\interface\callbacks can be used as example of create and update callbacks
    • If the data is stored elsewhere outside of Remedy
      • Create a service item that performs the necessary functions.
      • Use the existing ‘KS_SRV_Helper Add Update Data form’ and related JavaScript functions as a starting point.
      • Add that new form as an entry to the ‘Data Management Console – Service Item Names for Editing Data’ data type, using the Data Management Console to add a row to that dataset.
      • Create the necessary handlers to add and update data.
      • Create task tree(s) on the add/update service item to process the add update.
        • Note that this update may take time (tasks get queued up) and it may be desirable note this on the confirmation page and to send a note to the user when the update is complete.
  • Enable status toggling from the main data management page
    • If the data is stored within helper, the functions already exist to support status toggling.
    • If data exists in other forms, create a bundle model that allows access to the source data and toggles between the various functions.
      • Pay attention to status values, and learn/understand the data process for the source data.
      • Create the callback, using this as a guide:  themes\datamanagement\packages \datamanagement\interface\callbacks\updateHelperStatus.jsp
      • Edit the dmc.js file to use the appropriate call back…see lines 90-96. A new else if will need to be added to this if statement for the new form.
  • Extending import
    • To allow mass importing of data to an external source
      • Create a new service item for accepting the appropriate input, using the KS_SRV_Helper File Upload-CSV   as a guide
      • Create a task handler to properly handle the incoming data, using the provided kinetic_dmc_dataload_helper_v1 as a guide
      • Create a task tree to process the input , using the task tree on KS_SRV_Helper File Upload-CSV  as a guide

Known Issues

  • Recommend having the latest version of the Remedy ARS Bridge

Pending Enhancements

  • Buttons do not identify when features are not allowed
  • Handle data chunking server side and/or provide some way to display more records than allowed in one search by the Remedy server side search limitation.
  • Easier way to create “read only” data
  • Way to replace just the imported items, rather than just purge and replace all or append
  • Add more “out of the box” connections (ex. to AD)
  • Make toggling of status configurable with a data point, so editing of the js file directly is not necessary.

Installation

Prerequisites

  • Kinetic Request 5.1.2 or greater
  • Kinetic Task 2.0 or greater
  • Configured ARS Bridge

The ARS Bridge is deployed automatically upon install of Kinetic Request 5.1 or greater, but needs to be configured. See the Configure the Bridge section of the Getting Started documentation for bridges on the Community.

Installation Steps

Download the installation package from Kinetic Community, or if you know how to use GIT, from here to a temporary location and unzip the file.

Installation includes five parts

  1.  Adding the Data Management Console package to theme in the Kinetic Request web installation (on EACH Kinetic Request web server)
  2. Import the bridge configuration entries using KURL
  3. Importing the related service items
  4. Importing the handlers to support the service items
  5. Import configuration data
  6. Remove Public, View permissions from the Request ID field on the KS_SRV_Helper form.

Upgrade steps are the same as the installation steps for the files provided in the upgrade package unless otherwise stated. If a file is provided in the upgrade package in community (and you are not using GIT) it is expected that you would overwrite what is there. If you have made customizations, this will, of course, impact that. If you intend to make customizations, it is highly recommended you use GIT so you can merge your code with the changes provided. Upgrades will, unless otherwise stated, be just from the previously provided version (not cumulative).

Web Component

Place the included theme in the Kinetic Request web directory.  The expected location of the theme directory is:

<kinetic installation directory>\

Example:
e:\Program Files (x86)\Kinetic Apps\apache-tomcat-5.5.27-sr\webapps\kinetic\

Install the package on the webserver, by copying the themes directory from the download location into the existing Kinetic installation directory.  If a themes directory already exists in the Kinetic directory, it will add the directory structure and files from the Data Management Console Package into the existing location.  If not, the themes directory will be created.

Repeat this for each web server in the implementation.

Bridges

If you do not currently have an ARS Bridge set up, you will need to set one up. That is the bridge used by the Data Management Console.

Using the KURL utility, install the bridge configuration values (structures and mappings).  This needs to be performed once for each environment (e.g., development, stage, production).  The bridge configuration file, located in the bridges directory of the download, needs to be accessible from the system where KURL is installed (it does not need to be installed on a server).

  1. Ensure the KURL server connection parameters are configured to talk to the proper server (check the config.yml file within the KURL directory).
  2. From a command prompt, navigate to the KURL directory and execute the KURL command to import the bridge configurations.

java -jar kurl.jar -action=build_bridges -file=”<path to download bridges file location>/bridges_DMC.rb”

Example:  java -jar kurl.jar -action=build_bridges -file=”c:\data management console\bridges\bridges_DMC.rb”

  1. Check in the Bridge Manager Mappings section to be sure that the models all reference the correct name for your environment. They will import referencing "Local ARS Server". If that's not the name of your bridge, you'll need to update the bridge name in the mappings for the models. To update a mapping, select the model, click on the mapping name in the Model Mappings table, click Modify, choose the correct bridge from the drop down, and click save.
  2. Repeat for each environment

Service Items

Import the four service items included in the Service Items directory of the download location into each environment.  The four files correspond to these service items.

                Data Management Console

                New Data Type Definition

                KS_SRV_Helper Add Data Update Data

                    KS_SRV_Helper File Upload-CSV

It is recommended, though not required, that you open up the task tree of the KS_SRV_Helper File Upload-CSV item and update the "From" address on the SMTP handler to be something within your domain, either a no-reply email address or one people will be monitoring.

Handlers

Import the kinetic_dmc_dataload_helper handler to the Kinetic Task engine for each environment.  

Also, the Kinetic Request Submission Update Status, Kinetic Request Submission Close, and SMTP Email Send V1 handlers are used to support the file upload process and will be needed in your system if not already present. 

Be sure to configure the handlers after importing them. The handlers are located in the Handler directory of the download location. Restart the task engine on each Kinetic Task server after importing and configuring the handler(s).

Note than the Kinetic Request and SMTP handlers are not included in the package until version 1.5 of the DMC, but they are available on the Community via the links from their names above as well.

Data

Data is loaded into the KS_SRV_Helper form to to provide a couple of core configuration entries used by the Data Management Console.  Import this data using the ARS Data Import tool; import DataManagementConfigurationData.arx file in the Data directory of the download location.  Do this once for each environment.

                Source file: KS_SRV_Helper_DMC_Data.arx

                Form:  KS_SRV_Helper

                ‘Auto map’ all the fields

Remove Public, View Permissions from the KS_SRV_Helper form

A Remedy Admin will need to do this part. An RFE has been submitted for this, but until it is completed, you will need to remove the Public, View permissions from the Request ID field (Field 1) on the KS_SRV_Helper form for the DMC Security to function appropriately. 

Releases

1.9

Important note: Requires Kinetic Request 5.2.8 or higher

  • Streamline portions of the code in datatypedef.js
  • Remove encoding when storing data set definitions; this is now handled automatically by Kinetic Request in 5.2.8 and higher.

Migration from previous versions:  After updating the code from previous versions, ALL data type definitions needs to be opened for editing and saved (no changes need to be made to the dataset, but they need to be re-saved to store the bridge configurations without encoding.

1.8

  • Fix to the Dataset Security
  • Fix to saving of Dates and Date/Time values

1.7

  • Adding a new add/update service item no longer requires editing code to make it work/available
  • Leaving out parameters will now correctly halt the add of a new dataset, prompting the user to correct the data

1.6

  • Fixes a defect handling date/time values when adding/updating 

1.5

  • Fixes a defect with defaulting select/list fields
  • Removes reference to People Bridge
  • Adds handlers available on Community but necessary to the upload process to the provided install package and instructions
  • Adds the ability to export and import/upload DMC Dataset data through the DMC interface.
  • Updates the email handler on the upload to use SMTP, not Remedy email.

Related

Topics
Data Management Console
This presentation provides managers with an overview of how to use Kinetic Request to manage data. This is most often used for data supporting Kinetic Request and Kinetic Task processes, but truly, this Data Management Console can be used for any data.
Other