Функционал модуля заключается в автоматическом формировании xlsx-файла с комментариями к документу согласно шаблону, обновлении комментариев к документу согласно шаблону, а также выгрузке файла формата '.pdf' с комментариями, наложенными поверх исходного файла, комментирование которого было совершено в Pilot.
¶ Описание файла шаблона и макросов
Для работы с листом комментариев (CRS) необходимо создать в Pilot элемент шаблон с прикреплённым в нём xlsx-файлом шаблона создания CRS. Пример такого файла можно взять в архиве с дистрибутивом модуля (файл "Generate CRS Template.xlsx")
Файл шаблона создания листа с комментариями (CRS) содержит макросы, описывающие сам CRS-документ и документ с замечаниями к нему. Файл шаблона визуально делится на две части:
- верхняя часть - это "шапка" шаблона, описывающая сам лист замечаний (CRS)
- нижняя часть - таблица, названия колонок которой это названия атрибутов документа и замечания.
Шаблон должен отвечать следующим требованиям:
- макросы в шаблоне оформляются в соответствии с правилами формирования макросов, описанными в главе Макросы настоящего руководства пользователя;
- макросы для заполнения шапки шаблона CRS могут быть расположены c 1 строчки и до строчки с макросами, которые используются для описания документов и замечаний к ним;
- макросы, отвечающие за табличную часть, могут быть только для атрибутов типа документ, атрибутов типа замечание и пользовательские
- колонки таблицы, расположенные после колонок с наименованием атрибутов, должны быть пустыми;
- перед началом импорта данных файл шаблона должен быть закрыт.
Рис. 18. Файл шаблона CRS
Шаблон используется не только для формирования CRS, но и для его обновления. По записанным в нём макросам программа заносит данные о замечаниях и о самом документе CRS в xlsx-файл при его формировании и, в то же время, при чтении ответа на CRS, распознаёт куда занести значения ответов на комментарии и документа CRS при обновлении. Для ACRS (обновление комментариев) обязательно должен присутствовать макрос для типа doc_issue c зарезервированным атрибутом id ($doc_issue.id!), данный макрос должен быть обозначен как первичный ключ. Именно по нему программа распознает к кому замечанию относится ответ.
¶ Создание шаблона CRS в Pilot
- В Pilot в дереве проекта открыть папку «Шаблоны» и нажать на кнопку на панели инструментов Создать Шаблон Excel
- В открывшемся окне создания ввести название в поле Наименование.
- В правой нижней части обозревателя перейти на вкладку «Файлы», нажать кнопку «Добавить исходный файл» и выбрать файл шаблона CRS.
- В поле «Номер строки начала таблицы» нужно ввести номер строки xlsx-шаблона, на которой введены макросы для атрибутов документов и замечаний.
Для разных типов документа могут быть созданы разные шаблоны. По умолчанию модулем используется шаблон с наименованием «Generate CRS Template», в том числе в случае когда стандартная конфигурация не была добавлена в общих настройках.
Рис. 19. Окно создания шаблона CRS
¶ Алгоритм формирования листа с комментариями (CRS)
- Перейти к комплекту: в Pilot в дереве проекта выбрать необходимый проект и комплект. На панели инструментов нажать кнопку «Создать», из предложенных вариантов выбрать «CRS».
- Опционально выбрать шаблон CRS. Если оставить поле выбора незаполненным, то будет использован тот шаблон, название которого прописано в конфигурации общих настроек модуля.
- Заполнить необходимые поля, нажать кнопку «Создать».
- После создания объекта CRS нужно связать этот CRS во вкладке «Связи» нажатием кнопки «Добавить» с документами, замечания к которым, будет содержать в себе сформированный CRS.
Рис. 20. Окно создания документа CRS
- Выбрать созданный на предыдущем Шаге документ CRS. В панели инструментов перейти к опции «Сформировать CRS». Откроется окно выбора состояния замечаний, которые будут включены в лист CRS. Например:
- <Нет> - замечания без состояния;
- Принято;
- Отклонено;
- Удалено;
Список доступных состояний определяется администратором системы для объектов типа «Замечание».
В правом нижнем углу обозревателя проекта во вкладке «Файлы» появится сформированный лист с комментариями к документам комплекта.
Рис. 21. Кнопка формирования листа CRS
Рис. 22 Сформированный лист замечаний CRS в файле .xlsx
¶ Обновление комментариев (ACRS)
- Сформированный лист замечаний CRS направляется на дополнение комментариями/замечаниями ответственным сотрудникам/организациям. После заполнения CRS ответными замечаниями/комментариями, лист подгружается в соответствующий документ CRS во вкладку «Файлы».
Удалять предыдущие версии файла CRS необязательно, так как для обновления ответов на комментарии (замечания) программой всегда берётся последняя версия файла.
- Затем в панели инструментов к документу CRS выбрать опцию «Обновить комментарии». После обновления ответы на комментарии появятся в правой верхней части обозревателя документа проекта. Чтобы увидеть ответ, нужно нажать на комментарий (замечание).
Рис. 23 Ответ на замечание
После обработки (или неполной обработки) в xlsx файле построчно будут проставлены статусы загрузки данных в самой правой колонке таблицы.
В целях корректного заполнения данных в системе для замечаний в качестве первичного ключа обязательно выступает их идентификатор (марос: $doc_issue.id!)
¶ Перенос комментариев в другую базу данных посредством CRS
CRS можно использовать для переноса комментариев на такие же документы в других базах данных. Для этого необходимо чтобы документы имели те же значения атрибутов и такие же опубликованные файлы. Далее во вкладку «Файлы» CRS в другой базе добавляется xlsx-лист замечаний, созданный в другой базе. Следующим шагом нужно обновить комментарии CRS.
Важно переносить комментарии на такой же опубликованный файл во избежание ошибок работы системы. Комментарии создаются под именем того, кто импортировал CRS.
Рис. 24 Кнопка обновления комментариев для документа CRS
¶ Выгрузка документа в формате PDF с комментариями
Данный модуль позволяет выгружать документ формата .xps вместе с оставленными к нему комментариями в виде заметок и замечаний из системы Pilot в файл формата .pdf. При этом комментарии будут отображаться в .pdf файле в тех же местах, где были оставлены пользователем на документе формата .xps в системе Pilot
Программа не конвертирует xps обратно в pdf, а забирает комментарии из документа xps и переносит в файл pdf отдельным слоем, располагая их на тех же местах, что были в xps.
Для корректного отображения кириллических символов в PDF файле с комментариями рекомендуется использовать Adobe Acrobat Reader
Для успешной выгрузки документа с комментариями в файл формата .pdf требуется выполнить следующие действия:
- Необходимо, чтобы был установлен модуль расширения «PDF2XPS» (если этого не выполнено, обратитесь к администратору Системы). Проследите, чтобы в данном модуле расширения было настроено автоматическое конвертирование из формата .pdf в формат .xps.
- Переходим в дереве проекта к необходимому комплекту. На панели инструментов нажимаем на кнопку "Создать", выбираем опцию "Документ". Заполняем атрибуты и нажимаем "Выбрать файл", выбираем файл в формате .pdf, нажимаем "Создать".
- Выбранный файл .pdf копируем в Pilot Storage: на панели инструментов нажимаем кнопку «Показать исходный файл», в открывшуюся некорневую папку копируем выбранный ранее файл формата .pdf.
- Выбираем созданный документ, нажимаем на панели инструментов кнопку "Связать с...", выбираем опцию "Исходным файлом на диске...", находим и выбираем скопированный .pdf файл.
- Оставить комментарии к созданному документу (для этого использовать в обозревателе проектов расположенные сверху справа кнопки "Заметка" и "Замечание к документу").
- Выбираем созданный документ, нажимаем на панели инструментов кнопку «Выгрузить PDF с комментариями» (если этой кнопки нет, проверьте, связан ли документ с исходным файлом на диске и, если да, то представлен ли исходный файл в формате ".pdf").
- Откроется окно прогресса выгрузки. После завершения выгрузки откроется папка с выгруженным документом, внутри которого будут отображены комментарии, импортированные из документа системы Pilot (документ будет выделен и иметь префикс "CRS-").
¶ Различия Web-редакции
¶ Формирование CRS
В веб редакции кнопка «Сформировать CRS» открывает аналогичное окно с параметрами, как и в Desktop-редакции. После нажатия кнопки "Создать задание" в появившимся окне, будет создано фоновое задание, а не открыто окно прогресса.
Фоновое задание создается в папке типа Фоновые задания, если данной папки нет - будет выведена соответствующая ошибка, если папок несколько - задание будет создано в первой папке. После создания фонового задания во вкладке “Связи” созданного фонового задания будет находиться соответствующий CRS. После того как фоновое задание будет успешно выполнено на соответствующем CRS во вкладке “Файлы” появится xlsx файл (если данные файлы уже были до запуска фонового задания, то они будут перезаписаны). Как управлять фоновым заданием смотрите в главе Фоновые задания данного руководства пользователя.
¶ Обновление комментариев
Кнопка «Обновить комментарии» создает фоновое задание, а не открывает окно прогресса как это реализовано в desktop-редакции.
Фоновое задание создается в папке типа Фоновые задания, если данной папки нет - будет выведена соответствующая ошибка, если папок несколько - задание будет создано в первой папке. После создания фонового задания во вкладке “Связи” созданного фонового задания будет находиться соответствующий CRS. Как управлять фоновым заданием смотрите в главе Фоновые задания данного руководства пользователя.