koziavin
00717a92fb
All checks were successful
Deploy Static Site / deploy (push) Successful in 6m6s
219 lines
24 KiB
HTML
219 lines
24 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
|
||
<head>
|
||
<title>Business Process Activity</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="This activity is created in a custom module, where it is given a name, and the operation to be performed is configured. For example, the activity can call a process, execute a..." />
|
||
<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 > Graphical elements / Business Process Activity</p>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Business Process Activity</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">This activity is created in a <a href="extentions.html" class="topiclink">custom module</a>, where it is given a name, and the operation to be performed is configured. For example, the activity can call a process, execute a specified script, or call a delegated activity. </p>
|
||
<p class="p_Normal">When the module is enabled, the graphical element appears in the business process designer on the <span style="font-weight: bold;">Integrations</span> tab. Then you can use it in any custom process. In this case, the activity configured in the graphical element will only be executed when the module is enabled. If you start a process instance with the module disabled, the user will receive an error notification at the activity execution stage.</p>
|
||
<p class="p_Normal">Read about creating and customizing activities in modules in the <a href="extention-activities.html" class="topiclink">Business processes activities</a> article.</p>
|
||
<p class="p_Normal">Let's take a closer look at what tabs and options are available in such graphical elements. These options may differ depending on the activity type and individual settings of the graphical element specified when creating it.</p>
|
||
<p class="p_Normal">For example, let's customize the <span style="font-weight: bold;">Extract Data from PDF</span> activity, which performs an action of the <span style="font-weight: bold;">Call Process</span> type. It is used to extract the required data in a <span style="font-weight: bold;">.pdf</span> file during a custom process and write these data to context variables.</p>
|
||
<h2 class="p_Heading2"><span class="f_Heading2">Preliminary process settings</span></h2>
|
||
<p class="p_Normal">First, create variables in the process context where the activity will be used. These variables are required to transfer data from the process context to the corresponding attributes of the activity configured in the module.</p>
|
||
<p class="p_Normal">For this purpose, the process variables are mapped with the input and output attributes of the activity in its settings. In this way, the values of the input variables are sent to the graphical element to execute the customized activity, and the result of this operation is written to the output variables.</p>
|
||
<p class="p_Normal">The following attributes are set in the <span style="font-weight: bold;">Extract Data from PDF</span> activity:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal">Input: <span style="font-weight: bold;">File</span> of the <a href="360009707032.html#file_type" class="topiclink">Files (one)</a> type.</li><li class="p_Normal">Output: <span style="font-weight: bold;">Document number</span> of the <a href="360009707032.html#number" class="topiclink">Number (integer)</a> type, <span style="font-weight: bold;">Document date</span> of the <a href="360009707032.html#date-time" class="topiclink">Date/Time</a> type, and <span style="font-weight: bold;">Amount with VAT</span> of the <a href="360009707032.html#money" class="topiclink">Money</a> type.</li></ul>
|
||
<p class="p_Normal">Create the corresponding variables in the <a href="process_context.html" class="topiclink">context of the process</a> where you add the graphical element. Mapping of these variables is performed on the <a href="module-action.html#inputs-outputs" class="topiclink">Inputs and Outputs</a> tab.</p>
|
||
<h2 class="p_Heading2"><span class="f_Heading2">Activity settings</span></h2>
|
||
<p class="p_Normal">On the <a href="360012265552.html#process-modeling-page" class="topiclink">process page</a>, in the right toolbar, click the <span style="font-weight: bold;">Integrations</span> tab. Drag the <span style="font-weight: bold;">Extract Data from PDF</span> activity onto the flow chart and place it where you want to extract information from the electronic document and send these data to the process variables.</p>
|
||
<p class="p_Normal">The activity is configured on the following tabs: <span style="font-weight: bold;">General</span>, <span style="font-weight: bold;">Inputs and Outputs</span>, <span style="font-weight: bold;">Deadline</span>, and <span style="font-weight: bold;">Error Handling</span>.</p>
|
||
<h3 class="p_Heading3"><span class="f_Heading3">General tab</span></h3>
|
||
<p class="p_Normal">The <span style="font-weight: bold;">General</span> tab contains general information about the operation.</p>
|
||
<p class="p_Normal"><img alt="module-action-1" width="602" height="350" style="margin:0;width:602px;height:350px;border:none" src="module-action-1.png"/></p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><span style="font-weight: bold;">Name</span>. Enter the activity name. It will be displayed on the process flow chart.</li><li class="p_Normal"><span style="font-weight: bold;">Description</span>. Do not fill out this field. Here, you can see the description of the action if such description was added when customizing a <a href="script-activity.html" class="topiclink">script</a>, <a href="call-process-activity.html" class="topiclink">process call</a>, or <a href="delegated-activities.html" class="topiclink">delegated activity</a>.</li><li class="p_Normal"><span style="font-weight: bold;">Task Name</span>. You can specify a template for the name of the custom task if it is generated in the activity. To do this, enable the <span style="font-weight: bold;">Generate name from template</span> option and specify the template using context variables in the same way as in the <a href="360012495611.html#general" class="topiclink">settings</a> of the <span style="font-weight: bold;">Task</span> element.</li><li class="p_Normal"><span style="font-weight: bold;">Bind output attributes to</span>. Specify where the result of the activity execution will be written to. You can select the following options:</li></ul>
|
||
<ul style="list-style-type:disc"><ul style="list-style-type:disc">
|
||
<li style="line-height: 1.20;"><span style="font-weight: bold;">Process Context</span>. The values of the output attributes will be bound to business process context variables.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">App</span>. The values of the output attributes will be bound to the fields of the app added to the business process context.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Variable</span><span style="font-weight: bold; color: #ff0000;">*</span>. In the process context, select the app whose fields will be mapped to the output attributes of the activity.</li></ul></li></ul>
|
||
<ul style="list-style-type:disc">
|
||
<li style="line-height: 1.20;"><span style="font-weight: bold;">Perform on behalf of</span>. The option is available only for the <a href="call-process-activity.html" class="topiclink">Call process</a> activity type. Select the user who will be specified as the initiator of the activity on the <a href="360012498891.html#history_tab" class="topiclink">process instance page</a>:</li></ul>
|
||
<ul style="list-style-type:disc"><ul style="list-style-type:disc">
|
||
<li style="line-height: 1.20;"><span style="font-weight: bold;">Current user</span>. The user who starts the process instance.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Context variable</span>. Select a variable of the <a href="360009707032.html#users" class="topiclink">Users (one)</a> type from the process context. The activity will be performed on behalf of the employee that is specified in this variable. For example, you can select a context variable with the user in whose swimlane the activity is located.</li><li style="line-height: 1.20;"> <span style="font-weight: bold;">System</span>. The activity will be executed on behalf of the user selected as the <a href="360006871932.html#supervisor" class="topiclink">system supervisor</a>.</li></ul></li></ul>
|
||
<h3 class="p_Heading3"><a id="inputs-outputs" class="hmanchor"></a><span class="f_Heading3">Inputs and Outputs tab</span></h3>
|
||
<p class="p_Normal">On this tab, you can bind the attributes created in the activity with the process context variables. The standard mapping form contains two columns. The <span style="font-weight: bold;">Step</span> columns contain the activity input and output variables. In the <span style="font-weight: bold;">Process</span> column of each part, select the variables of the process in which the activity is used. To do this, click <span style="font-weight: bold;">Select field</span> next to the activity input and output variables and specify the process variable you want to match in the drop-down list. The matched variables must be of the same <a href="360009707032.html" class="topiclink">type</a>.</p>
|
||
<p class="p_Normal"><img alt="module-action-2" width="797" height="302" style="margin:0;width:797px;height:302px;border:none" src="module-action-2.png"/></p>
|
||
<p class="p_Normal">When creating a module activity, you can <a href="activities-features.html#custom-form" class="topiclink">customize the binding form</a>, as well as <a href="activities-features.html#arbitrary-type" class="topiclink">configure the dynamic binding</a>, i.e. create variables for binding using a script. In such cases, the <span style="font-weight: bold;">Activity Settings</span> tab will be displayed instead of the <span style="font-weight: bold;">Inputs and Outputs</span> tab. It is filled out according to the options set when creating the activity.</p>
|
||
<p class="p_Normal">Read more about it in the <a href="activities-features.html" class="topiclink">Binding and other aspects of business process activities</a> article.</p>
|
||
<h3 class="p_Heading3"><span class="f_Heading3">Deadline tab</span></h3>
|
||
<p class="p_Normal">The tab is available in the <span style="font-weight: bold;">Delegated activity</span> and <span style="font-weight: bold;">Call process</span> activity. If you create a task for employees using this graphical element, you can specify time limits for its execution and define users who will be notified if the specified deadlines are violated. The settings are the same as in standard activities of the <a href="360012495611.html#deadline" class="topiclink">Task</a> type.</p>
|
||
<p class="p_Normal"><img alt="module-action-3" width="509" height="167" style="margin:0;width:509px;height:167px;border:none" src="module-action-3.png"/></p>
|
||
<h3 class="p_Heading3"><a id="escalation" class="hmanchor"></a><span class="f_Heading3">Error handling tab</span></h3>
|
||
<p class="p_Normal">For custom activities, you need to add an escalation transition to the process. This allows you to avoid errors during the execution of a business process if the module is disabled. You can also set up the error notification to users.</p>
|
||
<p class="p_Normal"><img alt="module-action-4" width="545" height="394" style="margin:0;width:545px;height:394px;border:none" src="module-action-4.png"/></p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><span style="font-weight: bold;">Notification</span>. Select this option if you want BRIX to notify the responsible users in case of an error. Specify these users: the current user, a context variable such as an initiator, a group, or an org chart item. Please note that the current user is the executor who completed the task that is placed just before the custom activity on the process diagram.</li><li class="p_Normal"><span style="font-weight: bold;">Interrupt</span>. Check the option and specify in the <span style="font-weight: bold;">Transition</span> field which branch the process will follow if an error occurs. The transition specified in these settings will be marked on the process diagram with the <img alt="module-action-5" width="26" height="29" style="margin:0;width:26px;height:29px;border:none" src="module-action-5.png"/> icon.</li></ul>
|
||
<p class="p_Normal">Once the settings are set, click <span style="font-weight: bold;">Save</span>.</p>
|
||
|
||
<div class="bottom-nav">
|
||
|
||
<a id="prev-link" class="topic__navi_prev" href="todo.html">
|
||
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
|
||
class="bottom-nav__link">todo.html</span>
|
||
</a>
|
||
|
||
|
||
<a id="next-link" class="topic__navi_next" href="archive-the-project.html">
|
||
<span class="bottom-nav__link">archive-the-project.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">© 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>
|