Отчёт по использованию лицензии PayControl v3 — различия между версиями

Материал из PayControl Wiki
Перейти к: навигация, поиск
(Новая страница: «=Генерация отчёта= Отчёт может быть сгенерирован путём Вызов методов SOAP интерфейса|выз…»)
 
 
(не показаны 3 промежуточные версии этого же участника)
Строка 1: Строка 1:
 
=Генерация отчёта=
 
=Генерация отчёта=
 
Отчёт может быть сгенерирован путём [[Вызов методов SOAP интерфейса|вызова метода]] ''generateReport'' SOAP-интерфейса [[Сервер PayControl|сервера PCS]], например с помощью SoapUI или cURL.
 
Отчёт может быть сгенерирован путём [[Вызов методов SOAP интерфейса|вызова метода]] ''generateReport'' SOAP-интерфейса [[Сервер PayControl|сервера PCS]], например с помощью SoapUI или cURL.
 +
 +
WSDL схема с этим методом доступна на эндпоинте <code>/ws/PayControlReportService?wsdl</code>.
 +
 
==Значения полей==
 
==Значения полей==
 
===systemId===
 
===systemId===
Строка 11: Строка 14:
 
опциональны. Должны быть либо заполнены в формате YYYY-MM-DD±hh:mm, например 2019-04-24+03:00, либо удалены сами поля.
 
опциональны. Должны быть либо заполнены в формате YYYY-MM-DD±hh:mm, например 2019-04-24+03:00, либо удалены сами поля.
 
==SoapUI==
 
==SoapUI==
Для формирования отчёта необходимо выполнить вызов SOAP-метода ''generateReport'' на сервер PCS, на ''http://PCS/ws/PayControlReportService?wsdl''. В частности, такой запрос можно выполнить с использованием утилиты [https://www.soapui.org/ SoapUI].
+
Для формирования отчёта необходимо выполнить вызов SOAP-метода ''generateReport'' на сервер PCS, на ''http://%PCS%/ws/PayControlReportService?wsdl'' (заменив %PCS% на реальный адрес сервера). В частности, такой запрос можно выполнить с использованием утилиты [https://www.soapui.org/ SoapUI].
 
Пример формирования отчёта за 1 месяц:
 
Пример формирования отчёта за 1 месяц:
 
[[Файл:PCS Generate Report.png|обрамить|центр]]
 
[[Файл:PCS Generate Report.png|обрамить|центр]]
 
Для передачи отчёта компании SafeTech необходимо отправить весь результат, возвращённый сервером (в правой части представленного выше изображения).
 
Для передачи отчёта компании SafeTech необходимо отправить весь результат, возвращённый сервером (в правой части представленного выше изображения).
 +
 
==cURL==
 
==cURL==
 
# Скопировать или создать файл, содержащий параметры запроса в формате [[XML]] вызываемого SOAP-метода (к примеру, название файла будет ''generateReport.xml'') в любую директорию на машину, с которой будет производиться запуск команды curl. Этот файл должен содержать параметры запроса на генерацию отчёта. Пример состава файла ''generateReport.xml'' для формирования отчёта за один месяц:<syntaxhighlight lang="xml"><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pay="http://ws.safetech.ru/PayControlReport/">
 
# Скопировать или создать файл, содержащий параметры запроса в формате [[XML]] вызываемого SOAP-метода (к примеру, название файла будет ''generateReport.xml'') в любую директорию на машину, с которой будет производиться запуск команды curl. Этот файл должен содержать параметры запроса на генерацию отчёта. Пример состава файла ''generateReport.xml'' для формирования отчёта за один месяц:<syntaxhighlight lang="xml"><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pay="http://ws.safetech.ru/PayControlReport/">

Текущая версия на 13:24, 18 августа 2023

Генерация отчёта

Отчёт может быть сгенерирован путём вызова метода generateReport SOAP-интерфейса сервера PCS, например с помощью SoapUI или cURL.

WSDL схема с этим методом доступна на эндпоинте /ws/PayControlReportService?wsdl.

Значения полей

systemId

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

Поля для установки временного диапазона

Поля

  • <genDate>
  • <dateFrom>
  • <dateTo>

опциональны. Должны быть либо заполнены в формате YYYY-MM-DD±hh:mm, например 2019-04-24+03:00, либо удалены сами поля.

SoapUI

Для формирования отчёта необходимо выполнить вызов SOAP-метода generateReport на сервер PCS, на http://%PCS%/ws/PayControlReportService?wsdl (заменив %PCS% на реальный адрес сервера). В частности, такой запрос можно выполнить с использованием утилиты SoapUI. Пример формирования отчёта за 1 месяц:

PCS Generate Report.png

Для передачи отчёта компании SafeTech необходимо отправить весь результат, возвращённый сервером (в правой части представленного выше изображения).

cURL

  1. Скопировать или создать файл, содержащий параметры запроса в формате XML вызываемого SOAP-метода (к примеру, название файла будет generateReport.xml) в любую директорию на машину, с которой будет производиться запуск команды curl. Этот файл должен содержать параметры запроса на генерацию отчёта. Пример состава файла generateReport.xml для формирования отчёта за один месяц:
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:pay="http://ws.safetech.ru/PayControlReport/">
       <soapenv:Header/>
       <soapenv:Body>
          <pay:generateReportRequest>
             <systemId>e33affa9-1ff8-4d2a-aa42-856fb59309e0</systemId>
             <genDate>2019-04-24+03:00</genDate>
             <dateFrom>2019-03-24+03:00</dateFrom>
             <dateTo>2019-04-24+03:00</dateTo>
          </pay:generateReportRequest>
       </soapenv:Body>
    </soapenv:Envelope>
    
  2. Выполнить команду (в той-же директории, где располагается скопированный файл):
    curl --header "Content-Type: text/xml;charset=UTF-8" --header "SOAPAction: generateReport" --data @generateReport.xml  <PCServer_IP/localhost>:8080/ws/PayControlReportService
    
  3. Для передачи отчёта компании SafeTech необходимо отправить весь результат, возвращённый сервером.

Открытие файла отчёта

Для открытия файла отчёта необходимо декодировать из Base64 содержимое из тега <report>, и сохранить как файл с расширением docx. Например, это можно сделать на сайте http://base64converter.com/