Документація/Формати даних

Адміністратору

Довільні таблиці

Додаткові таблиці, custom_tables.xml, пункти меню та приклад завантаження через обмін.

Довільні таблиці дають змогу показати на пристрої додаткові дані облікової системи: наприклад, план продажів або аналітичний звіт. Для кожної таблиці з'являється окремий пункт головного меню. Можливість доступна для клієнтських ліцензій Medium і Full.

Назву довільної таблиці обирає інтегратор. ct_sales_plan нижче — лише приклад для таблиці «План продажів», а не зарезервована чи обов'язкова назва. Для своєї таблиці виберіть власне технічне ім'я та використовуйте його однаково в імені файла, атрибуті <table name>, елементі <name> і профілі <db name>.

Які файли потрібні

ФайлХто готуєПризначення
Файл даних вашої таблиціОблікова система.Дані таблиці у форматі табличного XML. Назву файла обирає інтегратор.
custom_tables.xmlІнтегратор.Перелік довільних таблиць та їхні назви в меню.
exchange.xmlІнтегратор.Профіль отримання даних і файла custom_tables.xml.

Усі файли розміщуються безпосередньо в outbox, налаштованій для пристрою. Дані таблиці та її запис у custom_tables.xml мають використовувати однакове ім'я.

Де використовується назваПриклад для таблиці «План продажів»
Файл данихct_sales_plan.xml
Кореневий елемент даних<table name="ct_sales_plan">
Пункт у custom_tables.xml<name>ct_sales_plan</name>
Отримання в exchange.xml<db name="ct_sales_plan"/>

Дані таблиці

Нижче наведено приклад файла даних для таблиці «План продажів». Ім'я ct_sales_plan використано лише в цьому прикладі:

<?xml version="1.0" encoding="utf-8"?>
<table name="ct_sales_plan">
  <schema>
    <field name="product_name" type="TEXT"/>
    <field name="plan" type="REAL"/>
    <field name="actual" type="REAL"/>
  </schema>
  <data>
    <record>
      <f>Вода 1 л</f>
      <f>500</f>
      <f>420</f>
    </record>
    <record>
      <f>Сік 1 л</f>
      <f>300</f>
      <f>315</f>
    </record>
  </data>
</table>

Завантажити приклад XML-файла.

Для власних імен таблиць використовуйте латинські літери, цифри та знак підкреслення, починаючи з літери. Префікс ct_ не обов'язковий, але допомагає відрізняти довільні таблиці від стандартних. Наприклад, для звіту про продажі можна використати sales_report: файл буде sales_report.xml, а значення атрибута name — sales_report.

Назви полів задає інтегратор. У кожному записі кількість і порядок <f> мають відповідати <schema>. Кодування файла має збігатися з encoding в оголошенні XML.

Пункти меню — custom_tables.xml

<?xml version="1.0" encoding="utf-8"?>
<custom-tables>
  <table>
    <name>ct_sales_plan</name>
    <label>План продажів</label>
  </table>
</custom-tables>

Завантажити custom_tables.xml.

  • <name> — ім'я таблиці без .xml, а не назва файла з розширенням.
  • <label> — текст пункту головного меню.

Для кількох таблиць додайте окремі елементи <table> у той самий файл. У кожного має бути одне непорожнє <name> та одне непорожнє <label>. Не повторюйте ім'я таблиці. Кожна перелічена таблиця повинна мати свій файл даних у outbox.

custom_tables.xml задає повний перелік пунктів, тому під час оновлення зберігайте в ньому всі довільні таблиці, які мають залишитися в меню.

Профіль обміну

Додайте цей профіль усередину <palm-client> вашого exchange.xml. Він містить одну довільну таблицю з прикладу; замініть ct_sales_plan на своє ім'я:

<exchange name="custom_tables" view="Завантажити додаткові таблиці">
  <get>
    <dbs>
      <db name="ct_sales_plan"/>
    </dbs>
    <files>
      <file name="custom_tables" files="custom_tables.xml"/>
    </files>
  </get>
</exchange>

Таблицю потрібно отримувати як <db>, а custom_tables.xml — як <file>. Для файла конфігурації залиште стандартне місце збереження: не додавайте storage="external" або destinationFolder.

Можна також додати ці елементи до наявного профілю. Якщо таблиць кілька, перелічіть кожну в <dbs>.

Завантаження й оформлення

  1. Покладіть файл даних і custom_tables.xml у outbox пристрою.
  2. Оновіть exchange.xml і виконайте на пристрої Завантажити файл обміну.
  3. Запустіть профіль Завантажити додаткові таблиці й перевірте журнал обміну на пристрої.
  4. Поверніться до головного меню та відкрийте пункт, назву якого задали в <label>.
  5. У меню таблиці відкрийте налаштування колонок. Задайте зрозумілі назви, порядок, видимість і формати. У прикладі для plan та actual виберіть дробове число, для product_name — текст.

Поточний імпорт tables_columns.xml налаштовує стандартні таблиці. Колонки довільних таблиць налаштовуються на пристрої. Нові поля спочатку показуються під своїми технічними назвами.

У таблиці доступні перегляд, сортування, фільтрація та налаштування колонок. Оновлення даних надходять з облікової системи через той самий профіль обміну.

Ієрархічна таблиця

Щоб показати групи та вкладені записи, додайте до схеми поля code, parent і group. Значення мають відповідати правилам ієрархічних довідників: порожній parent для верхнього рівня, код батьківської групи для вкладеного запису, group=0 для елемента та group=1 для групи.

За наявності всіх трьох полів застосунок розпізнає таблицю як ієрархічну. Не додавайте їх до плоского звіту без потреби.

Якщо таблиця не з'явилася

Спочатку перевірте журнал обміну на пристрої та журнал сервера за часом завантаження.

СимптомЩо перевірити
Немає пункту менюОтримання custom_tables.xml, правильність <name> і <label>, клієнтську ліцензію Medium або Full. Після обміну поверніться до головного меню.
Пункт є, але даних немаєНаявність вашої таблиці в <get><dbs> профілю, її файла в outbox і збіг імені таблиці у всіх файлах.
Помилка файла конфігураціїКорінь <custom-tables>, непорожні <name> і <label>, відсутність повторів та наявність усіх перелічених таблиць у outbox.
Неправильний вигляд чисел або датФормат відповідних колонок у налаштуваннях таблиці на пристрої.
Записи не видно в ієрархіїКоди батьківських груп, порожній parent для верхнього рівня та значення group.