Программа графического интерфейса Agami ID

Предисловие

Руководство администратора/пользователя.

Данная инструкция предназначена для администратора и пользователя программы графического интерфейса Agami (далее Agami ID).

Общая информация о программе

1. Назначение и функциональные возможности Agami ID

Основная функция программы - управление видимыми экранными объектами на терминале и управление параметрами оплаты. Данная программа позволяет изменять структуру меню, изображение фона, кнопок, текста и т.д., без изменения кода программы (все изменения будут прописываться в код автоматически).

Функциональные возможности программы Agami ID:

изменение структуры отображаемых объектов;

добавление и удаление изображений и звуков;
управление текстовым отображением;
управление параметрами оплаты и платежа:
- изменение комиссии за платеж;
- установка пороговой суммы;
- изменение информации по платежу на чеке и т.д.

2. Установка и запуск программы

Программа графического интерфейса Agami_ID входит в пакет программного обеспечения для конфигурации терминалов Xenus. Работать с программой можно на компьютере и на терминале. Для запуска программы Agami ID необходимо запустить файл. InterfaceDesigner.exe.

Работа с программой

Главное меню содержит команды для управления основными функциями программы. При выборе любого пункта меню оно раскрывается на подпункты (команды).

3. Меню «Файл»

Меню «Файл» включает в себя команду «Открыть», команду «Сохранить» и команду «Выход».

Для работы с программой необходимо открыть конфигурационный файл PinicolaGui.exe.config или файл PinicolaGui.exe, при открытии которого программа автоматически найдет файл PinicolaGui.exe.config. Выбор файла происходит с помощью меню «Файл» и команды «Открыть». После открытия файла программа готова к работе.

Внимание
Выбор конфигурационного файла является необходимым условием для работы с программой.
С помощью команды «Сохранить» происходит сохранение изменений в конфигурационный файл.
С помощью команды «Выход» и с помощью кнопки в правом углу основного окна осуществляется выход из программы Agami ID.

4. Меню «Редакторы»

Меню «Редакторы» содержит команды для редактирования и отображения ресурсов, провайдеров и меню. Каждая команда открывает диалоговое окно, в котором Вы можете произвести необходимые настройки.

4.1 Редактирование ресурсов

Команда «Редактор ресурсов» предназначена для управления изображениями и звуками. При выборе команды открывается окно редактирования изображений и звуков.

Рисунок 1. Окно редактирования ресурсов

В открывшемся окне Вы можете посмотреть изображения и прослушать звуки, которые используются или могут быть использованы в графическом интерфейсе терминала. При выборе одного из ресурса, информация, соответствующая данному изображению или звуку, отображается в области Изображение и в области Ресурс. Ресурсы объекта ( «Имя»/«Тип»/«Файл») можно изменять.

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

Для добавления нового изображения или звука необходимо нажать кнопку «Добавить». В окне редактора ресурсов появится новый объект с именем Image_Х, где х- порядковый номер объекта по умолчанию. Изменить имя объекта, назначить тип и определить файл объекту можно в соответствующих полях окна.

Поле «Имя» является обязательным к заполнению. Название ресурса (изображения или звука) должно быть уникальным, иначе программа выдаст сообщение об ошибке, с указанием того, что данное имя уже существует.
В поле «Тип» необходимо задать тип объекта (изображение или звук).
В поле «Файл» с помощью кнопки выбора необходимо определить объекту файл изображения или файл звука, который в дальнейшем отобразится в области Изображение. Для этого необходимо нажать на кнопку и в открывшемся окне выбрать файл с изображением или звуком.

Для удаления объекта необходимо выбрать изображение или звук в окне редактора ресурсов и нажать кнопку «Удалить». На экране появится запрос подтверждения удаления. После нажатия кнопки «ОК» выбранный объект будет удален.

Сохранение настроек осуществляется с помощью команды «Сохранить» в меню «Файл» и при запуске тестового окна с помощью команды «Запуск!». Все изменения сохраняются в файл Interface.xml.

4.2 Редактирование меню

Команда «Редактор меню» предназначена для редактирования меню, которое отображается на экране терминала. При выборе команды открывается окно редактирования меню.

Рисунок 2. Окно редактирования меню

«Дерево меню» - это иерархическая структура объектов, которая отображает порядок расположения экранов/провайдеров/групп на экране терминала. За каждым объектом в дереве стоит кнопка объекта (например, кнопка провайдера МТС, кнопка группы GroupTV, кнопка открытия экрана screen_Pause и т.д.). Исключение составляется корневой объект (root).

Объекты бывают четырех типов:

корневой объект;
экранные объекты;
объекты провайдеров;
объекты групп.

Объекты в дереве меню можно перемещать по своему усмотрению. Для этого необходимо выбрать объект в дереве и при нажатой правой кнопки мыши переместить объект. Необходимо помнить, что имена объектов должны быть уникальными в пределах одной ветви дерева, иначе программа (при запуске тестового экрана с помощью команды «Запуск!») выдаст сообщение об ошибке в работе терминала.

Т.к. за каждым объектом в дереве меню стоит кнопка объекта (кроме корневого объекта root), то от расположения и количества объектов в дереве меню зависит расположение и количество кнопок в экранном меню терминала. Рассмотрим на примере расположение объектов в дереве и расположение кнопок на экране терминала.

Пример 1. Если объектов в дереве до 8

Если в дереве меню создано восемь или менее объектов, кнопки, которые соответствуют данным объектам, разместятся на дисплее монитора в указанном порядке (см. пример 1). Изображения кнопок можно задать при создании или редактировании каждого объекта в окне редактора меню ( рис. 2).

Пример 2. Если объектов в дереве более 8

Если в дереве меню создано более восьми объектов, расположение кнопок разбивается на несколько экранов. На каждом экране меню будет по шесть кнопок объектов и кнопки «Продолжить»/«Назад», с помощью которых происходит перемещение между экранами.

Замечание

Данные правила распределения кнопок действительны для корневой ветви дерева и для ветвей групп.

Сохранение настроек осуществляется с помощью команды «Сохранить» в меню «Файл» и при запуске тестового окна с помощью команды «Запуск!».

4.2.1 Настройка главной страницы меню (корневого объекта)

Корневой объект представляет собой главную страницу меню, на которой расположены остальные объекты (экранные объекты, объекты провайдеров, объекты групп). Корневой объект имеет имя (см. рис. 3) и дополнительные параметры. Кнопка у корневого объекта отсутствует.

К дополнительным параметрам объекта относятся: баннер, изображения в заголовке, фон и текст (см. рис. 3 и Приложение 1, рис. 1).

Рисунок 3. Параметры главной страницы меню

Поле Имя предназначено для отображения имени объекта, которое можно изменять. Для этого необходимо выбрать в контекстном меню объекта команду «Переименовать».
В поле «Идентификатор» необходимо ввести глобально уникальный идентификатор провайдера, который определен в окне редактора провайдеров. Идентификатор провайдера можно ввести вручную или скопировать из редактора провайдеров с помощью кнопки открытия окна .
При определении идентификатора корневому объекту или группе все настройки для данной группы перейдут к объектам, которые вложены в корневой объект (например, объекту МТС, Билайн, Мегафон, GroupMobile и т.д.) Если только у вложенных в корневую группу объектов не были определены другие идентификаторы со своими настройками. Т.е. настройки каждого провайдера/группы/экрана имеют приоритетное значение, а настройки корневого объекта спускаются к провайдерам/группам/экранам, только в том случае, когда у них не были заданы свои настройки (не задан идентификатор, не заполнены поля). В стандартной поставке идентификатор для корневого объекта берется из провайдера с именем «Настройки по умолчанию».
В поле Входное событие можно ввести имя действия, которое произойдет при входе на главную страницу терминала. Данное действие прописывается в файле скрипта ( script.js). Входное событие главной страницы может пересекаться с выходным событием другого объекта. В данном случае вызываются оба события.
В поле Выходное событие можно ввести имя действия, которое произойдет при выходе с главного экрана. Данное действие прописывается в файле скрипта ( script.js). Выходное событие главной страницы может пересекаться с входным событием другого объекта. В данном случае вызываются оба события.
В поле Баннер можно указать имя изображения с баннером, который будет отображаться на главной странице меню. Изображение можно ввести вручную или скопировать имя изображения из редактора ресурсов (см. раздел 4.1 Редактирование ресурсов). Ввод нескольких изображений через запятую, позволяет показывать изображения на экране терминала, через заданный промежуток времени. Время задается в миллисекундах в конце данного поля через двоеточие. Если значение не указано или не является числом, то используется значение по умолчанию в 1000 мс, определенное в файле скрипта ( script.js).
В поле Изображения в заголовке можно указать имена изображений, которые будут отображаться на главной странице меню (см. Приложение 1, рис. 1). Изображения можно ввести вручную или скопировать имена изображений из редактора ресурсов (см. раздел 4.1 Редактирование ресурсов). Ввод нескольких изображений через запятую, позволяет показывать изображения на экране терминала, через заданный промежуток времени. Время задается в миллисекундах в конце данного поля через двоеточие. Если значение не указано или не является числом, то используется значение по умолчанию в 1000 мс, определенное в файле скрипта ( script.js).
В поле Фон необходимо указать имя изображения с фоном. Изображение можно ввести вручную или скопировать имя изображения из редактора ресурсов с помощью кнопки открытия окна .

Внимание

Для отображения баннера, фона и изображения в заголовке необходимо, чтобы используемые изображения с параметрами были определены в редакторе ресурсов (см. раздел 4.1 Редактирование ресурсов). Проверить целостность файлов можно при помощи команды «Проверка ресурсов».

В поле Текст с помощью кнопки выбора можно указать текстовый файл, который в дальнейшем отобразится на главном экране меню (см. Приложение 1, рис. 1). Путь к текстовому файлу может быть относительным или абсолютным.

4.2.2 Редактирование и создание экрана, провайдера и группы

Объекты экранов/провайдеров/групп располагаются в дереве меню. Существует возможность создать новый объект в дереве или отредактировать уже существующий.

Для того чтобы добавить новый объект, необходимо щелкнуть правой кнопкой мыши по группе в дереве меню (корневой группе root или другой группе в дереве меню) и выбрать команду «Создать» (Экран/Провайдер/Группа). В дереве меню появится созданный объект, который будет иметь имя по умолчанию (Screen/Provider/Group).

Экранный объект (Screen) представляет собой кнопку на экране терминала, по нажатии на которую открывается дополнительное окно (например, окно рекламной акции).

Рисунок 4. Редактирование экранного объекта

Поле Имя предназначено для отображения имени объекта, которое можно изменять. Для этого необходимо выбрать в контекстном меню объекта команду «Переименовать». Имена объектов должны быть уникальными в пределах одной ветви дерева, иначе программа (при запуске тестового экрана с помощью команды «Запуск!») выдаст сообщение об ошибке в работе терминала.
В поле Идентификатор необходимо ввести глобально уникальный идентификатор объекта, который используется для опознания экранного объекта в файле Interface.xml.
В поле Входное событие можно ввести имя действия, которое произойдет при нажатии на кнопку экрана. Данное действие прописывается в файле скрипта ( script.js). Входное событие экрана может пересекаться с выходным событием другого объекта. В данном случае вызываются оба события.
В поле Выходное событие можно задать имя действия, которое будет происходить при выходе с окна экрана. Данное действие прописывается в файле скрипта ( script.js). Выходное событие экрана может пересекаться с входным событием другого объекта. В данном случае вызываются оба события.
В полях Нормальное изображение, Нажатое изображение, Неактивное изображение необходимо указать имена изображений с кнопками, которые потом будут отображаться на экране терминала. Изображения можно ввести вручную или скопировать имена изображений из редактора ресурсов с помощью кнопки открытия окна .

Объект провайдера (Provider) представляет собой кнопку провайдера на экране терминала, по нажатии на которую открывается окно ввода номера.

Рисунок 5. Редактирование объекта провайдера

Поле Имя предназначено для отображения имени объекта, которое можно изменять. Для этого необходимо выбрать в контекстном меню объекта команду «Переименовать». Имена объектов должны быть уникальными в пределах одной ветви дерева, иначе программа (при запуске тестового экрана с помощью команды «Запуск!») выдаст сообщение об ошибке в работе терминала.
В поле «Идентификатор» необходимо ввести глобально уникальный идентификатор провайдера. Идентификатор можно ввести вручную или скопировать из редактора провайдеров с помощью кнопки открытия окна .
В поле Входное событие можно ввести имя действия, которое произойдет при нажатии на кнопку провайдера. Данное действие прописывается в файле скрипта ( script.js). Входное событие провайдера может пересекаться с выходным событием другого объекта. В данном случае вызываются оба события.
В поле Выходное событие можно задать имя действия, которое будет происходить при выходе с любого окна провайдера в другие окна, которые не имеют отношения к данному провайдеру. Данное действие прописывается в файле скрипта ( script.js). Выходное событие провайдера может пересекаться с входным событием другого объекта. В данном случае вызываются оба события.
В полях Нормальное изображение, Нажатое изображение, Неактивное изображение необходимо указать имена изображений с кнопками, которые потом будут отображаться на экране терминала. Изображения можно ввести вручную или скопировать имена изображений из редактора ресурсов с помощью кнопки открытия окна .

Объект группы (Group) представляет собой кнопку группы на экране терминала, по нажатию на которую открывается экран с другими объектами (экранами, провайдерами, группами), если они были созданы в данной группе.

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

Поле Имя предназначено для отображения имени группы, которое можно изменять. Для этого необходимо выбрать в контекстном меню объекта команду «Переименовать». Имена объектов должны быть уникальными в пределах одной ветви дерева, иначе программа (при запуске тестового экрана с помощью команды «Запуск!») выдаст сообщение об ошибке в работе терминала.
В поле «Идентификатор» необходимо ввести глобально уникальный идентификатор, который определен в окне редактора провайдеров. Идентификатор провайдера можно ввести вручную или скопировать из редактора провайдеров с помощью кнопки открытия окна .
При определении идентификатора провайдера группе все настройки данного провайдера перейдут к объектам, которые вложены в группу. Если только у вложенных в группу объектов не были определены другие идентификаторы со своими настройками. Т.е. настройки вложенных в группу объектов имеют приоритетное значение, а настройки группы спускаются к вложенным объектам, только в том случае, когда у них не были заданы свои настройки (не задан идентификатор, не заполнены поля). В стандартной поставке, идентификатор для группы берется из провайдера с именем «Настройки по умолчанию для ...».
В поле Входное событие можно ввести имя действия, которое произойдет при нажатии на кнопку группы. Данное действие прописывается в файле скрипта ( script.js). Входное событие группы может пересекаться с выходным событием другого объекта. В данном случае вызываются оба события.
В поле Выходное событие можно задать имя действия, которое будет происходить при выходе с окна группы. Данное действие прописывается в файле скрипта ( script.js). Выходное событие группы может пересекаться с входным событием другого объекта. В данном случае вызываются оба события.
В полях Нормальное изображение, Нажатое изображение, Неактивное изображение необходимо указать имена изображений с кнопками, которые потом будут отображаться на экране терминала. Изображения можно ввести вручную или скопировать имена изображений из редактора ресурсов с помощью кнопки открытия окна .
Дополнительные параметры группы, а точнее параметры окна группы, которое будет открываться после нажатия на клавишу группы, описаны в разделе 4.2.1 Настройка главной страницы меню (корневого объекта).

4.3 Редактирование и создание провайдеров

Команда «Редактор провайдеров» предназначена для настройки списка провайдеров. При выборе команды открывается окно редактирования провайдеров.

Рисунок 7. Окно редактирования провайдеров

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

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

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

Для добавления нового провайдера необходимо нажать кнопку «Добавить». В окне редактора ресурсов появится новый объект с именем Провайдер. Изменить настройки нового провайдера или уже существующего можно в соответствующих полях окна.

В поле Идентификатор провайдера необходимо ввести глобально уникальный идентификатор провайдера, который определен на сервере.
В поле Имя провайдера можно изменить имя провайдера. Данное имя используется в чеке, который выдается клиенту после оплаты (см. Приложение 1, рис. 3).
В поле Изображение можно указать имя изображения в заголовке (см. Приложение 1, рис. 1), которое будет отображаться на терминале при работе с данным провайдером. Имя можно ввести вручную или скопировать из редактора ресурсов с помощью кнопки открытия окна редактора .
В поле Регулярное выражение задается образец строки регулярного выражения (образец номера телефона, контракта, договора и т.д). Все введенные на экране терминала цифры будут проверяться на совпадение с заданным в поле регулярным выражением. В случае совпадения, пользователь сможет перейти на экран оплаты. В противном случае, будет возникать окно ошибки с предупреждением о неверном номере. Существует возможность проверить заданное регулярное выражение в окне редактора провайдеров. Для этого необходимо нажать на кнопку и в открывшемся окне ввести тестовый номер телефона/контракта/договора и др.

Закладка «Оплата»

Набор полей Оплата определяет денежную сумму (комиссию), которую заплатит клиент за пользование услугами терминала. Комиссия бывает процентная - взимается только процент с внесенной суммы. Заполняется поле Комиссия (%). Смешанная комиссия - взимается процент, но не менее суммы определенной в поле Минимальная комиссия. Заполняются поля Комиссия (%) и Минимальная комиссия. Пороговая комиссия - взимается процент в зависимости от порогового значения внесенной суммы. Заполняются поля Комиссия (%), Минимальная комиссия и Пороговая сумма.

Рисунок 8. Окно редактирования провайдеров. Закладка «Оплата»

В поле Минимальная сумма оплаты задается минимальная сумма денежных средств, которую необходимо внести пользователю для пополнения счета. Если пользователь внесет меньшее количество денег, то платеж выпадет в ошибку. Рекомендуется определить в дополнительных параметрах окно предупреждение, если указанная в поле сумма больше 10 руб. (см. поле Окно предупреждения).
Поле Комиссия (%) является обязательным к заполнению. В поле задается процент, который вычитается из внесенной суммы. Если комиссия взиматься не будет, то в поле задается нулевое значение.
В поле Минимальная комиссия задается сумма минимальной комиссии в денежных единицах. Если сумма вычитаемой комиссии (определенная процентом в поле Комиссия (%)) меньше суммы в данном поле, то взимается сумма, указанная в поле Минимальная комиссия. Если сумма больше, то взимается только процент, указанный в поле Комиссия (%).
В поле Пороговая сумма задается пороговая сумма в денежных единицах. Если внесенная клиентом сумма меньше порога, указанного в данном поле, то берется фиксированная сумма вычета (определенная полем Минимальная комиссия). Если больше, то взимается только процент, указанный в поле Комиссия (%).
В поле Текст комиссии можно ввести текст, который будет отображаться на экране оплаты (см. Приложение 1, рис. 2) и на чеке (см. Приложение 1, рис. 3).
В поле Тип комиссии с помощью кнопки выбора из списка необходимо выбрать метод вычисления комиссии. Данное поле является обязательным к выбору.

Закладка «Платеж»

Рисунок 9. Окно редактирования провайдеров. Закладка «Платеж»

Поле Описание платежа предназначено для ввода текста описания платежа, который будет отображаться на экране оплаты поставщика услуг (см. Приложение 1, рис. 2).
Поля Параметр платежа 1 и Параметр платежа 2 предназначены для ввода текста, который будет отображаться на экране оплаты поставщика услуг (см. Приложение 1, рис. 2).
Поля Параметр чека 1 и Параметр чека 2 предназначены для ввода текста, который будет отображаться на чеке (см. Приложение 1, рис. 3).

Закладка «Дополнительно»

Рисунок 10. Окно редактирования провайдеров. Закладка «Дополнительно»

При выставлении флага в опции Окно предупреждения, перед экраном ввода номера всплывает окно предупреждение. В поле можно указать текстовый файл с предупреждением. Имя файла можно ввести с помощью клавиатуры или выбрать с помощью кнопки . Рекомендуется выставить флаг в опции, если минимальная сумма оплаты больше 10 руб. (минимальная сумма выставляется в поле Минимальная сумма оплаты).
Поля Левое сообщение, Правое сообщение и Сообщение в заголовке предназначены для ввода текста, который будет отображаться на экране ввода номера поставщика услуг (см. Приложение 1, рис. 4). В случае пустых полей, используется текст по умолчанию для всех мобильных операторов. В полях указываются текстовые файлы с сообщениями. Имена файлов можно ввести с помощью клавиатуры или выбрать с помощью кнопки .
В поле Формат номера задается представление отформатированного номера. Т.е. визуальное отображение номера на чеке, на экране оплаты и на экране неверного номера. Под каждой решеткой подразумевается введенная цифра номера. Если решеток меньше чем введенных цифр, то на чеке, на экране оплаты и на экране неверного номера не будут отображаться остальные цифры (см. пример в Приложении 2, «Пример визуального отображения формата номера»).
В поле Интервалы номера задается количество ячеек для ввода номера на экране терминала и задаются интервалы между ячейками. Один интервал равен одному пикселю. Первый заданный интервал - это интервал между первой и второй ячейкой. Во втором поле можно сразу задать общее количество ячеек, но интервалы между ними установятся по умолчанию в 8 интервалов (8 пикселей). (см. пример в Приложении 2, «Пример визуального расположения ячеек для ввода номера»).
В поле Минимальная длина номера можно задать нижнюю границу длины номера, который вводится на экране ввода номера. Т.е. количество цифр, которые необходимо ввести пользователю для перехода на следующий экран. После ввода минимального количества цифр, на экране станет активна кнопка «Продолжить». Задавать значение рекомендуется, когда номер имеет разное количество цифр, например, от 5 до 12 цифр. В случае пустого поля, минимальная длина номера равна количеству ячеек для ввода номера.
В поле Обработчик запроса необходимо задать имя обработчика, которым будет обрабатываться запрос на оплату. Вы можете использовать свой обработчик или задать имя существующего. В файле скрипта (script.js) прописано три обработчика: мобильный обработчик - handler_CreateMobilePaymentRequest, немобильный обработчик - handler_CreateCustomPaymentRequest, стрим обработчик - handler_CreateStreamPaymentRequest. В случае пустого поля, обработчик выбирается по умолчанию.

5. Меню «Инструменты»

Меню «Инструменты» включает в себя команду «Проверка ресурсов», которая открывает окно (рис. 8) проверки целостности файла Interface.xml. В открывшемся окне можно проверить физическую доступность файлов, используемых в файле Interface.xml в блоке описания экранов и в блоке описания редактора ресурсов. Проверяется наличие файлов изображений, текстовых файлов и музыкальных файлов, которые используются в графическом интерфейсе. С помощью кнопок «Запуск!» и «Очистить» можно запустить проверку или очистить окно проверки наличия файлов.

Рисунок 11. Окно проверки наличия файлов

Validating: file:///C:/Documents and Settings/Interface Designer Distr/011107/Interface Designer Distr/Interface/Interface.xml

В данной строке указан путь к проверяемому файлу Interface.xml.

'#document/Interface/Resources/Sound[@name='resource_152']/@file' not found: ''

В данной строке указан путь к месту в файле Interface/Resources/Sound, где определен звуковой ресурс ( Sound) с именем 'resource_152', но сам файл не был найден not found: ''.

'#document/Interface/Resources/Image[@name='resource_158']/@file' not found: 'D:/Документы/у1/other1.jpg'

В данной строке указан путь к месту в файле Interface/Resources/Image, где определен ресурс изображения ( Image) с именем resource_158, но сам файл изображения other1.jpg по указанному пути D:/Документы/у1/ не был найден.

''#document/Interface/Screen[@name='screen_Welcome']/TextBox[@name='textbox_Welcome']/@file' not found: '_Welcome.txt'

В данной строке указан путь к месту в файле Interface/Screen, на экран с именем screen_Welcome, где в текстовом блоке TextBox с именем textbox_Welcome по указанному пути не найден файл _Welcome.txt.

Замечание

При закрытии окна результаты проверки не сохраняются.

6. Команда «Запуск!»

Внимание

При запуске команды «Запуск!» все изменения вступают в силу.

Команда «Запуск!» запускает тестовое окно, в котором имитируется работа пользователя с терминалом. В тестовом окне можно посмотреть все изменения графического интерфейса. Выход из тестового окна осуществляется с помощью сочетания клавиш «Alt+F4».