Skip to main content
Kinetic Community

Catalogs

A new catalog can be created by using the catalog function. The catalog function takes one argument, which is the string name of the catalog. The catalog function also takes a code block that contains function calls that create categories within the catalog.

Catalog Flags

The :active and :inactive flags are used to configure the status of the catalog to be created. One of these can be used for a catalog.

Catalog Options

The :assignee_group option configures the assignee group.

The :management_group option configures the management group.

The :description option configures the service catalog description and the short description.

The :web_server_url option configures the web server URL to be used by the catalog.

The :display_page option configures the display page JSP to be used by the catalog.

Catalog Functions

The category function (Chapter 2).

Catalog Creation

catalog "New Catalog",
  :description => "New Catalog description",
  :web_server_url => "http://127.0.0.1:8080/kinetic/",
  :display_page => "/displayPage.jsp",
  :assignee_group => "0;",
  :management_group => "Public"
  do
    # Catalog categories can be created here
end

Categories

Categories can be created by calling the category function within the code block passed to the catalog function.

Category Flags

The :active and :inactive flags are used to configure the status of the category to be created. One of these can be used for a category.

Category Options

The :sort_order option configures the sort order.

The :description option configures a description for the category

The :icon_html option configures an html string for the category to be used on a portal page.

The :icon_name option assigns an image from the image library to be used for the category on a portal page.  Note that when this option is used it will automatically create image html for the category, which will overwrite any specified by the :icon_html option above.

The :number_of_items option configures a number of items to be used on a portal page.

Category Creation

catalog "New Catalog"
  # Catalog configuration is done here...
  do
  category "Computer Hardware",
    :active,
    :sort_order => "10",
    :number_of_items => "1",
    :icon_name => "Hardware Icon",
    :description => "Service Requests and other Incidents involving computer hardware. "
  category "Software",
    :active,
    :sort_order => "20",
    :number_of_items => "5",
    :icon_name => "Software Icon",
    :description => "PC and server software requests.  PC software issue reporting and related items."
end

In the example above two categories are created.  The categories are named “Computer Hardware” and “Software” and have sort orders of 10 and 20 respectively.  Also note that both categories have icon names configured, these are image elements defined in the image library.