Files
help365/platform/use-dashboards-widgets.html
koziavin 00717a92fb
All checks were successful
Deploy Static Site / deploy (push) Successful in 6m6s
update
2025-05-29 16:42:45 +04:00

204 lines
26 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<title>Use dashboard widgets on custom pages</title>
<meta name="generator" content="Help+Manual" />
<meta name="keywords" content="" />
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="As dashboard widgets display charts and lists, they need input data for the reports to be generated. To pass this data, use the two kinds of parameters in the widgets settings:" />
<meta name="picture" content="" />
<meta property="og:type" content="website" />
<meta property="og:title" content="Full documentation for BRIX365 platform. Low-code developer guide. User guide. Admin guide. Developer guide." />
<meta property="og:url" content="https://brix365.com/en/help" />
<meta property="og:image" content="" />
<link rel="icon" href="favicon.png" type="image/png" />
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet" />
<link rel="stylesheet" href="./jquery-ui.min.css" />
<link rel="stylesheet" href="default.css" />
<link rel="stylesheet" href="./search-yandex.css" />
<link rel="stylesheet" href="./article.css" />
<link rel="stylesheet" href="./glossary.css" />
<link rel="stylesheet" href="./theme.css" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="helpman_settings.js"></script>
<script type="text/javascript" src="helpman_topicinit.js"></script>
<script type="text/javascript" src="highlight.js"></script>
<script type="text/javascript">
$(document).ready(function(){highlight();});
</script>
</head>
<body>
<script>!function(e,t,c,n,r,a,m){e.ym=e.ym||function(){(e.ym.a=e.ym.a||[]).push(arguments)},e.ym.l=1*new Date;for(var s=0;s<document.scripts.length;s++)if(document.scripts[s].src===n)return;a=t.createElement(c),m=t.getElementsByTagName(c)[0],a.async=1,a.src=n,m.parentNode.insertBefore(a,m)}(window,document,"script","https://mc.yandex.ru/metrika/tag.js"),ym(83179930,"init",{clickmap:!0,trackLinks:!0,accurateTrackBounce:!0,webvisor:!0})</script><noscript><div><img alt=""src=https://mc.yandex.ru/watch/83179930 style=position:absolute;left:-9999px></div></noscript>
<header class="header elma-365">
<div class="container">
<a class="header__logo" href="https://brix365.com/en/help">
<img src="./logo-en.svg" alt="header logo">
</a>
<!-- <div class="hero__search-form" id="search-panel">
<form class="search-form" onsubmit="ym(83180416,'reachGoal','poisk')">
<label class="search-form__label">
<span id="reset-search" class="search__icon"></span>
<input class="search-form__input" type="text">
</label>
<input class="search-form__submit" type="submit" value="Submit">
</form>
</div> -->
<div class="hero__search-form" id="search-panel"> <form class="search-form"> <label class="search-form__label"> <span id="reset-search" class="search__icon"></span> <input class="search-form__input" type="text"> </label> <input class="search-form__submit" type="submit" value="Submit"> </form> </div>
<div class="hero__search">
<a href="#" id="search-icon" class="hero__search-icon">
<img src="search-icon-white.svg" alt="search string">
</a>
<a href="#" id="side-menu-icon" class="hero__side-icon">
<img src="side_menu.svg" alt="side menu">
</a>
</div>
<div class="header__navi">
<ul class="header__list"><li><span class="solution-select"><span class="solution-select__selected"></span><svg width="7" height="4" viewBox="0 0 7 4" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L3.5 3.5L6 1" stroke="white" stroke-linecap="round" stroke-linejoin="round"/></svg><ul class="solution-select__list"><li><a class="project-link" href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a class="project-link" href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a class="project-link" href="https://brix365.com/en/help/crm/crm_overview.html">CRM</a></li><li><a class="project-link" href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a class="project-link" href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li><li><a class="project-link" href="https://brix365.com/en/help/business_solutions/-elma365-store.html">Business Solutions</a></li></ul></span></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li><li><a href="https://tssdk.brix365.com/" target="_blank">SDK</a></li></ul>
</div>
</div>
</header>
<main class="main container">
<aside class="sidebar" id="sidebar">
<div class="sidebar__header">
<a class="header__logo" href="https://brix365.com/en/help">
<img src="./logo-light-en.svg">
</a>
<span class="sidebar__close elma-365-close" id="close"></span>
</div>
<div class="sidebar__wrapper" id="side-menu">
</div>
</aside>
<article class="article" id="article">
<div class="article-inner">
<div class="content">
<header class="article__header">
<div class="article__bread" style="display:flex; gap:10px;">
<span id="subcategory" class="search-res__item-category search-res__item-category_subcategory subcategory article__badge"></span>
<div class="topic__breadcrumbs">
<p>Low-code designer &gt; <a href="interface_settings.html">Set up interfaces</a> &gt; Widget types &gt; CRM widgets &gt; <a href="crm-dashboards-widgets.html">Sales rep and sales manager dashboard widgets</a> / Use dashboard widgets on custom pages</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Use dashboard widgets on custom pages</span></h1>
</div>
</header>
<section class="article__content">
<div class="scroll-top-inner">
<a href="#h1-article" class="scroll-top"></a>
</div>
<!-- Placeholder for topic body. -->
<p style="line-height: 1.20; margin: 0 0 11px 0;"><span style="font-size: 13px; font-family: Inter;">As dashboard widgets display charts and lists, they need input data for the reports to be generated. To pass this data, use the two kinds of parameters in the widgets settings:</span></p>
<ul style="list-style-type:disc">
<li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter;">Fields linked with variables. These variables can be created in the widgets context. You can set their values manually or using scripts.</span></li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter;">Options that determine what the generated reports and lists will look like. They are configured manually.</span></li></ul>
<p style="line-height: 1.20; margin: 0 0 11px 0;"><span style="font-size: 13px; font-family: Inter;">Lets consider an example of how statistics from dashboard widgets can be displayed on custom pages. Well set up a page where the accounting department can view how deals are allocated among sales reps. To do that:</span></p>
<ol style="list-style-type:upper-roman">
<li value="1" style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter;"><a href="360009924451.html" class="topiclink">Create a page</a> and enter its name, for example, </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Accounting</span><span style="font-size: 13px; font-family: Inter;">.</span></li><li value="2" style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter;">Click the gear icon next to the pages name and select </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Widget Builder</span><span style="font-size: 13px; font-family: Inter;">.</span></li><li value="3" style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter;">In the interface designer, go to the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Context</span><span style="font-size: 13px; font-family: Inter;"> tab and create the following variables:</span><ul style="list-style-type:disc">
<li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Generate the report</span><span style="font-size: 13px; font-family: Inter;">. A <a href="360009707032.html#yes-no-switch" class="topiclink">Yes/No switch</a> type variable (code: </span><code><b>build</b></code><span style="font-size: 13px; font-family: Inter;">).</span></li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Start of the period</span><span style="font-size: 13px; font-family: Inter;">. A <a href="360009707032.html#date-time" class="topiclink">Date/time</a> (</span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Date</span><span style="font-size: 13px; font-family: Inter;">) variable.</span></li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter; font-weight: bold;">End of the period</span><span style="font-size: 13px; font-family: Inter;">. A <a href="360009707032.html#date-time" class="topiclink">Date/time</a> (</span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Date</span><span style="font-size: 13px; font-family: Inter;">) variable.</span></li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Responsible sales reps</span><span style="font-size: 13px; font-family: Inter;">. A <a href="360009707032.html#users" class="topiclink">Users</a> (</span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Many</span><span style="font-size: 13px; font-family: Inter;">) variable.</span></li></ul></li></ol>
<p style="text-indent: -24px; line-height: 1.20; margin: 0 0 11px 58px;"><img alt="use-dashboards-widgets-1" width="912" height="447" style="margin:0;width:912px;height:447px;border:none" src="use-dashboards-widgets-1.png"/></p>
<ol style="list-style-type:upper-roman" start="4">
<li value="4" style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter;">Go to the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Template</span><span style="font-size: 13px; font-family: Inter;"> tab. On the right-side panel, switch to </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Properties</span><span style="font-size: 13px; font-family: Inter;"> and add the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Start of the period</span><span style="font-size: 13px; font-family: Inter;">,</span><span style="font-size: 13px; font-family: Inter; font-weight: bold;"> End of the period</span><span style="font-size: 13px; font-family: Inter;">, and </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Responsible sales reps </span><span style="font-size: 13px; font-family: Inter;">fields</span><span style="font-size: 13px; font-family: Inter; font-weight: bold;"> </span><span style="font-size: 13px; font-family: Inter;">to the modeling canvas. The user will set the values of these properties manually on the reports page.</span></li><li value="5" style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter;">Add the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Button</span><span style="font-size: 13px; font-family: Inter;"> widget to the modeling canvas. In the widgets settings, specify the buttons name. In the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Action type</span><span style="font-size: 13px; font-family: Inter;"> field, select </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Run a script</span><span style="font-size: 13px; font-family: Inter;">.</span></li><li value="6" style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-size: 13px; font-family: Inter;">In the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">On click handler</span><span style="font-size: 13px; font-family: Inter;"> field, add a script. It will use the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Generate the report </span><span style="font-size: 13px; font-family: Inter;">variable (code </span><code><b>build</b></code><span style="font-size: 13px; font-family: Inter;">) that we added to the widgets context in step 3.</span></li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">async </span><span class="f_CodeExample" style="font-weight: bold;">function</span><span class="f_CodeExample"> build (): Promise&lt;</span><span class="f_CodeExample" style="font-weight: bold;">void</span><span class="f_CodeExample">&gt; {</span><br />
<span class="f_CodeExample"> &nbsp;&nbsp;&nbsp;Context.data.build = !Context.data.build;</span><br />
<span class="f_CodeExample">}</span></p>
<ol style="list-style-type:upper-roman" start="7">
<li value="7" style="line-height: 1.20; background: #fffffe; margin-top: 0; margin-right: 0; margin-bottom: 0;"><span style="font-size: 13px; font-family: Inter; color: #394149;">Save the settings of the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold; color: #394149;">Button</span><span style="font-size: 13px; font-family: Inter; color: #394149;"> widget.</span></li></ol>
<p style="text-indent: -24px; line-height: 1.20; background: #fffffe; margin: 0 0 0 38px;"><img alt="use-dashboards-widgets-2" width="827" height="525" style="margin:0;width:827px;height:525px;border:none" src="use-dashboards-widgets-2.png"/></p>
<ol style="list-style-type:upper-roman" start="8">
<li value="8" style="line-height: 1.20; background: #fffffe; margin-top: 0; margin-right: 0; margin-bottom: 0;"><span style="font-size: 13px; font-family: Inter;">Drag the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Allocation of Leads/Deals by Employee</span><span style="font-size: 13px; font-family: Inter;"> widget to the modeling canvas.</span></li><li value="9" style="line-height: 1.20; background: #fffffe; margin-top: 0; margin-right: 0; margin-bottom: 0;"><span style="font-size: 13px; font-family: Inter;">In the widgets settings, link the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Build chart</span><span style="font-size: 13px; font-family: Inter; font-weight: bold; color: #ff0000;">*</span><span style="font-size: 13px; font-family: Inter;">, </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Users</span><span style="font-size: 13px; font-family: Inter;">, </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Start of the period</span><span style="font-size: 13px; font-family: Inter;">, and </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">End of the period</span><span style="font-size: 13px; font-family: Inter;"> fields with the variables added to the context. To do that, click the </span><img alt="link-icon" width="17" height="17" style="margin:0;width:17px;height:17px;border:none" src="link-icon.png"/><span class="f_ImageCaption"> </span><span style="font-size: 13px; font-family: Inter;">icon to the right of a field and select </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">&lt;Not defined&gt;</span><span style="font-size: 13px; font-family: Inter;">. In the window that opens, select the corresponding variable.</span></li><li value="10" style="line-height: 1.20; background: #fffffe; margin-top: 0; margin-right: 0; margin-bottom: 0;"><span style="font-size: 13px; font-family: Inter;">Set up other parameters of the widget. For example, select </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Deals</span><span style="font-size: 13px; font-family: Inter;"> in the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">App</span><span style="font-size: 13px; font-family: Inter; font-weight: bold; color: #ff0000;">*</span><span style="font-size: 13px; font-family: Inter;"> field and check all sales pipelines in the </span><span style="font-size: 13px; font-family: Inter; font-weight: bold;">Pipelines</span><span style="font-size: 13px; font-family: Inter;"> field. With these settings, all deals from all pipelines that are assigned to the specified users will be included in the report.</span></li></ol>
<p style="text-indent: -24px; line-height: 1.20; background: #fffffe; margin: 0 0 0 38px;"><img alt="use-dashboards-widgets-3" width="683" height="774" style="margin:0;width:683px;height:774px;border:none" src="use-dashboards-widgets-3.png"/></p>
<p style="line-height: 1.20; background: #fffffe; margin: 0 0 0 36px;"><span style="font-size: 13px; font-family: Inter; color: #394149;">Read more about the widgets settings in <a href="crm-dashboards-widgets.html#assigned-items" class="topiclink">Sales rep and sales manager dashboard widgets</a>.</span></p>
<ol style="list-style-type:upper-roman" start="11">
<li value="11" style="line-height: 1.20; background: #fffffe; margin-top: 0; margin-right: 0; margin-bottom: 0;"><span style="font-size: 13px; font-family: Inter; color: #394149;">Save the widgets settings.</span></li><li value="12" style="line-height: 1.20; background: #fffffe; margin-top: 0; margin-right: 0; margin-bottom: 0;"><span style="font-size: 13px; font-family: Inter; color: #394149;">To make the page available to users, click </span><span style="font-size: 13px; font-family: Inter; font-weight: bold; color: #394149;">Save</span><span style="font-size: 13px; font-family: Inter; color: #394149;"> and </span><span style="font-size: 13px; font-family: Inter; font-weight: bold; color: #394149;">Publish</span><span style="font-size: 13px; font-family: Inter; color: #394149;"> in the interface designer toolbar.</span></li></ol>
<p style="line-height: 1.28; margin: 0 0 11px 0;"><span style="font-size: 13px; font-family: Inter; color: #394149;">The page you configure may look like this:</span></p>
<p style="line-height: 1.28; margin: 0 0 11px 0;"><img alt="use-dashboards-widgets-4" width="1035" height="650" style="margin:0;width:1035px;height:650px;border:none" src="use-dashboards-widgets-4.png"/></p>
<p style="line-height: 1.20; background: #fffffe; margin: 7px 0 16px 0;"><span style="font-size: 13px; font-family: Inter; color: #394149;">Users can specify the dates and the employees in the fields at the top of the page and click </span><span style="font-size: 13px; font-family: Inter; font-weight: bold; color: #394149;">Generate Report</span><span style="font-size: 13px; font-family: Inter; color: #394149;">. The widget on the page displays statistics on the number of deals in each status of the pipeline assigned to the selected sales reps.</span></p>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="crm-dashboards-widgets.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">crm-dashboards-widgets.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="product-item-widget.html">
<span class="bottom-nav__link">product-item-widget.html</span> <span
class="bottom-nav__arrow bottom-nav__arrow--next"></span>
</a>
</div>
<!-- добавляет на страницу строку блок Была ли статья полезной? -->
<div class="feedback" id="feedback"><div class="feedback-help"><span><b>Was this helpful?</b></span><form action="" method="POST" class="feedback-form" id="feedback-form"><div class="feedback__popup feedback__popup-response" id="feedback__popup_thx" style="display: none;">Thanks for your feedback!</div><div class="feedback__popup" id="feedback__popup_why" style="display: none;"><div class="feedback__popup-header">Please specify why:</div><input type="radio" name="category" id="bad_recommendation" value="bad_recommendation"><label for="bad_recommendation">Recommendations did not help me</label><input type="radio" name="category" id="difficult_text" value="difficult_text"><label for="difficult_text">Article is hard to understand</label><input type="radio" name="category" id="no_answer" value="no_answer"><label for="no_answer">Didn`t answer my question</label><input type="radio" name="category" id="bad_header" value="bad_header"><label for="bad_header">Content does not match the topic</label><input type="radio" name="category" id="other_reason" value="other_reason"><label for="other_reason">Other</label></div><div class="feedback__popup" id="feedback__popup-other" style="display: none;"><div class="feedback__popup-header">How we can improve it?</div><textarea class="feedback__textarea" name="other" id=""></textarea><input type="submit" class="feedback__other-btn" value="Submit"></div><div class="feedback-form__btn-group"><input type="radio" name="useful" id="feedback__useful_yes" value="true"><label for="feedback__useful_yes"><img src="like.svg" class="small-img" alt="like"><spanclass="feedback-form__btn-group_yes-btn">Yes</spanclass="feedback-form__btn-group_yes-btn"></label><input type="radio" name="useful" id="feedback__useful_no" value="false"><label for="feedback__useful_no"><img src="dislike.svg" class="small-img" alt="dislike"><spanclass="feedback-form__btn-group_no-btn">No</spanclass="feedback-form__btn-group_no-btn"></label></div><select name="category"><option disabled="">Please specify why</option><option value="bad_recommendation" selected="">Recommendations did not help me</option><option value="difficult_text">Article is hard to understand</option><option value="no_answer">Didn`t answer my question</option><option value="bad_header">Content does not match the topic</option><option value="other_reason">Other</option></select><input type="submit"></form></div><div class="found_typo"><p style="margin: 0px; margin-top: 16px !important;"><span><b>Found a typo?</b></span> Select it and press <i>Ctrl+Enter</i> to send us feedback</p></div></div>
</section>
</div>
<aside class="article__sidebar" style="display:none">
<input type="checkbox" />
<div class="article__arrow"></div>
<div class="table-of-contents elma365-right" id="toc2Content">
<h3 class="h3-toc">In this topic</h3>
<nav id="toc2"></nav>
</div>
</aside>
</div>
</article>
</main>
<footer class="footer">
<div class="footer-container">
<div class="footer-mobile">
<ul class="footer-mobile__list"><li><a href="https://brix365.com/en/" target="_blank">BRIX</a></li><li><a href="https://tssdk.brix365.com/en/latest/" target="_blank">SDK</a></li><li><a href="https://api.brix365.com/en/" target="_blank">API</a></li></ul><ul class="footer-mobile__list"><li><a href="https://brix365.com/en/help/platform/get-trial.html">Platform</a></li><li><a href="https://brix365.com/en/help/ecm/ecm-functions.html">ECM</a></li><li><a href="https://brix365.com/en/help/service/service-functions.html">Service</a></li><li><a href="https://brix365.com/en/help/projects/projects-functions.html">Projects</a></li></ul>
</div>
<div class="footer-wrap">
<div><span class="mobile-question-popup">Send feedback</span><form method="POST" action class="question__popup question-xs" id="question__popup"><div class="question-wrap"><span class="close"></span><span class="title">Ask a question</span><label for="help_question" style="display: none;"></label><textarea name="help_question" id="help_question"></textarea><input type="submit" value="Send"></div></form><div class="hidden fade-in question-success-xs">Sent</div></div>
<div class="footer-flex-b">
<span class="footer-copy">&copy; 2025 BRIX</span>
<ul class="footer-list">
<li class="footer-item">
<a href="#" class="arrow-top" style="display: block;"></a>
</li>
</ul>
</div>
</div>
</div>
</footer>
<iframe name="hmnavigation" style="display:none!important"></iframe>
<script src="./jquery-ui.js"></script>
<!--script src="//cdn.jsdelivr.net/npm/featherlight@1.7.14/release/featherlight.min.js" type="text/javascript" charset="utf-8"></script-->
<script src="./jquery.tocify.min.js"></script>
<script src="./TypoReporter.min.js"></script>
<script src="./google-search.js"></script>
<script src="./main.js"></script>
</body>
</html>