Плагины формирования отчетов
В Сервисе Аудита КриптоПро DSS доступна расширенная настройка различных отчетов. Эту возможность реализуют плагины формирования отчетов, настраиваемые при помощи специализированного набора командлетов.
В зависимости от типов отчетов, представленных в таблице ниже, к плагину нужно подключить
соответствующий класс отчета.
Все предопределенные типы отчетов содержатся в сборке CryptoPro.DSS.AnalyticsService.ReportPlugins.dll.
Имя сборки указывается в параметре –Assembly.
| Тип отчета | Класс отчета | Описание |
|---|---|---|
| Отчеты о сертификатах | CryptoPro.DSS.AnalyticsService.ReportPlugins.CertificateReports.CreatedCertificateReport | Отчет о созданных сертификатах |
| CryptoPro.DSS.AnalyticsService.ReportPlugins.CertificateReports.RevokedCertificateReport | Отчет об отозванных сертификатах | |
| CryptoPro.DSS.AnalyticsService.ReportPlugins.CertificateReports.HeldCertificateReport | Отчет о приостановленных сертификатах | |
| CryptoPro.DSS.AnalyticsService.ReportPlugins.CertificateReports.UnheldCertificatesReport | Отчет о сертификатах с возобновленным сроком действия | |
| Отчеты об ЭП | CryptoPro.DSS.AnalyticsService.ReportPlugins.SignatureReports.CreatedSignaturesReport | Отчет о количестве ЭП |
| Отчеты о Пользователях | CryptoPro.DSS.AnalyticsService.ReportPlugins.UserReports.CreatedUsersReport | Отчет о количестве созданных пользователей |
| Отчет о пользователях myDSS | CryptoPro.DSS.AnalyticsService.ReportPlugins.MyDss.MyDssUserReport | Отчет о количестве пользователей myDSS в рамках заданного периода |
| Отчет о пользователях Cloud CSP | CryptoPro.DSS.AnalyticsService.ReportPlugins.CloudCspReport.CloudCspReport | Отчет о количестве пользователей Cloud CSP в рамках заданного периода |
При администрировании плагинов формирования отчетности необходимо указать параметры
настраиваемого плагина. Это можно сделать с помощью параметра -parameters. Этот параметр имеет
тип Hashtable. В PowerShell для задания параметра типа Hashtable можно применить следующую
конструкцию:
@{paramName1=paramValue1; paramName2=paramValue2;…;paramNameN=paramValueN}
, где paramNamei, paramValuei – название и значение параметра соответственно. Каждый параметр
и его значение помещаются в двойные кавычки.
В таблице ниже указаны параметры плагинов формирования отчета, которые настраиваются при добавлении плагинов разных типов.
| Параметр | Тип | Описание |
|---|---|---|
| Отчеты о сертификатах | ||
| AuditConnectionString | string | Строка подключения к БД Сервиса Аудита |
| InstanceName | string | Уникальный идентификатор экземпляра Сервиса Подписи, по данным которого строится отчет. ВНИМАНИЕ: идентификатор имеет формат <SiteId>/<ApplicationName>, где значения SiteId и ApplicationName можно получить в выводе командлета Get-DssAnalyticsServiceInstance. |
| Xslt | string | Путь к файлу с XSLT-преобразованием |
| ReportName | string | Отображаемое имя отчета |
| Delimiter | string | Символ разделения элементов при экспорте отчета в CSV-формат |
| Отчеты об ЭП | ||
| AuditConnectionString | string | Строка подключения к БД Сервиса Аудита |
| InstanceName | string | Уникальный идентификатор экземпляра Сервиса Подписи, по данным которого строится отчет. ВНИМАНИЕ: идентификатор имеет формат <SiteId>/<ApplicationName>, где значения SiteId и ApplicationName можно получить в выводе командлета Get-DssAnalyticsServiceInstance. |
| Xslt | string | Путь к файлу с XSLT-преобразованием |
| ReportName | string | Отображаемое имя отчета |
| Delimiter | string | Символ разделения элементов при экспорте отчета в CSV-формат |
| StsConnectionString | string | Строка подключения к БД Центра Идентификации |
| Отчеты о Пользователях | ||
| StsConnectionString | string | Строка подключения к БД Центра Идентификации |
| RealmName | string | Идентификатор экземпляра ЦИ, которому принадлежат Пользователи. ВНИМАНИЕ: идентификатор равен значению параметра IssuerName, который можно получить в выводе командлета Get-DssIdentityProvider. |
| RdnList | string | Список объектных идентификаторов компонентов имени Пользователя, которые попадут в отчет. |
| Xslt | string | Путь к файлу с XSLT-преобразованием |
| ReportName | string | Отображаемое имя отчета |
| Delimiter | string | Символ разделения элементов при экспорте отчета в CSV-формат |
| Отчет о пользователях myDSS | ||
| AuditConnectionString | string | Строка подключения к БД Сервиса Аудита |
| InstanceName | string | Идентификатор экземпляра ЦИ, по данным которого строится отчет. ВНИМАНИЕ: идентификатор равен значению параметра <SiteId>/<ApplicationName>, где значения SiteId и ApplicationName можно получить в выводе командлета Get-DssStsInstance. |
| Xslt | string | Путь к файлу с XSLT-преобразованием |
| ReportName | string | Отображаемое имя отчета |
| Delimiter | string | Символ разделения элементов при экспорте отчета в CSV-формат |
| Отчет о пользователях Cloud CSP | ||
| AuditConnectionString | string | Строка подключения к БД Сервиса Аудита |
| InstanceName | string | Идентификатор экземпляра ЦИ, по данным которого строится отчет. |
| Xslt | string | ВНИМАНИЕ: идентификатор равен значению параметра <SiteId>/<ApplicationName>, где значения SiteId и ApplicationName можно получить в выводе командлета Get-DssStsInstance. |
| ReportName | string | Путь к файлу с XSLT-преобразованием |
| Delimiter | string | Отображаемое имя отчета |
Примечание
При настройке отчета о Пользователях необходимо дать права учетной записи, под которой работает
Сервис Аудита (по умолчанию – IIS AppPool\CryptoProDSS-1-AnalyticsService), на доступ к БД
ЦИ (по умолчанию - IdentityServiceDB). Для этого необходимо включить учетную запись Сервиса
Аудита в роль IdentityServiceInstance в БД ЦИ.
Примеры добавления плагинов отчетов на Сервисе Аудита:
Плагин отчета по количеству созданных ЭП:
Add-DssAnalyticsReportPlugin -DisplayName <DisplayName> -FileExtension csr -Assembly CryptoPro.DSS.AnalyticsService.ReportPlugins.dll -Classname CryptoPro.DSS.AnalyticsService.ReportPlugins.SignatureReports.CreatedSignaturesReport -Parameters @{"AuditConnectionString" = "<AuditServiceDbConnection>"; "InstanceName"="<SiteId/ApplicationName>"; "ReportName"="Количество созданных подписей";"StsConnectionString"="<StsDbConnection>";}
Плагин отчета по количеству созданных сертификатов:
Add-DssAnalyticsReportPlugin -DisplayName <DisplayName> -FileExtension ccr -Assembly CryptoPro.DSS.AnalyticsService.ReportPlugins.dll -Classname CryptoPro.DSS.AnalyticsService.ReportPlugins.CertificatesReport. CreatedCertificateReport -Parameters @{"AuditConnectionString" = "<AuditServiceDbConnection>"; "InstanceName"="<SiteId/ApplicationName>"; "ReportName"="Количество созданных сертификатов";}
Плагин отчета по количеству созданных Пользователей:
Add-DssAnalyticsReportPlugin -DisplayName <DisplayName> -FileExtension cur -Assembly CryptoPro.DSS.AnalyticsService.ReportPlugins.dll -Classname CryptoPro.DSS.AnalyticsService.ReportPlugins.UserReports.CreatedUsersReport -Parameters @{"StsConnectionString" = "<StsDbConnection>"; "ReportName"="Количество созданных пользователей"; "RealmName"="<STS Realm Name>";"RdnList"="2.5.4.3"}
Плагин отчета по количеству пользователей MyDSS:
Add-DssAnalyticsReportPlugin -DisplayName <DisplayName> -FileExtension mur -Assembly CryptoPro.DSS.AnalyticsService.ReportPlugins.dll -Classname CryptoPro.DSS.AnalyticsService.ReportPlugins.MyDss.MyDssUserReport -Parameters @{"AuditConnectionString" = "<AuditServiceDbConnection>"; "InstanceName"="<SiteId/ApplicationName>"; "ReportName"="Отчет о пользователях MyDss";}
Плагин отчета по количеству пользователей CloudCsp:
Add-DssAnalyticsReportPlugin -FileExtension clur -Assembly CryptoPro.DSS.AnalyticsService.ReportPlugins.dll -Classname CryptoPro.DSS.AnalyticsService.ReportPlugins.CloudCspReport.CloudCspReport -Parameters @{"AuditConnectionString" = "<AuditServiceDbConnection>"; "InstanceName"="<SiteId/ApplicationName>"; "ReportName"="Отчет о пользователях Cloud CSP";}