Files
help365/platform/business-process-metrics.html
2025-05-27 21:32:35 +04:00

234 lines
23 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>Business process performance indicators</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="An indicator is a Low-code development tool designed to collect various data while business process instances are executed. You can use this tool to record the results of..." />
<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>Business process designer / Business process performance indicators</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Business process performance indicators</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 class="p_Normal">An indicator is a Low-code development tool designed to collect various data while business process instances are executed. You can use this tool to record the results of passing specific steps, changes in variable values, time interval between two actions, etc.</p>
<p class="p_Normal">You can view the obtained data on a chart for further analysis. This will help you evaluate the efficiency of the process, identify problematic steps, find users who reduce the overall performance, and improve the current workflow.</p>
<p class="p_Normal">For example, you can track how often the task of creating a contract is repeated after it is rejected in the <span style="font-weight: bold;">Create a contract</span> process. You can then show this data in a chart. This helps you compare employee performance and see which sales rep need to redo contracts more often than others do.</p>
<h2 class="p_Heading2"><span class="f_Heading2">How to work with business process indicators</span></h2>
<p class="p_Normal">To measure the efficiency of a process using an indicator, do the following:</p>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal"><a href="business-process-metrics.html#create-indicator" class="topiclink">Create an indicator</a> in the workspace where the business process is configured. At the same time, define what information should be recorded in the process. To do this, select the <a href="business-process-metrics.html#indicator-type" class="topiclink">indicator type</a> and add custom <a href="business-process-metrics.html#context-property" class="topiclink">context properties</a> to record the results of the process execution.</li><li value="2" class="p_Normal">Save and publish the indicator to use it in the process. You can find the created indicators on the <span style="font-weight: bold;">Indicators</span> page in the workspace settings, as well as in <span style="font-weight: bold;">Administration &gt; Indicators</span>.</li><li value="3" class="p_Normal">Go to the business process designer and add the indicator to the process before the step for which you want to record statistics. To do this, place the <a href="set-process-metrics-value.html" class="topiclink">Set Indicators Value</a> activity on the process diagram.<br />
&nbsp;<br />
You can apply any indicator across multiple processes configured at different system levels.</li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;примечание</span></p>
<p class="p_Normal"><span style="font-weight: bold;">Note</span></p>
<p class="p_Normal">You cannot export an app, workspace, or module separately if a business process at its level uses an indicator created in another system component.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;примечание</span></p>
<ol style="list-style-type:upper-roman">
<li value="4" class="p_Normal">To visualize the collected data, create a separate page and configure the <a href="chart.html" class="topiclink">Chart</a> widget. You can add filters to the page for detailed data analysis. </li></ol>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">Начало&nbsp;внимание</span>&nbsp;</p>
<p class="p_Normal">Only users included in the <a href="360006871932.html#administrator" class="topiclink">Administrators</a> group can create and customize indicators.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">Конец&nbsp;внимание</span></p>
<h2 class="p_Heading2"><a id="create-indicator" class="hmanchor"></a><span class="f_Heading2">Create a process indicator</span></h2>
<ol style="list-style-type:upper-roman">
<li value="1" class="p_Normal">To add an indicator:</li></ol>
<ul style="list-style-type:disc">
<li class="p_Normal">At the app or workspace level — click the gear icon next to the name and select <span style="font-weight: bold;">Indicators</span>.</li><li class="p_Normal">At the company level — go to <span style="font-weight: bold;">Administration &gt; Indicators</span>.</li><li class="p_Normal">At the module level — on the <a href="create-extention.html#page-manage-extention" class="topiclink">module management page</a>, go to the <span style="font-weight: bold;">Performance Indicators</span> tab.</li></ul>
<ol style="list-style-type:upper-roman">
<li value="2" class="p_Normal">In the upper right corner of the page that opens, click <span style="font-weight: bold;">+ Indicator</span>.</li><li value="3" class="p_Normal">Fill in the fields:<br />
<img alt="business-process-metrics-1" width="589" height="395" style="margin:0;width:589px;height:395px;border:none" src="business-process-metrics-1.png"/></li></ol>
<ul style="list-style-type:disc">
<li class="p_Normal">Enter the name of the indicator.</li><li class="p_Normal">Enter the code that will be used when working with the <a href="https://api.brix365.com/en/" target="_blank" class="weblink">Web API</a>.</li><li class="p_Normal"><a id="indicator-type" class="hmanchor"></a>Select the indicator type:<ul style="list-style-type:circle">
<li class="p_Normal"><span style="font-weight: bold;">Counter</span>. Records the passing of a certain step on the process diagram. According to the configured process logic, you can count the increase or decrease of the counter. For example, in how many process instances the sales rep has completed the task of issuing a contract or how many process instances have not yet reached this stage.</li><li class="p_Normal"><span style="font-weight: bold;">Value</span>. Records a certain numeric value and also allows you to track the dynamics of values in the variable. For example, what was the preliminary amount of the contract and what amount is indicated in its final version.</li><li class="p_Normal"><span style="font-weight: bold;">Time Interval</span>. Records the time spent on the process step. For example, how many hours passed from the moment when a task was assigned to an employee until its completion. The time interval in the process is recorded using a <a href="360027203731.html" class="topiclink">script</a>.<br />
&nbsp;<br />
To learn more about how to use and customize each indicator type in a process, see the <a href="business-process-metrics-examples.html" class="topiclink">Use cases for customizing process indicators</a> article.</li></ul></li></ul>
<ol style="list-style-type:upper-roman" start="4">
<li value="4" class="p_Normal">Click <span style="font-weight: bold;">Save</span>. Indicator settings will open.</li></ol>
<ol style="list-style-type:upper-roman" start="5">
<li value="5" class="p_Normal">On the <span style="font-weight: bold;">General</span> tab you can:</li></ol>
<ul style="list-style-type:disc">
<li class="p_Normal">Change the name of the indicator.</li><li class="p_Normal">Enable the <span style="font-weight: bold;">According to the business calendar</span> option for the <span style="font-weight: bold;">Time Interval</span> indicator. Then only the working time of employees will be taken into account when calculating the time spent on a process step. &nbsp;</li></ul>
<ol style="list-style-type:upper-roman" start="6">
<li value="6" class="p_Normal"><a id="context-property" class="hmanchor"></a>On the <span style="font-weight: bold;">Context</span> tab, configure the properties of the indicator to record the values during the execution of process instances. You can use these variables to customize the chart and display data from the process in it.<br />
&nbsp;<br />
There are the following indicator context properties:</li></ol>
<ul style="list-style-type:disc">
<li class="p_Normal">System. Variables added to the indicator by default. These are the fields:<ul style="list-style-type:circle">
<li class="p_Normal"><span style="font-weight: bold;">Event author</span> and <span style="font-weight: bold;">Event time</span>. For each type of indicator.</li><li class="p_Normal"><span style="font-weight: bold;">Interval start</span> and <span style="font-weight: bold;">Interval end</span>. For an indicator of the <span style="font-weight: bold;">Time Interval</span> type.</li><li class="p_Normal"><span style="font-weight: bold;">Value</span>. For an indicator of the <span style="font-weight: bold;">Value</span> type.</li></ul>
<li class="p_Normal">Custom. You can create additional properties for more detailed indicator measurements. &nbsp; &nbsp;</li></ul>
<ol style="list-style-type:upper-roman" start="7">
<li value="7" class="p_Normal">Once the settings are complete, you can:</li></ol>
<ul style="list-style-type:disc">
<li class="p_Normal">Click <span style="font-weight: bold;">Publish</span>. The indicator will be available in the business process.</li><li class="p_Normal">Click <span style="font-weight: bold;">Save</span>. A draft of the indicator will be saved, but you cannot apply it to the process. You can finalize and publish it later. In the list of indicators, the name of the draft is italicized.</li></ul>
<p class="p_Normal">You can find the created indicator in the list of indicators indicators in the settings of the component where it has been created (app, workspace, or module), as well as in <span style="font-weight: bold;">Administration &gt; Indicators</span>.</p>
<h2 class="p_Heading2"><span class="f_Heading2">Actions with an indicator</span></h2>
<p class="p_Normal">On the page with the list of added indicators, you can perform certain actions. Click the three dots icon next to the indicator name and select an option:</p>
<ul style="list-style-type:disc">
<li class="p_Normal"><span style="font-weight: bold;">Cancel publication</span>. Switches the published indicator to draft mode. The indicator will not be available for use in the process. If it is placed on the process diagram, the instance execution will result in an error.</li><li class="p_Normal"><span style="font-weight: bold;">Delete</span>. Removes the indicator from the list in the workspace settings and in <span style="font-weight: bold;">Administration &gt; Indicators</span>.</li><li class="p_Normal"><span style="font-weight: bold;">Restore</span>. Click <span style="font-weight: bold;">Show Deleted</span> in the upper right corner of the page, select the indicator and return it to the list. For example, if you want to change its settings, publish it, and apply it to a business process. </li></ul>
<p class="p_Normal">You can export an indicator to another company. To do this, export the workspace where the indicator is created.</p>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="process-administration.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">process-administration.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="access_permissions.html">
<span class="bottom-nav__link">access_permissions.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>