Настройка генерации файлов SP-адаптером (spConfig)

Скопировать прямую ссылку на статью

SP-адаптер формирует xml и PDF заявления. Его настройка позволяет менять логику формирования файлов, а также логику отправки заявления в СМЭВ

Настройка SP-адаптера осуществляется в разделе «Генерация файлов по заявлению» настроек версии услуги

Пример настройки блока SP-конфига:

{
"files": [
{
"type": "request",
"fileName": "application.xml",
"extensionDisplay": true,
"addedFileName": "NONE",
"mnemonic": "application.xml",
"addedMnemonic": "NONE",
"attachmentType": "lk",
"templates": {
"Applicant": "60010132/60010132_Applicant.vm"
},
"outputEncoding": "utf-8"
},
{
"type": "COMMON_PDF",
"fileName": "req_preview.pdf",
"extensionDisplay": true,
"addedFileName": "NONE",
"mnemonic": "req_preview.pdf",
"addedMnemonic": "NONE",
"attachmentType": "lk",
"templates": {
"Applicant": "60010132/pdf_60010132_Applicant.vm"
},
"outputEncoding": "utf-8"
},
{
"type": "xml",
"fileName": "req.xml",
"extensionDisplay": true,
"addedFileName": "NONE",
"mnemonic": "req.xml",
"addedMnemonic": "NONE",
"attachmentType": "request",
"templates": {
"Applicant": "60010132/t_60010132.vm"
},
"outputEncoding": "utf-8"
}
]
}

Пояснения к атрибутам:

1. type — Указание формата генерируемого файла [PDF | COMMON_PDF | XML | REQUEST]
REQUEST — обязательная XML (business XML);
XML — обычная XML, в т. ч. и транспортная;
COMMON_PDF — эта PDF создается в определенном формате вроде следующего
{"className":"Panel", "label": "Дети", "value": ""} (обычно заявление в ведомство);
PDF — все остальные PDF.
2. fileName — Указывает имя создаваемого файла — виден при скачивании и в ЛК.
3. extensionDisplay — Добавление расширения файла.
4. addedFileName — Суффикс имени файла. [GUID | HASH | NONE] может быть не указан, тогда принимается NONE.
5. mnemonic — Мнемоника файла в СМЭВ.
6. addedMnemonic — Суффикс мнемоники. [GUID | HASH | NONE] может быть не указан, тогда принимается NONE.
7. attachmentType — Указывает на способ обработки файла как вложения запроса к СМЭВ [LK | REQUEST | SEND_SMEV_FORBIDDEN].
REQUEST — для транспортной XML, передаётся в самом запросе в SP. Для PDF — файл не будет отправлен в SP.
LK — передается в разделе files запроса в SP.
SEND_SMEV_FORBIDDEN — файл не будет направлен в SP.
8. outputEncoding — Кодировка генерируемого файла.

Если в услуге не определена секция spConfig.files, то sp-adapter использует настройки по умолчанию

Файлы, которые отображаются в личном кабинете и направляются в СМЭВ при использовании настроек по умолчанию:

req.xml — заявление в формате XML
trans.xml — транспортный XML
additional.pdf — дополнительный PDF-файл

Файл, который отображается в личном кабинете, но не направляется в СМЭВ:

req_preview.pdf — заявление PDF

Если требуется изменить логику работы, например, направлять в СМЭВ файл req_preview.pdf, необходимо создать и настроить собственную секцию spConfig.files в услуге, задав нужные значения type и attachmentType. Их описание приведено в пояснительной матрице выше

Для услуг с подписанием блок SP-конфиг должен быть обязательно прописан в настройках

Пример настроек блока SP-конфиг по умолчанию:

{

"type": "REQUEST",

"fileName": "req.xml",

"extensionDisplay": true,

"addedFileName": "GUID",

"addedMnemonic": "NONE",

"attachmentType": "LK",

"templates": {

"Applicant": "10000000100/10000000100_Applicant"

"outputEncoding": "utf-8"

{

"type": "XML",

"fileName": "trans.xml",

"extensionDisplay": true,

"addedFileName": "GUID",

"addedMnemonic": "NONE",

"attachmentType": "REQUEST",

"templates": {

"Applicant": "10000000100/t_10000000100"

"outputEncoding": "utf-8"

{

"type": "COMMON_PDF",

"fileName": "req_preview.pdf",

"extensionDisplay": true,

"addedFileName": "NONE",

"mnemonic": "req_preview.pdf",

"addedMnemonic": "NONE",

"attachmentType": "REQUEST",

"templates": {

"Applicant": "10000000100/pdf_10000000100_Applicant"

"outputEncoding": "utf-8"

{

"type": "PDF",

"fileName": "additional.pdf",

"extensionDisplay": true,

"addedFileName": "NONE",

"mnemonic": "additional.pdf",

"addedMnemonic": "NONE",

"attachmentType": "LK",

"templates": {

"Applicant": "10000000100/additional/pdf_add_10000000100_Applicant"

"outputEncoding": "utf-8"

}

, чтобы оставить комментарий к статье