Дистанційні налаштування — Документація PalmOrder

На цій сторінці

preferences.xml дає змогу змінювати налаштування Android-застосунку через обмін. Інтегратор готує файл і розміщує його в outbox, а застосунок отримує та застосовує параметри під час виконання відповідного профілю.

Структура файла

Кореневий елемент — <preferences>. Усередині нього розміщуються секції налаштувань, а в секціях — параметри зі значеннями.

<?xml version="1.0" encoding="utf-8"?>
<preferences>
  <global>
    <theme>light</theme>
  </global>
  <references>
    <back-hierarchy-up>true</back-hierarchy-up>
  </references>
  <document-order>
    <set-custom-price>false</set-custom-price>
    <forbid-edit-sent-document>true</forbid-edit-sent-document>
  </document-order>
</preferences>

Додавайте лише ті параметри, які потрібно змінити. Решта налаштувань зберігає поточні значення. Для логічних параметрів використовуйте true або false. Кодування файла має збігатися зі значенням encoding в оголошенні XML.

Як передати налаштування

Покладіть preferences.xml безпосередньо в теку outbox, налаштовану для потрібного пристрою.
Переконайтеся, що в exchange.xml є профіль отримання цього файла. У стандартному файлі обміну це Завантажити налаштування.
Якщо ви змінили exchange.xml, спочатку виконайте на пристрої дію Завантажити файл обміну.
Запустіть профіль Завантажити налаштування й перевірте журнал обміну на пристрої.
Відкрийте відповідний розділ налаштувань застосунку та перевірте отримані значення. Щоб побачити зміну теми, перезапустіть застосунок.

Приклад профілю для додавання всередину <palm-client> у exchange.xml:

<exchange name="preferences" view="Завантажити налаштування">
  <get>
    <files>
      <file name="preferences" files="preferences.xml"/>
    </files>
  </get>
</exchange>

У стандартному exchange.xml для цього файла зазначено deleteOnServer="true": після успішного встановлення застосунок просить сервер видалити файл. Для спільного outbox, з якого налаштування мають отримати кілька пристроїв, приберіть цей атрибут або задайте deleteOnServer="false". Після отримання файла всіма потрібними пристроями інтегратор може прибрати його з outbox.

Загальні параметри — global

Параметр	Значення	Призначення
`theme`	`dark`, `light`	Темна або світла тема застосунку.
`table-font-size`	`small`, `normal`, `large`, `extra-large`	Розмір шрифту в таблицях.
`debug-mode`	`true`, `false`	Режим налагодження для діагностики.

Довідники — references

Параметр	Значення	Призначення
`back-hierarchy-up`	`true`, `false`	Кнопка «Назад» спочатку переходить до батьківської групи, а не закриває довідник.
`show-parents-in-details`	`true`, `false`	Показує батьківські групи в картці товару.
`recursive-filter`	`true`, `false`	Під час фільтрації приховує групи, у яких немає відповідних елементів.
`view-type`	`0`, `1`, `2`	Вигляд довідника товарів: `0` — таблиця, `1` — плитки, `2` — галерея.

Замовлення — document-order

Усі параметри цієї секції мають значення true або false.

Параметр	Що вмикає значення `true`
`calculate-rest`	Перерахунок залишку з урахуванням кількості товару в замовленні.
`set-custom-price`	Можливість змінити ціну товару під час підбору.
`products-in-package`	Введення кількості у фасовках.
`customer-own-prices-only`	Вибір лише категорії цін, заданої для клієнта.
`forbid-new-document-with-expired-debt`	Заборону створювати замовлення клієнту з простроченою заборгованістю.
`check-photo`	Вимогу зробити фото перед підбором товарів у замовлення, якщо для клієнта задана ознака `photo_required`.
`forbid-edit-sent-document`	Заборону редагувати надіслані замовлення.

Оплати — document-payment

Усі параметри цієї секції мають значення true або false.

Параметр	Що вмикає значення `true`
`forbid-edit-saved`	Заборону редагувати збережені оплати.
`forbid-delete-not-sent`	Заборону видаляти ще не надіслані оплати.
`forbid-edit-sent-document`	Заборону редагувати надіслані оплати.

Додаткові поля підбору — product-count-dialog-info-fields

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

<product-count-dialog-info-fields>
  <code>true</code>
  <packaging>true</packaging>
</product-count-dialog-info-fields>

Використовуйте лише поля, які вже є в завантаженому довіднику товарів. Цей фрагмент потрібно розмістити всередині <preferences>.

Зображення товарів — product-reference-images

Параметр	Значення	Призначення
`path`	Шлях	Тека зображень на Android-пристрої.
`extensions`	Розширення через `;`, наприклад `jpg;jpeg;png`	Типи файлів, у яких застосунок шукає зображення товарів.

path задає шлях на пристрої. Він має відповідати місцю збереження зображень під час обміну.

Підключення до сервера — palmorder-server

Ця секція змінює адресу й параметри з'єднання вже налаштованого застосунку. Початкове підключення описано на сторінці Підключення пристрою.

Параметр	Значення	Призначення
`server-version-7-plus`	`true`	Режим роботи з PalmOrder Server 7.x.
`https`	`true`, `false`	`true` — підключення через HTTPS, `false` — через HTTP. Застосовується до локальної адреси й адреси для обміну через інтернет. Якщо параметр пропущено, поточне значення зберігається.
`local-address`	IP-адреса або доменне ім'я	Адреса сервера для локального обміну, без `http://`, `https://` і порту.
`remote-address`	IP-адреса або доменне ім'я	Адреса сервера для обміну через інтернет, без протоколу й порту.
`port`	Ціле число від `1` до `65535`	Порт підключення.
`timeout-seconds`	Ціле число більше `0`	Час очікування відповіді сервера в секундах.

<palmorder-server>
  <server-version-7-plus>true</server-version-7-plus>
  <https>false</https>
  <local-address>192.168.1.20</local-address>
  <port>8888</port>
  <timeout-seconds>60</timeout-seconds>
</palmorder-server>

Розмістіть цей фрагмент усередині <preferences>, замінивши адресу та порт на свої. Для сервера з HTTPS задайте <https>true</https> і відповідний порт. Секрет парування у preferences.xml не передається. Якщо пристрій переходить на інший сервер, виконайте парування з ним.

GPS-стеження — gps-tracking

Параметр	Значення	Призначення
`enabled`	`true`, `false`	Увімкнення GPS-стеження.
`required`	`true`, `false`	Вимога увімкненого визначення місцезнаходження для роботи застосунку.
`interval`	Ціле число більше `0`	Інтервал збереження координат у секундах.
`on`	Час `HH:mm`, наприклад `08:00`	Початок роботи стеження.
`off`	Час `HH:mm`, наприклад `18:00`	Завершення роботи стеження.
`login`	Текст	Логін облікового запису GPS-стеження.
`password`	Текст	Пароль облікового запису GPS-стеження.
`send-interval`	Ціле число більше `0`	Інтервал надсилання координат у секундах.
`service-check-interval`	Ціле число більше `0`	Інтервал перевірки роботи GPS-сервісу у хвилинах.

Якщо on і off однакові, стеження працює без обмеження за часом. Дозволи на визначення місцезнаходження надаються окремо в Android.

Якщо налаштування не застосувалися

Спочатку перевірте журнал обміну на пристрої: саме застосунок читає preferences.xml і повідомляє про результат встановлення.

Повідомлення або симптом	Що перевірити
Файл не завантажився	Ім'я `preferences.xml`, теку `outbox` для потрібного `syncName` і наявність файла в профілі обміну.
Невідома секція або параметр	Точне написання назви та її наявність у таблицях вище. Невідомі параметри пропускаються з попередженням.
Помилка встановлення	Коректність XML, кодування та допустимі значення параметрів. Після помилки перевірте фактичні налаштування перед повторним завантаженням.
Файл отримав лише один пристрій	Чи не видалено файл через `deleteOnServer="true"` у спільній теці `outbox`.