Knowledgebase Parameters

The following table displays the input parameters used in the Generic Control of the Workflow Designer's Screen Editor. They can be used for configuring the Generic Control to display Knowledgebase content in a script.

Name Type Description
AUTOSHOW BOOLEAN TBC
BACKGROUND COLOUR Sets the main background colour of the KB Viewer control
BORDER OPTION (TRUE, FALSE) Shows or hides the border
BORDERCOLOUR COLOUR The colour of the border
BORDERWIDTH NUMBER The width of the border in pixels
CURVEBOTTOMLEFT BOOLEAN If TRUE the bottom left corner will be shown curved
CURVEBOTTOMRIGHT BOOLEAN If TRUE the bottom right corner will be shown curved
CURVESIZE NUMBER The size of the corner curve
CURVETOPLEFT BOOLEAN If TRUE the top left corner will be shown curved
CURVETOPRIGHT BOOLEAN If TRUE the top right corner will be shown curved
HEADERBACKCOLOUR COLOUR The background colour of the main KB Text label
HEADERFONT FONT The font of the main KB Text label
HEADERFORECOLOUR COLOUR The text colour of the main KB Text label
HEADERTEXT CONTROL The text to be shown on the main KB control
Name Type Description
ITEMBACKGROUND COLOUR The background colour for the articles
ITEMFONT FONT The font the articles will be shown in
ITEMFOREGROUND COLOUR The text colour of the articles
ITEMHOVERBACKGROUND COLOUR The background colour of the article when the mouse is hovering over it
ITEMHOVERFOREGROUND COLOUR The text colour of the article when the mouse is hovering over it
ITEMICON OPTION(NONE, ARROW, BUBBLE, CIRCLE, DOT, FLAG, INFO, PLAY, PLUS, STAR, SQUARE, TICK) Used to show an image alongside each article listed in the viewer
ITEMICONCOLOUR OPTION (BLACK, WHITE) The colour of the article icon
ITEMICONSIZE OPTION (8, 16, 24, 32, 48, 64) The size of the article icon
ITEMMAXTOSHOW NUMBER The maximum number of articles to show
ITEMMAXWIDTH NUMBER The maximum width an article item will take up. If set to 0 it will take up as much space as is available
ITEMMINWIDTH NUMBER The minimum width an article item will take up
ITEMSELECTEDBACKGROUND COLOUR The background colour of the article when it is selected
ITEMSELECTEDFOREGROUND COLOUR The text colour of the article when it is selected
KNOWLEDGEBASEID NUMBER The ID of the KB the data is to be loaded from
Name Type Description
MENUCOLOUR COLOUR The background colour of the menu strip
MENUHOVERCOLOUR COLOUR The hover over colour of the menu options
MENUICONCOLOUR OPTION (BLACK, WHITE, BLUE) The colour of the menu icons
MENULOCATION OPTION (TOP, LEFT, BOTTOM, RIGHT) The location of the menu strip
MENULOGO NUMBER The ID of the logo to be shown on the KB Viewer
MENUSELECTEDCOLOUR COLOUR The background colour of the selected menu option
MENUSHOW BOOLEAN If set to TRUE the menu strip will be shown
MENUSHOWHISTORY BOOLEAN If set to TRUE the “history” menu option will be shown
MENUSHOWSEARCH BOOLEAN If set to TRUE the “search” menu option will be shown
MENUSHOWSTAR BOOLEAN If set to TRUE the “top” menu option will be shown
MENUUNSELECTEDCOLOUR COLOUR The background colour of the unselected menu options
MODE TEXT

Indicates what MODE the viewer should be in. Options are:

  • SEARCH – use the SEARCHSTRING parameter to look for matching articles
  • ARTICLE – use SEARCHSTRING and SEARCHCATEGORY to point to a specific article either by ID or text description
  • CATEGORYLIST – display a list of articles from the specified SEARCHCATEGORY, and sub category by setting SEARCHSTRING
  • RECENT – shows the top viewed items within the defined period
  • ORDERED – shows the articles for the specified SEARCHCATEGORY, and sub category by setting SEARCHSTRING, order by viewed count optionally by the recent period
  • TOP – Shows the top viewed items
Name Type Description
RECENTPERIOD CONTROL The time period to be used when determining the top most viewed articles. Set as np where n is the number and p is D for Day, W for week, M for month and Y for Year.
RECENTTOPCOUNT CONTROL The number of items to be returned when doing a recent top viewed list
SEARCHBACKGROUND COLOUR The background colour for the search panel
SEARCHBUTTONBACKGROUND COLOUR The background colour of the search button
SEARCHBUTTONFOREGROUND COLOUR The text colour of the search button
SEARCHBUTTONICON OPTION (NONE,WHITE, BLACK)| Used to indicate whether or not to show the icon on the search button, and if so which colour
SEARCHBUTTONTEXT CONTROL The text to be shown on the search button
SEARCHCATEGORY CONTROL Used to pass search data to the control on 1st and subsequent calls to “initialise generic control” command
SEARCHFONT FONT The font to be used on the search panel
Name Type Description
SEARCHFOREGROUND COLOUR The text colour for the search panel
SEARCHITEMWIDTH NUMBER The width of the search input
SEARCHSHOWCATEGORY BOOLEAN If TRUE then the category list will be shown on the search panel
SEARCHSTRING CONTROL Used to pass search data to the control on 1st and subsequent calls to “initialise generic control” command
SHOWHEADER BOOLEAN Used to show/hide the main KB Text Label
SHOWRELATED BOOLEAN if TRUE when an article is shown change item list to show related articles
VIEWERBACKGROUND COLOUR The background colour of the viewer title text
VIEWERFONT FONT The font for the viewer title text
VIEWERFOREGROUND COLOUR The text colour of the viewer title text
VIEWERHEIGHT NUMBER The initial HEIGHT location of the viewer window
VIEWERLEFT NUMBER The initial LEFT location of the viewer window
VIEWERTOP NUMBER The initial TOP location of the viewer window
VIEWERWIDTH NUMBER The initial WIDTH location of the viewer window