B2B CRM Kanban Boards
By default, the following Kanban boards are available in the B2B CRM application:
However, you can create boards for other tables, if such a table:
- Is created in the B2B CRM application.
- Has at least one column of type Choice.
- Has at least one column of type Reference: employee.
Role required: admin, crm_admin.
Create a kanban board
The boards are created automatically for sales directions when you click the Open opportunity board and Open content board buttons on the sales direction form.
You can also manually add records to the Sales Direction Board (crm_selling_direction_board) table. To do so, complete the following steps:
- Navigate to CRM → Parameters → Sales Direction Boards.
- Click New and fill in the fields.
- Click Save or Save and view.
Sales Direction Board form fields
Field | Mandatory | Description |
---|---|---|
Name | Y | Specify the board name. |
Sales direction | N | Specify the sales direction to which the board belongs. By default, the field is completed with the first found sales direction of the current user. If there is none, the field remains empty. You can edit the value. |
- General
- Cards
- Swimlanes
Field | Mandatory | Description |
---|---|---|
Table | Y | Specify the table whose records should be displayed as board cards. You can only select a table that belongs to the B2B CRM application and has at least one column of type Choice and one of type Reference: employee. When the field is cleared, the values of the following fields are cleared as well:
|
Specify displaying condition in JSON | N | Activate the toggle if you need to specify the access condition to cards in JSON for the users with different roles. |
Record displaying condition | N | Specify the access condition to cards for the users in the condition builder. The field is displayed only if the Specify displaying condition in JSON toggle is in the inactive position. |
Displaying condition in JSON | N | Specify the access condition to cards for the users with different roles in JSON using the template. In the template, the properties are user roles from the B2B CRM application, and the keys are the access conditions for these roles. Example: The The field is displayed only if the Specify displaying condition in JSON toggle is in the active position. |
Specify background image link | N | Activate the toggle if you need to specify a link to the background image. |
Background image | N | Click the clip icon to open the attachments widget and upload the background image for the board. The field is displayed only if the Specify background image link toggle is in the inactive position. |
Background image link | N | Specify a link to the background image for the board. The field is displayed only if the Specify background image link toggle is in the active position. |
Field | Mandatory | Description |
---|---|---|
Card name field | N | Specify the column of the Table that contains the titles of the cards. It is usually Name or Subject. |
Responsible field | Y | Specify the column of the Table that contains the employee responsible for the card. |
Date of last state change field | N | Specify a column of type Date or Date/time that contains the date of the latest record update. This data will be used for the displaying of number of days since the latest update on the cards. It is calculated as: The current date – The date specified in the Date of last state change field. |
Blocking field | N | Specify the column of the Table, whose value defines if the card should be displayed as blocked on the board. |
Blocking value | N | Specify the value of the Blocking field that blocks the card. |
Table name badge | N | The field is read-only. It shows the text that will be displayed on the card if you display the table name badge. |
Table name badge color | N | Specify the color of the table name badge in the HEX format. |
Display table name badge | N | Select the checkbox to display the table name badge on the cards. |
Badge 2, 3, 4, 5 | N | Select a column, whose value must be displayed as a badge on the cards. |
Badge 2, 3, 4, 5 color | N | Specify the badge color in the HEX format. |
Field | Mandatory | Description |
---|---|---|
Main swimlane name | Y | Specify the main swimlane name. |
Expedite swimlane name | N | Specify the name of the swimlane that contains expedite records. If the field is empty, but the Expedite field is specified, the default name is used: Important. |
Expedite field | N | Specify the column of the Table that defines if the card should be placed in the expedite swimlane. |
Expedite value | N | Specify the value of the Expedite field that places the card in the expedite swimlane. |
State field | Y | Specify the Choice column of the Table that contains the card state. |
Specify excluded states | N | Activate the toggle if you need to specify the states excluded from the board. |
States on the board | N | Specify the states, for which the columns need to be added to the board. The cards in other states will not be displayed on the board. The field is displayed only if the Specify excluded states toggle is in the inactive position. |
Excluded states | N | Specify the states, for which there must be no columns on the board. The cards in these states will not be displayed. The columns will be created for all other states. The field is displayed only if the Specify excluded states toggle is in the active position. |
Unite states in areas | N | Activate the toggle if you need to create areas on the board. |
Area configuration | N | Specify the logic for unifying the columns in areas in the JSON format. Only the columns for which the WIP limits are specified can be united in areas. The property in the object is the leftmost state in the area, and the value is the array of sequential states included in the area. Example: the{"correction": ["internal_editing"]} template unites the Correction and Internal editing states in an area on the content board if the WIP limits are specified for these columns. If the Specify excluded states toggle is in the active position, specify the logic for the states that are not selected in the Excluded states field. If the toggle is in the inactive position, specify the logic for the states selected in the States on the board field. |
WIP limits | N | Specify the WIP limits for the board columns. When the WIP limit is reached, the column is highlighted in red. When the States on the board or Excluded states field is completed, the system automatically forms a template where you need to specify only the WIP limits for each state. If the Specify excluded states toggle is in the active position, specify the logic for the states that are not selected in the Excluded states field. If the toggle is in the inactive position, specify the logic for the states selected in the States on the board field. |
Edit a kanban board
To edit an existing kanban board, follow one of the instructions below:
- Navigate to CRM → Parameters → Sales Direction Boards, find the required record and open its form. Edit the required fields and click Save or Save and view.
- Open the board and click to edit it. Edit the required fields and click Save or Save and view. Ways to open a board:
- Navigate to CRM → Parameters → Sales Directions, find the record of the sales direction, the board of which you need to configure. Click Open opportunity board or Open content board.
- Navigate to CRM → Boards, find the required board and click on it.
- Navigate to My Work in CRM → My Opportunity Board / My Content Board / My Task Board.
Configure JSON
The Configure JSON UI-action is available on the board form. Click it to open a modal window where you can specify the board configuration in the JSON format. The structure opened when you click the button shows the current board setting and corresponds to the values of the parallel form fields. Click Apply when you finish the configuration to save the changes and open the board in a new tab. The values of the form fields will be updated to correspond with the new JSON configuration.
JSON configuration parameters
- rows
- cards
- lines
- global
The kanban board columns configuration.
Parameter | Description |
---|---|
WIP_limits | Specify the limits to the number of records in each state. Only the columns for which the WIP limits are specified can be united in areas. |
included_state | Specify the states for which the columns need to be added to the board. The cards in other states will not be displayed on the board. Use this parameter only if the excluded_states parameter is not specified. |
excluded_states | Specify the states, the records in which must not be displayed on the board. Use this parameter only if the included_state parameter is specified. |
state_aggregation | Specify the states that need to be united in areas. The property in the object is the leftmost state in the area, and the value is the array of sequential states included in the area. Only the columns for which the WIP limits are specified can be united in areas. |
The record cards configuration.
Parameter | Description |
---|---|
body | Specify the system name of the column, the value of which will be used as the card title. |
badge1 | Set the value to true to display a badge with the table name on the cards. |
badge2-5 | Specify the system names of the columns, the values of which will be displayed as badges in the cards. You can configure up to 4 badges. |
color_badge | Specify the colors for the badges in the HEX format. |
responsible | Specify the system name of the column that contains the responsible for the card. |
expedite_field | Specify the system name of the column, the value of which defines if the card needs to be placed in the expedite swimlane. |
expedite_value | Specify the value of the expedite_field column that places the card in the expedite swimlane. |
need_action_field | Specify the system name of the column, the value of which defines if the card is blocked (the card is marked with a lock sign). |
need_action_value | Specify the value of the need_action_field column that blocks the card. |
time_in_current_state | Specify the system name of the Date or Date/time column that contains the date of latest update of the card record. This data will be used for the displaying of number of days since the latest state change on the cards. It is calculated as: The current date – The date specified in the Date of last state change field. |
The board swimlanes configuration.
Parameter | Description |
---|---|
main_name | Specify the main swimlane name. |
expedite_name | Specify the expedite swimlane name. If the value of this parameter is not specified, but the value of the expedite_field parameter is specified, the default name is used: Important. |
The general kanban board configuration.
Parameter | Description |
---|---|
condition | Specify the filter condition for the record displaying on the kanban board. |
role_dependent_condition | Specify the conditions defining access of users with different roles to the board cards. Default stands for a user with no roles. In the template, the properties are the B2B CRM application roles, and the keys are the conditions for the roles. Example: when the |
row_column_id | Specify the ID of the column, the value of which us used for the separation of records to columns on the board (the record state column). |
row_column_name | Specify the system name of the column, the value of which is used for the separation of records to columns on the board (the record state column). |
essence_table_id | Specify the ID of the table, the records of which need to be displayed on the board. |
essence_table_name | Specify the system name of the column, the records of which need to be displayed on the board. |
background_image_url | Specify a link to the background image. Use this parameter only if you do not use the background_image_id parameter. |
background_image_id | Specify the ID of the background image. Use this parameter only if you do not use the background_image_url parameter. |
Example of JSON configuration for an opportunity board
{
"rows":{
"WIP_limits":{},
"included_state":[],
"excluded_states":[
"Support and post-sale",
"Demand generation"
],
"state_aggregation":[]
},
"cards":{
"body":"name",
"badge1":"",
"badge2":"service_or_product",
"badge3":"selling_direction",
"badge4":"estimated_revenue",
"badge5":"opportunity_probability",
"color_badge_1":"#0068B3",
"color_badge_2":"#ff7514",
"color_badge_3":"#0068B3",
"color_badge_4":"#77dd77",
"color_badge_5":"#0068B3",
"responsible":"responsible",
"expedite_field":"",
"expedite_value":"",
"need_action_field":"status_reason",
"need_action_value":"on_hold",
"time_in_current_state":"sys_updated_at"
},
"lines":{
"main_name":"Main Opportunity",
"expedite_name":"Expedite"
},
"global":{
"condition":"",
"role_dependent_condition": {
"default": "(active=1^open=1^selling_directionDYNAMIC168752035023072720)",
"admin": "(active=1^open=1)",
"crm_admin": "(active=1^open=1)",
"crm_read_admin": "(active=1^open=1)"
},
"row_column_id":"166480673810623773",
"row_column_name":"stage",
"essence_table_id":"166480589916282031",
"essence_table_name":"crm_opportunity",
"background_image_url":"",
"background_image_id":"168907430726377278"
}
}
Example of JSON configuration for a content board
{
"rows":{
"WIP_limits":{
"backlog":5,
"approval":5,
"correction":5,
"in_progress":5,
"layout_editing":5,
"internal_editing":5
},
"included_state":[],
"excluded_states":[
"withdrawn",
"published",
"thematic_pool"
],
"state_aggregation":[]
},
"cards":{
"body":"name",
"badge1":"",
"badge2":"service_or_product",
"badge3":"master_content",
"badge4":"sme",
"badge5":"",
"color_badge_1": "#ff7514",
"color_badge_2": "#0068B3",
"color_badge_3": "#77dd77",
"color_badge_4": "#ff7514",
"color_badge_5": "#0068B3",
"responsible":"author",
"expedite_field":"expedite",
"expedite_value":"true",
"need_action_field":"blocked",
"need_action_value":"true",
"time_in_current_state":"sys_updated_at"
},
"lines":{
"main_name":"Main Contents",
"expedite_name":"Expedite"
},
"global":{
"condition":"",
"role_dependent_condition": {
"default": "(marketing_message_id.sales_direction_idDYNAMIC168752035023072720)",
"admin": "()",
"crm_admin": "()",
"crm_read_admin": "()"
},
"row_column_id":"167335724326704524",
"row_column_name":"status",
"essence_table_id":"167335630627617349",
"essence_table_name":"crm_content",
"background_image_url":"",
"background_image_id":"168907430726377278"
}
}
Example of JSON configuration for a task board
{
"rows": {
"WIP_limits": {},
"included_state": [],
"excluded_states": [
"cancelled",
"closed"
],
"state_aggregation": []
},
"cards": {
"body": "subject",
"badge1": "",
"badge2": "due",
"badge3": "",
"badge4": "priority",
"badge5": "",
"color_badge_1": "#ff7514",
"color_badge_2": "#0068B3",
"color_badge_3": "#77dd77",
"color_badge_4": "#ff7514",
"color_badge_5": "#0068B3",
"responsible": "owner",
"expedite_field": "",
"expedite_value": "",
"need_action_field":"state",
"need_action_value":"state",
"time_in_current_state": "sys_updated_at"
},
"lines": {
"main_name": "My Task"
},
"global": {
"condition": "",
"role_dependent_condition": {
"default": "(ownerDYNAMIC166065705218605748)",
"admin": "()",
"crm_admin": "()",
"crm_read_admin": "()"
},
"essence_table_id": "166505546317979915",
"essence_table_name": "crm_task",
"row_column_id": "166489007414837079",
"row_column_name": "state",
"background_image_url": "",
"background_image_id": ""
}
}