Skip to main content
Kinetic Community

Flyout

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.

Screenshots

Flyout MenusSubmissions list consoleSubmission's Activity

ListingService Item ExampleSubmission's Table

Repository

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

The link above is a link to the code repository where the theme can be found.  On the repository page there is a download link that says "Download 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 Bundle as development continues.  Changes may include implementation of new features, additional documentation, or bug fixes.  Github is a 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.

    • About
    • Catalog
    • Catalog Listing
    • Category
    • Profile
    • Search
    • Service Item Example with Person Lookup
    • Site Feedback
    • Submissions
  7. In the bundle directory open the your-theme-name/common/config/config.jspf file. Update each line where the word "Flyout" 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

This 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 necessary 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 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 Configuration property used to set the company name which can be referenced throughout the Bundle.
catalogName Configuration property used to set the Catalog that uses the Bundle.
aboutUrl Configuration property used for the url to the about page.
catalogUrl Configuration property used for the url to the catalog page.
profileUrl Configuration property used for the url to the profile page.
searchUrl Configuration property used for the url to the search page.
submissionsUrl Configuration property used for the url to the submission's page.
submissionActivityUrl Configuration property used for the url to the submission's activity page.
searchNameParam The parameter that is used in the "Display for URL" field on the search service item.
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
Draft Request A qualification used in the submissions page to retrieve parked/draft requests.
Open Request A qualification used in the submissions page to retrieve open requests.
Closed Request A qualification used in the submissions page to retrieve closed requests.
Pending Approval A qualification used in the submissions page to retrieve pending approvals.
Completed Approval A qualification used in the submissions page to retrieve complete approvals.
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.