Новинки документации DirectumRX 3.2

Итак, в справке описаны все-все новинки версии 3.2. Подробнее почитать про них можно в разделах «Новые возможности» для справки DirectumRX и Среды разработки. Кстати, обновленная справка со всеми новинками опубликована на DIRECTUM Club.

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

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

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

В главу «Программный код» добавлены рекомендации по написанию прикладного кода. Пользуйтесь, на здоровье :) А также по пожеланиям доработан раздел про атрибуты и модификаторы.

В разделе «Процесс разработки» появилась интерактивная схема с описанием этапов разработки. При нажатии на блок открывается раздел справки с описанием этапа:

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

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

Часть 1. Добавлено описание прикладных модулей DirectumRX. В новой главе «Модули DirectumRX» вы найдете схемы модулей прикладного уровня, описание типов сущностей и их свойств, дополнительную информацию, которая поможет изучить возможности модулей для дальнейшей модификации.

Часть 2. Появились интерактивные схемы предметных модулей Wokflow и Content. Схемы показывают, из каких сущностей состоит модуль и как они связаны между собой. На схеме можно посмотреть список видимых и скрытых свойств сущности и в один клик перейти к описанию сущности. Попробуйте сами посмотреть в справке, при нажатии на блок откроется описание.

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

• Простая задача – SimpleTask;
• Папки – Folders;
• Права доступа – AccessRights;
• Фоновые процессы – Jobs;
• Роли – Roles;
• История работы – History;

Добавлены и новинки версии: Подсветка контролов – HighlightColor; Подсветка областей в контроле предпросмотра – HighlightAreas; Cостояние вкладок на форме сущности – Pages. Подробнее смотрите в главе «Объектная модель».

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

Если помните, ранее в справке была глава «Пример разработки» с одним бооооольшим примером по перекрытию типа договора на слое. Создавалось впечатление: что у нас в справке всего один пример что ли O_O?

«Хватит терпеть такую несправедливость», – подумали мы и сделали главу с примерами разработки. Ведь справка зачастую написана от кейсов использования, и примеры разработки используются в описаниях. В общем-то примеры теперь можно найти в одном месте. Они сгруппированы по темам в главе «Примеры разработки». В дальнейшем глава будет пополняться. Например, в этой версии добавили примеры скриптов конвертации. Вот такая красивая обложка с примерами получилась:

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

В версии 3.2 появились новые сервисы, а также изменились существующие.

 

Чтобы вы легко смогли разобраться с изменениями, сделано следующее:

• полностью переработана глава с описанием архитектуры системы: доработана общая схема со всеми компонентами и сервисами, подробно описаны все компоненты, добавлено описание преимуществ архитектуры DirectumRX;
• описание архитектуры добавлено в справку по DirectumRX, чтобы и администраторы могли изучить систему. Ранее описание было только в справке по среде разработки;
• в документе «Изменения DirectumRX 3.2» подробно расписано, какие сервисы изменились, а какие новые. Смотрите раздел «Микросервисная архитектура». Документ доступен на сайте поддержки.

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

Для выпуска локальной версии в справку добавлен обновленный раздел с описаниями установки и обновления системы. Подробнее см. в главе «Локальная установка системы».

Для пользователя

Видеоролики

Снято три новых обучающих видеоролика по работе в веб-клиенте:

• Исходящие документы – как создать исходящее письмо, отправить на согласование, распечатать и передать на подпись, зарегистрировать подписанный документ и отправить контрагенту;
• Обработка и рассмотрение входящего письма – как обработать входящее письмо, отправить на рассмотрение руководителю, действия руководителя при рассмотрении, как создать поручения по вынесенной резолюции;
• Исполнение поручений по документу – порядок выполнения работ по поручению, как создать подчиненное поручение, как запросить продление срока поручения, порядок приемки работ по поручению.

Картинка из ролика по исполнению поручений

 

Кроме того, при съемке использовали новые подходы, которые помогут лучше погрузиться в ролик и изучить систему:

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

• при объяснении вариантов выполнения заданий появляются «стикеры» с краткими пояснениями, что произойдет при нажатии на кнопку:

Все ролики также доступны для просмотра на YouTube. Заходите ставить лайки и комментировать :)

Перечень терминов

В справке по DirectumRX, как и по среде разработки, появился «Перечень терминов». Он содержит определения основных понятий, которые используются в системе. Возможности в перечне:

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

 

В руководствах в формате PDF также появились разделы «Основные понятия». Там будут не все термины, а только те, которые полезны в данной предметной области, например, для делопроизводителя.

Развитие поиска по справке

Теперь результаты поиска можно фильтровать по главам справки. Например, можно оставить на странице только результаты, найденные в главе «Делопроизводство», «Локальная установка» или «Настройка системы». Или в справке по среде разработки отфильтровать результаты по главе «Объектная модель».

 

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

Еще в справку добавлена кнопка, с помощью которой можно в один клик раскрыть или свернуть области на странице:

Новые инструкции

• все исправленные замечания к системе теперь фиксируются в документе «Изменения DirectumRX 3.2. Исправленные замечания», он находится на сайте поддержки;
• подготовлены новые инструкции по разворачиванию отказоустойчивой архитектуры: «Настройка фермы серверов и NLB-кластера» и «Настройка отказоустойчивой архитектуры для PostgreSQL»;
• написана новая «Инструкция по установке терминальной службы веб-агента DirectumRX»;
• для разработчиков 1С написана «Инструкция по созданию кнопки для открытия записей DirectumRX из 1С». Инструкция предоставляется по запросу в службу поддержки DirectumRX;
• в комплект документации в формате PDF входят руководства «Электронный документооборот с контрагентами», «Интеграция с 1С», а также руководства по среде разработки: «Руководство разработчика», «Объектная модель» и «Модули базового решения».

На этом все, спасибо за внимание! Используйте новинки в своей работе. Ждем ваших пожеланий и вопросов :)