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

205 lines
25 KiB
HTML
Raw Permalink 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>External portal in the application</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="External users can interact with the portal from a browser, BRIX for desktop (version 2.0.6 and higher), and mobile devices (version&nbsp;1.3.0 and higher)." />
<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="service-portal.html">External portal</a> / External portal in the application</p>
</div>
</div>
<div class="topic__title"><h1 class="p_Heading1"><span class="f_Heading1">External portal in the application</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: 7px 0 16px 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">External users can interact with the portal from a browser, </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="360027248771.html" class="topiclink">BRIX for desktop</a></span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> (version 2.0.6 and higher), and </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="mobile_app.html" class="topiclink">mobile devices</a></span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> (version 1.3.0 and higher).</span></p>
<p style="line-height: 1.20; margin: 7px 0 16px 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">To enable external users to work with the portal from applications, the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="360006871932.html#administrators" class="topiclink">Administrator</a></span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> needs to place a special link on the portal page for access from the application.</span></p>
<p style="line-height: 1.20; margin: 7px 0 16px 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">To do this, in the interface designer of the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="portal-setting.html" class="topiclink">portal page</a></span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">, go to the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Scripts</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> tab and add the </span><code><b>Namespace.portal.generateELMAAppURL()</b></code><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> method. Then place the generated link on the portal page. For example, using a property of the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="360009707032.html#link" class="topiclink">Link</a></span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> type, into which the value generated by the method will be passed. We will consider a detailed example of placing the link on the page </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="portal-app.html#example" class="topiclink">later</a></span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">.</span></p>
<p style="line-height: 1.20; margin: 7px 0 16px 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">You can also convert the link into a QR code using an external service and also place the image with the code on the page, for example, using the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="text_widget.html" class="topiclink">Text</a></span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"><a href="text_widget.html" class="topiclink"> </a>widget.</span></p>
<p style="line-height: 1.20; margin: 7px 0 16px 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">To access the portal in the application, the user needs to follow the link placed on the page. This will open the BRIX application with the page of authentication to the external portal.</span></p>
<p style="line-height: 1.20; margin: 7px 0 16px 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">To access the portal via a QR code, the user needs to open the page of the portal where the code is placed and the BRIX application for mobile devices. Then on the authentication page in the application, they need to click </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Scan QR code</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">. After scanning the image, the sign-in page to the external portal will open.</span></p>
<h2 class="p_Heading2"><a id="example" class="hmanchor"></a><span class="f_Heading2">Example</span></h2>
<p style="line-height: 1.20; margin: 7px 0 16px 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">Lets consider an example of adding an application sign-in link to the portal page. We will make it so that the link is generated and displayed on the portal page after the button is clicked. To do this:</span></p>
<ol style="list-style-type:upper-roman">
<li value="1" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">Go to the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="interface_designer.html" class="topiclink">interface designer</a></span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> of the external portal page.</span></li><li value="2" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">On the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Settings</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> tab, in the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Available items</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> section, enable the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Allow using all items</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> option to enable access to global constants.</span></li><li value="3" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">On the </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;"> tab, create a property of </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="360009707032.html" class="topiclink">Link</a></span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> type.</span></li></ol>
<p style="line-height: 1.28; margin: 0 0 11px 34px;"><img alt="portal-app-1" width="585" height="466" style="margin:0;width:585px;height:466px;border:none" src="portal-app-1.png"/></p>
<ol style="list-style-type:upper-roman" start="4">
<li value="4" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">Open the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Template</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> tab and place the created property on the modeling canvas.</span></li><li value="5" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">In the opened property settings window, set the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Read only</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> option to </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Yes</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">. This is necessary to make the link clickable. Save the settings.</span></li><li value="6" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">Bring up the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; color: #0000ff;"><a href="button_widget.html" class="topiclink">Button</a></span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> widget in the field.</span></li><li value="7" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">In the opened settings window, set the widget parameters:</span></li></ol>
<ul style="list-style-type:disc">
<li style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Title/Tooltip</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;">. Enter a name for the button, for example, </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Get link</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">.</span></li><li style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Executed script</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">. Add a script that will generate a link and output it in the </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Link</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> field to work in the application. To do this, click </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Create</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">, specify the function name:</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;"> getBRIXAppURL</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">, select</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;"> Save</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">, and then click</span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;"> Open</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;">.</span></li></ul>
<p style="line-height: 1.20; margin: 7px 0 7px 34px;"><img alt="portal-app-2" width="787" height="362" style="margin:0;width:787px;height:362px;border:none" src="portal-app-2.png"/></p>
<ol style="list-style-type:upper-roman" start="8">
<li value="8" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">On the opened </span><span style="font-family: 'Times New Roman',Times,Georgia,serif; font-weight: bold;">Scripts</span><span style="font-family: 'Times New Roman',Times,Georgia,serif;"> tab, write the following code in the created function:</span></li></ol>
<p class="p_CodeExample" style="white-space: normal; page-break-inside: avoid;"><span class="f_CodeExample">async </span><span class="f_CodeExample" style="font-weight: bold;">function</span><span class="f_CodeExample"> getBRIXAppURL(): Promise&lt;</span><span class="f_CodeExample" style="font-weight: bold;">void</span><span class="f_CodeExample">&gt; {</span><br />
<span class="f_CodeExample">  </span><span class="f_CodeExample" style="font-weight: bold;">const</span><span class="f_CodeExample"> BRIXAppURL = await Namespace.portal.generateBRIXAppUrl();</span><br />
<span class="f_CodeExample">  // Assigning the generated link to a variable of the Link type</span><br />
<span class="f_CodeExample">  Context.data.link = BRIXAppURL;</span><br />
<span class="f_CodeExample">}</span></p>
<ol style="list-style-type:upper-roman" start="9">
<li value="9" style="line-height: 1.20; margin-top: 7px; margin-right: 0; margin-bottom: 7px;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">Save and publish the changes.</span></li></ol>
<p style="line-height: 1.20; margin: 7px 0 16px 0;"><span style="font-family: 'Times New Roman',Times,Georgia,serif;">After that, a button will be displayed on the external portal page where users can get the link to work in the external portal from the application.</span></p>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="block-user.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">block-user.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="solutions-building.html">
<span class="bottom-nav__link">solutions-building.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>