koziavin
00717a92fb
All checks were successful
Deploy Static Site / deploy (push) Successful in 6m6s
211 lines
21 KiB
HTML
211 lines
21 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
|
||
<head>
|
||
<title>Script</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="The Script activity is TypeScript code that allows you to access data in business process, create, request, modify, and delete app items, and exchange data with external..." />
|
||
<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 / Script</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;">Script</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;">The <span style="font-weight: bold;">Script</span> activity is TypeScript code that allows you to access data in business process, create, request, modify, and delete app items, and exchange data with external systems using the HTTP protocol.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">Let<span style="font-family: Inter;">’s say</span> a company sells products online on a website. When a customer clicks on the <span style="font-weight: bold;">Buy</span> button, a script launches a business process that receives information about the order placed on the website. The system automatically calculates the price of the product with a discount and then sends the data back to the website</p>
|
||
<h2 class="p_Heading2" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_Heading2" style="font-size: 24px;">Add the Script activity to the process</span></h2>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало внимание</span></p>
|
||
<p style="line-height: 1.20; margin: 19px 0 0 0;">Only users included in the <a href="360007146071.html" class="topiclink">Administrators</a> group can configure the <span style="font-weight: bold;">Script</span> activity.</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец внимание</span></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">On the <a href="360012265552.html#create_process" class="topiclink">process page</a>, to the right of the modeling canvas, find the activities panel and open the <span style="font-weight: bold;">Standard elements</span> tab. Drag the <span style="font-weight: bold;">Script</span> activity to the process diagram and place it where required.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="2.PNG" title="2.PNG" width="614" height="431" style="margin:0;width:614px;height:431px;border:none" src="360027088031-2.png"/></p>
|
||
<p style="line-height: 1.20; margin: 14px 0 0 0;">Please note that only two outgoing connectors can be applied to the <span style="font-weight: bold;">Script</span> activity. One connector for successful execution, the second, for when an <a href="360027203731.html#error-handling-tab" class="topiclink">error occurs</a> while the script is running. If the number of connectors from the activity is exceeded, the process will not be published.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">Double-click on the activity to open the settings window. It contains two tabs: <span style="font-weight: bold;">General</span> and <span style="font-weight: bold;">Error Handling</span>.</p>
|
||
<h3 class="p_Heading3" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_Heading3" style="font-size: 19px;">General tab</span></h3>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_ImageCaption"> <img alt="script 1" width="493" height="229" style="margin:0;width:493px;height:229px;border:none" src="hmfile_hash_9f913aa9.png"/></span></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">In the <span style="font-weight: bold;">Name</span><span style="font-weight: bold; color: #ff0000;">*</span><span style="font-weight: bold;"> </span>field, specify the name of the operation as it will be shown in the system, for example, <span style="font-weight: bold;">Calculate total amount</span>.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">In the <span style="font-weight: bold;">Function </span>field, you need to link a specific function to the activity. Functions previously added to the process are available in the drop-down list. If you need to create a new one, click <span style="font-weight: bold;">Create</span>. Specify the function<span style="font-family: Inter;">’s</span> name using English letters, numbers, and the underscore. The function<span style="font-family: Inter;">’</span>s name must begin with a letter. Click <span style="font-weight: bold;">Create</span> and then <span style="font-weight: bold;">Open</span>. </p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="script 2" width="685" height="243" style="margin:0;width:685px;height:243px;border:none" src="hmfile_hash_060fd573.png"/></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">You will be redirected to the <a href="360028476691.html" class="topiclink">script editor</a> in the business process designer. Here you can write scripts to work with the business process context. These scripts are executed on the server side, so access restrictions configured for app items are not applied. For example, if access to items in an app is restricted, an item that the current user doesn<span style="font-family: Inter;">’t have</span> access to can still be loaded; the server script will run successfully. If a script gets a list of an app<span style="font-family: Inter;">’s items, all items in the app will be returned.</span></p>
|
||
<p style="line-height: 1.20; margin: 14px 0 0 0;">Scripts are written in the <a href="https://www.typescriptlang.org/" class="weblink">TypeScript</a> programming language. To learn about the principles of script-writing in BRIX, please visit <a href="https://tssdk.brix365.com/" class="weblink">BRIX TS SDK</a>. </p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало внимание</span></p>
|
||
<p style="line-height: 1.28; margin: 0 0 11px 0;">Using <code><b>Global</b></code><span style="font-size: 13px;"> </span>or <code><b>Namespace</b></code><span style="font-size: 13px;"> </span>constants in scripts restricts the export of system components. Read more about it in the <span style="color: #0000ff;"><a href="global-constants.html" class="topiclink">Global constants in scripts</a></span> article.</p>
|
||
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец внимание</span></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><span class="f_ImageCaption"> <img alt="script 3" width="910" height="374" style="margin:0;width:910px;height:374px;border:none" src="hmfile_hash_d340ea9e.png"/></span></p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">In certain scripts, you can use additional parameters. They allow you to optimize some process operations or make changes to the script without republishing. Read more about this in the <a href="360009207779.html" class="topiclink">Additional parameters</a> article.</p>
|
||
<h3 class="p_Heading3" style="line-height: 1.20; margin: 19px 0 0 0;"><a id="error-handling-tab" class="hmanchor"></a><span class="f_Heading3" style="font-size: 19px;">Error Handling tab</span></h3>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;">During the execution of the process, a script error may occur, for example, BRIX cannot access an external service. You can define how the system should behave in this case.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;">To do this, click the <span style="font-weight: bold;">Error Handling</span> tab in the settings window.</p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;"> </p>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="script_act" width="668" height="503" style="margin:0;width:668px;height:503px;border:none" src="script_act.png"/></p>
|
||
<ul style="list-style-type:disc">
|
||
<li style="line-height: 1.20;"><span style="font-weight: bold;">Retry</span>.<span style="font-weight: bold;"> </span>Select this option if you want the system to re-execute the script.<ul style="list-style-type:disc">
|
||
<li style="line-height: 1.20;"><span style="font-weight: bold;">Number of retries</span>.<span style="font-weight: bold;"> </span>This field indicates how many attempts to re-execute the script the system will make.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Retry delay (sec)</span>.<span style="font-weight: bold;"> </span>Determine the frequency of script retry attempts.</li></ul>
|
||
<li style="line-height: 1.20;"><span style="font-weight: bold;">Notification</span>. Select this option if you want to inform specific users about the error. Specify the users to be notified of the script failure.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Interrupt</span>. In case of an error, the system will stop attempting to execute the script and direct the process to the selected connector. </li></ul>
|
||
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">When you configure the settings, click <span style="font-weight: bold;">Save</span>. </p>
|
||
|
||
<div class="bottom-nav">
|
||
|
||
<a id="prev-link" class="topic__navi_prev" href="360012266792.html">
|
||
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
|
||
class="bottom-nav__link">360012266792.html</span>
|
||
</a>
|
||
|
||
|
||
<a id="next-link" class="topic__navi_next" href="360012263332.html">
|
||
<span class="bottom-nav__link">360012263332.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>
|