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

218 lines
24 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>Debug a process</title>
<meta name="generator" content="Help+Manual" />
<meta name="keywords" content="published" />
<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="Debugging is a stage of business process development during which errors are detected and corrected. During debugging, the process is run step by step in real time. Thus, you..." />
<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 / Debug a process</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1" style="text-align: center; line-height: 1.20; margin: 19px 0 19px 0;"><span class="f_Heading1" style="font-size: 32px;">Debug a process</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" style="line-height: 1.20; margin: 14px 0 0 0;">Debugging is a stage of business process development during which errors are detected and corrected. During debugging, the process is run step by step in real time. Thus, you can:</p>
<ul style="list-style-type:disc">
<li class="p_Normal" style="line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;">Check the logic of operations.</li><li class="p_Normal" style="line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;">Evaluate how user-friendly and clear the task forms are set up.</li><li class="p_Normal" style="line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;">Make sure that all scripts work correctly.</li></ul>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;внимание</span></p>
<p style="line-height: 1.28; margin: 0 0 11px 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">Process debugging is available only to users included in the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="360006871932.html#administrators" class="topiclink">Administrators</a></span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> group.</span></p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;внимание</span></p>
<h2 class="p_Heading2"><span class="f_Heading2">Configure the debugging start form</span></h2>
<p class="p_Normal" style="background: #ffffff;"><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; color: #0d0d0d;">Before debugging, you can set up a start form to fill in the <a href="process_context.html" class="topiclink">context variables</a> of the process. This way, you wont need to manually fill in fields in the <a href="360012496011.html" class="topiclink">start event</a> and subsequent tasks of the process during debugging.</span></p>
<p class="p_Normal" style="background: #ffffff; margin: 20px 0 0 0;"><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; color: #0d0d0d;">To do this, navigate to the </span><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; font-weight: bold; color: #0d0d0d;">Settings</span><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; color: #0d0d0d;"> tab of the designer and go to the </span><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; font-weight: bold; color: #0d0d0d;">Debugging Settings</span><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; color: #0d0d0d;"> section. Select the desired context fields there.</span></p>
<h2 class="p_Heading2" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_Heading2" style="font-size: 24px;">Start debugging</span></h2>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;внимание</span></p>
<p class="p_Normal" style="line-height: 2.10;"><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif;">For the first version of a process, debugging can only be initiated after its publication.</span></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="1" style="line-height: 1.28; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">Open the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="360012265552.html#create_process" class="topiclink">process modeling page</a></span>.</li><li value="2" class="p_Normal"><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; color: #0d0d0d; background-color: #ffffff;">You can initiate debugging from a specific step. To do this, select the activity shape on the canvas from which you want to run the process. If no activity is selected, debugging will be executed for the entire process.</span></li><li value="3" style="line-height: 1.28; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">On the top panel, click </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Debug</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">.</span></li></ol>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 34px;"><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; color: #0d0d0d; background-color: #ffffff;">If an activity is selected on the canvas, a window will appear to choose the debugging mode: either for the entire process or starting from the selected step. In the picture, the&nbsp;</span><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; font-weight: bold; color: #0d0d0d; background-color: #ffffff;">Prepare order</span><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; color: #0d0d0d; background-color: #ffffff;">&nbsp;activity is selected, so the debugging mode&nbsp;</span><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; font-weight: bold; color: #0d0d0d; background-color: #ffffff;">Starting from the selected step</span><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; color: #0d0d0d; background-color: #ffffff;">&nbsp;is available. If it is selected, debugging will start from this activity.</span></p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 34px;"><img alt="pd1" width="443" height="294" style="margin:0;width:443px;height:294px;border:none" src="pd1.png"/></p>
<ol style="list-style-type:upper-roman" start="4">
<li value="4" style="line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;"><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; color: #0d0d0d; background-color: #ffffff;">The debugging start window will open. If you have configured its form, fill in the specified fields. By default, the window will only display the&nbsp;</span><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; font-weight: bold; color: #0d0d0d; background-color: #ffffff;">Start Debugging</span><span style="font-family: 'Segoe UI',Tahoma,Verdana,Arial,sans-serif; color: #0d0d0d; background-color: #ffffff;">&nbsp;button. Click it to initiate debugging.</span></li></ol>
<p style="line-height: 1.20; margin: 14px 0 0 34px;"><img alt="debugging-start-form" width="749" height="339" style="margin:0;width:749px;height:339px;border:none" src="debugging-start-form.png"/></p>
<ol style="list-style-type:upper-roman" start="4">
<li value="5" style="line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">The debugging monitor will open. It is divided into four sections: </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">History</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">, </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Map</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">, </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Activity Stream</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">, and </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Context</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">.</span></li></ol>
<ul style="list-style-type:disc">
<li style="line-height: 1.20;"><span style="font-weight: bold;">History</span>.<span style="font-weight: bold;"> </span>All tasks assigned during the process are displayed here. <span style="font-family: 'Times New Roman',Times,Georgia,serif;">You can see information about executors, deadlines, creation date,</span> and errors that occurred when the process was run.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Map</span>.<span style="font-weight: bold;"> </span>This is a process diagram that allows you to track process progress in real time. Using the map, you can track which process steps have already been completed and which have not yet been debugged.<ul style="list-style-type:disc">
<li style="line-height: 1.20;">Completed tasks, operations, and connectors are highlighted blue.</li><li style="line-height: 1.20;">Current activities are highlighted green.</li></ul></li></ul>
<ul style="list-style-type:disc">
<li style="line-height: 1.20;"><span style="font-weight: bold;">Activity Stream</span>. This section shows all system notifications that are automatically generated in the process, for example, when a task is performed or assigned, a script is triggered, or a document is generated. This section also shows notifications when a new task is assigned to a specific user. </li></ul>
<ul style="list-style-type:disc">
<li style="line-height: 1.20;"><span style="font-weight: bold;">Context</span>. In this section, by default, all process <a href="process_context.html" class="topiclink">context variables</a> and their values are displayed. </li></ul>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">If the context variable stores a link to a file or an app, you can open it directly from the Debugging Monitor in the preview mode.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="pd2" width="1900" height="740" style="margin:0;width:1900px;height:740px;border:none" src="pd2.png"/></p>
<h2 class="p_Heading2" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_Heading2" style="font-size: 24px;">Run a process in the debugging mode</span></h2>
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;">To run a process in the debugging mode, click on the name of a task in the <span style="font-weight: bold;">History</span> section. In the provided window, you will see the task page where you can enter data, select a user, attach a file, create an app item. In other words, to simulate all those actions that a user will perform at this step of the process.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">All new app items, files, and other system objects are created with the prefix [Debugging] and will be deleted after all the process steps are completed. </p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="process debugging" width="557" height="190" style="margin:0;width:557px;height:190px;border:none" src="hmfile_hash_aebdd482.png"/></p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;внимание</span></p>
<p style="line-height: 1.20; margin: 14px 0 0 0;">If for debugging you select an existing app item and make changes to it at any step of the debugging process, this data will be written to the item and saved after exiting the debugging mode.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;внимание</span></p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">If an error occurs at some step of debugging, the name of the incorrectly working operation will be highlighted in red. Hover over it to see the detailed information on the error.</p>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="360012495291.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">360012495291.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="360012498891.html">
<span class="bottom-nav__link">360012498891.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>