Средство диагностики предназначено для создания пакета отчетов, содержащего все относящиеся к проекту данные (с возможностью вложения файлов), информацию о проекте и параметрах установки, а также для отправки такой отчетности по электронной почте с помощью интегрированного SMTP-клиента. Создание пакета отчетов выполняется в несколько щелчков мыши.
Создание пакета отчетов рекомендуется в следующих случаях:
- Для сравнения данных нескольких проектов (например, конфигурационных файлов) с данными других проектов, например для быстрого выявления различий.
- Если после анализа данных проекта решить проблему самостоятельного не удается и необходимо связаться со службой поддержки Сибком (support@sdigital.ru). При отправке пакета отчетов нашей службе поддержки процесс решения проблемы может быть упрощен, а время ответа сокращено, поскольку все данные, необходимые для анализа, содержатся в пакете отчетов или могут быть легко в него добавлены.
- При необходимости отправить информацию о проекте и версии установленной программы третьим лицам по электронной почте с помощью SMTP-клиента, интегрированного в средство диагностики.
- При необходимости проводить контроль версий проекта или других файлов через любой установленный промежуток времени.
В этом разделе описываются следующие темы и функции средства диагностики:
- Содержание пакета отчетов
- Использование средства диагностики
- Запуск средства диагностики
- Создание отчета
- Отправка отчета по электронной почте
- Прикрепление файлов
- Информация о параметрах установки
- Подробная информация о средстве диагностики
- Указание и изменение реквизитов и настроек для отправки по электронной почте
- Файлы, создаваемые при создании отчета
Содержание пакета отчетов
Пакет отчетов представляет собой архив в формате ZIP, который по умолчанию включает в себя следующие данные:
- конфигурационные файлы («config», «config.level», «config.library», «config.redu») программы «КАСКАД Цифра», проекта и подпроектов
- файлы «progs» программы «КАСКАД Цифра», проекта и подпроектов
- файл «shield» программы «КАСКАД Цифра»
- переопределенные файлы (сценарии, библиотеки, панели и т. д.) программы «КАСКАД Цифра», проекта и подпроектов
- аппаратный код (файл «hw.txt»)
- файл отчета («report.txt») со следующей информацией (эта информация также частично выводится на панели средства диагностики до и после создания отчета, подробнее см. раздел «Информация о параметрах установки»):
- # PVR version – версия средства диагностики
- # Date – дата и время создания отчета (например, 04.11.2010 14:56:05)
- # Description – заголовок, который вводится пользователем в средстве диагностики
- # Operating System – операционная система, установленная на компьютере, на котором создается отчет (например, Microsoft Windows XP Professional)
- # Operating System Version – версия операционной системы (например, 5.1.2600)
- # Operating System Service Pack Level – информация об установленном пакете обновлений операционной системы (например, Пакет обновлений 3)
- # «КАСКАД Цифра» Version – установленная версия «КАСКАД Цифра»
- # «КАСКАД Цифра» Installation Path – путь к каталогу установки «КАСКАД Цифра»
- # Available «КАСКАД Цифра» Disk (MBytes) – доступный объем свободного места на жестком диске для работы «КАСКАД Цифра» в мегабайтах
- # Patch files – информация об установленных пакетах исправлений
- # Project Disk – путь к каталогу проекта «КАСКАД Цифра»
- # Available Project Disk (MBytes) – доступный объем свободного места на жестком диске для проекта «КАСКАД Цифра» в мегабайтах
- # Additional files – пути к прилагаемым файлам
- # Comments – описание, которое вводится пользователем в средстве диагностики
- # Subprojects Path – пути к каталогам подпроектов, подключенных к проекту
- # Over-configured Files – пути к переопределенным файлам
- # Listing of the bin dir of the «КАСКАД Цифра» Version – список файлов, которые хранятся в каталоге «/bin» в директории установки «КАСКАД Цифра» с указанием их размера в килобайтах, даты и времени изменения
Дополнительно к файлам, которые включаются в пакет отчетов по умолчанию, возможно прикрепление дополнительных файлов. Рекомендуется прикреплять, например, файлы журналов или снимки экрана с ошибками. Более подробная информация представлена в разделе «Прикрепление файлов».
Использование средства диагностики
Во время использования средства диагностики для создания пакета отчетов проект не обязательно должен быть запущен. То есть поддерживается использование средства диагностики независимо от Pmon.
Средство диагностики можно запускать или из
или
- с помощью менеджера интерфейса пользователя с параметром «-p projAdmin/pvr/pvr.pnl» в консоли проекта «КАСКАД Цифра», по которому требуется создать пакет отчетов.
Ниже описывается первый вариант запуска:
- Откройте панель администрирования проектов и щелкните правой кнопкой мыши по имени проекта, по которому требуется создать пакет отчетов.
- Выберите пункт «Средство диагностики».
- После этого откроется следующее диалоговое окно. Подождите, пока собираются данные по проекту (см.текст INFO: на рисунке ниже).
- После сбора необходимых данных над текстом INFO: необходимо ввести тему отчета. Дополнительно в текстовом поле «Описание» можно ввести описание отчета. В описании можно, например, указать сообщение об ошибке или иную информацию, которая может быть важной для получателя пакета отчетов.
- Кроме этого, поддерживается изменение имени файла и пути сохранения пакета отчетов. Для этого предусмотрено текстовое поле «ZIP-файл».
ПРИМЕЧАНИЕ
Если упаковщик ZIP не установлен в системе Linux, сначала установите его с помощью команды «zypper install zip».
- Нажмите на кнопку «Создать отчет».
- После этого пакет отчетов будет сохранен в указанном каталоге. Кроме этого, его можно будет отправить по электронной почте.
Отправка отчета по электронной почте
При установке «КАСКАД Цифра» автоматически устанавливается Бесплатный консольный SMTP-клиент (<путь_КАСКАД>/bin/sendEmail.exe). С его помощью можно отправлять пакеты отчетов в службу поддержки Сибком и другим получателям. Для этого необходимо подключение к Интернет и к SMTP-серверу.
ПРОЦЕСС ОТПРАВКИ ПАКЕТА ОТЧЕТОВ ПО ЭЛЕКТРОННОЙ ПОЧТЕ:
- Нажмите на кнопку
. Откроется следующее окно:
- Введите ваш адрес в поле «От» и, при необходимости, измените адрес получателя в поле «Кому» в области «Электронная почта» на экране отправки сообщения (по умолчанию в качестве получателя используется адрес электронной почты службы поддержки Сибком, но его можно изменить – см. раздел «Указание и изменение реквизитов и настроек для отправки по электронной почте»).
- В области «Конфигурация SMTP» заполните поля «Сервер», «Пользователь» и «Пароль».
ПРИМЕЧАНИЕ
Все поля являются обязательными для заполнения. Возле незаполненного поля появляется значок
.
- При сбое во время отправки пакета отчетов по причине неверно введенных данных в окне средства диагностики выводится сообщение: «ОШИБКА: Отчет не может быть отправлен. Проверьте файл журнала». Файл журнала «tmpOut.txt» находится в каталоге «/bin» в директории установки «КАСКАД Цифра», либо, если средство диагностики запускалось через менеджер интерфейса пользователя, выводится сообщение в средстве просмотра журналов «КАСКАД Цифра».
- Если отправка по электронной почте прошла успешно, выводится сообщение: «INFO: Отчет о проблеме успешно отправлен».
ПРИМЕЧАНИЕ
По умолчанию пакет отчетов отправляется в виде текстового файла. Это означает, что получателю необходимо сохранить текстовый файл и изменить его расширение на «.zip». Только после этого можно будет распаковать пакет отчетов и просмотреть содержание. Изменить тип файла, используемый для отправки пакета отчетов, можно с помощью файла «pvr.xml» (каталог «<путь_КАСКАД>/config») – см. раздел «Указание и изменение реквизитов и настроек для отправки по электронной почте». Пакет отчетов не отправляется автоматически с расширением «.zip», поскольку такие файлы часто блокируются антивирусными программами.
Прикрепление файлов
Дополнительно к файлам, которые по умолчанию включаются в пакет отчетов (см. раздел «Содержание пакета отчетов»), возможно прикрепление других файлов. Например, к пакету отчетов рекомендуется прилагать файлы журналов, снимки экранов с сообщением об ошибке или иными сбоями в работе «КАСКАД Цифра».
ПРОЦЕСС ВЛОЖЕНИЯ ФАЙЛОВ:
- Запустите средство диагностики (см. раздел «Отправка отчета по электронной почте»).
- Введите тему и описание отчета.
- Нажмите на
кнопку . После этого откроется окно добавления файлов.
Нажмите на кнопку и выберите файл, который необходимо вложить в отчет. Поддерживается вложение файлов любого типа.- Нажмите на кнопку
, чтобы добавить выбранный файл в качестве вложения..
- Чтобы вложить дополнительные файлы, повторите шаги 4 и 5.
- С помощью кнопки
файл добавляется в список вложений перед выделенным файлом. - С помощью кнопки
выделенный в списке вложений файл заменяется файлом, добавляемым с помощью функции добавления файлов. - Кнопка
используется для удаления выбранного файла из списка вложений. Кнопка 
используется для удаления всех вложений. - Нажмите «OK» для завершения вложения файлов и закрытия окна.
- Нажмите «Закрыть» для закрытия окна без вложения выбранных файлов.
- После прикрепления файлов цвет кнопки добавления файлов
в средстве диагностики изменяется на зеленый. - Для создания отчета нажмите на кнопку «Создать отчет».
ПРИМЕЧАНИЕ
Кнопка 
используется для вложения файлов журналов.
Информация о параметрах установки
Нажмите на кнопку 
в окне средства диагностики для просмотра информации о параметрах установки. Представленная здесь информация позже будет записана в файл отчета «report.txt» (см. раздел «Содержание пакета отчетов»).
Область с информацией о параметрах установки разделена на три секции:
- Информация об операционной системе (тип операционной системы, версия, пакет обновлений).
- Информация об установленной версии «КАСКАД Цифра» (версия, путь к каталогу установки, объем доступного места на жестком диске, где установлена «КАСКАД Цифра»). При нажатии на кнопку
справа от надписи «Исправл.» откроется список установленных пакетов исправлений. При нажатии на такую же кнопку справа от надписи «Зарегистр.проекты» откроется окно со списком зарегистрированных проектов и расширений. По умолчанию список пакетов исправлений включается в пакет отчетов (файл «report.txt»).
ПРИМЕЧАНИЕ
Список зарегистрированных проектов и расширений не включается в пакет отчетов, однако его можно прикрепить к отчету в виде вложенного файла («<путь_КАСКАД>/bin/PVSSProjects.txt») – см. раздел «Прикрепление файлов».
Рисунок: Пример всплывающего окна со списком зарегистрированных проектов
- Информация о проекте «КАСКАД Цифра» (имя проекта, путь к каталогу проекта, объем свободного места на жестком диске проекта в мегабайтах). При нажатии на кнопку справа от надписи «Подпроекты» открывается окно со списком подпроектов. При нажатии на такую же кнопку справа от надписи «Переопределенн.файлы» откроется список переопределенных файлов проекта. По умолчанию список подпроектов и перечень переопределенных файлов включаются в пакет отчетов (файл «report.txt»).
Рисунок: Пример всплывающего окна со списком подпроектов
Подробная информация о средстве диагностики
Указание и изменение реквизитов и настроек для отправки по электронной почте
Реквизиты и настройки, использующиеся по умолчанию для отправки по электронной почте , можно изменить в файле «pvr.xml» (каталог «<путь_КАСКАД>/config»).
Откройте файл «pvr.xml» с помощью редактора. Его содержание должно быть следующим:
<pvr>
<SMTP_SERVER></SMTP_SERVER>
<SMTP_USER></SMTP_USER>
<SMTP_PWD></SMTP_PWD>
<TO_USER>product_center@sybcom.at</TO_USER>
<FROM_USER></FROM_USER>
<FILE_EXTENSION>txt</FILE_EXTENSION>
</pvr>
Между открывающими и закрывающими тегами пользователь может менять данные, которые будут использоваться каждый раз при составлении и отправке сообщения с пакетом отчетов.
Эти теги соответствуют следующим полям на панели отправки сообщения по электронной почте (см. раздел «Отправка отчета по электронной почте»):
<pvr>
Конфигурация SMTP -> Сервер:
<SMTP_SERVER></SMTP_SERVER>
Конфигурация SMTP -> Пользователь:
<SMTP_USER></SMTP_USER>
Конфигурация SMTP -> Пароль (не рекомендуется указывать):
<SMTP_PWD></SMTP_PWD>
Электронная почта -> Кому:
<TO_USER></TO_USER>
Электронная почта -> От:
<FROM_USER></FROM_USER>
Расширение файла пакета отчетов:
<FILE_EXTENSION></FILE_EXTENSION>
</pvr>
ПРИМЕР
<pvr>
<SMTP_SERVER>smtpServerName</SMTP_SERVER>
<SMTP_USER>John Doe</SMTP_USER>
<SMTP_PWD>пароль</SMTP_PWD>
<TO_USER>product_center@sybcom.at</TO_USER>
<FROM_USER>john.doe@sybcom.at</FROM_USER>
<FILE_EXTENSION>zip</FILE_EXTENSION>
</pvr>
Файлы, создаваемые при создании отчета
Каждый раз при создании отчета создаются или обновляются следующие файлы в каталоге «/bin» в директории установки «КАСКАД Цифра»:
- tmpOut.txt – журнал средства диагностики
- report.txt – файл отчета с информацией о параметрах установки
- PVSSProjects.txt – список всех проектов и расширений «КАСКАД Цифра»
- PVRdiskCaptions.txt – список букв дисков на компьютере
- PVRDiskSpaces.txt – данные о наличии свободного места на каждом диске
- PVR.txt – информация об операционной системе