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

215 lines
24 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.

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>Generate from Template</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 Generate from Template activity allows you to create documents in a business process by using templates uploaded to the system. The system automatically inserts relevant..." />
<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 &gt; Graphical elements / Generate from Template</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;">Generate from Template</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;"><img alt="gen_template1" width="92" height="74" style="float:left;margin:0;width:92px;height:74px;border:none" src="gen_template1.png"/>The <span style="font-weight: bold;">Generate from Template</span> activity allows you to create documents in a business process by using <a href="360026936731.html" class="topiclink">templates</a> uploaded to the system. The system automatically inserts relevant process data into the document.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">As a result, you have, for example, a contract that already includes the signing date, the contractor<span style="color: #202122; background-color: #ffffff;"></span>s name, and the contract price.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">начало&nbsp;внимание</span></p>
<p style="line-height: 1.20; margin: 14px 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;">Generate from Template</span> activity.</p>
<p class="p_CodeExample" style="page-break-inside: avoid;"><span class="f_CodeExample">конец&nbsp;внимание</span></p>
<h2 class="p_Heading2" style="line-height: 1.20; margin: 19px 0 0 0;"><span class="f_Heading2" style="font-size: 24px;">Set up the Generate from Template activity</span></h2>
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;"><a href="360012265552.html#create_process" class="topiclink">On the process page</a>, go to the right pane and open the <span style="font-weight: bold;">System Elements</span> tab.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 19px 0 0 0;"><img alt="generate-by-template-2" width="775" height="537" style="margin:0;width:775px;height:537px;border:none" src="generate-by-template-2.png"/></p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">Drag the <span style="font-weight: bold;">Generate from Template </span>activity to the process diagram and place it in the spot where you need the system to create a document.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">In our example, we need to create an equipment purchase contract right after the <span style="font-weight: bold;">Place order</span> task and before the <span style="font-weight: bold;">Sign contract</span> task.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="13.PNG" title="13.PNG" width="729" height="652" style="margin:0;width:729px;height:652px;border:none" src="360027297671-13.png"/></p>
<p style="line-height: 1.20; margin: 14px 0 0 0;">Double-click on the activity to open its settings.</p>
<h2 class="p_Heading2"><span class="f_Heading2">General tab</span></h2>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="generate-from-template-02" width="685" height="455" style="margin:0;width:685px;height:455px;border:none" src="generate-from-template-02.png"/></p>
<ul style="list-style-type:disc">
<li style="line-height: 1.20;"><span style="font-weight: bold;">Name</span><span style="font-weight: bold; color: #ff0000;">*</span>.<span style="font-weight: bold;"> </span>Specify the name of the operation as it will be shown on the process diagram.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Document Template</span>.<span style="font-weight: bold;"> </span>Select a <a href="360026936731.html" class="topiclink">template</a>. Please note that templates added to a <a href="360009661232.html" class="topiclink">workspace</a> or an <a href="360009921131.html" class="topiclink">app</a> can only be used in business processes created in the same workspace or app.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Output file</span><span style="font-weight: bold; color: #ff0000;">*</span>.<span style="font-weight: bold;"> </span>Select the file that will store the created document. Make sure that you have previously added a <a href="360009707032.html#file_type" class="topiclink">File</a> type variable to the <a href="process_context.html" class="topiclink">process context</a>.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Generated file name</span><span style="font-weight: bold; color: #ff0000;">*</span>.<span style="font-weight: bold;"> </span>By default, the output document file will be named after the selected template. You can specify a different name if needed. For naming the file you can also use properties of the process variables and the <code><b>DateTime()</b></code> function. To add a variable, click <span style="font-weight: bold;">{+}</span> on the right side of the field. To use a function, click<span style="font-weight: bold;"> f(x)</span>. Read more about using functions in the <a href="360027003711.html" class="topiclink">Template syntax</a> article. Also in the file name, specify the available format: <span style="font-weight: bold;">.doc</span>, <span style="font-weight: bold;">.docx</span>, <span style="font-weight: bold;">.xls</span>, <span style="font-weight: bold;">.xlsx</span>, or <span style="font-weight: bold;">.rtf</span>.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">Convert to PDF</span>.<span style="font-weight: bold;"> </span>Check this box if you want the document to be converted into the <span style="font-weight: bold;">.pdf</span> format.</li><li style="line-height: 1.20;"><span style="font-weight: bold;">PDF standard</span>. This field appears when the <span style="font-weight: bold;">Convert to PDF</span> option is enabled. Select the desired <span style="font-weight: bold;">.pdf</span> format. The default option is PDF/A-1a. Other available formats are PDF/A-1b and PDF1.7</li></ul>
<h2 class="p_Heading2"><span class="f_Heading2">Field Values tab</span></h2>
<p>After you have chosen the template, the <span style="font-weight: bold;">Field Values</span> tab will appear in the settings window.</p>
<p style="line-height: 1.20; margin: 14px 0 0 0;"><a id="bind_shablon" class="hmanchor"></a>The left column shows <a href="360026936731.html#add_variables" class="topiclink">document template variables</a>. In the right column, you have to specify the corresponding <a href="process_context.html" class="topiclink">process variables</a>. The values of these variables will then be added to the generated document.</p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;"><img alt="gft2" width="694" height="344" style="margin:0;width:694px;height:344px;border:none" src="gft2.png"/></p>
<p class="p_Normal" style="line-height: 1.20; margin: 14px 0 0 0;">During the process, the document will be created only if values are assigned to all of these variables. Make sure that you have added them to the <a href="360012495611.html#form" class="topiclink">forms of tasks</a> that are placed before the <span style="font-weight: bold;">Generate from Template</span> activity in the process.</p>
<h2 class="p_Heading2"><span class="f_Heading2">Error Handling tab</span></h2>
<p>An error may occur during document generation, for example, if the file creation service is unavailable. You can set the further course of the process and the actions to be performed in this case.</p>
<p style="text-align: justify; line-height: 1.20; margin: 14px 0 0 0;">To do this, fill in the fields on the <span style="font-weight: bold;">Error Handling</span> tab:</p>
<p style="text-align: justify; line-height: 1.20; margin: 14px 0 0 0;"><img alt="gft3" width="647" height="454" style="margin:0;width:647px;height:454px;border:none" src="gft3.png"/></p>
<ul style="list-style-type:disc">
<li style="text-align: justify; line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;"><span style="font-weight: bold;">Notification</span>. Enable the option so that in case of an error, responsible users will be notified about it. You can select:<ul style="list-style-type:circle">
<li style="text-align: justify; line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;"><span style="font-weight: bold;">Current User</span>. The one who has completed the task preceding the <span style="font-weight: bold;">Generate from Template</span> activity in the process diagram.</li><li style="text-align: justify; line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;"><span style="font-weight: bold;">Context variable</span>, for example, the initiator.</li><li style="text-align: justify; line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;"><span style="font-weight: bold;">Group</span>.</li><li style="text-align: justify; line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;"><span style="font-weight: bold;">Org Chart Item</span>.</li></ul>
<li style="text-align: justify; line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;"><span style="font-weight: bold;">Interrupt</span>. Check the box and select the connector the process will follow in case of an error.</li><li style="text-align: justify; line-height: 1.20; margin-top: 14px; margin-right: 0; margin-bottom: 0;"><span style="font-weight: bold;">Write an error</span>. Enable the option and specify the variable to which the error text will be written.</li></ul>
<p style="text-align: justify; line-height: 1.20; margin: 14px 0 0 0;">When the settings are complete, click <span style="font-weight: bold;">Save</span>.</p>
<h2 class="p_Heading2"><span class="f_Heading2">Use the generated file</span></h2>
<p>During the execution of the process, the generated document will be saved to the variable you specified as the output file. You can add it to the form of the <span style="color: #0000ff;"><a href="360012495611.html" class="topiclink">task</a></span> in which the user should receive the document. In our example, this is the <span style="font-weight: bold;">Sign contract</span> task.</p>
<p style="text-align: justify; line-height: 1.20; margin: 14px 0 0 0;"><img alt="gft4" width="704" height="538" style="margin:0;width:704px;height:538px;border:none" src="gft4.png"/></p>
<p style="text-align: justify; line-height: 1.20; margin: 14px 0 0 0;">Save and publish the process.</p>
<p style="text-align: justify; line-height: 1.20; margin: 14px 0 0 0;">When executing the process, the employee responsible for filling out the order will enter the contractors name, date and the total amount to be paid.</p>
<p style="text-align: justify; line-height: 1.20; margin: 14px 0 0 0;">The contract template will be automatically completed with this data. The next process task is <span style="font-weight: bold;">Sign contract</span>. On its page, the executor will see the attached contract. The employee who is completing the<span style="font-weight: bold;"> Sign contract</span> task can simply click on the contract, view it, and print it out.</p>
<div class="bottom-nav">
<a id="prev-link" class="topic__navi_prev" href="await_status.html">
<span class="bottom-nav__arrow bottom-nav__arrow--prev"></span> <span
class="bottom-nav__link">await_status.html</span>
</a>
<a id="next-link" class="topic__navi_next" href="generate-from-file.html">
<span class="bottom-nav__link">generate-from-file.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>