Information
This documentation is created by Fusion, a BMC partner.

Single-Source


This section explains how to create a Single-Source Kanban Board.

Boards configured in this mode will display data from a single record definition. The lanes will be auto-generated, e.g., based on the available status options.

Before you begin

There are two cases to consider before we start configuring a Single-Source Kanban Board:

Case 1: If you want to configure Kanban for BMC Helix Business Workflows, BMC Helix ITSM or an entity from Fusion Agility Suite, no changes are required in the data model. 

Case 2: Apart from the above for any other use case that needs to be implemented the following requirements should be met: 


    • The custom record definition, that needs to be displayed in the Kanban Board, must have an association with the record definition "CTM: People".
      • One to Many
      • Node A: CTM: People
      • Node B: Custom Record Definition 
    • The record definition must have an association with the record definition "CTM: Support Group" (or any other record definition, that serves as a group).
      • One to Many
      • Node A: Group Record Definition
      • Node B: Custom Record Definition
      • Alternatively to the above, it is possible to have a separate record, that holds the relation between the people and groups. However, the usage of associations is recommended.
    • The chosen group record definition also needs an association with "CTM: People". If "CTM: Support Group" is chosen, this is not needed.
      • Many to Many
      • Node A: Group Record Definition
      • Node B: CTM: People

Once these requirements are met we can move on with the configuration of the Kanban Board. Below is an example, that shows a configuration of the Kanban Board for BMC Helix ITSM Tasks

To configure Single-Source Kanban board

image2020-12-18_11-52-34.png












  1. Create a “New” regular view and give a name to the view, e.g., "Kanban - ITSM - Task" and save it.
  2. Search for the Kanban Board component in the palette on the left-hand side of the canvas. It can be found in the "Fusion Toolbox" section or using the search bar.
  3. Drag and drop the component onto the canvas.
  4. Configure the Kanban Board using the property pane on the right-hand side of the canvas. An explanation for each property can be found below.

General

In the "General" section, you can specify the height and width of the lanes in addition to the label. The current values are well suited for five lanes.

image2022-2-23_13-0-13.png





















Field Name

Description

View Component Name

Choose a unique description to distinguish the component from potential other Kanban Boards o the view.

Label Field

In this field, you specify the title of the Kanban Board.

Data Source

In this field, you specify the source. It contains two values: Single-Source and Multi-Source.

Lane Height

This field is used in configuring the height of the Kanban Board lanes using CSS.

Lane Width

This field is used in configuring the width of the Kanban Board lanes using CSS.

Hidden Toggle

Switching it on will hide the Kanban Board.

Refresh Button in the toolbar

Switching this toggle on will add a refresh button on the Kanban Board. 

Entry

In this section, the properties of a Kanban Board entry are mapped to a record definition and its fields.

image2022-2-23_13-2-50.png

Field Name

Description

Record Definition Name

Selection of the record definition, that serves as a source for the cards.

Description Field

The field's value will be displayed as the headline of each card.

Display ID Field

Display ID or Prefix Display ID Field should be mapped here.

Modified Date Field

Modified Date Field should be mapped here.

Person ID Type

Here you can choose from 2 values: Login ID, and ID. The value you choose here should depend on the type of value the assigned person field contains in your record. If the Login ID is stored in the field which contains the Assigned person, then "Login ID" should be chosen here and likewise, the ID option can be chosen.

Person ID Field

Here you should map the field which holds the data for an assigned person.

Group ID Type

Here you can choose from 2 values: ID, and Display ID. The value you choose here should depend on the type of value the assigned group field contains in your record. If the ID of the group is stored in the field which contains the Assigned Group then, the ID should be chosen here otherwise the Display ID option can be chosen.

Group ID

Here you should map the field where Group ID is stored.

Lane Configuration

In this section, it is determined what method the Kanban Board uses to generate its lanes, along with other lane configurations.

image2020-12-15_18-23-25.png

Field Name

Description

Source

This field determines from where the Kanban Board extracts its lanes. There are 3 types;

  • Selection Field: It can be used for all the use cases.
  • Behaviour: It can be used for use cases related to root objects of Agility Suite.
  • Flow set: It is used for use cases of BWF Cases and Tasks.

Company ID

Applicable only for BWF use cases. It helps to determine the correct Flowset.

Behaviour ID / Flowset ID

If the "Source" is Behavior or Flowset, then this field should contain the ID of the corresponding Flowset or Behavior, respectively. The information is used to extract the status lifecycles and generate the lanes. 

Successor Indication

If Successor Indication is enabled, the Kanban Board visualizes which successors are possible for a certain item, when dragging it. This option is available for Behaviors and Flowsets.

Lane Field

A field can be chosen, out of all the fields of type "Selection" from the record definition. The options of that field will be displayed as lanes on the Kanban Board.

Invisible Lanes

The values of the selection field that you do not want to show in the Kanban Board can be put here. The values need to be comma-separated.

E.g., if you do not want to display the status 'New' in the Kanban Board, you can add the value of 'New' (1000) to the list, which hides the lane and therefore all the instances with this status option.

Lane Change Dialog Lanes

You can specify in which lane the Lane Change Dialog should be displayed.

A potential use case is when the status reason has to be specified for items when they are moved to the lane "Closed". The selection of the status reason can be handled in the dialogue.

Group Configuration

image2022-2-23_13-19-21.png

Field Name

Description

Group Record Definition Name

The record that is associated with the item and acts as a group needs to be selected here.

Group Id

The ID field of the group record needs to be mapped here.

E.g., the Record ID field from the Support Group Record contains the Id of the group.

Group Display Id

Map the field, that contains the Display Id of the group.

Group Name

Map the field that contains the name of the group that should be displayed to the end-user on the Kanban Board.

Association Mode

  • Record: This value should be chosen when there is a record definition, that stores the association between people and groups, e.g., the "Support Group People Assoc Join", a join record, that stores the relation between CTM:People and CTM:Support Group.
  • Association: This value should be chosen when there is an association between the group record and the People record.

Person to Group Relation (Join)

Only applicable when the Association Mode is "Record".

A record needs to be selected, that represents the relationship between people and the group record.

Person Id Field

Only applicable when Association Mode is "Record" 

Map the field which stores the ID of a person.

E.g., "PeopleRecordID" stores the ID of the person in "Support Group People Assoc Join".

Group Id Field

Only applicable when Association Mode is "Record" 

Map the field which stores the ID of the group.

E.g., "Support Group IS GUID" stores the ID of the person in "Support Group People Assoc Join".

Person to Group Relation (Association)

Only applicable when Association Mode is "Association".

Choose an association between CTM:People and the group record.

Filters

image2022-3-1_12-19-4.png

Field Name

Description

Initial Entry Filters

This expression is applied to the entry record and allows to filter out items with certain properties. 

Group Filter Expression

This expression is applied to the group filters the groups, that will be visible on the Kanban Board.

User Filter Expression

This filter expression is applied when loading the users, which can be used on the Kanban Board.

The value in this field is : "'4' !=\"NULL\"".

Note: Sometimes the field will display an error, this error can be ignored if the filter works as per your expectations.

Available filter fields

Ids of the field can be added here in a comma-separated format. Fields added here will be available in the filter section of the Kanban Board, and items can be filtered based on these fields.

Initial Entry Filter formating

The following examples describe the format of the filters for different types of fields:

No.

Type of Filter

JSON Format

When used in Expression Editor

1

Text Field Filter

Only items with the value "123456789" in the text field '536875002' will be displayed.

{
 "fieldId": 536875002,
 "resourceType": "com.bmc.arsys.rx.standardlib.record.CharacterFieldDefinition",
 "values": [
   {
     "name": "123456789"
   }
  ]
}
 "[{
  \"
fieldId\": 536875002,
  \"
resourceType\": \"com.bmc.arsys.rx.standardlib.record.CharacterFieldDefinition\",
  \"
values\": [
    {
      \"
name\": \"123456789\"
    }
  ]
}]"

2

Selection Field Filter

 Only items where the selection field (536870916) has a value of '2' or '3' will be displayed.

{
"fieldId": 536870916,
"resourceType": "com.bmc.arsys.rx.standardlib.record.SelectionFieldDefinition",
"values": [
{
"id": "2"
},
{
"id": "3"
}
]
}
 "[{
          \"
fieldId\": 536870916,
          \"
resourceType\": \"com.bmc.arsys.rx.standardlib.record.SelectionFieldDefinition\",
          \"
values\": [
            {
              \"
id\": \"2\"
            },
            {
              \"
id\": \"3\"
            }
          ]
}]"

3

Date Field Filter

 Only the items where the date field (6) has a value between "2020-8-5 - 2020-8-6" will be displayed.

{
         "fieldId": 6,
         "resourceType": "com.bmc.arsys.rx.standardlib.record.DateTimeFieldDefinition",
         "values": [
           {
             "name": "2020-8-5 - 2020-8-6"
           }
          ]
}
"[{
          \"
fieldId\": 6,
          \"
resourceType\": \"com.bmc.arsys.rx.standardlib.record.DateTimeFieldDefinition\",
          \"
values\": [
            {
              \"
name\": \"2020-8-5 - 2020-8-6\"
            }
          ]
}]"

Each lane item in a Kanban Board contains a "Link" button.

image2021-7-19_11-41-9.png

On click, a new tab will be opened, navigating to a preconfigured link. This link is configured in this section.

image2020-12-15_18-31-56.png






Field Name

Description

Link Text

This expression should contain a URL. The link must start with "https://" or "http://" and will be extended by the ID of the respective entity that as clicked. 

Instead of providing a static link, here, the "Setting Value" object contains the base URL which can be extended by a suitable substring("task/").

Lane Change Blade

In this area, the custom view for the Lane Change Dialog is configured. This view is only opened when a user moves the item to another lane via drag and drop.

For example, it can be used to set the status reason when changing the status.

image2022-2-23_15-7-3.png

Field Name

Description

Lane Change Dialog Definition Name

Here, you need to select the view that you want to open up when changing lanes.

The dialogue will only open up when you move an item on the lanes where you have configured 'Lane Change Dialog Lanes' in the Lane Configuration Section.

Size

This field will determine the size of the dialogue. There are six possible values in this field, a value can be chosen according to requirement.

Presentation Type

This field will determine where the dialogue will open up. There are three possible values for this field, a value can be chosen according to requirement.

Title

Here you can specify the title of the blade. It will be displayed at the top of the dialogue when it opens up.

NOTE: The Input parameters of the selected view need to be exactly the same as it is in the Extension Toolbox template view. You can take that view as a reference.

Custom Blade

In this section, we configure the view that will open when clicked on the pencil icon on the Kanban Board. Here we can decide the size, title, and presentation type of the view. 

image2022-2-23_15-7-44.png

Field Name

Description

View Definition Name

Here, you need to select the view that you want to open up, by clicking the pen/edit icon on the Kanban Board.

Size

This field will determine the size of the dialogue. There are six possible values in this field, a value can be chosen according to requirement.

Presentation Type

This field will determine where the dialogue will open up. There are three possible values for this field, a value can be chosen according to requirement.

Title

Here you can specify the title of the dialogue box. It will be displayed at the top of the dialogue when it opens up. 

NOTE: The input parameters of the selected view need to be exactly the same as it is in the Extension Toolbox. You can take that view as a reference while creating your views.

Processes

In this section we map the process that will be triggered by the following actions:

  • Dragging groups from the chip bars onto lane items.
  • Dragging users from the chip bar onto lane items.
  • Moving items to different lanes.

image2022-2-23_15-8-19.png

Field Name

Description

Group Drop Process

The selected process is triggered when a group is dragged from the chipbar onto an item. The process should be used to assign the group to that item.

User Drop Process

The selected process is triggered when a person is dragged from the chipbar onto an item. The process should be used to assign the user to that item.

Item Drop

The selected process is triggered when you change the lane of an item. This process should be used to change the corresponding field, which is represented by the lane. 

NOTE: When creating any of these processes, for best results you can copy the respective process from the corresponding Extension Toolbox templates. If not, then you need to take care of the naming conventions of the input parameters of the process. The names of input parameters should be exactly the same as the ones in the templates.

Timestamp

image2022-2-23_15-8-51.png

Field Name

Description

Date Threshold

Here you can specify after how many days you want to change the format of the modified date.

For example, The date threshold is set to 5, so for days the modified date will be like "Modified 4 days ago", after the 5th day it will start showing the modified date in the format specified below.

Date Format

This date format is pre-configured however, it can be changed according to requirements.

Colours

In this area, colour codes can be used to customize the appearance of the Kanban Board.

image2022-2-23_15-9-16.png

The default values are currently filled in here.

Clicking on the field opens up a colour picker, and colours can be selected from there.

Field Name

Description

Toolbar Color

Allows you to change the colour of the toolbar.

Toolbar Text Color

Allows you to change the text colour of the toolbar.

Lane Color

Allows you to change the colour of Lane.

Lane Text Color

Allows you to change the text colour of Lane.

Card Color

Allows you to change the colour of the card.

Card Text Color

Allows you to change the text colour of the card.

Successor Indication Color

Allows you to change the colour of the successor indication in the Kanban Board.

Card Shadow

image2022-2-23_15-9-39.png

Field Name

Description

Card Shadow Field

In this field, you can choose from all the selection fields available in the record.

Setting this field allows you to distinguish items based on an attribute, e.g., the priority. Just looking at the items, allows you to distinguish their priority.

Here is an example of how items will look once the card shadow field is set up.

image2021-3-3_16-22-2.png

Once the configuration is done, click on Save and the Kanban Board is ready to use.

                                                         

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

Fusion Visual Boards for BMC Helix 21.3