Проект

Общее

Профиль

Wiki »

Руководство пользователя

Общие положения.

Описание компонентов. Системные требования.

Приложение ScalesLoader предназначено для загрузки товаров на весы, а также отслеживания состояния весов и возникающих на них ошибок.
Приложение состоит из следующих компонент:

  1. Служба rbs-service, которая осуществляет передачу файлов на весы.
  2. База данных Scales.
  3. Клиентское приложение (модуль визуализации), позволяющая пользователю осуществлять функции, предусмотренные приложением.

В процессе своей работы пользователь напрямую взаимодействует только с Клиентским приложением. Служба и База Данных может быть установлена как на компьютере с Клиентским приложением, так и отдельно от него.
Системные требования включают в себя:

  • Операционная система: Платформа Windows 7 и новее, Windows Server 2008R2 и новее.
  • Свободное место: 400 MB свободного места на диске;
  • Оперативная память: 1 GB оперативной памяти.

Установка приложения в двух конфигурациях:

  1. Полная установка (установка БД, службы и клиентского приложения).
  2. Установка только клиентского приложения

Полная установка.

Для полной установки необходимо запустить инсталлятор Setup.exe с правами администратора.
В появившемся окне вам будет необходимо указать порт, который будет использовать PostgreSQL Server версии 9.6. Значение по умолчанию: 5432

Рис.1 выбор порта

Далее заполните информацию о себе согласно заданному шаблону:

Рис.2 Заполнение информации о пользователе

Далее выберите папку, куда должен быть установлен ScalesLoader:

Рис.3 Выбор папки установки

После выбора папки инсталлятор готов к установке, нажмите кнопку "Установить" для начала процесса установки:

Рис.4 Готовность к установке

В том случае, если на компьютере не установлен PostgreSQL версии 9.6, то через определенное время появится соответствующее окно начала установки:

Рис.5 Установка Postgres

Нажмите "Next" для выбора директории установки:

Рис.6 Выбор директории установки

Далее нажмите "Next" для выбора директории хранения информации:

Рис.7 Выбор директории хранения информации

В окне задания пароля в обоих полях укажите pgsql:

Рис.8 Ввод пароля

Далее укажите порт, который будет использовать сервер (значение по умолчанию - 5432):

Рис.9 Выбор порта

*Обратите внимание: Номер порта должен обязательно совпадать с номером порта, выбранном в начале установки (см. рисунок 1).

Далее выберите язык "Russian" из выпадающего списка:*

Рис.10 Выбор языка

Рис.11 Процесс установки

Далее ожидайте окончания установки PostgreSQL, после окончания установки снимите галочку с опции StackBuilder и нажмите Finish:

Рис.12 Завершение установки

Если на вашем компьютере уже установлен PostgreSQL версии 9.6 шаги инструкции одинаковы за исключением выбора директории установки, директории хранения информации, пароля и языка, они будут пропущены установщиком.
После установки PostgreSQL на компьютер, установщик поставит последнюю версию Java, если это необходимо.

Установка клиентского приложения.

Распакуйте архив ScalesLoader, и зайдите в папку ScalesLoader. Откройте файл config.conf c помощью любого текстового редактора и укажите в dbHost значение ip-адреса базы и порта, показывающее куда необходимо подключиться.
Например:
dbHost = 127.0.0.1:5432
Далее в этой же папке запустите приложение ScalesLoader.exe.
Установка завершена, теперь возможно использование программы.

Вкладка "Весы".

Настройка весов.

В утилите можно указать системе какие данные и в какие весы требуется загружать для того, чтобы быстро сконфигурировать работу системы в условиях магазина.
Для создания весов необходимо нажать кнопку "добавить весы" внизу экрана, после нажатия кнопки появится следующее окно:

Рис.13 Добавление весов

Перечень параметров весов:

  1. Номер весов (обязательный параметр).
  2. Название весов (опциональный параметр).
  3. Модель (Тип весов. Только "РБС КS 4010").
  4. IP- адрес (обязательный параметр).
  5. Порт (обязательный параметр).
  6. Список отделов, к которым привязаны данные весы (указывается отдельно во вкладке "Отделы", для информации о привязке весов к отделам см. пп 2.4 "Настройка отделов").
  7. Статус (включены или выключены). Статус включены /выключены предназначен для включения/выключения процесса загрузки данных в весы. Если весы выключены, данные в них не загружаются. При выключении очередь для них очищается.
    После указания параметров для добавления весов нужно нажать кнопку "Cоздать", весы будут добавлены в список:

Рис.14 Настройка весов

Кнопка "Отменить" предназначена для отмены добавления весов в список.
Для совершения каких - либо действий над уже добавленными весами нажмите на добавленные весы в списке, а далее перейти во вкладку весы:

Рис.14 Настройка весов

Кнопка "Cохранить" позволяет сохранить пользовательские изменения в заданных весах.
Кнопка "Отменить" позволяет отменить пользовательские изменения.
Кнопка "Удалить" позволяет удалить выбранные весы.

Настройка отделов.

Настройка отделов позволяет сопоставлять товары конкретным весам для того, чтобы загружать в весы только необходимые данные.
Сопоставление товаров весам выполняется через отделы. Товар загружается на весы только в том случае, если товар и весы привязаны к одному и тому же отделу. Весам обязательно должен быть назначен отдел, при этом допускается назначение нескольких отделов. В весы будут загружены только товары из назначенных отделов.
Исключением в данном случае является явное указание ip-адреса весов в имени импортируемого файла. В таком случае данные загружаются в указанные весы без дополнительных условий и привязок.

Для того, чтобы перейти к настройке отделов, необходимо нажать на любые весы из списка, а далее перейти во вкладку "отделы":

Рис.15 Настройка отделов

Над отделами можно производить следующие операции:
1. Добавление.
2. Изменение.
3. Удаление.
Для создания нового отдела нажмите на кнопку "Новый отдел", откроется окно создания отдела:

Рис.16 Создание отдела

Кнопка "Создать" подтверждает создание нового отдела и отдел появляется в списке.
Кнопка "Отменить" производит операцию отмены.
Для редактирования или удаления какого-нибудь отдела, выберите этот отдел в списке и нажмите на него, откроется окно редактирования отдела:

Рис.17 Редактирование отдела

Кнопка "Удалить" позволяет удалить данный отдел.
Кнопка "Применить" позволяет сохранить изменения после редактирования отдела.
Кнопка "Отмена" позволяет отменить операцию и закрыть окно.
Для привязки весов к заданному отделу необходимо отметить чекбоксы напротив названия отдела и далее нажать кнопку "Cохранить":

Рис.15 Настройка отделов

На заданном рисунке весы номер 1 привязаны к отделу 1 и 2.
До того момента как была нажата кнопка "Сохранить", можно отменить изменения, нажав кнопку "Отменить".
Для одного из отделов может быть установлен признак отдела по умолчанию. Товары, загружаемые из файлов, без указания отдела будут сопоставляться ему. При назначении отдела по умолчанию, у отдела, который был таким ранее, признак сбрасывается. Для того, чтобы назначить отдел по умолчанию, щелкните на выпадающий список и выберите отдел, далее нажмите кнопку "Сохранить":

Рис.18 Выбор отдела по умолчанию

Мониторинг по файлам.

По умолчанию приложение открывается на вкладке "Весы" в окне "Мониторинг по файлам". Мониторинг по файлам позволяет видеть ошибки, возникшие при импорте файлов, для того, чтобы оперативно принять меры по устранению причин и последствий ошибок. При этом каждая из возникших ошибок содержит в себе следующую информацию:

  1. Дату и время окончания обработки файла.
  2. Имя файла, включая путь
  3. Текст ошибки.
  4. Порядковый номер строки данных в файле.
  5. Строка с ошибочными данными.
    После запуска приложения открывается стартовое окно:

Рис.19 Мониторинг по файлам

Мониторинг по весам.

Мониторинг по весам позволяет видеть ошибки, возникшие при загрузке данных в весы, для того, чтобы оперативно принять меры по устранению причин и последствий ошибок.
При этом каждая из возникших ошибок содержит в себе следующую информацию:

  1. Дату и время возникновения ошибки.
  2. Текст ошибки.
  3. Код товара.
  4. Наименование товара.

Для того, чтобы перейти в окно мониторинга по каким-либо весам достаточно нажать на любые весы из списка. После этого откроется окно мониторинга, относящееся к заданным весам:

Рис.20 Мониторинг по весам

Аналогично мониторингу по файлам, для получения более детальной информации об ошибки необходимо два раза нажать на строку в списке с мониторингом ошибок, откроется всплывающее окно с детальной информацией:

Рис.21 Детальный текст ошибки

Обратите внимание, что кроме информации об ошибках мониторинг весов позволяет получать следующую информацию:
1.Товаров в очереди на загрузку.
2.Количество ошибок.
Эта информация отображается под названием весов.
Весы в списке отображаются с цветовым индикатором, обозначающим статус весов:

1.Красный цвет - означает, что от весов в данный момент приходит какая - нибудь ошибка, например, весы сейчас недоступны.
2.Желтый цвет - означает, что весы сейчас доступны и работают, но хотя бы один раз за последние 24 часа на них происходила ошибка.
3.Зеленый цвет - означает, что весы сейчас доступны и работают.
4. Серый цвет - означает, что весы были выключены пользователем через приложение (более подробно о выключенном состоянии см пп. 2.3 Настройка весов).
5. Белый цвет - означает, что служба не может определить состояние весов в данный момент, состояние является промежуточным, возникает после добавления новых весов и меняется на одно из четырех вышеописанных в течение нескольких минут.
Данные мониторинга по весам хранятся в течении 7 календарных дней. По истечении срока хранения автоматически и безвозвратно удаляются.

Вкладка "Настройки импорта".

Формат Файла.

Основное предназначение настроек во вкладке формат файла - указать системе какие данные и в каком порядке размещены в импортируемом файле для того, чтобы быстро и своими силами настроить систему для работы с файлами различных бэк-офисных систем:

Рис.22 Формат файла

Во вкладке "Формат Файла" можно установить следующие настройки:

  1. Тип файла XML и CSV !Внимание, при выборе типа файла XML - настройки ниже не доступны, данные обрабатываются исходя из наименования XML-тегов!
  2. Наличие заголовка.
    Если отметить данную настройку, то заголовок файла будет исключен из обработки (первая строка в файле будет игнорироваться).
  3. Символ-разделитель.
    В данном поле необходимо указать символ, с помощью которого будут разделяться поля данных в файле, отправляемом на весы.
  4. Поля данных.
    В окне "Поля данных" необходимо указать тип полей данных, которые находятся в файле.
    Обратите внимание, что порядок полей, и их количество в клиентском приложении должно совпадать с порядком и количеством полей в файле. Поля "Номер PLU," Штриховой код товара"," Полное наименование товара"," Короткое наименование товара", "Цена на товар" являются обязательными. Добавить поля из "перечня возможных полей" в "поля данных" можно, перемещая их мышкой.

На рисунке дополнительно к обязательным полям добавлено поле "Действие".

Тип каждого из полей представлен в следующей таблице:

Действие Целое(0,1)
Номер PLU Целое
Штриховой код товара Целое
Полное наименование товара Строка(1000)
Короткое наименование товара Строка(1000)
Номер отдела Целое
Тип товара: 0 - весовой; 1 - штучно-весовой Целое{0,1}
Вес тары Десятичное(19, 3)
Цена по карте (фиксированная) Десятичное(19, 2)
Цена на товар Десятичное(19, 2)
состав Строка(1500)
Срок годности в днях Целое
Имя файла с изображением товара Строка(255)
использовать до Целое
номер этикетки Целое
Дополнительная информация 1..8 Строка(1500) для 1-4@Строка(500) для 5-8@
Номер кнопки в весах Целое
Пищевая ценность Строка(1500)
Изготовитель Строка(1500)
Имя файла логотипа типов сертификации Строка(255)

Кнопки "Импорт" и "Экспорт" позволяют импортировать и экспортировать шаблоны полей данных.
    5. Текст java-скрипт.
    Поле "Текcт java- скрипт" позволяет обрабатывать файлы, используя возможности языка JavaScript. Для работы с именем файла необходимо использовать переменную fileName, для работы с текстом файла необходимо использовать                    переменную fileText. Все остальные используемые переменные и структуры должны объявляться и использоваться согласно синтаксису языка JavaScript.

Импорт. Работа с данными.

Удаление товаров
Для удаления товаров необходимо добавить поле «действие» в список полей файла в разделе «формат файла». Для этого поля (если оно добавлено) было жестко зафиксировано положение на первом месте

В самом csv-файле для удаления товара должны быть указаны поля в следующем порядке:

   1. Действие =1
   2. Номер PLU
   3. Номер отдела (можно не указывать, тогда будет использоваться отдел по умолчанию)

Примеры строк в csv-файле:

   1;12345678
   1;87654321;2

Действие =0 используется для добавления товаров, порядок последующих полей определяется настроенным списком полей файла.

Добавление категорий
Для добавления новой категории товаров необходимо добавить поле «действие» в список полей файла в разделе «формат файла».
В самом csv-файле должны быть указаны поля в следующем порядке:
1. Действие =2
2. Номер категории
3. Наименование категории
4. Номер отдела (можно не указывать, тогда будет использоваться отдел по умолчанию)
5. Описание категории (можно не указывать)
6. Порядок категории (можно не указывать)
7. Путь к картинке (можно не указывать)
Примеры строк в csv-файле:
2;1;Новая категория
2;2;Новая категория2;20
2;3;Новая категория3;;Описание категории
Удаление категорий
Для удаления категории товаров необходимо добавить поле «действие» в список полей файла в разделе «формат файла».
В самом csv-файле должны быть указаны поля в следующем порядке:
1. Действие =3
2. Номер категории
3. Номер отдела (можно не указывать, тогда будет использоваться отдел по умолчанию)
Примеры строк в csv-файле:
3;1
3;2;20
3;3

Загрузка картинок в весы
Для загрузки картинок в весы, необходимо, чтобы
В csv-файле были заполнены соответствующие поля ImageFilename, LabelImage для товаров или соответствующее поле для категорий.
В папке с csv-файлом должна быть папка image_product, в которой должны располагаться файлы картинок с именами, идентичными предоставленным в 1-ом пункте.
Картинки запишутся в БД вместе с товарами/категориями. При отсутствии файлов или их неверном именовании, товар/категория попадет в лог с ошибками и не попадет в очередь на загрузку в весы.

Загрузка из XML-файлов
Загрузка данных из XML происходит автоматически при установке расширения файла «*.xml». Важно при этом верно указать кодировку файла, например, в имеющемся у нас примере кодировка UTF-16.
Обязательность остается прежняя. Неизвестные элементы и атрибуты XML игнорируются.

Импорт. Настройки импорта.

Общие положения о импорте:

В процессе импорта служба rbs-service периодически (1 раз в минуту по умолчанию, данный параметр можно изменить) опрашивает ресурс, предназначенный для файлов импорта, на появление новых файлов. Простейшие примеры файлов можно посмотреть в папке Examples в директории с уставленным ПО.

Если обнаружен файл, служба начинает обработку, в том случае, если файл успешно обработан и данные переданы весовому загрузчику, служба удаляет или перемещает файл, в зависимости от настройки.

Если файл не удалось обработать, служба удаляет или перемещает файл, в зависимости от настройки, в мониторинг по файлам или мониторинг по весам записывается информация об ошибке.

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

Настройки импорта позволяют указать системе, какие файлы получать для загрузки данных в весы и где их брать:

 Рис.23 Настройки импорта

Настройки импорта включают в себя:

  1. Маску файла. Службой будут обрабатываться только файлы, соответствующие маске.
  2. Кодировка. Та кодировка, в которой записаны обрабатываемые файлы. Обратите внимание, что указание верной кодировки файла является обязательным условием корректной работы приложения.
  3. Размещение файлов. Ресурс, на котором размещаются данные, нажмите на значок папки, чтобы выбрать размещение. В случае, если ресурс является сетевым или FTP (ресурс начинается на "ftp://":ftp:// ), то необходимо указать логин и пароль, противном случае - оставьте эти поля пустыми                                              
  4. Действия с файлом после обработки и при ошибке.

С помощью чекбоксов можно выбрать варианты, что делать с файлом в случае успешной обработке и при ошибке.

  1. Удалить - файл будет удален.
  2. Переместить - файл будет перемещен в указанное расположение. Аналогично, если ресурс является сетевым или FTP (ресурс начинается на "ftp://":ftp:// ), то необходимо указать логин и пароль, противном случае - оставить эти поля пустыми.

Кнопка "Сохранить" - сохраняет настройки импорта.

Кнопка "Отменить" - отменяет изменения.

Вкладка "База Данных".

Во вкладке база данных отображаются параметры подключения БД Scales:

           Рис.24 Вкладка база данных         

Прочие параметры:

  • Хранить логи не более указанного кол-ва дней. Логи страше будут удалены.
  • Интервал опроса файла - указать интервал, для опроса файла с товарами; не рекомендуется указывать менее 60 секунд.           

Обратите внимание, что через клиентское приложение параметры подключения к БД изменить невозможно. Если это необходимо, то изменяйте файл config.conf.