Knowledge base van het KE-chain platform

Page tree
Skip to end of metadata
Go to start of metadata

Definition

A widget is an element that can be added and visualized inside a task and which is used to show and edit data in an accessible way for the user. There are multiple type of widgets that can be used to perform work with inside a task. There is no limit on the number or type of widgets that a task can have, but keep in mind that multiple widgets will mean a larger vertical scrollbar.


Widget configuration dialog

Most of widgets interact directly with other concepts inside KE-chain, by providing a better visualization, accessibility or usability of parts, properties, tasks, services, projects, etc. All of them have a simple interface that guide the user through the entire process of configuring everything he desires with minimum effort. All the widgets will be thoroughly described in a table at the bottom of the page. An example of such a configuration dialog is presented in the images below.

Figure 1: Select widget dialog showing all the type of widgets a user can choose from


Once a widget is selected, the next step is usually to select a certain KE-chain element that will be linked and shown by the widget. For example, in the case of the Task Navigation widget, one must add buttons that link to a task in the same project.

Figure 2: Providing the data linked to the widget


The penultimate step is to style the widget. The styling options differ as well from widget to widget, but overall they are related to how the widget will be displayed in the task. For example, for the Task Navigation widget, one can choose where to have the buttons displayed.

Figure 3: Styling the widget

Lastly, the widget is saved and added to the task.


List of widgets available in KE-chain

#Widget nameKE-chain data needed?Included in the PDF download?How does it look?Additional options
1Meta Panel widgetNone

NO

Header bar
  • show/hide breadcrumbs
  • show/hide title
  • show/hide assignees
  • show/hide start date
  • show/hide due date
  • show/hide progress bar
  • show/hide status
  • include/exclude download pdf button
  • customize progress bar (if shown):
    • height of progress bar
    • show/hide progress text
    • customize colors
2Form widget
  • Part model and at least one of its properties
  • A Part instance of the selected part model

YES

Grid:

  • each row is a property of the selected part
  • between 2 and 4 columns: property name, property value and (optionally) property unit and property description
  • title of the widget can be adapted
  • height of the widget can be adapted or set to Automatic
  • add/remove padding
  • grid can be collapsible/non-collapsible and be fixed in a default collapsed or expanded state
  • headers of columns can be shown or hidden
  • columns that can be shown or hidden:
    • property unit
    • property description
3Basic table widget
  • Part model and at least one of its properties
  • Parent instance (where quantity applies)

YES

Grid:

  • each row is a part instance of the selected part model
  • each column is a property of the selected part model
  • title of the widget can be adapted
  • add/remove padding
  • grid can be collapsible/non-collapsible and be fixed in a default collapsed or expanded state
  • height of the widget can be adapted
  • grid buttons that allow to interact with the product (button can be emphasized):
    • add part
    • clone part
    • edit part
    • delete part
    • show/hide incomplete rows
    • export to excel
    • import from excel
  • grid can be sorted on the following columns:
    • the part name
    • any property (sorting is performed on the values of the respective property)
  • sorting can be done in ascending or descending order
  • show/hide name column
4Paginated table widget
  • Part model and at least one of its properties
  • Parent instance (where quantity applies)

YES

Same as for Basic table widget, but it includes a filtering panel on the left

  • same as for Basic table widget
  • pagination (number of elements to be shown per page)
  • pre-filter and included columns:
    • which properties to show
    • which values to have the properties pre-filtered on
5Script widget
  • A KE-chain "Python script" service
  • The service can contain a Python script, a .zip file or a kecpkg file

NO

Button:

  • when it gets pressed in starts the customized script
  • contact the Service desk to consult on how to better build your desired script
  • read more about the potential of scripts inside KE-chain here
  • title of the widget can be adapted
  • text on the button can be adapted
    • button itself can be emphasized or not
  • add/remove padding
  • include/exclude the log
  • add the possibility to download the log
  • widget can be collapsible/non-collapsible and be fixed in a default collapsed or expanded state
6Notebook widget
  • A KE-chain "Notebook" service
  • The service can contain IPython Notebook Script

NO

Same as for Script widget, but in addition, the script can be edited live inside the task

  • title of the widget can be adapted
  • height of the widget can be adapted
  • add/remove padding
  • make the widget collapsible and fix it in a default collapsed state
7Text widgetNone

YES

Text container
  • title of the widget can be adapted
  • text container can be collapsible/non-collapsible and be fixed in a default collapsed or expanded state
8Attachment viewer widget

An Attachment Property instance

YES

Preview of the attachment inside the selected property. Preview can only be generated for specific files: image file formats and PDF's.

  • title of the widget can be adapted
  • widget can be collapsible/non-collapsible and be fixed in a default collapsed or expanded state
  • add/remove padding
  • image/PDF can be aligned to the left, center or right of the widget
  • height of the widget can be adapted
  • image can be fitted in a contained or cover form
9Task Navigation widget(Optional) A KE-chain task

NO

Button(s):

  • pressing the button will take you to the task that has been selected
  • pressing the external button will take you to the link that has been added
  • alignment of the button(s) can be adapted to the left, center or right of the widget
  • text on the button can be adapted
  • button can be emphasized
  • the link can either open in the current tab or in a new one
10Tasks widgetA KE-chain process

NO

List of activities similar to the tasks grid, but potentially filtered and only showing the activities under a certain process.
  • title of the widget can be adapted
  • height of the widget can be adapted
  • widget can be collapsible/non-collapsible and be fixed in a default collapsed or expanded state
  • grid buttons that allow configuration of the grid:
    • edit
    • delete
    • my tasks toggle button
    • open tasks toggle button
    • search filter
    • showing filter panel in a collapsed/expanded state
  • prefilters that only show some tasks:
    • in the entire workflow/catalog or under a certain selected process
    • any tasks/only assigned tasks/only assigned to the logged user/unassigned
    • any tasks/open tasks/completed tasks
    • prefiltering by tags is possible
  • columns can be shown or hidden
    • assignees
    • start date
    • due date
    • status
    • tags
    • progress
  • grid can be sorted on the following columns (in ascending or descending order):
    • name of activity
    • assignees
    • start date
    • due date
    • progress
    • status
  • pagination can be set
11Multi Column widgetA KE-chain widget which is not a multi-column widget

YES


A container of widgets placed next to each other horizontally
  • title of the widget can be adapted
  • add/remove padding
  • height of the widget can be adapted
  • widget an be collapsible/non-collapsible and be fixed in a default collapsed or expanded state
12Projects table widgetA KE-chain team or a project tag

NO

Grid:

  • each row is a project belonging to the selected team or with the selected tag
  • each property is a project attribute (start date, due date, progress, status)
  • title of the widget can be adapted
  • add/remove padding
  • widget an be collapsible/non-collapsible and be fixed in a default collapsed or expanded state
  • columns that can be shown or hidden:
    • start date
    • due date
    • progress
    • status
  • grid can be sorted on the following columns:
    • the name of the project itself
    • start date
    • due date
    • progress
    • status
  • sorting can be done in ascending or descending order

13Progress widgetNone

NO

Progress bar
  • height of the widget can be adapted
  • show/hide progress text
  • customize colors
14Signature widgetAn Attachment Property instance

YES

A canvas where the user can draw a signature using the mouse cursor or his finger
  • title of the widget can be adapted
  • text on the place signature button can be adapted
  • text on the remove signature button can be adapted
15Card widget(Optional) An Attachment Property instance

NO

An image with text that is clickable and points to a certain link
  • title of the widget can be adapted
  • description of the widget can be adapted
  • link can be adapted:
    • no link
    • a link to a task
    • an external link
  • the link can either open in the current tab or in a new one
  • height of the widget can be adapted
  • the image to be displayed can be provided
    • the content of the selected attachment property
    • no image
16Weather bar widgetAn Weather information Property instance

YES

A container specifying:

  • Location where the weather information is recorded
  • Time of recording
  • Temperature
  • Real feel temperature
  • Weather status (cloudy, sunny, rainy, etc)
  • Wind speed (km/h)
  • Wind direction
  • Precipitation (mm)
  • Humidity (percentage)
  • title of the widget can be adapted
  • add/remove padding
  • widget an be collapsible/non-collapsible and be fixed in a default collapsed or expanded state