Skip to main content
Kinetic Community

Air

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.

Repository

https://github.com/kineticdata/request-bundle-air

The link above is a link to the code repository where the Air bundle can be found.  On the repository page there is a download link that says "ZIP" which will allow you to download the bundle as a zip file.

Since this is an open source repository you can also view the modifications we make to the Air bundle as development continues.  Changes may include implementation of new features, additional documentation, or bug fixes so it is a good way to see what is happening with the bundle.  

Setup

The bundle contains two directories, "setup" and "theme". The theme directory contains the web application files and the setup directory contains the Kurl catalog that sets up the service items needed for the bundle.

Bundle

The "theme" directory should be placed into the "themes" directory of your kinetic installation and renamed to match your catalog name

Parent path:
.../apache-tomcat-X.X.XX-sr/webapps/kinetic/themes

Catalog

  1. Unzip the catalog.zip file

  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 underscores or dashes instead of spaces.

  4. Edit the “THEMES_BASE” with the path to the bundle directory

  5. Using Kurl (http://community.kineticdata.com/10_Kinetic_Request/KURL/02_Get_Started), use the following command to start your catalog import by replacing the text, "path-to-kurl-catalog-directory", with the path (from your kurl directory) to your unzipped kurl catalog files:

    java -jar kurl.jar -action=build_catalog -directory=path-to-kurl-catalog-directory
    
  6. When the import is complete, verify that the catalog is visible in Remedy and all the service items are imported.

    • Catalog Login
    • Catalog Portal
    • Profile
    • Search
    • Submission Details
    • Submissions
  7. In the bundle directory open the your-theme-name/common/config/config.jspf file. Update each line where the word “AIR” is with the name of your catalog then save the file.

  8. Verify configuration by opening the web site in a browser:
    http://your-web-server/kinetic/DisplayPage?name=your-catalog-name

  9. If installing on a version of Kinetic Request earlier than 5.1.0 you must also add the jar file below to your WEB-INF/lib.  You will need to restart the web server once the jar files are copied into place.  This jar file was added to the Kinetic Request application in 5.1.0 and the klean bundle uses a method from this library (StringEscapeUtils.escapeXml).  To get klean working without removing that method call this jar file must be installed.

commons-lang3-3.1.jar

 

Review Request 

To allow reviewing of submissions by review.jsp, each service item requires the Review JSP attribute. The attribute is already configured in Kinetic Request and available for use. 

  1. Under the "Available Attributes" in the "Settings" tab, select "Review JSP"
  2. In the "Review JSP" text field enter the path to your review.jsp page starting from the kinetic directory.
    /themes/your-theme-name/packages/base/review.jsp

Display Options

The Air bundle allows the option to have Category and Service Item descriptions separate from the description line in Request. This allows extending descriptions for richer, longer descriptions that can include images, html, etc. To enable extended descriptions requires the use of attributes. The attributes neccesary to enable extended descriptions need to be added to the catalog. 

To add attributes to your catalog, in the Service Catalog Console, choose "Configuration", "Attribute Type" tab, then "New". In "Data Type" choose "Character" and in the "Attribute Type" field, type in the attribute you are adding from the table below.
 

Attribute Description
 HasDescription

This attribute is required for service item type Request and the value must contain the name of the service item with type “Request Description”This attribute is required for service item type Request and the value must contain the name of the service item with type “Request Description”

 IsTemplateDescription

This attribute is required for service item type Request and the value must contain the name of the service item with type “Request”

 IsCategoryDescription

This attribute is required for service item type Category Description and the value must contain the name of the category.

 

Once your attributes are added to your catalog, you will need to create service items to hold the descriptions, set the type for your service items and add the text for descriptions. All the features you can add in a service item you can use in a description. 

The following table shows all the types that need to be added to service items.

 

Type Description
 Request

This service item is usually the actual service item or form that the client will be making the request with.

 Request Description

This service item is meant to store a description about service item type “Request”.

 Category Description

This service item is meant to store a description about the category.

 Portal

This service item is used to point to the catalog display pages.  Usually the bundle pages that show categories and service items.

Example

The ACME company has a catalog with the category "Laptops". This category needs to show images of each available laptop along with who can use this category.The catalog would need to contain a service item with the type "Category Description" which contains text elements and images elements laid out accordingly. Then under the "Settings" tab, the "IsCategoryDescription" attribute would be chosen and in the text field "Laptops" would be added. 

Screen Shot 2013-07-16 at 5.30.05 PM.png

 

Configurable Properties

Below are the default configurable properties found in the air bundle.  Most of the properties will have default values configured already but some of them will require change upon setup, these will be in bold.

Properties found in common/config/config.jspf

companyName A company name to be used throughout jsps in the bundle.  This is an example of a configuration property that is used to reduce duplication and make it easier to change these values (one place rather than many).
catalogName The name of the catalog that will be displayed in the catalog jsp.  This property also limits the submissions displayed in the submissions.jsp
catalogUrl A url that is used when clicking a catalog link and is ususally the main landing page for the bundle.  It currently builds a url to a launcher named "Catalog Portal". Typically this will be the name of the catalog launcher template created during setup.  This could also be any other arbitrary url.
profileUrl A url to the profile service item which is accessed by clicking on the username in the portal. This service items create a request to update the users information.
searchUrl A url for the search results service item/page. 
submissionsUrl A url for the submissions service item/page in the protal. This page allows the user to view their submitted requests.
submissionDetailsUrl A url for the page that is used to handle the submission details for each submitted request. 
searchNameParam The parameter that is used in the "Display for URL" field on the search service item.
loginUrl The url that goes to the login service item.  It currently builds a url to a launcher named "Login" but in most cases this will be the name of the login launcher template created during setup.
logoutUrl The url that logs a user out of the application.  It is simply a url to a servlet in Kinetic Request that performs a logout
RequestsParked A qualification used in the submissions page to retrieve parked requests.
RequestsOpen A qualification used in the submissions page to retrieve open requests.
RequestsClosed A qualification used in the submissions page to retrieve closed requests.
ApprovalsPending A qualification used in the submissions page to retrieve pending approvals.
ApprovalsComplete A qualification used in the submissions page to retrieve complete approvals.

Properties found in packages/base/config.jspf

defaultLoginAction A url that is used for redirection after the user logs in via the login launcher template created during setup.  Note that redirection occurs only if the user when straight to the login page.
forgotPasswordAction A url that is used on the login page as a forgot password link.  This will generally be a url to a service item that helps the user reset/recover their password.