Документация для разработчиков. Новинки Directum RX 3.3

В версии 3.3 документация разработчика пополнилась описанием новинок: асинхронные обработчики, возможности копирования отчетов, свойств, действий, добавлено описание нового события «Фильтрация выбора из списка при поиске» и т.д. О новинках традиционно написано в разделе «Новые возможности». Далее расскажем, что еще новенького появилось в справке.

Наследование и перекрытие

Основные механизмы разработки – это наследование и перекрытие. Чтобы помочь разобраться в этих процессах и выбрать нужный механизм, в справке появился раздел «Что использовать: наследование или перекрытие».

Дополнительно к этому:

• добавлены рекомендации по разработке перекрытий. В них также перечислены особенности перекрытия задачи на согласование документа по регламенту;

• переработан и дополнен пример о том, как перекрыть тип документа и модуль. Кейс перекрытия: в карточку Договора нужно добавить флажок Резидент. А чтобы посмотреть список всех договоров, заключенных с резидентами, на обложку модуля «Договоры» нужно добавить соответствующее действие. В примере пошагово расписан порядок действий с примерами кода.

Объектная модель

Еще в версии 3.2 справка пополнилась большой главой с описанием модулей и типов сущностей базового решения Directum RX. Постепенно наполняем главу новыми описаниями.

1. 1. В главу «Docflow – документооборот» добавлены разделы:

      • Право подписи

      • Автоматическое назначение прав на документы

      • Персональные настройки

      • Задача на свободное согласование

      • Задача на продление срока

      • Задача на контроль возврата

      • Очередь преобразования документов в PDF

   2. В главу «RecordManagement – делопроизводственные документы» добавлены описания задач и заданий, связанных с процессом рассмотрения документов.

   3. Добавлены новые главы: FinancialArchive – Финансовые документы и Projects – Проекты.

Описана новая порция объектов платформы:

  А еще справку доработали по пожеланиям, которые приходят от разработчиков:

1. 1. В описание диалога CreateInputDialog добавлены примеры кода для его методов:

      • AddFileSelect(). С помощью примеров можно узнать, как сохранить файл в новую версию документа и получить полный путь до файла;

      • AddData(). Пример разработки диалога с запросом параметров отчета;

      • AddPasswordString(). Пример диалога с запросом пароля.

   2. Добавлено описание метода GetAllCached() – получить все сущности из кэша.

   3. Добавлено перечисление DateTimeFormat и описаны вычисляемые папки SpecialFolders.

В скором времени доработаем структуру объектной модели, чтобы удобнее ориентироваться по содержанию и расположению разделов. Опишем блоки схемы (Blocks) и что-нибудь еще. Ждите обновлений справки на Directum Club.

Примеры разработки

В прошлой версии мы писали, что появилась глава «Примеры разработки». Постепенно и ее наполняем новыми примерами. В этот раз добавили такие:

Рекомендации по разработке

Для удобства разработки панели фильтрации в папках и списках:

• доработали рекомендации по настройке панели фильтрации;

• добавили информацию, как с помощью проверки фильтров уменьшить количество обращений к серверу приложений и улучшить быстродействие системы;

• обновили примеры настройки фильтрации записей в папке и в списке.

Кроме того, теперь в справке есть рекомендации, когда нужно применять валидацию свойств и действий: при заполнении данных, при сохранении данных, перед выполнением действия в карточках или диалогах, при открытии карточки сущности. Следуя рекомендациям, можно обеспечить целостность данных в системе, т.к. система не пропустит ни одной ошибки.

Структура данных

  Также к документации часто приходили замечания, что нет описания структуры хранения данных, непонятно, как строятся названия таблиц. А в справке на эту тему был всего лишь маленький раздел.

Мы услышали все пожелания и добавили в руководство разработчика новую главу «Структура хранения данных», с помощью которой вы узнаете:

• как строятся названия таблиц и колонок в базе данных. Также рассматривается пример, как определить, в какой таблице базы данных хранится справочник и в какой колонке находится добавленное свойство.

• как обеспечивается уникальность таблиц и колонок, а также уникальность и ограничения кодов компании, модуля, типа сущности, свойства;

• приведены примеры системных таблиц и их краткое назначение.

Таким образом, разработчик сможет легко обратиться в коде к таблицам по их названиям. Это может понадобиться при разработке отчетов.

Поиск в справке

В результатах поиска теперь отображаются и термины. Можно ознакомиться с определением, не открывая его в перечне терминов.

Также напомню, что при поиске можно использовать символы * и ? в любом месте поискового запроса. Например, попробуйте ввести *employee*. В результаты поиска попадут все разделы справки, у которых в примерах кода встречается искомый фрагмент:

*********

Кроме того, справку по среде разработки теперь обновляем на Directum Club чаще. Об обновлениях будем писать в комментариях к данной статье. Это позволит, не дожидаясь выхода новой версии, ознакомиться с обновленными разделами. Подписывайтесь на обновления статьи, чтобы быть в курсе.

А если хотите ознакомиться с новинками документации Directum RX для пользователей и администраторов, то смотрите в справке новые возможности, подраздел «Документация». Там рассказано про изменения типовых требований и обновленную структуру с новыми разделами для администратора.

Спасибо за внимание!