Новинки документации Directum RX 3.6

В справке Directum RX 3.6 традиционно описаны все новинки версии. Подробнее почитать про них можно в разделах «Новые возможности» для справки Directum RX и Среды разработки. Кроме новинок в данной версии сделали упор на развитие документации для разработчиков и администраторов. О всех новинках далее расскажу подробнее.

Для разработчика

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

В ходе мониторингов и опросов клиентов часто звучит пожелание – добавить больше примеров кода. В новой версии мы проанализировали опыт прикладных разработчиков: собрали популярные примеры модификации системы с проектов разработки, рассмотрели вопросы по разработке на Directum Club. По результатам разработали и протестировали новую порцию примеров кода в формате How To (как сделать).

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

Новые примеры находятся в главе «Примеры разработки» и отмечены значком . Например, добавлены следующие примеры в группу по созданию и модификации типов документов:

Если вы только приступаете к разработке, то примеры помогут погрузиться и разобраться с доработками системы на основе имеющегося опыта. Не нужно долго придумывать что-то свое, так как можно делать по аналогии. А если вы уже опытный разработчик, то примеры помогут разобраться с крупными доработками в системе. Например, когда нужно внести модификации в задачу на согласование по регламенту, изменять права автора на документ во время согласования и др.

Структура справки разработчика

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

Описание разработки типов сущностей

Вся информация по особенностям разработки типов задач и заданий, документов и справочников теперь под рукой. Для этого в главе «Элементы разработки» появились разделы с соответствующими названиями:

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

В каждом разделе на стартовой странице дается разводная информация:

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

Упрощение поиска описания событий

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

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

Уход от дублирования и большой вложенности разделов

Схожая информация по копированию свойств и действий объединена в один раздел. Также описание порядка настройки и рекомендации по разработке панели фильтрации в списках и папках теперь находится в одной главе:

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

Рекомендации по перекрытиям в одном месте

Глава с рекомендациями по перекрытиям пополнилась разделами:

Раньше рекомендации были раскиданы по разным частям справки, теперь все особенности перекрытия задачи на согласование, формы типа сущности, обложки модуля можно прочитать в одном месте.

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

Не забываем и про развитие описаний объектной модели.

По новинкам версии описаны:

• метод GetStartedSchemeVersion() – получить версию схемы;
• объектная модель для работы с почтовым сервером;
• класс Sungero.Core.UserDigest и событие GetDigest для создания и вызова всплывающих подсказок с информацией о сотрудниках.

По пожеланиям разработчиков дополнено описание:

• свойства Body и PublicBody для версии документа;
• интерфейсы для методов Add* для CreateInputDialog();
• все методы Can<Имя операции>() у свойства AccessRights;
• свойство Info.Actions – метаданные действия сущности;
• методы GetFilter(), TryGetFilter() – получить значение фильтра по свойству.

В раздел «Правила оформления» добавлены рекомендации, как в среде разработки быстро написать комментарий к коду по XML-формату.

Для администратора

Видеоролики по настройке системы

Правильная настройка – залог успешной и эффективной эксплуатации системы. Чтобы упростить настройку системы, добавлены новые ролики для администраторов в веб-клиенте Directum RX. В них на примерах рассказано, как настроить:

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

 правила согласования для исходящих документов. В ролике рассказаны особенности разных этапов согласования, показаны простые схемы, раскрыты лайфхаки настройки.

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

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

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

Описание сервисов

Для детального изучения архитектуры системы в справку добавлено подробное описание сервисов Directum RX: назначение сервисов, схема работы, пояснения по установке и настройке:

В описании сервисов также можно найти полезные кейсы по настройке. Например, как сменить учетную запись для сервиса выполнения блоков задач (WorkflowBlockService) или как настроить предпросмотр больших документов.

Кроме того, в справке для администратора теперь есть инструкция по установке сервисов Directum Ario.

***

На этом все. Если у вас есть вопросы или пожелания к документации, пишите нам.