Directum RX 3.4. Новинки документации прикладного разработчика

В версии 3.4 справка для прикладного разработчика значительно пополнилась новыми описаниями объектов, добавлены кейсы разработки в формате HowTo. Обо всем подробнее расскажем в статье.

Обновлена структура объектной модели

C тех пор, как появилась глава «Объектная модель», количество описанных классов и методов существенно увеличилось. От разработчиков стали поступать пожелания, что сложно ориентироваться, структура справки слишком уж разрослась. Поэтому было решено, что пора ее менять.

Теперь все разделы в объектной модели скомпонованы по модулям и решаемым задачам:

Действия с репозиториями и сущностями. Здесь найдете информацию о том, как создать, удалить, изменить сущность, как получить информацию о состоянии сущности, выдать права доступа – базовые действия при работе с сущностью.

Основные механизмы. А здесь находятся описания классов, методов и свойств из Sungero.Core и не только. Это большая глава с описанием объектов платформы, она содержит материалы по разработке диалогов, работе с подписями, датой и временем, гиперссылками, блокировками и т.д.

Content – управление документами. Напомню, Content – это предметный модуль на уровне платформы. В главе содержится опиcание базового типа документа ElectronicDocument, а также все, что с ним связано. Вам сюда, если нужно узнать, как работать с версиями, настраивать связи, шаблоны документов.

Workflow – управление бизнес-процессами. Тоже предметный модуль на уровне платформы. Содержит описание базовых типов задач, заданий, уведомлений. Также здесь найдете информацию по работе с вложениями, блоками схемы.

CoreEntities – администрирование. Содержит все сущности, которые используются для настройки системы Directum RX. Здесь информация про роли, пользователей, календари рабочего времени, цифровые сертификаты.

Базовое решение Directum RX. А здесь все про прикладной слой. В главе описаны особенности модулей и сущностей из базового решения, которое предоставляет вендор. Например, здесь найдете все про самый большой прикладной модуль Docflow, информацию про задачу на согласование по регламенту, схемы модулей и типов сущностей и многое-многое другое.

Кроме того, изменен формат заголовков разделов: название начинается с названия класса, метода или свойства, которое используется в среде разработки. Это поможет лучше ориентироваться в структуре справки и быстрее найти нужный раздел. На обложке главы «Объектная модель» все скомпоновано по главам, заходите посмотреть.

Еще одна порция описаний объектной модели

Продолжаем активно пополнять справку описаниями объектов, их методов и свойств. Новые разделы появились в следующих главах:

«Действия с репозиториями и сущностями»:

• AccessRights – работа с действиями, которые необходимо выполнить с повышенными правами;
• AccessRightsTypes – типы прав;
• e.AddError, e.AddInformation(), e.AddWarning() – методы валидации.

«Основные механизмы»:

• Cache – работа с кэшем;
• CaseConverter – склонение по падежам и определение рода;
• Colors – цвета;
• Encryption – шифрование;
• ExternalSignatures – внешние подписи;
• InitializationLogger – работа с логом при инициализации модуля;
• ISignatureCertificate – сертификат подписания;
• ISignatureInfo – информация о подписи;
• Licenses – лицензии;
• PersonFullName – персональные данные:
• StateView, StateBlock, StateBlockContent – контрол состояния;
• TenantInfo – информация о текущем сервере приложений;
• Zip –Zip-архив;
• В раздел Dialogs добавлено описание метода CreateSelectTypeDialog() – диалог с выбором типа сущности.

«Content – управление документами»:

• AssociatedApplications – приложения обработчики;
• ElectronicDocumentTemplates – шаблоны документов.

«Workflow – управление бизнес-процессами»:

• Attachments – работа с вложениями;
• Blocks – блоки схемы.

«CoreEntities – администрирование»:

• Logins – учетные записи;
• В раздел Certificates добавлено описание метода ShowSelectSertificate() – показать окно выбора сертификата.

Еще в главе «CoreEntities – администрирование» для классов добавлена информация о том, от кого они наследуются. Например, для Roles указано, что он наследник от Sungero.CoreEntities.Group, а для Group – Sungero.CoreEntities.Recipients.

Базовое решение Directum RX

Полным ходом развиваем описание объектной модели базового решения Directum RX. В этот раз добавлены:

1. Описания модулей Meetings (совещания), Contracts (договоры) и SmartProcessing (интеллектуальная обработка).
2. В модуль Docflow добавлены описания: шаблон документа, политики хранения, персональные настройки пользователей, настройки интеллектуальной обработки.
3. В модуль RecordManagement добавлены главы «Поручение, продление срока, запрос отчета поручения», «Ознакомление с документом».
4. В модуль Commons добавлена глава EntityRecognitionInfo – результаты распознавания сущности.
5. В модуль Company добавлена глава «Ограничение видимости оргструктуры».
6. Обновлены схемы модулей Docflow, Shell и общая диаграмма всех модулей.
7. При изучении прикладного модуля теперь можно сразу посмотреть примеры перекрытия и доработки модулей и типов сущностей. Например, посмотрите список см. также в модуле Contracts.

Кейсы HowTo

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

Итак, в новой версии разработаны следующие кейсы:

1. По новинкам версии:

   • как отфильтровать список шаблонов, доступных при создании документа;

   • как добавить дополнительный классификатор для интеллектуальной обработки документов;

   • как изменить стиль подсветки выделенного факта в области предпросмотра;

   • как ограничить видимость сотрудников в списках, в котором используется новое событие «UI-фильтрация»;

   • как добавить результат выполнения в задание на согласование.

2. Примеры разработки, связанные с доступностью, обязательностью и видимостью свойств. Из них вы узнаете:

   • как сделать свойство обязательным в зависимости от значения другого свойства;

   • как сделать свойство доступным в зависимости от прав доступа пользователя;

   • как управлять видимостью нового свойства, если оно зависит от существующего свойства;

   • как скрыть свойство из области регистрации в карточке документа.

3. Дополнительно разработаны новые примеры:

   • как изменить отметку об ЭП;

   • как добавить сводку по новому типу документа;

   • как настроить список для двух типов документов с одинаковыми свойствами;

   • передача данных между разными событиями;

   • как добавить действие в историю работы с сущностью;

   • как в задании скрыть результат выполнения.

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

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

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

Поиск объектов в справке

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

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

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

******

Ждем ваши пожелания и кейсы разработки, описание которых хотелось бы увидеть в справке. Спасибо!