Boards Configurations
You can change the configuration of the CRM kanban boards, including the content and opportunity boards. To do so, complete the following steps:
- Navigate to CRM → Edit Boards.
- Open the record of the required board and configure it.
- Click Save and view.
The following parameters can be changed for each board:
- Name – add the title of the board.
- Sales direction – specify the sales direction, whose content or opportunity related records are displayed on the board. If not specified, the records of all sales directions are displayed on the board.
- Background – add backgorund image for the booard.
- JSON config – configure the board parameters in JSON.
JSON config parameters
- rows
- cards
- lines
- global
The kanban board header configuration.
| Parameter | Description | Default value for content | Default value for opportunity |
|---|---|---|---|
| WIP_limits | Specify the limits of records in each state. The limits may vary for each state or may not be specified. | "backlog":5, "approval":5, "correction":5, "in_progress":5, "layout_editing":5, "internal_editing":5 | - |
| included_state | Specify the records states that will be displayed on the board. If empty, the records in all states are displayed except for those that are in the states specified in the excluded_states parameter. | - | - |
| excluded_states | Specify the states of records that will be hidden from the board. | "withdrawn", "published", "thematic_pool" "Support and post-sale", | "Demand generation" |
| state_aggregation | Not used. | - | - |
The record cards configuration.
| Parameter | Description | Default value for content | Default value for opportunity |
|---|---|---|---|
| body | Specify the system name of the column whose values are used as the card titles. | "name" | "name" |
| badge | Specify the system name of the columns whose values will be displayed in colored badges on the cards. You can configure from 0 to 5 badges. | "badge1":"", "badge2":"service_or_product", "badge3":"master_content", "badge4":"sme", "badge5":"", | "badge1":"", "badge2":"service_or_product", "badge3":"selling_direction", "badge4":"estimated_revenue", "badge5":"opportunity_probability", |
| color_badge | Specify the HEX-coded colors for the badges. | "color_badge_1": "#ff7514", "color_badge_2": "#0068B3", "color_badge_3": "#77dd77", "color_badge_4": "#ff7514", "color_badge_5": "#0068B3", | "color_badge_1":"#0068B3", "color_badge_2":"#ff7514", "color_badge_3":"#0068B3", "color_badge_4":"#77dd77", "color_badge_5":"#0068B3", |
| responsible | Specify the system name of the column that contains the employee responsible for the card. | "author" | "responsible" |
| expedite_field | Specify the system name of the column, whose value is used for the Expedite parameter. | "expedite" | - |
| expedite_value | Specify the value of expedite_field that puts the card into the Expedite swimlane on the board. | "true" | - |
| need_action_field | Specify the system name of the column used to determine whether the card is blocked (the card is marked with the lock). | "blocked" | "status_reason" |
| need_action_value | Specify the value of need_action_field that blocks the card. | "true" | "on_hold" |
| time_in_current_state | Specify the system name of the column used for the calculation of time from the last record update. The time is displayed on the card. | "sys_updated_at" | "sys_updated_at" |
The card swimlanes configuration.
| Parameter | Description | Default value for content | Default value for opportunity |
|---|---|---|---|
| main_name | Add the title of the main swimlane. | "Main Contents" | "Main Opportunity" |
| expedite_name | Add the title of the expedite swimlane. | "Expedite" | "Expedite" |
The global kanban board configuration.
| Parameter | Description | Default value for content | Default value for opportunity |
|---|---|---|---|
| condition | Specify the conditions for filtering the records displayed on the board. | - | "(active=1^open=1)" |
| row_column_id | Specify the ID of the column used as the main criteria for separating the stages on the board. | "167335724326704524" | "166480673810623773" |
| row_column_name | Specify the system name of the column used as the main criteria for separating the stages on the board. | "status" | "stage" |
| essence_table_id | Specify the ID of the table for which the kanban board is added. | "167335630627617349" | "166480589916282031" |
| essence_table_name | Specify the system name of the table for which the kanban board is added. | "crm_content" | "crm_opportunity" |
| background_image_url | Specify the background image URL. | - | - |
| background_image_id | Specify the background image ID. | "168907430726377278" | "168907430726377278" |
Example of JSON config 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":"(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 config 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":"()",
"row_column_id":"167335724326704524",
"row_column_name":"status",
"essence_table_id":"167335630627617349",
"essence_table_name":"crm_content",
"background_image_url":"",
"background_image_id":"168907430726377278"
}
}