Automated Document Generation for Bitrix: Custom Module

Streamline Document Generation in 1C-Bitrix

A typical scenario: a CRM operator spends 10 minutes generating an invoice in Word, copying data from the order—makes a mistake in the VAT rate, and the document goes to the client. Or an e-commerce store generates hundreds of waybills daily via phpWord, and when the logo changes, every template must be edited individually. 54-FZ requires fiscalization, and errors in requisites lead to fines up to €1,000. We develop a module for Bitrix that systematically solves these problems: templates, variables, versioning, automatic generation based on events.

Problems We Solve

• Document errors: wrong TIN, incorrect amount, missing VAT rate. Manual entry leads to 30% errors—automation reduces error rate to under 1%. The module eliminates human factors: data is pulled directly from the order or deal via providers.
• Slow generation: a manager spends 5–10 minutes per document. With 200 orders per day, that's over 30 hours of work—automation reduces generation to 200–500 ms per document, a 95% time savings. This translates to an average reduction of manual labor costs by €2,000 per month.
• Inconsistent templates: Word documents from different departments use different fonts, margins, headers/footers. The module centralizes templates with versioning—changes apply immediately to all new documents.
• Non-compliance with requirements: missing mandatory fields (KPP, OKTMO, QR code for tax authorities). Variable setup and template validation prevent such omissions.

How the Document Generation Module Works

The module vendor.docgen uses four ORM tables:

• b_vendor_docgen_template — document templates: id, name, type (order/contract/act/offer), format (docx/pdf), template_file, variables_schema, version, is_active
• b_vendor_docgen_document — generated documents: id, template_id, entity_type, entity_id, file_id (in b_file), status, generated_at, generated_by
• b_vendor_docgen_variable — registered variables: name, source_class, description

Each template contains a JSON variable schema—the module validates that all mandatory fields are present.

Variable System

Variables are wrapped in {{....}}. Substitution is done via data providers registered in the module settings. Example provider for an order:

class OrderVariableProvider implements VariableProviderInterface
{
    public function getVariables(int $entityId): array
    {
        $order = \Bitrix\Sale\Order::load($entityId);
        $props = $order->getPropertyCollection();

        return [
            'ORDER_NUMBER'   => $order->getField('ACCOUNT_NUMBER'),
            'ORDER_DATE'     => $order->getDateInsert()->format('d.m.Y'),
            'ORDER_SUM'      => number_format($order->getPrice(), 2, ',', ' '),
            'ORDER_CURRENCY' => $order->getCurrency(),
            'CLIENT_NAME'    => $props->getPayerName(),
            'CLIENT_INN'     => $props->getUserProp('INN')?->getValue(),
            'CLIENT_ADDRESS' => $props->getAddress(),
            'ITEMS_TABLE'    => $this->buildItemsTable($order->getBasket()),
        ];
    }
}

Providers can be written for any entity: CRM deals, leads, user profiles. A typical template contains 20–30 variables; the module does not limit the count.

Why Twig Is Better Than Simple Replacement

Simple str_replace breaks with nested data and tables. Twig provides loops, conditions, filters. Example HTML template:

<h1>Invoice No. {{ORDER_NUMBER}}</h1>
<table>
{% for item in ITEMS %}
  <tr>
    <td>{{ item.name }}</td>
    <td>{{ item.quantity }}</td>
    <td>{{ item.price|number_format(2, ',', ' ') }}</td>
  </tr>
{% endfor %}
</table>

Twig compiles to cache—performance is on par with manual replacement, but maintaining templates is tens of times easier. More details in the Twig documentation and Wikipedia.

How to Set Up DOCX and HTML Templates

For Word templates we use PhpWord with table row cloning:

$templateProcessor = new \PhpOffice\PhpWord\TemplateProcessor($templatePath);

foreach ($variables as $name => $value) {
    if (is_array($value)) {
        $templateProcessor->cloneRow('ITEM_NAME', count($value));
        foreach ($value as $i => $item) {
            $templateProcessor->setValue("ITEM_NAME#{$i}", $item['name']);
            $templateProcessor->setValue("ITEM_QTY#{$i}", $item['quantity']);
            $templateProcessor->setValue("ITEM_PRICE#{$i}", $item['price']);
        }
    } else {
        $templateProcessor->setValue($name, htmlspecialchars($value));
    }
}

$outputPath = '/upload/vendor_docgen/' . uniqid() . '.docx';
$templateProcessor->saveAs($outputPath);

How to Choose a PDF Converter

DOCX is generated quickly, but clients often want PDF. Conversion is the most painful part. Comparison of methods:

Converter choice is a module setting parameter. Default: mPDF for HTML templates, LibreOffice for DOCX. More about mPDF and LibreOffice. Read about the PDF format on Wikipedia.

HTML Templates

Alternative to Word—HTML with CSS. Easier to maintain, no encoding issues. Template is stored in b_vendor_docgen_template in the html_template field. Conversion via Twig and mPDF:

$loader = new \Twig\Loader\ArrayLoader(['doc' => $template['HTML_TEMPLATE']]);
$twig = new \Twig\Environment($loader);
$html = $twig->render('doc', $variables);

$mpdf = new \Mpdf\Mpdf(['mode' => 'utf-8', 'format' => 'A4']);
$mpdf->WriteHTML($html);
$mpdf->Output($outputPath, 'F');

mPDF supports headers/footers, signatures, stamps, QR codes.

How to Ensure Security and Automation

Storage and Access

Generated files are saved via \CFile::SaveFile() into the b_file table. Download link—\CFile::GetPath(). Metadata is stored in b_vendor_docgen_document. Access rights: users download only their own documents, CRM managers download documents of their deals, administrators download all.

Automatic Generation via Events

Documents can be generated on event occurrence:

AddEventHandler('sale', 'OnSaleOrderPaid', ['\Vendor\DocGen\EventHandler', 'onOrderPaid']);

class EventHandler
{
    public static function onOrderPaid(\Bitrix\Main\Event $event): void
    {
        $orderId = $event->getParameter('id');
        DocGenerator::generate('invoice', 'sale_order', $orderId);
    }
}

Similarly, you can hook to deal closure, user registration, product upload.

What's Included in the Work

As a result, you receive:

• Documentation: Full technical documentation on data providers, variable schema, and extensibility.
• Access: Access to the source code repository and administrative interface for templates.
• Training: 1 hour of online employee training on module usage and template management.
• Support: 30-day support after delivery for bug fixes and questions.
• Deliverables:
  • Working module with ORM tables and installer.
  • Set of templates (3–5) for typical documents.
  • Documentation on data providers and extensibility.

Process

1. Analysis: we study business processes and document requirements.
2. Design: module architecture, variable schema, converter selection.
3. Development: implementation of the module, creation of templates.
4. Integration: setup of events and automatic generation.
5. Testing: up to 3 iterations of edits on your server.
6. Deployment and training: handover of documentation, employee training.

Estimated Timeline

Complex document layout with headers/footers, signatures, and stamps adds +2 days.

Investment in the module starts from €1,500 and pays off within 2–3 months, saving up to €2,000 per month in manual labor costs.

Typical Errors During Implementation

• Ignoring validation: if mandatory fields are not checked, a document with empty requisites can be generated. Our module validates the JSON schema before generation.
• Wrong converter choice: mPDF does not support complex tables with merged cells—for such cases LibreOffice is needed. We help choose the optimal option.
• Lack of caching: on each call, the module reads the template from the database. We recommend enabling caching via \Bitrix\Main\Data\Cache.

Experience and Guarantees

10+ years in Bitrix development, over 50 projects on document automation. We work with templates of any volume—from simple invoices to multi-page contracts with QR codes and digital signatures. Certified 1C-Bitrix specialists. We meet deadlines: 95% of projects delivered on time. Contact us to discuss your project—you will receive a clear specification, timeline, and individual pricing. Order module development and eliminate document errors forever.

1C-Bitrix Module Development and Setup

The main trap of Bitrix is init.php. You add an OnBeforeIBlockElementUpdate handler there, then another one — a year later the file is 2000 lines, and on every hit all that code executes. We move business logic into full-fledged modules with D7 ORM, custom tables, and administrative interface. The module can be disabled, transferred to another project, covered with tests — none of that is possible with init.php. Our team has 10+ years of Bitrix experience, certified specialists, and a 6-month code guarantee. Request a consultation — we'll explain how to migrate legacy code to a modular architecture.

Why is init.php the worst place for business logic?

Init.php does not support class autoloading, lacks an isolated namespace, cannot be unit tested, and cannot be disabled without editing the file itself. Every handler written there runs on every request, even if not needed. In a module, you register handlers through EventManager, and they only execute when the event occurs. Performance difference: up to 3x with 10+ handlers.

Standard Modules: Typical Problems and Solutions

Information blocks. IBlock architecture is the first thing we review on any project. A classic mistake: one catalog infoblock with 80 properties, 30 of which are multiple. The b_iblock_element_property table swells to millions of rows, and CIBlockElement::GetList with filtering on three properties does a full scan. We move reference data to Highload-blocks, eliminate multiple properties where possible, and design the structure for 5x growth.

e-Store (sale). Cart business rules are a separate story. We set discount priorities to prevent two campaigns from giving 60% instead of 30%, connect payment handlers, and write custom validation via OnSaleOrderBeforeSaved.

Search. The built-in search module with morphology works up to 10–15 thousand elements. Beyond that — Elasticsearch. We configure it via the Bitrix search module API, indexing through CSearchFullText or custom indexers.

Highload-blocks for dictionaries, logs, user data — instead of bloated IBlocks. Direct queries via Bitrix\Highloadblock\HighloadBlockTable, custom tables instead of the EAV structure of standard infoblocks. A million records — no degradation.

Mail events. Configuration is not just templates in b_event_message. The key is SPF, DKIM, DMARC on the DNS, otherwise transactional emails go to spam. We check deliverability and set up bounce handling.

How to Design Infoblocks for Performance?

We use Highload-blocks for reference data (colors, sizes, manufacturers) that are not involved in complex queries. For SKUs — a separate infoblock with linking via IBLOCK_ELEMENT_PROPERTY. Enable INDEX_PROPERTY for frequently filtered properties. Tagged caching: when an element changes, only the related cache is cleared. Highload-blocks process up to 10x faster than infoblocks with multiple properties on volumes of 100,000 records.

Custom Module Development

Each module follows the structure /local/modules/vendor.modulename/:

• install/index.php — setup class, create tables via $DB->RunSQLBatch()
• lib/ — D7 ORM classes, extending Bitrix\Main\ORM\Data\DataManager
• admin/ — administrative pages using CAdminList, CAdminForm
• include.php — autoloading, event handler registration via EventManager::getInstance()->registerEventHandler()
• REST API endpoints via \Bitrix\Rest\RestManager

The module registers in the system, appears in the "Installed Solutions" list, and has its own settings at /bitrix/admin/settings.php?mid=vendor.modulename. It can be enabled, disabled, and updated through UpdateSystem or custom migration mechanics.

Examples of implemented tasks:

• Campaign management — visual condition builder via CAdminCalendar, timers via agents (CAgent::AddAgent), analytics linked to the sale module
• Cost calculator — React widget on the frontend, REST API in the module, formulas stored in a Highload-block
• Booking system — real-time calendar, locking via $DB->StartTransaction() / $DB->Commit() on concurrent requests, integration with channel manager via webhook

Components and Composite Cache

Component customization via result_modifier.php and component_epilog.php, not by editing template.php of the standard template. This way core updates are painless.

Composite cache ("Composite Site" technology) — the server sends ready HTML, bypassing PHP routing. Dynamic areas (cart, authorization) are loaded via CBitrixComponent::setFrameMode(true) and AJAX. TTFB drops to 30–50 ms. But there are caveats: not all components are compatible, $APPLICATION->ShowPanel() breaks composite, and careful markup of <div id="bx-composite-..."> is required.

What to Check Before Installing a Marketplace Module?

Before installing a module from the marketplace, an audit is mandatory. We check: SQL queries without prepared statements (hello SQL injection), direct use of $_REQUEST without filtering, use of outdated kernel API instead of D7, conflicts with the composite cache module. A module with no updates for over a year and a few dozen installations is likely a problem on the next PHP update. A typical case: a module calls CIBlockElement::GetList with no cache reset — the site crashes with 5000 elements.

Migration to D7

When upgrading PHP or switching to a new edition — refactor outdated calls:

• CIBlockElement::GetList() → Bitrix\Iblock\Elements\ElementTable::getList()
• CSaleOrder::GetList() → Bitrix\Sale\Order::getList()
• CModule::IncludeModule() → Bitrix\Main\Loader::includeModule() Testing on staging, rollback via git on issues.

According to official 1C-Bitrix documentation, D7 ORM is the recommended tool for working with data, providing type safety and automatic query generation.

Comparison: Init.php vs Module

Module Development Scope and Cost

What is included in module development?

• Technical specification and architectural plan
• Code following PSR-4 and Bitrix code style
• Unit tests (PHPUnit) for business logic
• Integration tests for events and REST API
• Installation, configuration, and API documentation
• Repository and documentation access
• Administrator training for module usage
• 6-month warranty support

Estimated timelines and complexity:

Cost is calculated individually — contact us for a project estimate.

Module Testing

Unit tests via PHPUnit cover business logic: discount calculation, validation, document generation. Mocks for Bitrix\Main\Application::getConnection() allow tests to be DB-independent. Integration tests verify event handlers on a real database — OnAfterIBlockElementAdd, OnSaleOrderSaved, etc. REST API endpoints are tested via curl or PHPUnit HTTP client. Critical for modules working with b_sale_order, b_catalog_price — where errors cost money.

Compatibility is checked on PHP 7.4, 8.0, 8.1, 8.2 and editions: Standard, Small Business, Business. We check conflicts with popular marketplace modules — they often intercept the same events. Load testing: measurements on 10K, 100K, 1M records, profiling via Xdebug for memory leaks and N+1 queries.

Practical Examples

Campaign module for an electronics chain. The built-in sale module discounts did not cover scenarios like "2+1", a gift with purchase over a certain amount, or combined conditions. We built a visual builder: marketers create rules via drag-and-drop without development tickets. Campaign calendar, auto-deactivation via agents, analytics linked to b_sale_order — conversion, average check, usage count. Time to launch a new campaign dropped from two days to half an hour.

Calculator for builders. Parameters (area, materials, number of floors) → formula → preliminary estimate → lead to CRM via CRest::call('crm.lead.add'). Regional coefficients and seasonal markups from a Highload-block, material prices from 1C exchange. The number of target leads increased by a third: clients see a breakdown before calling a manager.

Booking for a hotel chain. Real-time availability via AJAX requests to a custom table vendor_booking_slots, seasonal tariff calculation, synchronization with Booking.com via channel manager API. Room locking on concurrent booking via SELECT ... FOR UPDATE in transactions. Timezones handled via \DateTimeZone — a guest from Vladivostok and a manager from Moscow see the same picture.

We will evaluate your project within one day. Write to us — we'll tell you what is included in turnkey development. Contact us for a consultation on your project. Order a custom module development — get a ready solution with documentation and support.