Руководство разработчика Интеграл
Задача Интеграла — избавить пользователя от необходимости прикладного программирования. Это среда разработки приложений, а сама разработка сводится к постановке задачи — пользователь описывает модель
данных, правила их обработки и формат выдачи результатов. Конструктор прост, в нем реализованы только основные возможности, но он постоянно развивается, чтобы стать более понятным и дружественным к
пользователю.
С базовыми функциями Интеграла вы можете ознакомиться здесь.
С базовыми функциями Интеграла вы можете ознакомиться здесь.
Регистрация, установка и состав системы
Установка и выбор шаблона для Интеграла здесь: регистрация
После установки вы получаете доступ к собственной базе, в которой уже существуют такие объекты как Пользователь, Роль, Запрос, имеющие свой набор реквизитов. Интеграл знает, как обращаться с этими объектами — Роль пользователя определяет уровни доступа ко всем объектам базы, Запрос выбирает данные из базы и так далее. Предустановленные объекты необходимы в любом приложении, а вот всему остальному вы научите Интеграл самостоятельно.
После установки вы получаете доступ к собственной базе, в которой уже существуют такие объекты как Пользователь, Роль, Запрос, имеющие свой набор реквизитов. Интеграл знает, как обращаться с этими объектами — Роль пользователя определяет уровни доступа ко всем объектам базы, Запрос выбирает данные из базы и так далее. Предустановленные объекты необходимы в любом приложении, а вот всему остальному вы научите Интеграл самостоятельно.
Пользователь, созданный при регистрации вместе с базой, имеет имя, совпадающее с именем базы, и права администратора в системе.
Также, всем новым пользователям будет предложено посмотреть ознакомительный ролик, который поможет освоиться в новой системе.
Обязательно пройдите интерактивные вводные уроки, которые будут предложены вам сразу после регистрации на главном окне вашей первой базы!
При регистрации вам создается личный кабинет (ЛК), в котором вы можете создавать свои базы данных, заходить в них и строить приложения.
ЛК — это такое же приложение Интеграла, как ваше, в котором хранятся пользователи, сделаны рабочие места и запросы для наполнения их данными.
Первая созданная вами база будет названа:
(а) выбранным вами именем при регистрации по email
(б) именем из вашей электронной почты или синтетическим именем вида g9999, если имя электронной почты по каким-то причинам не подошло для именования базы (короче 3 символов, занято, начинается с цифры и т.д.) при регистрации через Google.
ЛК — это такое же приложение Интеграла, как ваше, в котором хранятся пользователи, сделаны рабочие места и запросы для наполнения их данными.
Первая созданная вами база будет названа:
(а) выбранным вами именем при регистрации по email
(б) именем из вашей электронной почты или синтетическим именем вида g9999, если имя электронной почты по каким-то причинам не подошло для именования базы (короче 3 символов, занято, начинается с цифры и т.д.) при регистрации через Google.
Войти в ЛК можно через ссылку в меню справа вверху
Способы входа в приложение и ЛК
Вы можете перемещаться из личного кабинета в свои базы и обратно, авторизовавшись единожды как зарегистрированный пользователь.
Вы можете зарегистрироваться и войти в свой личный кабинет, используя авторизацию Google, при этом для вашего пользователя не создается пароль. Тем не менее, вы можете также создать и пароль для своего пользователя, если не хотите использовать авторизацию Google.
При регистрации по электронной почте вы задаете одинаковый пароль для ЛК и вашей первой базы, которая будет создана автоматически.
Создание и сброс пароля
Если вам понадобится задать пароль себе или пользователям в ваших базах, то вы можете нажать ссылку «Напомнить пароль», предварительно указав имя пользователя и имя базы (если имя базы оставить пустым, то вам предложат сбросить пароль от личного кабинета).
Архитектура приложения Интеграл
Разработка приложений в Интеграле происходит в 4 этапа:
Редактор структуры
Задаем структуру данных заказчика в виде связанных прямоугольников
Навигатор данных
Импортируем данные, просматриваем их и можем добавлять и править их, как в таблицах Excel.
Конструктор запросов
Создаем запросы: правила выборки, создания и изменения данных.
Конструктор форм или шаблонизатор
Делаем рабочие места — удобные и понятные формы для пользователей.
Рабочие места сервиса
Система состоит из пяти универсальных форм и специализированного меню для работы с файловой системой:1. Форма редактирования терминов и структуры данных — меню Структура
2. Список терминов (таблиц) системы — меню Таблицы
3. Форма для работы с таблицей
4. Форма редактирования записи таблицы
5. Форма отчета
6. Администратор директорий, где можно загружать шаблоны страниц
Основной принцип Интеграла: его программист не обязан знать язык программирования или теорию баз данных, а максимальная требуемая квалификация не превышает уровень пользователя MS Excel. Интеграл позволяет решать любую задачу, оперируя только терминами бизнеса и не неся никаких накладных расходов при постановке задачи и ее выполнении.
Разумеется, самыми примитивными функциями уровня Excel (СУММА, СРЕДНЕЕ и т.п.) познакомиться, вероятнее всего, понадобится, что не противоречит озвученному выше принципу. Также будет очень полезно знать список служебных слов Интеграла и правила их использования.
Значительная часть функционала Интеграла построена средствами самого Интеграла, это Пользователи, Роли пользователей, Объекты доступа и Запросы. Вы можете использовать и дополнять соответствующие сущности, исходя из ваших задач, но при этом следует соблюдать осторожность. Категорически не рекомендуется удалять перечисленные термины или их реквизиты.
Модель данных
В вашем распоряжении модель данных, состоящая из связанных между собой таблиц (которые мы иногда также называем термин, тип, класс, объект). Вы определяете термины, такие как Клиент, Счет, Договор, Телефон, Встреча, Категория, а затем указываете связи между
соответствующими объектами. С помощью этих связей система самостоятельно агрегирует данные для навигации в системе и при построении отчетов. Система позволяет создать любую иерархию данных, подобно
реляционной базе данных.
Например:
• Клиент имеет реквизит Телефон (подчиненный реквизит Телефон);
• Клиент имеет списочный реквизит Категория (подчиненный реквизит, ссылающийся на значение из справочника Категорий);
• Для Клиента хранится информация обо всех проведенных с ним Встречах (подчиненный массив Встречи);
• Договор имеет ссылку на Клиента, с которым он заключен (Один клиент — много Договоров).
Структура базы данных для описанного выше примера:
Например:
• Клиент имеет реквизит Телефон (подчиненный реквизит Телефон);
• Клиент имеет списочный реквизит Категория (подчиненный реквизит, ссылающийся на значение из справочника Категорий);
• Для Клиента хранится информация обо всех проведенных с ним Встречах (подчиненный массив Встречи);
• Договор имеет ссылку на Клиента, с которым он заключен (Один клиент — много Договоров).
Структура базы данных для описанного выше примера:
В простых случаях вы можете добавлять таблицы в меню Таблицы, используя соответствующую кнопку:
Введите имя таблицы, выберите тип её первой колонки и при необходимости проставьте признак уникальности первой колонки:
Таблица будет добавлена в список таблиц, а также она откроется для просмотра и редактирования. Теперь можно добавить в неё колонки кнопкой + справа вверху таблицы, указав тип новой колонки, при этом можно сделать значение колонки справочным (выбирать его из списка).
Далее вы можете редактировать и перемещать колонки этой таблицы, создавать для неё справочные и подчиненные таблицы:
Внимание: создание и редактирование таблиц доступно пользователю с ролью admin.
Редактор структуры Интеграла
Для создания и редактирования сложных схем данных, когда требуется обозреть связи десятков таблиц, используется Редактор структуры, который находится в меню Структура. Вы обнаружите, что в Редакторе структуры уже зарегистрировано какое-то множество объектов, потому что Интеграл написан, по большей части, средствами самого Интеграла,
что позволяет вам дописывать и переписывать его под себя.
Объекты в Редакторе структуры расположены в порядке связанности или подчиненности, при этом каждый объект встречается только один раз — нарисован в иерархии при первом упоминании в качестве реквизита.
Для удобства чтения схемы, при наведении курсора на какой-либо объект или его реквизит, стрелками отображаются их связи с другими объектами, если таковые есть.
Объекты в Редакторе структуры расположены в порядке связанности или подчиненности, при этом каждый объект встречается только один раз — нарисован в иерархии при первом упоминании в качестве реквизита.
Для удобства чтения схемы, при наведении курсора на какой-либо объект или его реквизит, стрелками отображаются их связи с другими объектами, если таковые есть.
Все термины (таблицы), используемые системой, создаются здесь (см. поле Новый термин и кнопку Создать на рисунке). Вы задаете название термина и указываете для него базовый тип данных:
| Базовый тип | Описание |
|---|---|
| SHORT | Короткая строка (до 127 символов) |
| CHARS | Строка неограниченной длины |
| MEMO | Текст (отличается от CHARS только полем ввода — оно многострочное) |
| DATE | Дата |
| DATETIME | Дата и время |
| HTML | HTML-текст (теги HTML не экранируются при выводе этого термина в отчетах) |
| FILE | Файл |
| NUMBER | Целое число |
| SIGNED | Число с десятичной частью |
| BUTTON | Действие (кнопка) над экземпляром термина |
| BOOLEAN | Логическое значение (Да / Нет) |
| PWD | Пароль, маскируется при выводе на экран набором «******» |
| GRANT | Объект системы — выбор из всех зарегистрированных структуры и реквизитов |
| REPORT_COLUMN | Колонка запроса — выбор из всех зарегистрированных структуры и реквизитов |
| PATH | Путь к файлу в системе |
Базовый тип сообщает системе, как выводить и обрабатывать соответствующие значения.
Для добавления нового термина в Интеграл необходимо задать его имя, выбрать базовый тип и нажать «Создать». Для примера создадим термин «Клиент»:
Для добавления нового термина в Интеграл необходимо задать его имя, выбрать базовый тип и нажать «Создать». Для примера создадим термин «Клиент»:
Как только вы добавили термин, в меню Таблицы появляется соответствующий пункт, и вы сразу же можете заносить в эту таблицу записи о клиентах.
Добавление новых объектов происходит при помощи значка «+», который открывает форму ввода значения объекта.
При добавлении объекта в базовом интерфейсе вы указываете значение первой колонки этой таблицы. То есть, первая колонка — это сам объект, в то время как все последующие — его свойства.
После добавления объект сразу же отображается в списке. В данном случае это таблица Клиент, состоящая из единственной колонки с именами клиентов.
Аналогичным образом в меню Структура создаются все остальные термины (типы), например: Счет, Договор, Сделка. После этого можно подчинять одни термины другим, создавая сущности произвольного состава: выбираем
тип «Клиент» из списка, кликнув его имя.
Добавим ему свойство «Телефон», которое уже есть в Интеграле и нам нужно просто выбрать его из выпадающего списка и нажать кнопку «Добавить свойство».
Как только мы добавляем свойства здесь, они также становятся видны в соответствующей таблице.
Теперь добавим клиенту новый, неизвестный Интегралу реквизит «Встречи». Для этого в меню Структура в выпадающем списке реквизитов выберем «добавить новое». После этого вводим название нового свойства и указываем к какому
базовому типу он относится. Встречи мы будем назначать на какое-то время, поэтому базовый тип выберем DATETIME (дата и время):
Напомню, все изменения в Редакторе структуры немедленно вступают в силу и отображаются в таблицах.
Если какое-то свойство планируется использовать в качестве справочного значения, выбирая его из списка, то необходимо создать ссылку на справочную таблицу. Например, добавим ссылку на запись в справочнике Категория. Для этого, как и в прошлом шаге, мы должны выбрать «добавить новое» свойство, но поставить галку, что это будет ссылка:
Если какое-то свойство планируется использовать в качестве справочного значения, выбирая его из списка, то необходимо создать ссылку на справочную таблицу. Например, добавим ссылку на запись в справочнике Категория. Для этого, как и в прошлом шаге, мы должны выбрать «добавить новое» свойство, но поставить галку, что это будет ссылка:
В результате добавления ссылки на справочник, будет создана таблица соответствующего справочника, связанная с таблицей клиента. Чтобы не загромождать схему, стрелки, связывающие таблицы, показываются только при наведении курсора на прямоугольник таблицы или конкретное её свойство:
Справочник категорий — точно такая же таблица, как и таблица клиентов, и мы можем добавить в неё записи о категориях, используя кнопку (+):
Теперь, нажав левую колонку в таблице клиентов, чтобы отредактировать запись о клиенте, мы сможем выбрать его категорию из справочника:
Нам может понадобиться добавить ссылку на уже существующий реквизит, например, если мы хотим проставлять ссылку на клиента в записях таблицы договоров. В этом случае нужно выбрать необходимый реквизит — Клиент — и непосредственно в нем создать ссылку с помощью соответствующей кнопки.
В списке структуры появится новый термин со значком справочника: «Клиент». Мы можем использовать этот термин как ссылочное свойство — ссылку на запись в справочнике клиентов.
Давайте добавим ссылку на клиента в нашу таблицу договоров — это свойство в списке с префиксом -->: так мы указываем, что требуется именно ссылка на клиента, а не текстовое поле Клиент, заполняемое каждый раз руками.
В результате этих действий мы получили 3 связанные таблицы: У каждого договора есть ссылка на клиента в таблице клиентов, а каждому клиенту назначена категория из справочника (таблицы) категорий.
А теперь вернемся к свойству Встреча у клиента. Мы можем создавать множество встреч с клиентом, и Интеграл нам предлагает возможность создать таблицу встреч, которая будет относиться к определенному клиенту.
Здесь действует такое правило: если некое свойство само имеет свойства, то оно отображается в виде массива данных, то есть позволяет задать не одно, а несколько значений.
Такой подход в некоторых случаях может значительно упростить навигацию в системе. Кликнем свойство Встреча и добавим ему пару свойств: Примечание и ссылку на Статус.
Здесь действует такое правило: если некое свойство само имеет свойства, то оно отображается в виде массива данных, то есть позволяет задать не одно, а несколько значений.
Такой подход в некоторых случаях может значительно упростить навигацию в системе. Кликнем свойство Встреча и добавим ему пару свойств: Примечание и ссылку на Статус.
Вы видите, как усложнилась наша схема данных. Уже на этом уровне сложности мы не сможем ориентироваться в структуре таблиц и связей, глядя на неё в режиме таблиц Excel, Google sheets или Airtable. В то время как Интеграл позволяет нам видеть и понимать её всю разом.
Итак, на схеме выше вы видите все три типа полей, применяемых в таблицах Интеграла. Их достаточно легко отличить друг от друга:
1. Простое свойство (Телефон, Примечание)
2. Ссылка на запись в таблице (ссылки на Клиент, Категория, Статус)
3. Подчиненная таблица (Встреча)
Ссылок на запись в таблице-справочнике может быть несколько, например, если нужно указать автора и исполнителя задачи, оба из которых — записи в таблице пользователей. В этом случае свойству следует задать псевдоним, а в скобках будет указано настоящее имя таблицы-справочника.
1. Простое свойство (Телефон, Примечание)
2. Ссылка на запись в таблице (ссылки на Клиент, Категория, Статус)
3. Подчиненная таблица (Встреча)
Ссылок на запись в таблице-справочнике может быть несколько, например, если нужно указать автора и исполнителя задачи, оба из которых — записи в таблице пользователей. В этом случае свойству следует задать псевдоним, а в скобках будет указано настоящее имя таблицы-справочника.
Подчиненная таблица встреч клиента выглядит в навигаторе Интеграла следующим образом: мы видим количество записей в этой таблице в соответствующем поле таблицы клиента и можем перейти к ним в один клик.
Свойства объекта (поля таблицы) можно добавлять, удалять (знак «Х» напротив реквизита) и изменять их порядок (нажатие на знак «^» перемещает реквизит на одну позицию выше).
Для того, чтобы сместить какую-либо строчку вниз необходимо поднять все строчки, стоящие ниже, вверх.
В меню Структура вы можете в один клик перейти к объявлению ссылки на термин и в его таблицу-справочник. Здесь же вы можете задать псевдоним для ссылки на справочник, как она будет отображаться в таблице.
Последовательность реквизитов в Редакторе структуры определяет их последовательность и в таблицах системы:
Таблицы (справочники)
Все данные представлены в Интеграле в виде таблиц — меню Таблицы.
Администратор системы может настроить доступ пользователей только к определенным словарным типам, используя механизм ролей.
В первой колонке таблицы содержится значение объекта, в остальных — его свойства. Для изменения записи в таблице следует нажать на её самую левую колонку, тогда откроется меню её редактирования. Таблица Пользователь:
Любая запись в таблице всегда имеет уникальный системный идентификатор (цифровой, выделен на рисунке красным). Обычному пользователю этот идентификатор, вероятнее всего, никогда не понадобится. Однако, как мы увидим позже, знание о нем может пригодиться аналитику при настройке системы.
Таблицы могут быть подчинены друг другу, как, например, таблица встреч определенного клиента, рассмотренная выше. Также таблицы могут быть связаны между собой через ссылочные реквизиты, как, например, ссылка на Роль Пользователя. В меню Таблицы есть кнопка «Связи», которая отображает все таблицы и записи, ссылающиеся на эту запись.
Удалить запись из таблицы можно нажатием кнопки «Удалить», при этом Интеграл запросит подтверждение на удаление. Если на запись есть ссылки в системе (например, это списочное значение, использующееся в объектах
Интеграла), то система выдаст предупреждение и не позволит удалить эту запись.
Валидация(проверка значений) данных
Одно из простейших средств для проверки данных при вводе — это реквизит, обязательный для заполнения. Вы можете указать его в Редакторе структуры, нажав на соответствующую кнопку со знаком «!» напротив
выбранного реквизита (она загорится красным):
При попытке сохранить неверно заполненную форму система выведет предупреждение и оставит пользователя в режиме редактирования формы:
Вычисляемые реквизиты
Поле «Значение по умолчанию» можно также использовать для автоматического заполнения значений реквизитов при создании объекта: то, что вы впишете в это поле, попадет в соответствующее поле формы
редактирования при создании новой записи. В этом поле также можно использовать служебные слова.
Например, если мы хотим по умолчанию присваивать клиенту категорию «Потенциальный», то в редакторе структуры в поле «Значение по умолчанию» у нас появится выпадающий список, в котором мы можем выбрать необходимое нам значение.
Например, если мы хотим по умолчанию присваивать клиенту категорию «Потенциальный», то в редакторе структуры в поле «Значение по умолчанию» у нас появится выпадающий список, в котором мы можем выбрать необходимое нам значение.
Не забудьте нажать кнопку «Сохранить» или Enter после редактирования каждого поля!
Теперь при создании клиента система сама проставит ему Категорию «Лид», причем пользователь сможет изменить это значение на любое другое.
Если объект с идентификатором, вычисленным по умолчанию, не соответствует типу реквизита, то его значение не будет использовано и не будет сохранено в базу формой редактирования объекта.
Теперь при создании клиента система сама проставит ему Категорию «Лид», причем пользователь сможет изменить это значение на любое другое.
Если объект с идентификатором, вычисленным по умолчанию, не соответствует типу реквизита, то его значение не будет использовано и не будет сохранено в базу формой редактирования объекта.
Поиск в таблицах и списках
По умолчанию в таблицах системы отображаются только первые 20 записей, а поиск объектов осуществляется с помощью фильтров в заголовке таблицы. Поля фильтра открываются по клику на шапке таблицы
объектов или по нажатию иконки «воронка» над шапкой таблицы. Фильтр может быть диапазонным, если это потенциально применимо (для дат и чисел), или по маске.
Типичные способы задания фильтров показаны на рисунке:
Типичные способы задания фильтров показаны на рисунке:
Клиент: фамилия клиента начинается на «Кри» (регистр букв не важен, будет найден и «Криворучко», и «кривой», и «КРИШНА»)
Телефон: заканчивается на 4041
Карта: номера карт в диапазоне от 4000 до 5000(включительно)
Примечание: содержит текст «подар» (будет найдено: подарок, подарочная, подарили и т.д., содержащие этот текст)
Телефон: заканчивается на 4041
Карта: номера карт в диапазоне от 4000 до 5000(включительно)
Примечание: содержит текст «подар» (будет найдено: подарок, подарочная, подарили и т.д., содержащие этот текст)
Договор: непустое значение
Дата: в диапазоне с 1 числа текущего месяца по вчерашний день(служебное слово [YESTERDAY])
ДР: день рождения — сегодня(служебное слово [TODAY])
Источник: пустое значение поля
Менеджер: точное совпадение имени менеджера — Василий
Обратите внимание на конструкцию !% («не непустой», в противоположность %). Эта конструкция одинаково работает и в списках, и в отчетах. Вообще, модификатор «!», используемый в начале строки условия, обозначает отрицание последующего условия, например, !%подар% будет означать «всё, что не содержит 'подар', включая пустые (отсутствующие) значения».
При задании даты в текущем месяце текущего года можно указать только число. Например, если сегодня 31.08.2021, то:
12 — 12-е число текущего месяца: 12.08.2021
12.6 — 12 июня текущего года: 12.06.2021
При указании года двумя цифрами, например 12.12.21, система сохранит год в текущем веке: 12.12.2021. Если необходимо указать год в другом веке, то его нужно указывать целиком: 12.12.1916.
В качестве разделителя дат можно использовать символы «.», «,» или «/».
Дата: в диапазоне с 1 числа текущего месяца по вчерашний день(служебное слово [YESTERDAY])
ДР: день рождения — сегодня(служебное слово [TODAY])
Источник: пустое значение поля
Менеджер: точное совпадение имени менеджера — Василий
Обратите внимание на конструкцию !% («не непустой», в противоположность %). Эта конструкция одинаково работает и в списках, и в отчетах. Вообще, модификатор «!», используемый в начале строки условия, обозначает отрицание последующего условия, например, !%подар% будет означать «всё, что не содержит 'подар', включая пустые (отсутствующие) значения».
При задании даты в текущем месяце текущего года можно указать только число. Например, если сегодня 31.08.2021, то:
12 — 12-е число текущего месяца: 12.08.2021
12.6 — 12 июня текущего года: 12.06.2021
При указании года двумя цифрами, например 12.12.21, система сохранит год в текущем веке: 12.12.2021. Если необходимо указать год в другом веке, то его нужно указывать целиком: 12.12.1916.
В качестве разделителя дат можно использовать символы «.», «,» или «/».
Поиск в выпадающих списках
Если в выпадающем списке какой–то формы более 80 записей, то в списке присутствуют только первые 80 из них, и тогда для поиска записей нужно использовать поле справа от списка. Введите условие для поиска и нажмите Enter — форма будет сохранена и содержимое выпадающего списка обновится.
Для поиска по различным полям выпадающего списка следует разделять маски поиска знаком «слэш», например, для поиска записей со словом «red» во второй колонке нужно использовать условие поиска: /%red% (или %/%red%):
Если в выпадающем списке какой–то формы более 80 записей, то в списке присутствуют только первые 80 из них, и тогда для поиска записей нужно использовать поле справа от списка. Введите условие для поиска и нажмите Enter — форма будет сохранена и содержимое выпадающего списка обновится.
Для поиска по различным полям выпадающего списка следует разделять маски поиска знаком «слэш», например, для поиска записей со словом «red» во второй колонке нужно использовать условие поиска: /%red% (или %/%red%):
Если у пользователя есть доступ для создания объектов используемого списочного значения, например, Товар на рисунке выше, то слева от списка будет изображена кнопка немедленного добавления списочного
значения (со знаком «+»). По этой кнопке можно задать новое значение, которое будет добавлено в список при сохранении формы:
Система позволяет сделать копию любого объекта вместе со всеми его реквизитами, включая массивы. Для этого нужно открыть объект, при необходимости внести изменения и нажать кнопку «Дублировать». Исходная запись при этом изменена не будет.
При добавлении записей в подчиненный массив данных они сохраняются в порядке добавления. Записи можно удалять (значок «Х») или перемещать (значок «^» перемещает запись на одну позицию вверх):
Экспорт и импорт данных
Экспорт и импорт структуры и данных
Пользователь может экспортировать структуры данных и сами данные, а затем импортировать их в другую базу Интеграла или использовать по другому назначению. Также возможна подготовка данных из сторонних систем для загрузки их в Интеграл.
Формат выгрузки содержит необходимый минимум информации, начиная с описания типа, для которого делается выгрузка.
Описание структуры (после описания каждого типа идет описание подчиненных и связанных структуры):
ID_типа:имя_типа:базовый_тип_типа;[имя_реквизита:базовый_тип_реквизита; | ID_типа_ссылочного_реквизита;, ...]
Описание данных:
ID_типа_записи:[ID_записи];значение_записи;[реквизит;, ...]
Для экспорта необходимо зайти в нужный вам справочник, отфильтровать данные, если требуется, и нажать кнопку «Экспорт BKI». Будет выгружен файл, содержащий:
1. Описание структуры данных, включая все подчиненные данные и связанные справочники
2. Сами данные (на рисунке ниже данные начинаются с выделенной серым строки)
Пользователь может экспортировать структуры данных и сами данные, а затем импортировать их в другую базу Интеграла или использовать по другому назначению. Также возможна подготовка данных из сторонних систем для загрузки их в Интеграл.
Формат выгрузки содержит необходимый минимум информации, начиная с описания типа, для которого делается выгрузка.
Описание структуры (после описания каждого типа идет описание подчиненных и связанных структуры):
ID_типа:имя_типа:базовый_тип_типа;[имя_реквизита:базовый_тип_реквизита; | ID_типа_ссылочного_реквизита;, ...]
Описание данных:
ID_типа_записи:[ID_записи];значение_записи;[реквизит;, ...]
Для экспорта необходимо зайти в нужный вам справочник, отфильтровать данные, если требуется, и нажать кнопку «Экспорт BKI». Будет выгружен файл, содержащий:
1. Описание структуры данных, включая все подчиненные данные и связанные справочники
2. Сами данные (на рисунке ниже данные начинаются с выделенной серым строки)
Для импорта можно зайти в любой справочник и нажать кнопку «Импорт BKI» (она находится рядом с «Экспорт BKI»).
Таким образом вы можете:
- экспортировать ваши наработки, например, если вы хотите продать разработанные вами шаблоны новому клиенту;
- экспортировать и импортировать справочники, включая иерархические структуры любой вложенности;
- импортировать подчиненные массивы данных для выбранного объекта (например, историю встреч клиента).
Интеграл корректно разрешит ситуацию, если в целевой системе уже есть нужные вам типы данных: они будут найдены по комбинации «Термин:базовый тип» и использованы в качестве терминов или их реквизитов.
Интеграл разрешит проблемы с конфликтующими ID в целевой системе, но прекратит импорт, если реквизит с данным номером уже занят, и существующий реквизит имеет имя и тип, отличные от загружаемого. Например, Интеграл сообщит об ошибке, если вы импортируете Клиентов с двумя реквизитами Имя (SHORT) и Телефон (SHORT), а в целевой базе Клиент имеет реквизит Имя с типом CHARS или эти реквизиты имеют другой порядок или названия (например, «Тел.» вместо «Телефон»). Если же все имеющиеся реквизиты совпадают, но вы импортируете какие-то дополнительные, то они будут добавлены к описанию термина в целевой системе. Например, вы можете выгрузить Клиентов с указанием Имени и Телефона, добавить в выбранный файл третий реквизит Категория, указать значение этого реквизита для всех клиентов и загрузить всё это обратно в Интеграл (предварительно удалив выгруженных клиентов из справочника!).
Если выгружаемые значения могут быть использованы как справочные (в Справочнике структуры есть реквизит ссылки на этот термин, например, «--> Товар»), то данные будут выгружены вместе с идентификаторами. В противном случае идентификаторы выгружены не будут, поскольку не имеют критичного значения.
Если в каких-то полях данных встретятся переводы строки или точки с запятой (служащие разделителями в файле), то Интеграл с этим легко справится и корректно загрузит данные, экранировав точки с запятой и контролируя количество полей данных.
Если в загружаемом файле указаны ID записей, то Интеграл не будет заменять уже имеющиеся записи с такими ID, значением и типом, не проверяя соответствие остальных реквизитов. Если ID занят, а тип и значение не совпадают, то Интеграл прекратит импорт, сообщив о конфликте (ID занят объектом с другим значением или типом).
Формат выгрузки или загрузки для простейшего справочника, который можно выгрузить из Интеграла или подготовить вручную приведен на рисунке:
Таким образом вы можете:
- экспортировать ваши наработки, например, если вы хотите продать разработанные вами шаблоны новому клиенту;
- экспортировать и импортировать справочники, включая иерархические структуры любой вложенности;
- импортировать подчиненные массивы данных для выбранного объекта (например, историю встреч клиента).
Интеграл корректно разрешит ситуацию, если в целевой системе уже есть нужные вам типы данных: они будут найдены по комбинации «Термин:базовый тип» и использованы в качестве терминов или их реквизитов.
Интеграл разрешит проблемы с конфликтующими ID в целевой системе, но прекратит импорт, если реквизит с данным номером уже занят, и существующий реквизит имеет имя и тип, отличные от загружаемого. Например, Интеграл сообщит об ошибке, если вы импортируете Клиентов с двумя реквизитами Имя (SHORT) и Телефон (SHORT), а в целевой базе Клиент имеет реквизит Имя с типом CHARS или эти реквизиты имеют другой порядок или названия (например, «Тел.» вместо «Телефон»). Если же все имеющиеся реквизиты совпадают, но вы импортируете какие-то дополнительные, то они будут добавлены к описанию термина в целевой системе. Например, вы можете выгрузить Клиентов с указанием Имени и Телефона, добавить в выбранный файл третий реквизит Категория, указать значение этого реквизита для всех клиентов и загрузить всё это обратно в Интеграл (предварительно удалив выгруженных клиентов из справочника!).
Если выгружаемые значения могут быть использованы как справочные (в Справочнике структуры есть реквизит ссылки на этот термин, например, «--> Товар»), то данные будут выгружены вместе с идентификаторами. В противном случае идентификаторы выгружены не будут, поскольку не имеют критичного значения.
Если в каких-то полях данных встретятся переводы строки или точки с запятой (служащие разделителями в файле), то Интеграл с этим легко справится и корректно загрузит данные, экранировав точки с запятой и контролируя количество полей данных.
Если в загружаемом файле указаны ID записей, то Интеграл не будет заменять уже имеющиеся записи с такими ID, значением и типом, не проверяя соответствие остальных реквизитов. Если ID занят, а тип и значение не совпадают, то Интеграл прекратит импорт, сообщив о конфликте (ID занят объектом с другим значением или типом).
Формат выгрузки или загрузки для простейшего справочника, который можно выгрузить из Интеграла или подготовить вручную приведен на рисунке:
Упрощенный импорт плоских таблиц
Вы можете воспользоваться упрощенной версией импорта, если у вас уже есть нужная таблица данных. В этом случае вам потребуется подготовить файл с простым списком строк — без описания структуры, но со словом DATA в первой строке, как показано на рисунке ниже.
Далее следует зайти в таблицу, в которую вы хотите импортировать данные, и загрузить файл кнопкой «Импорт BKI».
Вы можете воспользоваться упрощенной версией импорта, если у вас уже есть нужная таблица данных. В этом случае вам потребуется подготовить файл с простым списком строк — без описания структуры, но со словом DATA в первой строке, как показано на рисунке ниже.
Далее следует зайти в таблицу, в которую вы хотите импортировать данные, и загрузить файл кнопкой «Импорт BKI».
Запросы (отчеты)
Построитель отчетов Интеграла позволяет конструировать отчет, просто выбирая нужные пользователю колонки и не заботясь о том, как связать таблицы, участвующие в построении отчета.
Построитель отчетов позволяет реализовать любую конструкцию языка SQL, включая вложенные запросы. При этом сам язык SQL знать не обязательно.
Допустим, нам требуется выбрать всех клиентов, с которыми были подписаны договоры и прошли встречи в этом месяце, в формате:
Клиент-Категория-Телефон-Дата-Тема встречи
Также нужно подсчитать общее количество таких встреч.
Такой отчет потребует выборки данных из 4 таблиц системы, но это нас нисколько не заботит.
Заходим в меню Таблицы –> Отчет и добавляем нужный нам отчет. Для добавления колонок в отчете выбираем необходимые нам (из выпадающего списка), например, создадим запрос «Встречи за тек. Месяц» и добавим туда колонку Клиент:
Построитель отчетов позволяет реализовать любую конструкцию языка SQL, включая вложенные запросы. При этом сам язык SQL знать не обязательно.
Допустим, нам требуется выбрать всех клиентов, с которыми были подписаны договоры и прошли встречи в этом месяце, в формате:
Клиент-Категория-Телефон-Дата-Тема встречи
Также нужно подсчитать общее количество таких встреч.
Такой отчет потребует выборки данных из 4 таблиц системы, но это нас нисколько не заботит.
Заходим в меню Таблицы –> Отчет и добавляем нужный нам отчет. Для добавления колонок в отчете выбираем необходимые нам (из выпадающего списка), например, создадим запрос «Встречи за тек. Месяц» и добавим туда колонку Клиент:
Для того, чтобы в дальнейшем отчет выводил общее количество клиентов необходимо воспользоваться контекстным меню. Выбираем Итоги –> COUNT. Графа «Итог» служит для указания функции, которую нужно
вывести в итоговой строке отчета по этому полю: AVG (среднее), COUNT (количество), MAX (максимальное), MIN (минимальное), SUM (сумма).
Как мы видим, Интеграл сразу добавляет дополнительную строчку с количеством всех имеющихся у нас клиентов.
Таким же образом и дальше добавляет в отчет необходимые нам колонки. Обратите внимание, после того, как мы добавили первую колонку отчета, выпадающий список «Колонки отчета» сократился до тех значений, которые имеют связь с таблицей клиентов:
Таким же образом и дальше добавляет в отчет необходимые нам колонки. Обратите внимание, после того, как мы добавили первую колонку отчета, выпадающий список «Колонки отчета» сократился до тех значений, которые имеют связь с таблицей клиентов:
Добавляем колонки «Клиент –> Категория», «Клиент –> Телефон», «Договор –> Дата», «Договор –> Тема встречи»:
Теперь добавим последнюю колонку Договор. Сама по себе эта колонка в отчете не нужна, но у нас есть условие, что клиент должен попасть в отчет, только если у нас с ним есть договор. Чтобы скрыть
колонку в дальнейшем отчете нажмем соответствующую кнопку:
Далее задаем условие, что поле «Договор» не должно быть пустым.
Наконец добавляем условия по дате встречи: с 1 по сегодняшнее число текущего месяца (Двойным кликом по полю «От» или «До» можно открыть выпадающий список):
Все эти действия заняли у нас не больше 2 минут, и теперь, кликнув по названию нашего отчета мы получим таблицу, построенную точно по нашему заданию:
Агрегирование в отчетах
В запросе можно применять агрегирующие функции: сумма, количество, минимальное, максимальное, среднее. В следующем примере создан отчет, который выводит количество встреч с клиентами с указанием
периода, в который эти встречи прошли:
Отчет отсортирован сначала по категории клиента, затем по его имени. Также, для удобства восприятия, формат даты приведен к виду DATE (дата), вместо DATETIME (дата и время):
Интерактивные отчеты
Если в отчете выставлена опция «Интерактивный», то объекты в этом отчете отображаются гиперссылками, по которым можно попасть на форму просмотра и редактирования этого объекта:
Фильтрование данных в отчете и экспорт в MS Excel
Интеграл позволяет применять фильтры к данным в уже построенном отчете, при этом отчет будет перезапрошен с сервера, чтобы удовлетворять заданным условиям. Фильтр открывается по клику на шапке отчета
или иконке «воронка» справа вверху отчета. Фильтр сработает на тех полях, у которых задано «Имя в отчете», это сделано из соображений безопасности — чтобы пользователь не мог отменить фильтры,
наложенные разработчиком отчета на такие поля.
Сформированный отчет можно выгрузить в MS Excel соответствующей кнопкой.
Сформированный отчет можно выгрузить в MS Excel соответствующей кнопкой.
Использование отчетов в Редакторе структуры
С помощью отчетов мы можем вычислять поля по умолчанию на формах редактирования объектов. Например, при заведении в компьютер нового клиента нам нужно проставить имя менеджера, который его завел.
Добавим в Редакторе структуры новый тип Менеджер и ссылку на него:
Добавим в Редакторе структуры новый тип Менеджер и ссылку на него:
Добавим наших менеджеров в таблицу (Таблицы –> Менеджер):
Затем добавим ссылку на менеджера в таблицы Пользователь и Клиент в Редакторе структуры:
Теперь мы можем указать для каждого пользователя, какой менеджер под ним работает:
Далее мы сделаем отчет (назовем его «ID_менеджера»), который позволит нам вычислить менеджера по имени пользователя:
Здесь мы используем фильтр для поля пользователь: служебное слово [USER], а также служебную функцию abn_ID, чтобы преобразовать имя менеджера в его идентификатор (список служебных слов смотрите в
разделе Служебные слова и функции).
Когда мы запустим этот отчет, то увидим в нем единственную строку с идентификатором менеджера Мария (182053), привязанного нами ранее к пользователю viktor13:
Когда мы запустим этот отчет, то увидим в нем единственную строку с идентификатором менеджера Мария (182053), привязанного нами ранее к пользователю viktor13:
В поле «Значение по умолчанию» реквизита «--> Менеджер» (ссылка на менеджера) типа Клиент проставим имя нашего отчета: ID_менеджера.
Теперь Интеграл будет знать, что при создании нового Клиента нужно запустить отчет ID_менеджера и подставить полученное в нем значение в поле Менеджер:
Колонки отчета: подробнее
Рассмотрим подробнее назначение полей Колонки отчета:
Имя в отчете — название колонки в выводимом отчете, по умолчанию — значение Колонки отчета.
Формула задает вычисляемое выражение или псевдоним колонки. В выпадающем списке колонок отчета на последней позиции находится значение «Вычисляемое». Это синтетическое поле, которое позволяет вставить произвольные операторы и функции, допустимые в языке SQL. При этом можно оперировать любыми другими колонками отчета, если для них задан псевдоним в их поле Формула.
В этой версии сервиса используются функции MySQL (версия 10.5.26-MariaDB).
Например, следующий отчет вычисляет название месяца на английском из даты встречи (в базе она хранится в секундах с 01-01-1970 00:00:00) и преобразует имя клиента в заглавные буквы:
Имя в отчете — название колонки в выводимом отчете, по умолчанию — значение Колонки отчета.
Формула задает вычисляемое выражение или псевдоним колонки. В выпадающем списке колонок отчета на последней позиции находится значение «Вычисляемое». Это синтетическое поле, которое позволяет вставить произвольные операторы и функции, допустимые в языке SQL. При этом можно оперировать любыми другими колонками отчета, если для них задан псевдоним в их поле Формула.
В этой версии сервиса используются функции MySQL (версия 10.5.26-MariaDB).
Например, следующий отчет вычисляет название месяца на английском из даты встречи (в базе она хранится в секундах с 01-01-1970 00:00:00) и преобразует имя клиента в заглавные буквы:
Отчет при этом будет выглядеть так:
Вряд ли вы будете часто использовать подобные возможности, но вы должны знать, что Интеграл предоставляет доступ к очень мощным и гибким средствам для различных вычислений.
Если в поле Формула встречается выражение в квадратных скобках, то система попытается найти соответствующий отчет и использовать данные из него (см. Использование вложенных запросов в отчете).
Назначение кнопок построителя запросов
Значение (от), Значение (до) — диапазон значений (для дат и чисел) или маска (для текста). Здесь работают правила фильтрования из раздела Поиск в таблицах и можно использовать служебные слова. Также здесь можно использовать значение других полей отчета, если заключить их имя из колонки Формула в квадратные скобки.
Функция — агрегирующая функция, применяемая к значению поля: AVG (среднее), COUNT (количество), MAX (максимальное), MIN (минимальное), SUM (сумма). Группировка значений, посчитанных этой функцией, происходит по всем полям, в которых не используется агрегирование (не указана одна из перечисленных функций): в рассмотренном выше отчете «Встречи по клиента» группировка осуществляется для всех комбинаций Клиент — Категория.
Скрыть — если поставить галку в этом поле, то соответствующая колонка не будет отображена в отчете, хотя ее значение может использоваться для вычислений, фильтрования и сортировки отчета.
Формат — конечный формат отображения поля. Служит для приведения значения к нужному виду. При использовании формата HTML теги языка HTML не экранируются, как это делается со всеми остальными типами данных для исключения внедрения и исполнения произвольного javascript на страницах браузера.
Сорт. — указатель последовательности и направления сортировки отчета. Отрицательное число здесь даст обратную сортировку (по убыванию значений).
Итог — агрегирующая функция, применяемая к значениям колонки отчета. Если указана функция хотя бы в одной колонке, то в отчете выводится итоговая строка с соответствующими значениями.
HAVING (Функция (от), Функция (до)) — диапазон значений (для дат и чисел) или маска (для текста), применяемые после вычисления функций, указанных в поле Функция (аналог ключа HAVING в SQL). Здесь также работают правила фильтрования из раздела Поиск в таблицах и можно использовать служебные слова. Также здесь можно использовать значение других полей отчета, если заключить их имя из колонки Формула в квадратные скобки.
SET — выражение, значение которого будет присвоено колонке, попавшей в эту строку запроса.
Если в поле Формула встречается выражение в квадратных скобках, то система попытается найти соответствующий отчет и использовать данные из него (см. Использование вложенных запросов в отчете).
Назначение кнопок построителя запросов
Значение (от), Значение (до) — диапазон значений (для дат и чисел) или маска (для текста). Здесь работают правила фильтрования из раздела Поиск в таблицах и можно использовать служебные слова. Также здесь можно использовать значение других полей отчета, если заключить их имя из колонки Формула в квадратные скобки.
Функция — агрегирующая функция, применяемая к значению поля: AVG (среднее), COUNT (количество), MAX (максимальное), MIN (минимальное), SUM (сумма). Группировка значений, посчитанных этой функцией, происходит по всем полям, в которых не используется агрегирование (не указана одна из перечисленных функций): в рассмотренном выше отчете «Встречи по клиента» группировка осуществляется для всех комбинаций Клиент — Категория.
Скрыть — если поставить галку в этом поле, то соответствующая колонка не будет отображена в отчете, хотя ее значение может использоваться для вычислений, фильтрования и сортировки отчета.
Формат — конечный формат отображения поля. Служит для приведения значения к нужному виду. При использовании формата HTML теги языка HTML не экранируются, как это делается со всеми остальными типами данных для исключения внедрения и исполнения произвольного javascript на страницах браузера.
Сорт. — указатель последовательности и направления сортировки отчета. Отрицательное число здесь даст обратную сортировку (по убыванию значений).
Итог — агрегирующая функция, применяемая к значениям колонки отчета. Если указана функция хотя бы в одной колонке, то в отчете выводится итоговая строка с соответствующими значениями.
HAVING (Функция (от), Функция (до)) — диапазон значений (для дат и чисел) или маска (для текста), применяемые после вычисления функций, указанных в поле Функция (аналог ключа HAVING в SQL). Здесь также работают правила фильтрования из раздела Поиск в таблицах и можно использовать служебные слова. Также здесь можно использовать значение других полей отчета, если заключить их имя из колонки Формула в квадратные скобки.
SET — выражение, значение которого будет присвоено колонке, попавшей в эту строку запроса.
Использование вложенных запросов в отчете
Приведем более сложный пример для построения отчета. Задача: у клиента есть несколько оплаченных услуг, и нам необходимо выбрать тех клиентов, у кого оплаченное время скоро заканчивается. При этом
нужно игнорировать клиентов, кто уже заранее оплатил аналогичную услугу. Получается, нужно дважды обратиться к таблице Оплаты с разными запросами.
В 9-ой строке Колонок отчета используется вызов отчета PAID_TILL, который в качестве условия отбора использует номер карты CARD_NO исходного отчета: отчет PAID_TILL выберет максимальную дату, до которой оплачена услуга по заданной карте.
В 9-ой строке Колонок отчета используется вызов отчета PAID_TILL, который в качестве условия отбора использует номер карты CARD_NO исходного отчета: отчет PAID_TILL выберет максимальную дату, до которой оплачена услуга по заданной карте.
Еще один пример использования вложенных отчетов в поле Формула: данные собираются из трех дополнительных отчетов Daily_bar, Daily_purchase и Daily_replenish. Подобные решения применяются,
например, при расчете оборотно–сальдовой ведомости.
Вызов отчета с произвольными параметрами
Пользователь может передать в отчет свои параметры для фильтрации данных. Здесь работают правила фильтрования из раздела Поиск в таблицах и можно использовать служебные слова
Например, есть такой отчет:
Например, есть такой отчет:
Он выводит следующую информацию:
Обратите внимание на параметры в строке адреса: FR_MANAGER=Света&FR_DATE=09/09/2016
Эти параметры позволяют передать в отчет произвольные фильтры, которые будут применены построителем отчета. Правила таковы: для фильтра «Значение (от)» колонки отчета MANAGER следует передать в отчет FR_MANAGER=значение; для фильтра «Значение (до)» используется конструкция TO_MANAGER=значение.
Важная особенность с точки зрения безопасности: фильтр можно применить только к тем колонкам, для которых задано «Имя в отчете». Это позволяет аналитику защититься от принудительной замены фильтра со стороны пользователя.
Вам ни в коем случае не следует привыкать задавать эти параметры вручную через строку адреса, но вы можете передать их в качестве параметра из собственной html–формы, как описано в разделе Пользовательские html–формы.
Эти параметры позволяют передать в отчет произвольные фильтры, которые будут применены построителем отчета. Правила таковы: для фильтра «Значение (от)» колонки отчета MANAGER следует передать в отчет FR_MANAGER=значение; для фильтра «Значение (до)» используется конструкция TO_MANAGER=значение.
Важная особенность с точки зрения безопасности: фильтр можно применить только к тем колонкам, для которых задано «Имя в отчете». Это позволяет аналитику защититься от принудительной замены фильтра со стороны пользователя.
Вам ни в коем случае не следует привыкать задавать эти параметры вручную через строку адреса, но вы можете передать их в качестве параметра из собственной html–формы, как описано в разделе Пользовательские html–формы.
Запросы на изменение данных
Интеграл позволяет массово изменять данные, в том числе находящиеся в разных таблицах. Запрос на изменение можно добавить к любому отчету — необходимо указать новые значения колонок, отобранных в
отчете. Таким запросом можно удалять объекты и их реквизиты, а также создавать новые записи, подчиненные или связанные с выбранными в отчете объектами.
Изменение данных происходит в 2 этапа. Сначала формируется отчет, в котором указаны какие данные будут изменены и как, после чего пользователь дает команду выполнить эти изменения, и они выполняются.
Рассмотрим такой пример: нам необходимо отобрать всех Клиентов, с кем первая встреча была осенью 2021 года, и указать в Примечании Клиента «Осень 2021». Отчет, выполняющий эту работу, будет выглядеть так (обратите внимание на графу «SET»):
Изменение данных происходит в 2 этапа. Сначала формируется отчет, в котором указаны какие данные будут изменены и как, после чего пользователь дает команду выполнить эти изменения, и они выполняются.
Рассмотрим такой пример: нам необходимо отобрать всех Клиентов, с кем первая встреча была осенью 2021 года, и указать в Примечании Клиента «Осень 2021». Отчет, выполняющий эту работу, будет выглядеть так (обратите внимание на графу «SET»):
Результат работы отчета будет следующим:
В графе SET указано, какие изменения будут внесены в данные. При нажатии гиперссылки «Выполнить» отчет сформируется еще раз, и все изменения будут применены. Отчет при этом будет отображать данные
какими они были до внесения изменений:
Но в таблице Клиентов мы увидим обновленные данные:
Обратите внимание, что в построителе отчетов присваиваемое значение заключено в кавычки, в отличие от полей Фильтр (от и до) и Функция. Поле «SET» может использовать значения поля «Формула», а также
функции языка SQL для вычисления присваиваемого значения. Для демонстрации этих возможностей на примере усложним задачу — будем не заменять Примечание Клиента, а дописывать к нему текст в конце с
указанием номера телефона. Доработаем наш отчет следующим образом:
Функция CONCAT() будет сцеплять переданные ей аргументы в строку. А IFNULL проверяет значение некоторого выражения. Если оно равно NULL, то функция возвращает значение, которое передано в качестве
второго параметра.
Теперь мы не будем терять информацию из Примечания, а просто дополним её:
Теперь мы не будем терять информацию из Примечания, а просто дополним её:
У вас может возникнуть вопрос: что будет, если какой-то объект встречается в отчете больше одного раза, и мы пытаемся его изменить. Ответ: объект будет изменен только 1 раз. Например, в следующем
отчете мы добавляем Примечание клиента, который упомянут в нескольких строках отчета, и Интеграл выполнит изменение только 1 раз для каждого клиента:
Теперь продемонстрируем создание новых записей. Пример: нам нужно запланировать на 1 ноября 2021 года встречи со всеми клиентами в статусе «Лид». Создадим такой отчет:
Внимание! Если в колонке отчета заданы условия отбора и заполнено поле SET, то Интеграл трактует условие отбора как заданное условием или пустое. Таким образом можно убедиться, что будет создано
только одно новое значение и предотвратить создание дубликатов при многократном запуске отчета.
Этот отчет выдаст нам следующее:
Этот отчет выдаст нам следующее:
Если у клиента при этом не было назначено никаких встреч, то Интеграл добавит им соответствующие записи, когда мы нажмем «Выполнить».
Если мы запустим этот отчет снова, то он уже не добавит еще раз эти записи, но может, например, исправить Тему встречи, если она будет отличаться от заданной.
А в следующем примере мы удалим информацию обо всех встречах сентября 2021 года:
Если мы запустим этот отчет снова, то он уже не добавит еще раз эти записи, но может, например, исправить Тему встречи, если она будет отличаться от заданной.
А в следующем примере мы удалим информацию обо всех встречах сентября 2021 года:
Для удаления записей используется пустое значение: "". Интеграл не тратит память на пустые значения, поэтому информация будет просто удалена:
При нажатии кнопки «Выполнить» все эти записи будут удалены, включая все подчиненные им реквизиты (в том числе массивы).
Внимание! При удалении записей таким образом Интеграл не проводит проверку существующих связей, то есть, вы можете удалить даже справочные значения, использующиеся в других объектах (например, удалить менеджера, на которого есть ссылка у одного или более клиентов).
Рассмотренные примеры достаточно просты и затрагивают всего пару связанных таблиц. В реальных задачах вы можете использовать любое количество связанных таблиц и обновлять данные в любых полях этих таблиц одним запросом.
Внимание! При удалении записей таким образом Интеграл не проводит проверку существующих связей, то есть, вы можете удалить даже справочные значения, использующиеся в других объектах (например, удалить менеджера, на которого есть ссылка у одного или более клиентов).
Рассмотренные примеры достаточно просты и затрагивают всего пару связанных таблиц. В реальных задачах вы можете использовать любое количество связанных таблиц и обновлять данные в любых полях этих таблиц одним запросом.
Запросы на изменение — это очень мощный инструмент Интеграла, не имеющий аналогов в других системах хранения и управления данными.
В строке адреса отчета, выполняющего изменения, можно наблюдать флаг «confirmed» — этот флаг сообщает Интегралу, что изменения подтверждены пользователем и должны быть немедленно выполнены. Вы можете использовать это знание для генерации ссылок на страницах интерфейса пользователя, чтобы выполнять изменения без подтверждения: по ссылке будет запущен отчет, который сразу выполнит запрошенные изменения.
Внимание! Параметр «confirmed» должен быть передан с POST-запросом, иначе он не сработает.
В следующем примере мы обновляем примечание клиента:
В строке адреса отчета, выполняющего изменения, можно наблюдать флаг «confirmed» — этот флаг сообщает Интегралу, что изменения подтверждены пользователем и должны быть немедленно выполнены. Вы можете использовать это знание для генерации ссылок на страницах интерфейса пользователя, чтобы выполнять изменения без подтверждения: по ссылке будет запущен отчет, который сразу выполнит запрошенные изменения.
Внимание! Параметр «confirmed» должен быть передан с POST-запросом, иначе он не сработает.
В следующем примере мы обновляем примечание клиента:
Использование параметра EXECUTE для немедленного выполнения запросов
В некоторых случаях вам может понадобиться вносить изменения в вашу базу данных без подтверждения. Например, для сохранения информации о пользовательских действиях или других автоматических изменений данных. Такой запрос можно внедрить в нужное вам рабочее место, и он будет срабатывать каждый раз при открытии этого рабочего места.
Если установить параметр EXECUTE у запроса, то запрос будет выполнен при вызове любым методом: POST или GET.
В некоторых случаях вам может понадобиться вносить изменения в вашу базу данных без подтверждения. Например, для сохранения информации о пользовательских действиях или других автоматических изменений данных. Такой запрос можно внедрить в нужное вам рабочее место, и он будет срабатывать каждый раз при открытии этого рабочего места.
Если установить параметр EXECUTE у запроса, то запрос будет выполнен при вызове любым методом: POST или GET.
Если в вашем Интеграле нет параметра EXECUTE у запроса, то вы можете добавить его в таблицу запроса сами, и он будет работать. Этот параметр доступен в новых регистрациях с апреля 2024 года.
Пример запроса для удаления дубликатов
Допустим, в нашу таблицу с фильмами были добавлены дубликаты. Какие-то из них мы видим сразу, другие скрыты среди сотен фильмов, и искать глазами их проблематично.
Допустим, в нашу таблицу с фильмами были добавлены дубликаты. Какие-то из них мы видим сразу, другие скрыты среди сотен фильмов, и искать глазами их проблематично.
Мы сделаем пару запросов: основной, где выведем все фильмы, и вложенный, который для каждого фильма попробует найти всех его двойников и вычислить минимальный из их ID.
Идея такова, что у самого первого фильма ID будет минимальным (ID выделяются в возрастающем порядке), поэтому записи с таким ID мы оставим, а остальные — удалим.
Ниже приведен пример составления таких запросов с пояснениями. Запрос Оригинал вложен в запрос Дубликаты и вычисляет минимальный ID для каждой комбинации фильма и режиссера.
Ниже приведен пример составления таких запросов с пояснениями. Запрос Оригинал вложен в запрос Дубликаты и вычисляет минимальный ID для каждой комбинации фильма и режиссера.
Вложенный запрос, если его запустить самостоятельно, будет показывать ошибку (она убрана на скриншоте выше).
Это нормальное поведение, потому что он не может понять, откуда взять значения [Director] и [Movie], которые должны быть переданы из родительского запроса и не доступны в режиме конструктора.
В итоге у нас получится такой отчет, который выводит дубликаты и позволяет их удалить. Его можно вывести в пункт меню или запускать по расписанию POST-запросом с переданным флагом «confirmed».
В итоге у нас получится такой отчет, который выводит дубликаты и позволяет их удалить. Его можно вывести в пункт меню или запускать по расписанию POST-запросом с переданным флагом «confirmed».
Аналог ключа LIMIT в отчетах Интеграла
Пользователь может задать максимальное количество возвращаемых отчетом записей и смещение, начиная с которого необходимо выбирать записи: аналог ключа LIMIT в языке SQL. Соответствующий параметр
отчета так и называется «LIMIT» и он может принимать пару значений, разделенный запятой, аналогично LIMIT. Этот параметр также можно передать запросом POST или GET при вызове отчета.
Следующий отчет вернет не более 10 записей:
Следующий отчет вернет не более 10 записей:
Количество записей на страницы, переданное параметром запроса, не может превышать заданное в отчете из соображений безопасности.
Будучи вызван с двумя параметрами в LIMIT, задающими количество строк и смещение, запрос вернет требуемое количество записей (8) с заданной строки отчета (15), позволяя таким образом «листать» отчет:
Выгрузка отчета в формат JSON
Для построения интерфейсов и выгрузки данных может оказаться полезным выгрузка результатов отчета в виде JSON-файла. Для этого при запуске отчета следует передать параметр JSON, как показано на
следующем рисунке:
Для получения сокращенного формата JSON, без описания колонок отчета и его итогов, а только содержащий данные под именами столбцов, следует вместо JSON использовать параметр JSON_DATA, например:
https://ideav.online/viki/report/384225?JSON_DATA
Если необходимо получить результат в формате "key1":"val1", "key2":"val2", например, если у вас база данных для Bubble.io, то используйе ключ JSON_KV:
https://ideav.online/viki/report/384225?JSON_KV
Для использования Интеграла в качестве back-end к сервису Creatium используйте ключ JSON_CR:
https://ideav.online/papago/report/3605?JSON_CR
Настройки импорта данных в Creatium с помощью базовой HTTP-аутентификации выглядят так (пользователь api, пароль ************):
Использование запросов к внешним источникам
Интеграл позволяет обратиться к внешним системам (сайты, API, файлы и т.д.) по протоколу http во время выполнения отчета. Для этого необходимо задать шаблон URL внешнего источника в поле URL отчета. В
шаблоне можно использовать значения полей отчета, заключив их имена в квадратные скобки (см. [phone], [name]):
Далее при выборе колонок отчета можно задать их имена, и значения этих колонок будут подставлены в шаблон для каждой строки отчета:
Функция abn_URL заменит содержимое своего поля на результат выполнения запроса к полученному URL. В результате выполнения, например, заданного выше запроса к API поставщика SMS-сервиса мы получим
ответ сервиса с идентификатором отправленного сообщения, которое придет на заданный нами телефон [phone] получателю с именем [name]:
Результат запроса к URL можно также сохранить в базе, присвоив его значение какому-либо полю, в том числе с использованием флага confirmed.
Внимание! Интеграл вычисляет значения колонок отчета последовательно, поэтому все используемые в шаблоне поля должны быть определены до поля с функцией abn_URL (находиться в колонках левее).
Внимание! Интеграл вычисляет значения колонок отчета последовательно, поэтому все используемые в шаблоне поля должны быть определены до поля с функцией abn_URL (находиться в колонках левее).
Реквизит типа Кнопка (BUTTON)
Среди базовых структуры данных есть особый тип — BUTTON. Реквизит этого типа отображается на форме редактирования объекта в виде «кнопки» — это некое действие с редактируемым
объектом. Эта кнопка вызывает пользовательскую html–форму и передает ей в качестве параметра идентификатор текущего объекта. Для пользовательской формы можно настроить отчет,
получив тем самым любое рабочее место для операций над текущим объектом и любыми связанными данными.
Интеграл заменит значения [ID] и [VAL] соответственно на идентификатор и значение родительского элемента, в данном случае Товара: ID=183755 и VAL=1240000214642.
Таким образом, вы можете сверстать в html любое рабочее место и передать в него данные конкретного объекта для выполнения нужных вам действий.
Таким образом, вы можете сверстать в html любое рабочее место и передать в него данные конкретного объекта для выполнения нужных вам действий.
Разграничение прав пользователей
Интеграл поддерживает разграничение прав пользователей при помощи ролей доступа с детализацией до отдельных полей и их значений. Список пользователей находится в меню Таблицы –> Пользователь. Имя
пользователя, работающего в системе в данный момент, отображено в нижнем левом углу каждой страницы (см. рисунок ниже). Для каждого пользователя задана Роль:
Кликнув название роли пользователя, можно просмотреть детали этой роли и заданные ей объекты:
На рисунке показаны все разрешенные для просмотра и редактирования типы объектов, а также видно, что колонка «Фирма» в таблице товар будет скрыта от пользователя с ролью Manager. Кроме того, Артикул,
доступный только для чтения, ограничен маской «2%», то есть пользователь увидит только те товары, Артикул которых начинается с 2.
Уровни доступа Интеграла заданы в справочнике Таблицы –> Доступ:
Уровни доступа Интеграла заданы в справочнике Таблицы –> Доступ:
На уровне Роли Интеграл позволяет разрешить или запретить доступ пользователей к функциям экспорта и массового удаления данных определенный структуры:
Гостевой (анонимный) доступ
Для анонимного доступа в систему вы можете создать пользователя guest (гость) и назначить ему роль guest, которая изначально есть в системе (если в вашей системе её нет, то её можно создать, и она заработает). Гость не сможет видеть никакие объекты, пока вы не добавите их в роль, но сможет видеть ту страницу системы, на которую вы его отправите.
Для анонимного доступа в систему вы можете создать пользователя guest (гость) и назначить ему роль guest, которая изначально есть в системе (если в вашей системе её нет, то её можно создать, и она заработает). Гость не сможет видеть никакие объекты, пока вы не добавите их в роль, но сможет видеть ту страницу системы, на которую вы его отправите.
Если при входе гостя вы видите ошибку Неверный токен пользователя GUEST (Invalid token for GUEST), то значит по каким-то причинам этот пользователь ранее авторизовывался с паролем, и ему необходимо сбросить авторизационный токен: очистите этому пользователю поле Token и сохраните изменение:
На рисунке выше вы также видите поле Secret (секрет), которое используется для задания доступа по секретному слову. Если вы установите пользователю это свойство в какое-то значение, а потом передадите его в качестве POST или GET параметра, то пользователь авторизуется в системе с указанной для него ролью.
Для использования секрета его следует добавить в качестве параметра в ссылку, вот таким образом, передав параметр secret с запросом:
Секретное слово хранится в открытом виде, в отличие от пароля и токенов, поэтому не обеспечивает надежной защиты и обычно используется когда вы даете простой демо-доступ пользователю с определенной ролью, как, например, сделано здесь:
https://bkint.ru/index.php?db=demo&secret=1p2r3o4d5a6v7a8n90.
Для использования секрета его следует добавить в качестве параметра в ссылку, вот таким образом, передав параметр secret с запросом:
https://ideav.online/test?secret=xxxxxxxxxxxx
Секретное слово хранится в открытом виде, в отличие от пароля и токенов, поэтому не обеспечивает надежной защиты и обычно используется когда вы даете простой демо-доступ пользователю с определенной ролью, как, например, сделано здесь:
https://bkint.ru/index.php?db=demo&secret=1p2r3o4d5a6v7a8n90.
Пользовательские файлы
Меню Файлы в Интеграле доступны только пользователю с именем, совпадающим с именем базы, и пользователю с именем admin.
Все файлы, загруженные в систему пользователями через интерфейс Интеграла (например, фотографии товаров или файлы договоров), сохраняются в директории download, доступной администратору Интеграла. Для исключения неавторизованного доступа файлы хранятся в папках с зашифрованными именами, не более 1000 файлов в каждой папке. Имена зашифрованы с использованием имени базы, поэтому у каждой базы получается свой алгоритм шифрования.
У каждого файла есть системный идентификатор, из которого вычисляется имя папки и имя файла: имя файла — это последние 3 цифры идентификатора + шифр из 8 цифр; имя папки — это остальные цифры идентификатора + шифр из 8 цифр. На следующем рисунке показано, как будет храниться файл с идентификатором 0774 и расширением jpg:
Все файлы, загруженные в систему пользователями через интерфейс Интеграла (например, фотографии товаров или файлы договоров), сохраняются в директории download, доступной администратору Интеграла. Для исключения неавторизованного доступа файлы хранятся в папках с зашифрованными именами, не более 1000 файлов в каждой папке. Имена зашифрованы с использованием имени базы, поэтому у каждой базы получается свой алгоритм шифрования.
У каждого файла есть системный идентификатор, из которого вычисляется имя папки и имя файла: имя файла — это последние 3 цифры идентификатора + шифр из 8 цифр; имя папки — это остальные цифры идентификатора + шифр из 8 цифр. На следующем рисунке показано, как будет храниться файл с идентификатором 0774 и расширением jpg:
Зная идентификатор файла, вы можете визуально найти его среди остальных. Вы можете скачивать файлы на свой компьютер, а также загружать их на сервер, при необходимости перезаписывая существующие
файлы.
Обратите внимание, что файлы сохраняются в зашифрованных папках только будучи загружены через форму редактирования объекта — edit_obj (см. формы), то есть при нормальной работе пользователей Интеграла). Если администратор загрузит файл через меню Файлы, то он будет загружен как есть. Поэтому если вы загружаете в эту папку актуальные версии руководства пользователя и/или служебных инструкций, то рекомендуется использовать секретное (хешированное) имя файла.
Обратите внимание, что файлы сохраняются в зашифрованных папках только будучи загружены через форму редактирования объекта — edit_obj (см. формы), то есть при нормальной работе пользователей Интеграла). Если администратор загрузит файл через меню Файлы, то он будет загружен как есть. Поэтому если вы загружаете в эту папку актуальные версии руководства пользователя и/или служебных инструкций, то рекомендуется использовать секретное (хешированное) имя файла.
Генерация web–страниц Интеграла
Базовый интерфейс Интеграла построен на пяти универсальных формах по единому принципу: html–шаблон содержит точки вставки информации из системных отчетов. Все эти формы,
кроме отчета, вставляются в главную форму main.html, шаблон которой доступен для редактирования администратору. Администратор также может создавать свои html–формы и использовать их
как внутри главной формы, так и самостоятельно.
На каждое действие пользователя генерируется страница рабочего места с одной из упомянутых универсальных форм (или пользовательской формой). Пользователю нет необходимости обращать внимание на адресную строку браузера, но аналитику Интеграла нужно знать несколько простых правил для внедрения в систему собственных html–форм.
Адрес страницы выглядит так:
db — имя базы данных;
action — имя формы (html-шаблона);
id — идентификатор объекта, над которым производится действие.
Например, адрес для редактирования (форма edit_obj) объекта с id=776 в базе test будет:
Задача аналитика при разработке html–формы: правильно подготовить и передать параметры для ее отображения. На данном этапе дорабатывается спецификация для более простого и быстрого создания собственного функционала, и вскоре она будет опубликована.
На каждое действие пользователя генерируется страница рабочего места с одной из упомянутых универсальных форм (или пользовательской формой). Пользователю нет необходимости обращать внимание на адресную строку браузера, но аналитику Интеграла нужно знать несколько простых правил для внедрения в систему собственных html–форм.
Адрес страницы выглядит так:
https://ideav.online/{db}/{action}/{id}
где синим цветом выделены параметры:db — имя базы данных;
action — имя формы (html-шаблона);
id — идентификатор объекта, над которым производится действие.
Например, адрес для редактирования (форма edit_obj) объекта с id=776 в базе test будет:
https://ideav.online/test/edit_obj/776
Задача аналитика при разработке html–формы: правильно подготовить и передать параметры для ее отображения. На данном этапе дорабатывается спецификация для более простого и быстрого создания собственного функционала, и вскоре она будет опубликована.
Шаблон со стандартными html–формами
Вы можете зарегистрировать базу с полным набором html-форм, выбрав при создании базы в Личном кабинете шаблон Full with HTMLs:
В этом случае вы сможете поправить все формы базового интерфейса Интеграла, найдя их в меню Файлы, в директории templates. Эти изменения коснутся только этой базы, не затрагивая других пользователей и другие ваши приложения.
Пользовательские html–формы и блоки данных
Все пользовательские html–формы находятся в меню Файлы, в директории templates:
В коде форм встречаются объявления блоков данных — это кубики, из которых собирается Интеграл:
<!-- Begin: Store --> … <!-- End: Store -->
Эти конструкции обозначают блоки для вставки информации из отчетов. При построении страницы Интеграл заполняет точки вставки, заключенные в фигурные скобки {...} в блоках данных, пока у него не закончатся данные. Если данных для точки вставки нет, то блок не будет выведен ни разу.
Если вы используете ES6 или иные языки с использованием фигурных скобок, то можно вставить пробелы перед фигурными скобками, чтобы шаблонизатор не воспринял эту конструкцию как незаполненную точку вставки:
Внимание: Если в блоке не используются точки вставки, то есть, не упоминаются никакие поля отчета в фигурных скобках, то блок будет выведен один раз даже при пустом отчете. Логика такова: незаполненных точек вставки нет, значит блок отображается.
Есть две полезные конструкции для обращения к значениям родительского блока и значениям, переданным запросом POST или GET, а также сохраненными в cookie:
Встретив выражение {_parent_.GOOD_ID}, Интеграл будет просматривать все родительские блоки, пока не обнаружит первое значение GOOD_ID.
Конструкция {_request_.GOOD_ID} проверит наличие параметра GOOD_ID, переданного с запросом, и будет использовать его значение, если таковое задано.
Блоки данных — третий важнейший элемент, помимо отчетов и структуры. Принцип работы Интеграла очень прост: берем шаблон, смотрим, какие там блоки, ищем соответствующие отчеты и заполняем блоки данными.
Некоторые отчеты являются служебными, например, для блока &Top_Menu в главной форме Интеграла, представленной на следующем рисунке. Служебные отчеты начинаются с амперсанда «&», их не видно среди других отчетов Интеграла и нельзя редактировать.
<!-- Begin: Store --> … <!-- End: Store -->
Эти конструкции обозначают блоки для вставки информации из отчетов. При построении страницы Интеграл заполняет точки вставки, заключенные в фигурные скобки {...} в блоках данных, пока у него не закончатся данные. Если данных для точки вставки нет, то блок не будет выведен ни разу.
Если вы используете ES6 или иные языки с использованием фигурных скобок, то можно вставить пробелы перед фигурными скобками, чтобы шаблонизатор не воспринял эту конструкцию как незаполненную точку вставки:
const name = 'Alex';
const hello = `Hello ${ name }`;
const hello = `Hello ${ name }`;
Внимание: Если в блоке не используются точки вставки, то есть, не упоминаются никакие поля отчета в фигурных скобках, то блок будет выведен один раз даже при пустом отчете. Логика такова: незаполненных точек вставки нет, значит блок отображается.
Есть две полезные конструкции для обращения к значениям родительского блока и значениям, переданным запросом POST или GET, а также сохраненными в cookie:
Встретив выражение {_parent_.GOOD_ID}, Интеграл будет просматривать все родительские блоки, пока не обнаружит первое значение GOOD_ID.
Конструкция {_request_.GOOD_ID} проверит наличие параметра GOOD_ID, переданного с запросом, и будет использовать его значение, если таковое задано.
Блоки данных — третий важнейший элемент, помимо отчетов и структуры. Принцип работы Интеграла очень прост: берем шаблон, смотрим, какие там блоки, ищем соответствующие отчеты и заполняем блоки данными.
Некоторые отчеты являются служебными, например, для блока &Top_Menu в главной форме Интеграла, представленной на следующем рисунке. Служебные отчеты начинаются с амперсанда «&», их не видно среди других отчетов Интеграла и нельзя редактировать.
Конструкция <!-- File: a --> означает, что будет найден файл, имя которого передано как {action} в адресе https://ideav.online/{db}/{action}/{id}, и этот файл будет вставлен вместо этой конструкции. Если {action} не указан, то будет взят файл info.html — действие по умолчанию.
Если требуется вставить какой-то конкретный файл, например xxx.html, то его следует указать в этой конструкции без расширения: <!-- File: xxx -->, а сам файл должен находиться в директории templates меню Файлы.
Во вставляемом файле могут содержаться точки вставки данных и другие файлы, что будет также обработано Интегралом и заполнено данными.
Внимание! Имя файла должно передаваться без указания расширения html.
Рассмотрим пример создания пользовательской формы для оперативного просмотра остатков на складе (пользовательское меню Склад). Форма склада будет вложена в главную страницу системы main.html при помощи только что рассмотренной конструкции File. На этой форме пользователь может искать товар по нескольким параметрам, по умолчанию — по штрих–коду:
Если требуется вставить какой-то конкретный файл, например xxx.html, то его следует указать в этой конструкции без расширения: <!-- File: xxx -->, а сам файл должен находиться в директории templates меню Файлы.
Во вставляемом файле могут содержаться точки вставки данных и другие файлы, что будет также обработано Интегралом и заполнено данными.
Внимание! Имя файла должно передаваться без указания расширения html.
Рассмотрим пример создания пользовательской формы для оперативного просмотра остатков на складе (пользовательское меню Склад). Форма склада будет вложена в главную страницу системы main.html при помощи только что рассмотренной конструкции File. На этой форме пользователь может искать товар по нескольким параметрам, по умолчанию — по штрих–коду:
Файл формы Склада в директории templates — store.html, а его код представлен на следующем рисунке.
Форма состоит, в частности, из элемента html <form> — форма, которая вызывает сама себя (см. action="/{_global_.z}/store") и передает введенные параметры: Штрих-код (FR_CODE), Марка (FR_FIRM) и другие. Эти параметры будут использованы в отчете, как описано в разделе Вызов отчета с произвольными параметрами.
блок Store не является служебным, поэтому Интеграл попытается найти соответствующий отчет в справочнике отчетов, выполнить его, а из его колонок заполнить точки вставки в блоке Store: {DATE}, {FIRM} и остальные. Сколько строк вернет отчет Store, столько раз повторится на странице кусок html–кода между тегами <!-- Begin: Store --> и <!-- End: Store -->, а значения из отчета попадут в соответствующие точки вставки.
Форма состоит, в частности, из элемента html <form> — форма, которая вызывает сама себя (см. action="/{_global_.z}/store") и передает введенные параметры: Штрих-код (FR_CODE), Марка (FR_FIRM) и другие. Эти параметры будут использованы в отчете, как описано в разделе Вызов отчета с произвольными параметрами.
блок Store не является служебным, поэтому Интеграл попытается найти соответствующий отчет в справочнике отчетов, выполнить его, а из его колонок заполнить точки вставки в блоке Store: {DATE}, {FIRM} и остальные. Сколько строк вернет отчет Store, столько раз повторится на странице кусок html–кода между тегами <!-- Begin: Store --> и <!-- End: Store -->, а значения из отчета попадут в соответствующие точки вставки.
По умолчанию при открытии этой формы фокус попадет в поле штрих–код (оно помечено «autofocus»), и если при этом пользователь введет код и нажмет Enter или отсканирует код сканером, то форма вызовет
сама себя с параметром FR_CODE, который применится в виде фильтра по полю CODE в отчете Store (см. выделенное красными прямоугольниками на рисунке).
На приведенном выше рисунке меню Склад был отсканирован код 8697923495536, для которого отчет вернул одну запись, и эта запись была в итоге отражена в таблице на форме Склада.
Несколько моментов, на которые нужно обратить внимание:
блоки, обозначенные зеленым цветом в html–коде, являются вложенными: info содержит Store, который, в свою очередь, содержит блок MyBar;
из блока MyBar мы можем обратиться к вышестоящему блоку и запросить у него данные — идентификатор товара GOOD_ID, для чего используем {_parent_.GOOD_ID};
при отправке формы на сервер Интеграла следует использовать адрес /{_global_.z}/store, где store — имя вызываемой формы;
{_global_.z} — внутренняя глобальная константа Интеграла, содержащая имя базы;
блок MyBar — это гиперссылка не некое действие (продажа товара из этой конкретной строки), это действие создает объект «продажа», для чего содержит команду ;
вы можете сообщить Интегралу, какую форму открыть после того, как он выполнит заданное вами действие (например, создание «продажи», запущенное из блока MyBar);
создавая произвольные формы (рабочие места) и направляя пользователя от одной из них к другой, вы можете моделировать бизнес–процессы любой сложности.
Интеграл также понимает конструкцию <!--Elapsed-->, которая будет заменена информацией об имени пользователя, количестве запросов к базе для построения этой страницы, времени выполнения запросов, полном времени построения страницы и временном сдвиге относительно времени сервера (значения времени секундах), например:
Еще одна полезная особенность — возможность применения в отчете фильтра по значениям полей данных из произвольных блоков формы. Например, можно обратиться к значениям вышестоящего блока intFormPanels при генерации запроса для блока intPanelFields:
На приведенном выше рисунке меню Склад был отсканирован код 8697923495536, для которого отчет вернул одну запись, и эта запись была в итоге отражена в таблице на форме Склада.
Несколько моментов, на которые нужно обратить внимание:
блоки, обозначенные зеленым цветом в html–коде, являются вложенными: info содержит Store, который, в свою очередь, содержит блок MyBar;
из блока MyBar мы можем обратиться к вышестоящему блоку и запросить у него данные — идентификатор товара GOOD_ID, для чего используем {_parent_.GOOD_ID};
при отправке формы на сервер Интеграла следует использовать адрес /{_global_.z}/store, где store — имя вызываемой формы;
{_global_.z} — внутренняя глобальная константа Интеграла, содержащая имя базы;
блок MyBar — это гиперссылка не некое действие (продажа товара из этой конкретной строки), это действие создает объект «продажа», для чего содержит команду ;
вы можете сообщить Интегралу, какую форму открыть после того, как он выполнит заданное вами действие (например, создание «продажи», запущенное из блока MyBar);
создавая произвольные формы (рабочие места) и направляя пользователя от одной из них к другой, вы можете моделировать бизнес–процессы любой сложности.
Интеграл также понимает конструкцию <!--Elapsed-->, которая будет заменена информацией об имени пользователя, количестве запросов к базе для построения этой страницы, времени выполнения запросов, полном времени построения страницы и временном сдвиге относительно времени сервера (значения времени секундах), например:
[username] 7 / 0.0023 / 0.0102 (3600)
Эта конструкция изначально находится внизу страницы main.html и может быть удалена.Еще одна полезная особенность — возможность применения в отчете фильтра по значениям полей данных из произвольных блоков формы. Например, можно обратиться к значениям вышестоящего блока intFormPanels при генерации запроса для блока intPanelFields:
Служебные слова, функции и константы
Интеграл содержит небольшое количество служебных слов и функций, которые дают контроль над происходящим в системе. В фильтрах таблиц и отчетов могут быть использованы следующие слова:
[TODAY] — сегодняшний день, например, 15, если сейчас 15.03.2021 г.
[NOW] — текущие дата и время
[YESTERDAY] — вчерашний день, например, 31.10.2021, если сейчас 1.11.2021 г.
[TOMORROW] — завтрашний день.
[MONTH_AGO] — день месяц назад, например, 28.02.2021, если сейчас 28.03.2021 г.
[MONTH_PLUS] — день через месяц, например, 28.04.2021, если сейчас 28.03.2021 г.
[USER_ID] — ID пользователя, вошедшего в систему
[USER] — имя пользователя, вошедшего в систему (его также видно в левом нижнем углу любой формы системы)
[TSHIFT] — временной сдвиг на рабочей станции пользователя относительно сервера
! — префикс отрицания последующего условия, например, !% означает «пусто»
Внутренние функции
В построителе отчетов могут использоваться внутренние функции Интеграла (их немного и все они начинаются с префикса «abn_»). Эти функции нужны аналитику для программирования собственного функционала в Интеграле, такого как формы для быстрого сохранения, контекстные действия и, вообще, любые операции над данными в Интеграле:
abn_DATE2STR — преобразование даты в строку (пример: 5 мая 2004 г.)
abn_ID — внутренний идентификатор объекта
abn_NUM2STR — преобразование числа в строку (пример: Пятьсот пятьдесят)
abn_RUB2STR — преобразование суммы в строку с рублями и копейками (Один рубль 00 коп)
abn_REQ — внутренний идентификатор типа реквизита
abn_TYP — внутренний идентификатор типа объекта
abn_ORD — внутренний идентификатор порядка (номера) объекта среди равных ему
abn_UP — внутренний идентификатор родителя объекта
abn_ROWNUM — номер строки в отчете, применим только к вычисляемому полю
abn_URL — результат запроса URL (см. Использование запросов к внешним источникам)
Полный список функций находится в меню Таблицы –> Функция.
Глобальные константы
Также Интеграл поддерживает использование следующих констант, которые могут быть использованы в шаблонах HTML-страниц:
{_global_.action} — имя запрошенной формы или действия ;
{_global_.id} — идентификатор запрошенного объекта ;
{_global_.role} — роль пользователя, который вошел в систему.
{_global_.role_id} — ID роли пользователя, который вошел в систему.
{_global_.token} — токен пользователя, который вошел в систему.
{_global_.uri} — путь (URL) к текущей странице, запрошенной пользователем;
{_global_.USER} — имя пользователя, который вошел в систему;
{_global_.USER_ID} — идентификатор пользователя, который вошел в систему;
{_global_.z} — имя текущей базы данных db.
POST и GET параметры
Служебный префикс _request_ позволяет обратиться к переданным в запрос параметрам, чтобы использовать их в фильтрах и формулах запроса. Например, выражение _request_.user будет заменено на содержимое параметра user, переданного при вызове запроса.
[TODAY] — сегодняшний день, например, 15, если сейчас 15.03.2021 г.
[NOW] — текущие дата и время
[YESTERDAY] — вчерашний день, например, 31.10.2021, если сейчас 1.11.2021 г.
[TOMORROW] — завтрашний день.
[MONTH_AGO] — день месяц назад, например, 28.02.2021, если сейчас 28.03.2021 г.
[MONTH_PLUS] — день через месяц, например, 28.04.2021, если сейчас 28.03.2021 г.
[USER_ID] — ID пользователя, вошедшего в систему
[USER] — имя пользователя, вошедшего в систему (его также видно в левом нижнем углу любой формы системы)
[TSHIFT] — временной сдвиг на рабочей станции пользователя относительно сервера
! — префикс отрицания последующего условия, например, !% означает «пусто»
Внутренние функции
В построителе отчетов могут использоваться внутренние функции Интеграла (их немного и все они начинаются с префикса «abn_»). Эти функции нужны аналитику для программирования собственного функционала в Интеграле, такого как формы для быстрого сохранения, контекстные действия и, вообще, любые операции над данными в Интеграле:
abn_DATE2STR — преобразование даты в строку (пример: 5 мая 2004 г.)
abn_ID — внутренний идентификатор объекта
abn_NUM2STR — преобразование числа в строку (пример: Пятьсот пятьдесят)
abn_RUB2STR — преобразование суммы в строку с рублями и копейками (Один рубль 00 коп)
abn_REQ — внутренний идентификатор типа реквизита
abn_TYP — внутренний идентификатор типа объекта
abn_ORD — внутренний идентификатор порядка (номера) объекта среди равных ему
abn_UP — внутренний идентификатор родителя объекта
abn_ROWNUM — номер строки в отчете, применим только к вычисляемому полю
abn_URL — результат запроса URL (см. Использование запросов к внешним источникам)
Полный список функций находится в меню Таблицы –> Функция.
Глобальные константы
Также Интеграл поддерживает использование следующих констант, которые могут быть использованы в шаблонах HTML-страниц:
{_global_.action} — имя запрошенной формы или действия ;
{_global_.id} — идентификатор запрошенного объекта ;
{_global_.role} — роль пользователя, который вошел в систему.
{_global_.role_id} — ID роли пользователя, который вошел в систему.
{_global_.token} — токен пользователя, который вошел в систему.
{_global_.uri} — путь (URL) к текущей странице, запрошенной пользователем;
{_global_.USER} — имя пользователя, который вошел в систему;
{_global_.USER_ID} — идентификатор пользователя, который вошел в систему;
{_global_.z} — имя текущей базы данных db.
POST и GET параметры
Служебный префикс _request_ позволяет обратиться к переданным в запрос параметрам, чтобы использовать их в фильтрах и формулах запроса. Например, выражение _request_.user будет заменено на содержимое параметра user, переданного при вызове запроса.
API
Всё, что вы можете делать в базовом интерфейсе Интеграла, вы можете сделать с помощью API. Можно просматривать и изменять структуру данных, импортировать данные, создавать и запускать запросы, не дожидаясь, когда нужные функции API будут реализованы на платформе.
API поддерживает ту же авторизацию и разграничение прав, что реализованы в базовом интерфейсе Интеграла. Разумеется, правами тоже можно управлять по API.
При вызове API возможны два варианта обращения к сервису. В основном выбор варианта зависит от места вызова: с сервера приложения (как в Creatium или Bubble) или из браузера пользователя. В первом случае используется префикс api/ перед именем базы и необходимо вначале получить авторизационный токен командой API auth, как описано ниже.
Формат вызова API с сервера:
/api/{имя базы}/{cmd}[/{id объекта}][?{параметры}]
По команде auth клиент получает токен, который далее передает в заголовке X-Authorization={токен} для всех запросов c префиксом api/.
Также возможен вариант более простой авторизации, так называемая Basic HTTP Authentication, когда имя и пароль передаются в заголовке каждого запроса:
Authorization: Basic Username:Password
По RFC7617 фрагмент Username:Password должен быть закодирован в BASE64, однако, для простоты допускается отправить его без кодирования, это тоже сработает. Пример использования такой авторизации приведен здесь.
Формат вызова из браузера:
/{имя базы}/{cmd}[/{id объекта}]?JSON[&{параметры}]
Во втором случае, при обращении из браузера, авторизационный токен у вас уже, как правило, есть в cookie браузера, поэтому вы можете не использовать префикс api/, а передать параметр JSON, чтобы получить ответ в формате JSON.
Обязательный параметр cmd может иметь два префикса для команд на изменение данных:
_d_* — изменение структуры данных (DDL, команды Редактора структуры);
_m_* — изменение самих данных (DML, команды базового интерфейса);
Остальные команды возвращают JSON с данными, используемыми системой для построения форм.
Ответом является набор параметров для создания следующего экрана базового интерфейса, как если бы команда была подана формой интерфейса, или сообщение об ошибке.
Все запросы на изменение данных отправляются как POST и требуют токен XSRF (параметр _xsrf). Также обычно требуется указать в заголовках 'Content-Type' равный 'application/x-www-form-urlencoded'.
Примеры обращений к API и их полный список здесь — help.ideav.online/files/api.xlsx
Пример использования API в веб-приложении при обращении с сервера приложения:
vc.ru/dev/352122-nocode-bekend-dlya-bubble-io-poshagovoe-rukovodstvo
Пример использования API на странице браузера с авторизацией по cookie:
https://ideav.pro/ace/editor.html?src=/misa/dir_admin/&download=1&add_path=/js&gf=js.js
Демо-доступ к этой системе: ideav.pro/misa
Обзор: https://www.youtube.com/watch?v=nBD8Kghy8k4
Known issues
Интеграл постоянно развивается, поэтому в нем неизбежно появляются разного рода дефекты. Если вы столкнулись с какой-либо ошибкой или неудобством, посмотрите, может, это есть в списке ниже. Будем
благодарны за сообщение о незарегистрированных проблемах на support@ideav.online.