Files
help365/platform/global-constants.html
2025-05-27 21:32:35 +04:00

202 lines
20 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.

<!DOCTYPE html>
<html lang="en">
<head>
<title>Global constants in scripts</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 , , and &nbsp;global constants can be used in scripts within widgets, business processes, and modules. They allow access to:" />
<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><a href="solutions-building.html">Build solutions in BRIX</a> / Global constants in scripts</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Global constants in scripts</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;">The <code><b>Global</b></code>, <code><b>Namespace</b></code>, and <code><b>Imports</b></code> global constants can be used in scripts within widgets, business processes, and modules. They allow access to:</p>
<ul style="list-style-type:disc">
<li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><code><b>Global</b></code>. All workspaces as well as <span style="color: #0000ff;"><a href="360009207779.html#parameter-types" class="topiclink">global parameters</a></span>.</li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><code><b>Namespace</b></code>.<span style="font-weight: bold;"> </span>All apps, business processes, and other components within the workspace.</li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><code><b>Imports</b></code>. Selected workspaces or modules with which an <span style="color: #0000ff;"><a href="optional-dependencies.html" class="topiclink">optional dependency</a></span> is set up in the script settings. Using the <code><b>Imports</b></code> constant in a script does not restrict the export of the component or its import to another company. Therefore, making links to workspaces or modules using <code><b>Imports</b></code> is suitable for solution development.</li></ul>
<p style="line-height: 1.20; margin: 0 0 11px 0;">For components created within the company, the <code><b>Global</b></code> constant is always available in scripts. In components created within workspaces, apps, or modules, access to the <code><b>Global</b></code>, <code><b>Namespace</b></code>, and <code><b>Imports</b></code> constants needs to be enabled in the script settings.</p>
<p style="line-height: 1.20; margin: 0 0 11px 0;">The use of global constants can be enabled:</p>
<ul style="list-style-type:disc">
<li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;">For widgets: on the <span style="color: #0000ff;"><a href="designer-tabs.html#available-items" class="topiclink">Settings</a></span> tab of the interface designer.</li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;">For business processes: on the <span style="color: #0000ff;"><a href="360028476691.html#settings" class="topiclink">Scripts</a></span> tab of the business process designer.</li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;">In modules: in the module settings, in the following objects:</li></ul>
<ul style="list-style-type:disc"><ul style="list-style-type:circle">
<li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;"><span style="font-weight: bold;">Script</span> type activity: on the <span style="color: #0000ff;"><a href="360028476691.html#settings" class="topiclink">Scripts</a></span> tab (<code><b>Global</b></code> and <code><b>Imports</b></code> constants are available).</li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;">API methods: on the <span style="color: #0000ff;"><a href="360028476691.html#settings" class="topiclink">Scripts</a></span> tab (<code><b>Global</b></code> and <code><b>Imports</b></code> constants are available).</li><li style="line-height: 1.20; margin-top: 0; margin-right: 0; margin-bottom: 11px;">Event handler of the <span style="font-weight: bold;">Run script</span> type: on the <span style="color: #0000ff;"><a href="360028476691.html#settings" class="topiclink">Scripts</a></span> tab (only the <code><b>Imports</b></code> constant is available).</li></ul></li></ul>
<p style="line-height: 1.20; margin: 0 0 11px 0;">To learn about using the <code><b>Global</b></code> and <code><b>Namespace</b></code> constants, see the <span style="color: #0000ff;"><a href="https://tssdk.brix365.com/en/latest/pages/quick-start/intro_globals.html" target="_blank" class="weblink">Global context and isolation</a></span> article in BRIX TS SDK. The use of the <code><b>Imports</b></code> constant is described in the <span style="color: #0000ff;"><a href="optional-dependencies.html#use-imports" class="topiclink">Optional dependencies</a></span> article.</p>
<h2 class="p_Heading2"><a id="export" class="hmanchor"></a><span class="f_Heading2">Export components with global constants</span></h2>
<p style="line-height: 1.20; margin: 7px 0 16px 0;">Note that the use of global constants affects the export of system components, namely:</p>
<ol style="list-style-type:decimal">
<li value="1" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 8px;">If a script contains the <code><b>Global</b></code> constant, the script cannot be exported. Therefore, the export of any system component (workspace, app, module) in which the script is applied is unavailable.</li><li value="2" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;">If the script within an app contains the <code><b>Namespace</b></code> constant:</li></ol>
<ol style="list-style-type:decimal" start="3"><ul style="list-style-type:disc">
<li style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;">Export of the app is not available.</li><li style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;">Export of the workspace where this app is located is available. The exception is the <span style="color: #0000ff;"><a href="system-workspaces.html" class="topiclink">export of a system workspace</a></span> as part of a solution. This type of export is performed individually for each app, and is therefore not available.</li></ul></li></ol>
<ol style="list-style-type:decimal">
<li value="3" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;">If the script contains the <code><b>Imports</b></code> constant, a non-critical warning about an <span style="color: #0000ff;"><a href="optional-dependencies.html" class="topiclink">optional dependency</a></span> will be displayed when exporting the component in which it is located. The component is linked to a specific workspace or custom module, but the export can be successfully completed.</li></ol>
<p style="line-height: 1.28; margin: 0 0 11px 34px;"><img alt="global-constants-1" width="651" height="469" style="margin:0;width:651px;height:469px;border:none" src="global-constants-1.png"/></p>
<p style="line-height: 1.20; margin: 0 0 11px 0;">When importing the component, a similar warning will be displayed. Import can be completed even if the company does not have a component with which the optional dependency is set. However, scripts that use the <code><b>Imports</b></code> constant may not work correctly if the dependency is not found.</p>
<p style="line-height: 1.20; margin: 0 0 11px 0;">During development, it is recommended to add a block of code that is executed if the selected workspace or module cannot be accessed. For example, to provide a clear error message for the user.</p>
<p style="line-height: 1.20; margin: 0 0 11px 0;">Moreover, you can <span style="color: #0000ff;"><a href="create-solution.html" class="topiclink">create a solution</a></span> with the component in which a script with the <code><b>Imports</b></code> constant is written and the workspace or module with which an optional dependency is configured.</p>
<p style="line-height: 1.20; margin: 0 0 11px 0;"><span style="font-weight: bold;">Note</span>: The Imports constant is not available in system versions below 2023.11. To learn how to make the solution compatible with earlier versions, see the <span style="color: #0000ff;"><a href="optional-dependencies.html#compatible-with-older-versions" class="topiclink">Optional dependencies</a></span> article.</p>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="js-imprecise-calculations.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">js-imprecise-calculations.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="optional-dependencies.html">
<span class="bottom-nav__link">optional-dependencies.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>