Skip to main content
Kinetic Community

Bundle Configuration

 

Download File
Bundle Responsive
An interactive tour of setting up the Bundle for Kinetic Request

Bundle Basics

A Bundle is a self contained collection of files intended to simplify the improvement of web-based Kinetic Request interfaces. These files are stored with the Kinetic Request web application.  The Kinetic Bundle leverages common web technologies (HTML, CSS, JavaScript) together with JSP to implement a fully brandable service interface.  A Bundle represents a consistent identity for service items stored in the Kinetic Request application. 

Bundle Base Directory

The Bundle has five top level directories

  1. common
  2. core
  3. libraries
  4. packages
  5. setup
 
The common directory contains resources that are accessible across multiple packages.  These resources are usually custom per Bundle and are likely to change.
 
The core directory contains resources that are global to the application and are not likely to change unless an update is being made.
 
The libraries directory contains third party and/or Kinetic Data authored libraries that are used in the bundle. 
 
The packages directory contains all the modules that make up the Bundle.  It is important to note that a 'catalog' package will always be provided with a Bundle. 
 
The setup directory contains the kurl files needed to set up the catalog in Kinetic Request.

Bundle Directory Organization

All the directories within the bundle follow a folder structure that is flexible and familiar and can be described as:
  1. config
  2. framework
  3. interface
  4. assets
 
Configuration files are used to abstract values that can or should be changed when a package is implemented. This ensures that there is a single point of modification when a package is deployed to a new server or environment, significantly improving modularity.
 
Framework files are those that facilitate the architecture of the Bundle (or package), and are almost always JSP fragment files. These files are usually models and helper files with a single include file.
 
Interface files are files, typically JSP or JSP fragment, that represent the actual content that is rendered when a display request is made to the Bundle.
 
Assets are files like CSS, Images, and JavaScript that are referenced by a Bundle's interface files.

Packages Inside Bundle

A Bundle will always contain a package directory where packages are stored.  Each package is a group of files for a specific functionality.  These packages each have a .jsp file inside that is the display page for the package. The following package is included:

  1. Catalog
 
The catalog package contains all the files for rendering a complete service item catalog.

Setup

Each bundle is housed in a git repository and has instructions on it's particular setup. The bundle in this training is the Responsive bundle and is located at the following git repository. Follow the instructions on the main page of the git repository.

Basic Download from github

  1. Navigate to the Responsive git repository
  2. Click on the "Clone or Download" button and choose the "Download Zip" link
  3. Save the zip file to your computer and unzip.
  4. Locate your kinetic themes directory on your web server (.../apache-tomcat-X.X.XX-sr/webapps/kinetic/themes). If your kinetic directory does not contain a themes directory, create one now.
  5. Copy or move the request-bundle-responsive folder to the themes directory. You can rename the request-bundle-responsive or leave as is.

Request Configuration

In order to start viewing the portal pages in the Bundle, we must first create a catalog in Kinetic Request with the required service items for the catalog to run.  We will use KURL to setup the catalog and basic portal page service items for the Bundle.

Request Configuration - Setup KURL to point to your Kinetic Request web server

  1. Download the latest version of KURL.
  2. Add the KURL jar to the Setup directory of the downloaded Bundle and rename it to kurl.jar
  3. Open a command prompt or terminal and navigate to the setup directory.
  4. Run the setup command, which can be found here.
  5. Verify that KURL is configured to your server using list catalogs.

Request Configuration - Setup KURL catalog configuration files

  1. Navigate to setup/kurl/
  2. Open the config.rb file in a text editor
  3. Edit the “CATALOG_NAME” variable with the name you want to call your catalog. Use dashes or underscores instead of spaces.
  4. Edit the “THEMES_BASE” with the path to the bundle directory. The path starts from the kinetic directory (e.g. /themes/request-bundle-responsive)
  5. Edit the "DISPLAY_NAME_FOR_URL" with the name of your catalog or with a user friendly unique name. This is used in the url to identify pages for your catalog.
  6. Using Kurl and a command line, execute the following kurl command to start your catalog import by replacing the text, "path-to-kurl-catalog-directory", with the path (from your kurl directory) to your catalog kurl files:
    java -jar kurl.jar -action=build_catalog -directory=path-to-kurl-catalog-directory
    

    Tip: If you are executing the kurl.jar from bundle/setup, your path to the kurl directory is kurl/.
  7. When the import is complete, verify that the catalog is visible in the Kinetic authoring tool and the following service items are imported:

    • About
    • Catalog (home page to browse catalog)
    • Common
    • Profile
    • Service Item Example with Person Lookup
    • Site Feedback

Request Configuration - Catalog Attributes

Once you have verified that the catalog is installed and complete, you will need to configure catalog attributes to connect the bundle to the catalog. Add the following attributes to the catalog (it is suggested to use the same values as used in the last section):

Note: If these catalog attributes are not available you will need to add them to your catalog by following the instructions on community and and using the KS_RQT_ServiceCatalog_base for "Parent Form".

  • slug (set to the same value as DISPLAY_NAME_FOR_URL with a delimeter such as a dash or underscore - e.g. ACME-)
  • catalogName (set to the name of your catalog)
  • companyName (set to your company name as you want displayed on the portal)

Bundle Dry Run

After your Bundle is configured, it's time to take it for a spin.

There are two methods to opening your catalog.

  1. Using the url: 
    http://_your-web-server_/kinetic/DisplayPage?name=_slug_Catalog
    
  2. Navigating from inside Kinetic Request
    1. Navigate to your Remedy user tool and open Kinetic Request-Service Catalog Console if it's not already open.
    2. Select your recently created catalog under the Service Catalog drop down naviagtion which is located in the upper left side.
    3. Select type Portal under your Search Type drop down.  This is great solution for filtering these service items.
    4. Select the Catalog service item you created under the Service Items list on your upper right side.
    5. Click the Open Anonymous link to the right of Service Item Details.

Your default web browser will open and ask you to login. Use Demo to login.

 

 

Tags recommended by the template: stage:draftarticle:topic-feature