Skip to main content
Kinetic Community

Bundles v1

IDF guide rendered from cache
Bundles are web-based add ons to Kinetic Request which allow you to quickly create a web interface to your request catalog. Bundles include all of the files that you need to get started and come in different themes for styling and branding. A typical bundle includes a category listing page which allows the user to browse through the catalog, a display page for your service items, a submissions page which lists all the submitted, closed and pending requests for the user and a submission details page which shows all of the details and tasks for each request. Bundles are based on a web application framework and run in the same tomcat instance as Kinetic Request under the themes directory. Bundles consists of Java Server Pages, HTML, CSS, and JavaScript. Due to the fact that they are based on HTML and JSP pages they are easy to configure for your needs. View the KEG 2013 presentation "Bundles and Themes - Next Generation"

Structure

Bundles utilize a very structured configuration. There are three root directories:

  • common
    The common directory contains all the files that are used globally in the bundle, such as CSS files with color and standard element declarations, header files containing the logo and navigation and global configuration files.
  • core
    The core directory holds files and models that run the bundle (these file should not be changed) and can be extended in packages.
  • packages
    Packages are directories of files that perform a specific function and/or plug-ins that you can use in your bundle to add extra functionality.


All directories in the bundle follow a reusable directory structure
file-structure.png

config
The config directory includes the typical configuration files for that package. For example it can include variables that are used for urls or remedy qualifications. The read me for your package will include instructions on the necessary configurations. Having a configuration directory allows you to keep all the configuration files in one place and changes in this directory change the behavior throughout the package.

framework
The framework directory contains all the files for the technical internals of the package. The directories included are models, helpers, and includes. Each directory contains a specific type of files that run specific code for the bundle.

models
Models are classes that interface back end data and put it in a form that is used by the web front end. Models often use the configuration files for qualifications to retrieve data. Most models include several methods that you call throughout the package. This allows rapid development and customization. Kinetic request includes several models in the core directory; catalog, category, submission, template, task, and task message.

helpers
The helper directory includes code that is used several times throughout package . Helpers usually perform functionality that is used inside of other methods or portal pages. For example the date helper helps to format dates and the mobile helper determines whether you're on a mobile or desktop device .

includes
The Includes directory holds files that contain JSP code that is included in a specific page. Typically includes perform base application functions. For example an include will render the initialization such as the catalog categories or a users information. Another example is a header include that pulls in all of the JavaScript and CSS files for the package.

interface
The interface directory contains files specific to rendering the user interface of package.

callbacks
Callbacks are used by Ajax calls and return dynamic information.

fragments
Fragments are small portions of HTML you can include in several pages or that you can include in a loop over and over again. They typically contain variables that are populated from a method.

resources
The resources directory contains the base user interface files for the package. This includes the CSS, images, and JavaScript. These files are included in the JSP pages for the package. By modifying these pages you can control user interaction, content displayed and layout. The majority of modifications to this package will happen with these files.


Packages

Portal pages are the main landing pages of the web interface and are usully driven by a package in the bundle. Packages typically require at least one "portal" type service item in the catalog pointing to its JSP page. These service items are usually blank but do have several configuration options to make them work properly in the bundle. Refer to your bundle's or package's readme page for the configurations necessary.

The following packages are typical to bundles.

For additional packages refer to Bundle Packages at http://community.kineticdata.com/10_Kinetic_Request/Resources/Bundle_Packages

Catalog 
The catalog package is used to show categories and associated request items that allows the user to browse through the catalog. Categories are configured in Kinetic Request by modifying the catalog and adding them under the "Service Item Categories" tab. Once the categories are added they are available to add to your service items in the "Settings" tab under "Attributes" then "Category". Categories will not typically appear on the catalog page until a service item is associated with a category.

The catalog package also typically includes a search page or search function. Refer to the readme of your bundle for details on the search function.

Base
The base package holds all the files that render service items. These include the display.jsp for displaying the service item to be filled out, review.jsp that allows the user to review the service item request after it's been submitted and login.jsp that allows your catalog to have a themed login page. Some bundles also include a description.jsp to use for service item or category descriptions. This usually requires attributes to be applied and the configuration on using those attributes will be included in your particular bundle's readme.

Submissions
The submissions package runs the "My Requests" page that allows the user to view their submitted, closed and pending requests along with any closed or pending approvals.  The typical submissions page utilizes a tables for listing the submissions and can be configured in many different ways. Refer to the bundle/package readme for configuration details.

Once a user has chosen to view a submission, they can either view the filled out form or your bundle might contain a submission details jsp. This file has a few differnt configurations, but will typlically show the requestor information, contact information and tasks associated with the submission. Refer to your bundle's readme for details on if submission details are available and what format and/or configuration is needed.

Available Bundles

Topics
  • Air an out of the box Bundle solution for Kinetic Request. It contains the Air Theme and a Kurl catalog. Air contains the following portal pages: Catalog Search Submissions Air contains the following display pages specific to certain functions: Profile This display page is used to update the user's profile information and is accessed from clicking on the user's login name throughout the bundle. Submission Details This display page uses the "Timeline" and shows the details of each task by time taken to complete each task. Hovering over the task brings up a tooltip that shows the details associated. At the top is a link to the form submission answers. This page is entered from the submissions listing table on the submission page.  This service item usually does not contain any text or elements.
  • Flyout is an out of the box Bundle solution for Kinetic Request. It contains the Flyout theme and a Kurl catalog. This theme contains the following portal pages: About This display page is used to render content through Request that can by dynamically managed. Catalog This display page is used to render popular requests based on submissions. Catalog Listing Category This display page is used to render information on a specific category accessed from the Flyout menus in the header. Profile This display page is used to update the user's profile information and is accessed from clicking on the user's login name throughout the bundle. Search This display page is used to render search results from a catalog search. Service Item Example with Person Lookup Site Feedback Submissions This display page is used to render a Request submissions. Submission Activity (includes two display pages for two different user interfaces) This display page is used to render a listing of all tasks for a given submission.