Документация модуля ЛДМ. Управление документами

Перечень эксплуатационной документации модуля ЛДМ. Управление документами состоит из следующих документов:

  • Описание функциональных возможностей – содержит перечень, состав и описание основных функциональных возможностей модуля ЛДМ. Управление документами, перечисленных ниже:
    • управление документами;
    • управление моделью данных, включая следующее:
      • управление структурой хранимых основных объектов;
      • управление атрибутивным составом хранимых основных объектов, включая работу с атрибутами, наборами атрибутов, а также классами основных объектов;
    • управление связями;
    • управление папками;
    • управление коллекциями;
    • управление избранным;
    • управление архивацией;
    • хранение актуальной информации об основных объектах (сервис «Информация по объектам»);
    • ведение альтернативных представлений основных объектов (документов);
    • работа с комментариями;
    • переразмещение документов;
    • управление перемещениями контента документов;
    • управление редактированием контента документов;
    • проверка уникальности (настройка ключей для классов основных объектов);
    • управление отчетам, включая формирование отчетов, экспорт и импорт готовых шаблонов отчетов;
    • управление формированием печатных форм;
    • управление массовой печатью;
    • хранение моделей и экземпляров статических (неизменяемых) моделей классов документов и бизнес-объектов;
    • управление массовой обработкой персональных данных, включая следующее:
      • обезличивание персональных данных;
      • анонимизация персональных данных;
      • удаление персональных данных;
    • управление индексацией контента документов для возможности полнотекстового поиска по текстовому содержимому прикрепленных к документу файлов;
    • управление федеративным поиском;
    • использование интерфейса SAP ArchiveLink для хранения и управления документами и их контентом;
    • принцип работы сервиса «GraphQL»;
  • Руководство администратора – содержит общую информацию о модуле ЛДМ. Управление документами и работе его администратора, включая следующее:
    • назначение модуля ЛДМ. Управление документами;
    • архитектура модуля ЛДМ. Управление документами (набор микросервисов);
    • управление моделью данных, включая следующее:
      • работа с классами основных объектов;
      • работа с атрибутами;
      • работа с наборами атрибутов;
    • работа с документами, включая следующее:
      • настройка сервиса «Управление документами»;
      • просмотр документов;
      • массовая загрузка документов;
      • массовая печать документов;
      • экспорт документов в виде архива;
      • работа с композитными документами;
      • комментирование простых и композитных документов;
      • создание документов;
      • публикация документов;
      • резервирование документов;
      • создание рабочих копий документов;
      • массовое редактирование документов;
      • добавление документов в коллекции;
      • версионирование документов;
      • работа с альтернативными представлениями документов;
      • управление правами доступа к документам;
      • совместное редактирование контента документов;
      • работа со связями документов;
      • работа с папками документов;
      • работа с ЭП;
      • работа с корзиной документов;
      • работа с историей событий, произошедших с документами (сравнение событий);
      • удаление документов;
    • работа с бизнес-объектами, включая следующее:
      • создание бизнес-объектов;
      • редактирование бизнес-объектов;
      • удаление бизнес-объектов;
      • добавление бизнес-объектов в коллекции и в папки;
      • создание связей бизнес-объектов;
      • управление правами доступа к бизнес-объектам;
      • работа с историей событий, произошедших с бизнес-объектами (сравнение событий);
      • работа с корзиной бизнес-объектов;
    • работа с сервисом «LDM SAP ArchiveLink»;
    • работа с сервисом «Управление документами SAP»;
    • работа с папками, включая следующее:
      • настройка сервиса «Папки»;
      • создание корневых папок;
      • просмотр и редактирование свойств папок;
      • добавление в папки других папок;
      • добавление в папки документов, коллекций и бизнес-объектов;
      • добавление объектов из папок и самих папок в коллекцию;
      • перемещение объектов из папок в другие папки;
      • проверка комплектности папок;
      • управление правами доступа к папкам;
      • работа с историей событий, произошедших с папками (сравнение событий);
      • удаление папок (включая отвязывание документов от папок, удаление документов в текущем дереве папок, удаление документов из папок);
    • работа со связями (включая настройку сервиса «Связи», сравнение событий, произошедших со связями);
    • работа с коллекциями, включая следующее:
      • настройка сервиса «Коллекции»;
      • создание коллекций;
      • изменение атрибутов коллекций;
      • добавление коллекций в другие коллекции;
      • работа с папками коллекций (добавление коллекций в папки, открепление коллекций от папок, перемещение коллекций в другие папки);
      • работа с содержимым коллекций;
      • управление правами доступа к коллекциям;
      • работа с историей событий, произошедших с коллекциями (сравнение событий);
      • удаление коллекций;
    • работа с избранным (включая добавление документов, бизнес-объектов, папок и коллекций в избранное, их просмотр и удаление из избранного);
    • проведение аудита, включая следующее:
      • работа с журналом событий аудита;
      • просмотр событий аудита;
      • работа с подписками на события аудита (создание, активация/деактивация, изменение и удаление подписок на события аудита);
      • архивирование журнала событий аудита (работа с политиками архивирования, работа с запросами на архивирование, работа с архивами журнала событий аудита);
    • управление переразмещением документов, включая следующее:
      • настройка сервиса «Переразмещение документов»;
      • работа с профилями задач на перемещение (создание (включая запуск, отмену выполнения и удаление задач на перемещение), изменение и удаление профиля задач на перемещение);
    • управление перемещением контента документов, включая следующее:
      • работа с доменными событиями перемещения контента документов (создание и удаление доменных событий);
      • работа с политиками перемещения (создание, изменение и удаление политик перемещения);
    • работа с сервисом печатных форм (описание формата разметки в шаблоне печатных форм);
    • управление массовой печатью, включая следующее:
      • настройка сервиса «Массовая печать»;
      • добавление принтеров;
      • изменение принтеров;
      • удаление принтеров;
      • создание заданий на массовую печать;
      • просмотр заданий на массовую печать;
      • изменение заданий на массовую печать;
    • удаление заданий на массовую печать;
    • управление отчетами, включая следующее:
      • настройка сервиса «Отчеты» (настройка backend и frontend сервиса, настройка классов шаблонов отчетов и самих отчетов, правила обработки шаблонов, статические классы отчетов и шаблонов, общие сценарии использования);
      • создание шаблона отчета;
      • создание задачи на формирование отчета;
    • правление проверкой уникальности, включая следующее:
      • настройка сервиса «Проверка уникальности»;
      • создание наборов ключей;
      • изменение состояния наборов ключей;
      • изменение наборов ключей;
      • удаление наборов ключей;
    • управление массовой обработкой персональных данных, включая следующее:
      • настройка сервиса «Массовая обработка персональных данных»;
      • работа с субъектами персональных данных (создание и изменение субъектов персональных данных);
      • работа с задачами на массовую обработку персональных данных (создание, отмена и удаление задач на массовую обработку персональных данных);
    • работа с сервисом «Информация об объектах»;
    • работа с сервисом хранения моделей и экземпляров системных объектов;
    • фильтрация и работа с поиском в рамках модуля ЛДМ. Управление документами, включая следующее:
      • полнотекстовый поиск;
      • атрибутивный поиск;
      • настройка таблиц разделов;
    • работа с сервисом «GraphQL», включая следующее:
      • создание модулей функционала поиска связанных объектов;
      • резервирование модулей функционала поиска связанных объектов;
      • версионирование модулей функционала поиска связанных объектов;
      • экспорт модулей функционала поиска связанных объектов;
      • подключение модулей функционала поиска связанных объектов;
      • пересборка модулей функционала поиска связанных объектов;
      • фиксация версий модулей функционала поиска связанных объектов;
      • GraphQL-запросы;
  • Руководство пользователя – содержит общую информацию о модуле ЛДМ. Управление документами и работе его пользователя, включая следующее:
    • назначение модуля ЛДМ. Управление документами;
    • краткое описание разделов руководства пользователя;
    • авторизация в Платформе;
    • работа с уведомлениями в Платформе;
    • настройка интерфейса Платформы», включая следующее:
      • настройка темы интерфейса;
      • настройка языка интерфейса;
      • просмотр информации о Платформе и ролях пользователя;
      • переключение профилей пользователя;
      • просмотр действий пользователя, произведенных в Платформе;
      • очистка кэша;
      • настройка перечня отображаемых полей в табличном представлении каждого раздела;
      • работа с вкладками;
    • описание ролевой модели;
    • работа с документами, включая следующее:
      • просмотр документов (массовая загрузка документов, массовая печать документов, экспорт документов в виде архива, комментирование документов);
      • создание документов;
      • публикация версий документов;
      • резервирование документов;
      • отмена резервирования документов;
      • создание рабочих копий документов (копирование документов);
      • массовое редактирование документов;
      • работа с композитными документами (создание композитных документов, добавление вложений в композитные документы и их исключение, публикация композитных документов, резервирование композитных документов, создание рабочих копий композитных документов, проверка комплектности композитных документов);
      • добавление документов в коллекции;
      • версионирование документов;
      • работа с альтернативными представлениями документов;
      • управление правами доступа к документам;
      • совместное редактирование контента документов;
      • работа со связями документов (добавление, изменение и удаление связей документов, а также экспорт связанных объектов);
      • работа с папками документов (добавление документов в папки, перемещение документов в другие папки, открепление документов от папок);
      • работа с ЭП (добавление, изменение и удаление ЭП документов);
      • удаление документов;
      • работа с корзиной документов (восстановление документов из корзины, удаление документов из корзины, очистка корзины документов);
      • работа с историей событий, произошедших с документами (сравнение событий);
    • работа с бизнес-объектами, включая следующее:
      • создание бизнес-объектов;
      • редактирование бизнес-объектов;
      • удаление бизнес-объектов;
      • добавление бизнес-объектов в коллекции и в папки;
      • создание связей бизнес-объектов;
      • управление правами доступа к бизнес-объектам;
      • работа с историей событий, произошедших с бизнес-объектами (сравнение событий);
      • работа с корзиной бизнес-объектов;
    • работа с папками, включая следующее:
      • создание корневых папок;
      • просмотр и редактирование свойств папок;
      • добавление в папки других папок;
      • добавление в папки документов, коллекций и бизнес-объектов;
      • добавление объектов из папок и самих папок в коллекцию;
      • перемещение объектов из папок в другие папки;
      • проверка комплектности папок;
      • управление правами доступа к папкам;
      • работа с историей событий, произошедших с папками (сравнение событий);
      • удаление папок (включая отвязывание документов от папок, удаление документов в текущем дереве папок, удаление документов из папок);
    • работа со связями (сравнение событий, произошедших со связями);
    • работа с коллекциями, включая следующее:
      • создание коллекций;
      • изменение атрибутов коллекций;
      • добавление коллекций в другие коллекции;
      • работа с папками коллекций (добавление коллекций в папки, открепление коллекций от папок, перемещение коллекций в другие папки);
      • работа с содержимым коллекций;
      • управление правами доступа к коллекциям;
      • работа с историей событий, произошедших с коллекциями (сравнение событий);
      • удаление коллекций;
    • работа с избранным (добавление документов, бизнес-объектов, папок и коллекций в избранное, их просмотр и удаление из избранного);
    • проведение аудита, включая следующее:
    • работа с журналом событий аудита;
    • просмотр событий аудита;
    • работа с подписками на события аудита (создание, активация/деактивация, изменение и удаление подписок на события аудита);
    • архивирование журнала событий аудита, включая следующее:
      • работа с политиками архивирования;
      • работа с запросами на архивирование;
      • работа с архивами журнала событий аудита;
    • переразмещение документов (работа с профилями задач на перемещение (создание (включая запуск, отмену выполнения и удаление задач на перемещение), изменение и удаление профиля задач на перемещение));
    • перемещение контента документов, включая следующее:
      • работа с доменными событиями перемещения контента документов (создание и удаление доменных событий);
      • работа с политиками перемещения (создание, изменение и удаление политик перемещения);
    • работа с сервисом печатных форм (описание формата разметки в шаблоне печатных форм);
    • массовая печать, включая следующее:
      • добавление принтеров;
      • изменение принтеров;
      • удаление принтеров;
      • создание заданий на массовую печать;
      • просмотр заданий на массовую печать;
      • изменение заданий на массовую печать;
      • удаление заданий на массовую печать;
    • работа с отчетами, включая следующее:
      • создание шаблона отчета (работа с параметрами шаблона отчета);
      • создание задачи на формирование отчета;
    • проверка уникальности, включая следующее:
      • создание наборов ключей;
      • изменение состояния наборов ключей;
      • изменение наборов ключей;
      • удаление наборов ключей;
    • массовая обработка персональных данных, включая следующее:
      • работа с субъектами персональных данных (создание и изменение субъектов персональных данных);
      • работа с задачами на массовую обработку персональных данных (создание, отмена и удаление задач на массовую обработку персональных данных);
    • работа с сервисом «Информация об объектах»;
    • фильтрация и работа с поиском в рамках модуля ЛДМ. Управление документами, включая следующее:
      • полнотекстовый поиск;
      • атрибутивный поиск;
      • настройка таблиц разделов;
  • Руководство по установке и конфигурированию – содержит следующую информацию по установке модуля ЛДМ. Управление документами:
    • назначение модуля ЛДМ. Управление документами;
    • требования к внешнему программному обеспечению;
    • установка модуля ЛДМ. Управление документами в режиме Docker;
    • установка платформы Debezium в режиме Docker;
    • установка модуля ЛДМ. Управление документами в режиме Kubernetes (включая описание работы с PostgreSQL);
    • чеклист готовности установки модуля ЛДМ. Управление документами;
    • порядок обновления модуля ЛДМ. Управление документами в режиме Kubernetes;
    • механизмы проверки целостности микросервисов модуля ЛДМ. Управление документами;
  • Руководство разработчика и описание REST API – содержит информацию об используемых методах REST API в микросервисах модуля ЛДМ. Управление документами.