Add a tutorial to your user guide
Tutorials describes steps for completing an end-user task. To mark a tutorial, add any of the following tags to any page:
Add a troubleshooting page
Troubleshooting pages are for users to identify reasons and fixes for problems. To mark a troubleshooting page, add the tag
Add a reference page to your user guide
Reference pages list essential facts about a feature or system. To mark a reference page, add the tag
All file paths in the following documentation are relative to the kinetic/themes/vattenfall directory.
<config: keyname> - refers to a setting in /packages/catalog/config/config.jsp
bundle. - refers to the bundle object in Java. This object is built from the /core/framework/includes/bundleInitialization.jspf file and is added to from other jsp pages as needed. This object is available to all pages.
Bundles utilize a very structured configuration. Note this is the current/newer structure. There are a number of themes available bundles with a different structure that was used previously. If you have a theme/bundle in place from 2013-early 2015, it might be the structure documented here.
Theme / branding / layout for the kinetic request application implementation.
Layout files used across the portal.
Core application files. These should not be modified.
Externally created library files (e.g. jQuery, moment, etc.). These files can differ based on the customers’ implementation and can change as functionality is customized, added, or removed.
Drop in modules of functionality. The service catalog package is included in all bundles.
Standard Bundle Page Flow
package: The package name
Sets miscellaneous java variables for the specific package.
Common files are used to create the visible portions of the portal that are used on every portal page and form. They also preload data for global use and some of this common data is stored in the browser session.
This file is responsible for initializing the common framework. It is loaded by the core bundleInitialization.jspf file (which is responsible for initializing the bundle framework). It loads the common configuration file and any present helpers or models. This file will need to be modified if there are any helper or model classes that are added to common.
This file is responsible for initializing the language files for translations. This file should not be modified.
This file will send an HTTP (302) Found redirection response if there is a context associated with the request (indicating the user is presently logged in). It is frequently included by login pages so that the user is never returned to the login page after they have logged in.
The header includes the logo, search bar, links to all the pages in the portal and the user information / links. The tabs and links come from an aggregation of the the config.json files in each package. The menus and links are defined under the “links” json object and uses “type” to specify where the links are shown.
link types: main-menu
The footer includes link for about and site feedback.
link types: footer
These files are the main formatting pages that include the html head files, header, footer, and pull in the content based on the url view parameter. These layouts can be overwritten by the package layout files.
The files in this directory are used for Kinetic Request and should not be modified.
Portal pages are the main landing pages of the web interface and are usually 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 read.me 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
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.