Перейти до змісту

Імпорти

Описи формату для служб XLSX імпорт і XLSX експорт: які колонки Excel-файлу в які поля реєстру лягають. Без опису служба не знає, як читати файл, — у її списку «Документ імпорту» з'являються саме записи цього реєстру.

Де шукати: Модулі → Система → Регістри → Імпорти

Як створити опис

  1. Новий запис: Код — короткий і унікальний, Назва — так опис видно у списку «Документ імпорту» служби.
  2. Регістр — куди імпортувати. Щойно ви обрали реєстр у новому записі, поле JSON заповнюється заготовкою: усі поля реєстру з підписами, ключові вже позначені "primary": true. Приберіть зайві колонки й, за потреби, перейменуйте заголовки.
  3. Поле JSON підсвічується зеленим, коли текст — правильний JSON, і червоним, коли ні. З неправильним JSON запис не збережеться: «Дані запиту не є коректним JSON».

Рядки документів (таблиці всередині документа) окремим реєстром не обираються — їх імпорт не пише.

Опис колонки

JSON — список, по одному об'єкту на колонку файлу. Підказки до властивостей видно просто у вікні над полем JSON.

[
    { "key": "fCode", "header": "Code", "primary": true },
    { "key": "fName", "header": "Name", "required": true },
    { "key": "fPhone", "header": "Phone" },
    { "key": "fCUType", "header": "Client", "default": "1" }
]
  • key — технічна назва поля в реєстрі.
  • header — заголовок колонки в першому рядку файлу; має збігатися дослівно.
  • primary — ключ запису (код, номер). За ним оновлення знаходить наявний запис, а саме значення ключа не змінюється. У описі має бути хоча б одне таке поле.
  • required — клітинка в цій колонці не може бути порожньою.
  • default — значення, яке підставляється в порожню клітинку.

Той самий опис задає колонки й XLSX експорту: вивантажили, виправили в Excel, завантажили назад.

Що опис не може містити

Опис перевіряється ще до читання файлу, і відмова приходить на весь файл, якщо в ньому є:

  • колонка, якої немає серед полів реєстру;
  • колонка проведення документа (прапорець «ОК» чи статус, що проводить) — імпорт пише напряму, без руху складу й проводок;
  • захищене поле (паролі, токени) — його вводять лише у вікні;
  • поле, яке роль користувача не бачить або може лише переглядати.

Типові ситуації

У службі список «Документ імпорту» порожній. Для цього реєстру немає жодного опису — створіть його тут.

«У документі імпорту є колонка "…", якої немає серед полів реєстру». У key описка — звірте з полями реєстру або візьміть заготовку заново: оберіть реєстр у новому записі.

«У документі імпорту має бути хоча б одне первинне (primary) поле». Позначте ключову колонку (код чи номер) "primary": true.

«Запис за ключем не знайдено: …». Ви оновлюєте записи, а запису з таким ключем немає. Нові записи завантажують типом «Створити нові регістри».

«Колонка "…" обов'язкова, але клітинка … порожня». У файлі порожня клітинка колонки з "required": true — заповніть її або задайте default.