koziavin
00717a92fb
All checks were successful
Deploy Static Site / deploy (push) Successful in 6m6s
195 lines
23 KiB
HTML
195 lines
23 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
|
||
<head>
|
||
<title>Create a custom module</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="You can create custom modules for the BRIX platform. For example, you can make new widgets for forms or business processes activities with complex logic. Such modules can be..." />
|
||
<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="360024498352.html">Modules</a> > <a href="extentions.html">Custom modules</a> / Create a custom module</p>
|
||
</div>
|
||
|
||
</div>
|
||
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">Create a custom module</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">You can create custom modules for the BRIX platform. For example, you can make new widgets for forms or business processes activities with complex logic. Such modules can be used multiple times and for different purposes. You can set up integration with a third-party system or add a custom API method.</p>
|
||
<p class="p_Normal">To create a custom module:</p>
|
||
<ol style="list-style-type:decimal">
|
||
<li value="1" class="p_Normal">Go to <span style="font-weight: bold;">Administration > Modules</span>.</li><li value="2" class="p_Normal">Click the <span style="font-weight: bold;">+ Module</span> button and in the window click <span style="font-weight: bold;">Create</span>.</li><li value="3" class="p_Normal">Specify the name and description of the module, select an icon, and click <span style="font-weight: bold;">Create</span>.</li></ol>
|
||
<p class="p_Normal"><img alt="add_module_01" width="595" height="293" style="margin:0;width:595px;height:293px;border:none" src="add_module_01.png"/></p>
|
||
<p class="p_Normal"><a id="page-manage-extention" class="hmanchor"></a>After that, the module management page will open. Module configuration settings are broken down into separate tabs:</p>
|
||
<ul style="list-style-type:disc">
|
||
<li class="p_Normal"><a href="create-extention.html#main-tab" class="topiclink">Main</a>.<span style="font-weight: bold;"> </span>The tab contains general information about the module: its name, icon, short and full description, link to the documentation that describes how to use the module, the developer of the module, and the link to the developer<span style="font-family: Inter;">’</span>s website. </li><li class="p_Normal"><a href="extention-settings.html" class="topiclink">Settings</a>. The tab contains the global properties of the module.</li><li class="p_Normal"><a href="extention-widegets.html" class="topiclink">Widgets</a>. On this tab, you can add custom widgets for business process forms, apps, workspace pages, and more.</li><li class="p_Normal"><a href="extention-api.html" class="topiclink">API Methods</a>. On this tab, you can create module methods accessible from external systems. For example, it can be a method that starts a business process from an external application. You can also call such methods from scripts on the forms of widgets, processes, or pages in the system.</li><li class="p_Normal"><a href="extention-activities.html" class="topiclink">Business Process Activities</a>. You can add new business process activities on this tab.</li><li class="p_Normal"><a href="extention-processes.html" class="topiclink">Processes</a>. You can add business processes that work within the module and are used to configure activities.</li><li class="p_Normal"><a href="portable-services.html" class="topiclink">Services</a>. Integrate custom portable microservices into the module to expand its functionality and address various tasks in BRIX.</li><li class="p_Normal"><a href="events_processing.html" class="topiclink">Event Handling</a>. Create and set up the way the system behaves when certain events occur. You can use <a href="script-activity.html" class="topiclink">scripts</a> for event handling, set up <a href="call-process-activity.html" class="topiclink">processes to start</a>, and send messages about the event to an <a href="custom_services.html" class="topiclink">external service</a>.</li><li class="p_Normal"><a href="module-external-app.html" class="topiclink">External app</a>. Connect an external application to provide third-party services with access to protected resources in BRIX using the OAuth2 authorization protocol. After this, data from BRIX can serve as a method of authentication on a third-party service, as well as a source for requests via Web API.</li><li class="p_Normal">External services. Set up integration with a web service using the SOAP (Simple Object Access Protocol) protocol to exchange data with BRIX. This will allow access to the web service description language (WSDL) and enable the use of its methods and data types in server-side scripts to address tasks in BRIX.</li><li class="p_Normal"><a href="set-new-locale.html" class="topiclink">Translations</a>. Add .<span style="font-weight: bold;">po</span> files with translation of resources into languages that differ from the source language of the module. To enable the <a href="set-new-locale.html" class="topiclink">interface translation option</a> and get access to the tab, contact BRIX tech support</li></ul>
|
||
<p class="p_Normal">You can download the configured module as an <span style="font-weight: bold;">.e365</span> file. See the <a href="export_extention.html" class="topiclink">Export a custom module</a> article for details. When your module is imported, users can manage it.</p>
|
||
<p class="p_Normal">You can change the module settings. To do this, in <span style="font-weight: bold;">Administration</span> > <span style="font-weight: bold;">Modules</span>, hover over the module and click the gear icon that appears. The module management page will open. After making changes, save them.</p>
|
||
<h2 class="p_Heading2"><a id="main-tab" class="hmanchor"></a><span class="f_Heading2">Main tab</span></h2>
|
||
<p class="p_Normal">You can add or edit general information about a module.</p>
|
||
<p class="p_Normal"><img alt="create-extention-1" width="789" height="716" style="margin:0;width:789px;height:716px;border:none" src="create-extention-1.png"/></p>
|
||
<ul style="list-style-type:disc">
|
||
<li style="line-height: 1.20; background: #ffffff; margin-top: 7px; margin-right: 0; margin-bottom: 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;">Name</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #ff0000;">*</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">. The </span><span style="font-family: Inter;">name of the module.</span></li><li style="line-height: 1.20; background: #ffffff; margin-top: 7px; margin-right: 0; margin-bottom: 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;">Icon</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">.</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;"> </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">An image representing the module.</span></li><li style="line-height: 1.20; background: #ffffff; margin-top: 7px; margin-right: 0; margin-bottom: 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;">Brief description</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #ff0000;">*</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">.</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;"> </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">Information about the module</span><span style="font-family: Inter;"> functionality that is displayed in the </span><span style="font-family: Inter; font-weight: bold;">Administration</span><span style="font-family: Inter;"> workspace.</span></li><li style="line-height: 1.20; background: #ffffff; margin-top: 7px; margin-right: 0; margin-bottom: 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;">Detailed description</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">.</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;"> </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">Full description of the module functionality.</span></li><li style="line-height: 1.20; background: #ffffff; margin-top: 7px; margin-right: 0; margin-bottom: 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;">Language</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">. The source language of the interface in which the module was created.</span></li><li style="line-height: 1.20; background: #ffffff; margin-top: 7px; margin-right: 0; margin-bottom: 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;">Help link</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">.</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;"> </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">Link to the documentation describing how to use the module.</span></li><li style="line-height: 1.20; background: #ffffff; margin-top: 7px; margin-right: 0; margin-bottom: 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;">Developer</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">.</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;"> </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">The developer (the development company) that created the module.</span></li><li style="line-height: 1.20; background: #ffffff; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;">Developer's site</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">.</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold; color: #394149;"> </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #394149;">Link to the developer</span><span style="font-family: Inter;">’s website.</span></li></ul>
|
||
<p class="p_Normal" style="text-indent: -24px; background: #ffffff; margin: 7px 0 7px 22px;"><span style="font-family: Inter; color: #394149;">Specify the necessary information and click</span><span style="font-family: Inter; font-weight: bold; color: #394149;"> Save</span><span style="font-family: Inter; color: #394149;">.</span></p>
|
||
|
||
<div class="bottom-nav">
|
||
|
||
<a id="prev-link" class="topic__navi_prev" href="extentions.html">
|
||
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
|
||
class="bottom-nav__link">extentions.html</span>
|
||
</a>
|
||
|
||
|
||
<a id="next-link" class="topic__navi_next" href="extention-settings.html">
|
||
<span class="bottom-nav__link">extention-settings.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>
|