Standard manual

Обзор

Область применения

Этот документ предоставляет документацию по управлению и использованию демонстрационного сайта Auto.MstarProject, подробное описание находится по адресу http://www.mstarproject.com/?action=tecdoc_mysql_site.

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

Цели

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

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

Версия пакета стандарт

Текущая версия документации и пакета стандарт - 4.5.1. Версия текущего сайта выводится в закрытой цмс mpanel - вверху в виде {$ProjectName} MPanel v{$CurrentVersion}. Пример для текущего демо проекта - Auto.Mstarproject - MPanel v4.5.1

Подробнее о выпущенных версиях и внесенных в них изменения можно прочитать на отдельной странице http://manual.mstarproject.com/index.php/Auto.Mstarproject_-_Release_notes

Документация

Клиентская часть

Модуль регистрации и профайл

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

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

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

Текст данного уведомления хранится в шаблоне с кодом confirmation_letter. Вы должны его отредактировать в модуле >>Содержание>Шаблоны ЕмПанели , подставив данные своей компании. Подробнее, как пользоваться шаблонами в ЕмПанели рассказано в модуле Менеджер шаблонов.

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

ЕмПанель>>Пользователи>Заказчик

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

Свои данные и настройки пользователь может отредактировать самостоятельно в своем Профиле:

Кроме того, что заказчик может зарегистрироваться сам через форму регистрации - он может создать вин запрос, оформить заказ без регистрации или для заказчика вин запрос может оформить менеджер. В таких случаях создается т.н. "временная" учетная запись, к примеру логин a62392 (пароль: d39102). Чтобы заказчик смог воспользоваться такой учетной записью - нужно сменить временный логин на постоянный, пароль можно оставить без изменений.

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

Управление заказами и корзиной

Модуль состоит из таких частей:

1) http://manual.mstarproject.com/images/4/4e/Auto_cart1.jpg

Корзина заказчика, в пределах которой он оперделяется, что покупать

http://auto.mstarproject.com/?action=cart_cart

2) http://manual.mstarproject.com/images/8/8f/Auto_cart2.jpg

Оформление заказа в нсколько шагов с указанием данных на каждом шаге.

3) http://manual.mstarproject.com/images/5/5c/Auto_cart3.jpg

Модуль списка оформленных заказов

http://auto.mstarproject.com/?action=cart_package_list

4) http://manual.mstarproject.com/images/f/fc/Auto_cart4.jpg

Модуль отслеживания движения (статусов) по заказанным деталям в работе.

http://auto.mstarproject.com/?action=cart_order

Поиск по коду с использованием кроссов

Предназначен для поиска запчастей по заданному коду. Для поиска необходимо в форму поиска

ввести нужный код. Cистема подберет запчасти найденные по точному совпадению кода и по кроссам данного кода.

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

Менеджерская часть

Загрузчик цен различных поставищиков

Данный модуль позволяет добавлять цены в систему под учетной записью менеджера Для добавления цен с использованием профайла по умолчанию необходимо

1. Создать поставщика обязательно установив валюту цен и запомнить его логин
2. Зайти на страницу загрузки цен
3. Cкачать пример файла
   
4. Заполнить соответствующие столбцы в файле
5. Загрузить данные, после успешной загрузки (данные появятся на экране)
6. Проверить префиксы - установить соответствия брендов файла брендам системы
7. Установить цены, после установки цен данные будут перенесены в систему

Для добавления цен с использованием собственных профайлов необходимо

1. Создать поставщика обязательно установив валюту цен и запомнить его логин
2. Создать профайл
3. Переименовать файл согласно названия шаблона файла согласно правила: первые символы до подчеркивания должны соответствовать названию шаблона файла и заканчиваться знаком подчеркивания (пример default_new_provider.xls, default_.xls, default_price.xls)
4. Если файл больше 8 МБайт то его необходимо добавить в зип архив.
5. Зайти на страницу загрузки цен
6. В поле Путь к файлу : выбрать профайл, который вы создали, в поле Путь к файлу : выбрать файл (зип архив) соответствующий данному профайлу
7. Загрузить данные, после успешной загрузки (данные появятся на экране)
8. Проверить префиксы - установить соответствия брендов файла брендам системы
9. Установить цены, после установки цен данные будут перенесены в систему

При непредвиденном сбое или не обработанной ошибке в момент загрузки цен, последующая загрузка может прекратиться, и на экране будет ошибка Now is loading price (идет загрузка цен) Для возобновления загрузчика необходимо зайти в ЕмПанель>>Настройки>Константы и установить значение константы price:is_load = 0

Настройка профайлов цен

Для упрощения загрузки цен от разных поставщиков есть возможность под файл каждого поставщика создать свой профайл

На примере default приведена логика создания профайла.

Название шаблона файла: наименование файла до первого подчеркивания
Тип: для выбора типа файла (Excel, csv)
Кол-во листов (для Excel): для загрузки ексель файлов больше чем 1 лист
Поставщик или пусто : Выбор поставщика
№Колонки поставщика если поставщик пустой: Если не выбрать поставщика в колонке выше то необходимо задать колонку, в которую необходимо будет записать логин поставщика
Коефициетн: значение на которое будет умножена закупочная цена
Разделитель: для текстовых можно загружать с ; или tab
№ строки начала загрузки: начало загрузки файла
Название каталога или пустое: выбор бренда
№Колонки названия Производителя: если бренд не выбран необходимо указать колонку в которой будет название бренда
№Колонки кода запчасти:
№Колонки названия (РУС):
№Колонки названия (АНГ):
№Колонки минимального кол-ва:
№Колонки закупочной цены:
№Колонки поставки: колонка с термином доставки
№Колонки доступного кол-ва: колонка с остатками
№Колонки артикула поставщика:
№Колонки описания запчасти:
Кодировка: для текстовых файлов с разделителями необходимо задать кодировку файла обычно это или windows-1251 или UTF-8
Удалить перед вставкой: цены данного поставщика, которые были загружены в систему перед добавлением новых будут удалены.
Порядок: сортировка профилей.

Внутренние сообщения и уведомления

Модуль по сути является аналогом почты, только локальной для проекта. У человека может не быть почты, но ему нужны уведомления и возможность общаться внутри проекта. Также на акаунт заказчика высылается в автоматическом режиме уведомления, и чтобы был аргумент "Сообщение всегда доставлено" и не попало в спам, удалено антивирус фильтрами - мы его доставляем в личку.

Находится по адресу: http://auto.mstarproject.com/?action=message

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

http://manual.mstarproject.com/images/6/63/Auto_message1.jpg

Вместо адреса используются логины пользователей:

http://manual.mstarproject.com/images/d/d9/Auto_message2.jpg

http://manual.mstarproject.com/images/7/73/Auto_message3.jpg

Аналогичный модуль есть и в клиентской части.

Заказы

Модуль необходим для просмотра и управления заказами. http://auto.mstarproject.com/?action=manager_package_list
Заказ это набор заказанных запчастей, которые заказчик оформил за один раз. Может состоять из одной или более запчастей.
Модуль состоит из

• верхних ссылок для быстрой фильтрации заказов по статусам заказа

• основного фильтра

Который позволяет найти заказ по номеру заказа, логину заказчика, индексу заказчика, статусу заказа, производителю запчасти и коду запчасти

• таблицы заказов

В колонке "ИД" расположены ссылка на редактирование заказа которая ведет на форму редактирования заказа
В колонке "Дата / Клиент" расположены ссылки на сокращенную карточку клиента, дату оформления заказа и баланс заказчика.
В колонке "Код / Производитель/ Кол-во / Наименование " расположена краткая информация о заказанных запчастях данного заказа.
В колонке "Цена" стоимость запчастей и стоимость доставки по данному заказу.
В колонке "Сумма" общая стоимость всего заказа и признак об оплате данного заказа.

Форма редактирования заказа

Состоит из двух частей

• Шапка заказа

Позволяет отредактировать информацию о заказе: данные о клиенте, комментарий к заказу, информацию об оплате. Позволяет добавить скрытый комментарий для менеджера. Имеете ссылку на внесение оплаты по данному заказу.

• Таблица позиций заказа

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

Детали в работе

Модуль предназначен для работы со всеми позициями заказанными заказчиками. http://auto.mstarproject.com/?action=manager_order Предоставляет информацию и дает возможность изменять данные по запчастям, которые попали в заказы. Состоит из

• Панель быстрой смены статусов

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

• Заголовок таблицы (фильтр по позициям)

Содержит поля для поиска по
ЗК - номеру заказа
Заказчик - логину или части наименования заказчика
Производитель - производителю заказанной позиции
Код запчасти - коду заказанной позиции
Название - наименованию заказанной позиции
Поставщик - поставщику заказанной позиции
Дата - выбранному периоду за который делались заказы
Статус позиции - статусам позиций

• Таблици позиций

В колонке "#ЗК" расположены номер заказа, ссылка на быстрый фильтр по заказу и идентификатор позиции
В колонке "Заказчик" расположены баланс клиента, логин клиента, при наведении на логин появляется краткая карточка клиента, менеджер обслуживающий данного клиента
В колонке "Производитель" расположена информация о производителе.
В колонке "Код запчасти" расположен код заказанной позиции.
В колонке "Название" расположено название заказанной позиции,а так же ссылка на изменение данного названия.
В колонке "Поставщик" расположено наименование поставщика, а так же ссылка на изменение данного поставщика
В колонке "Цена" расположена цена заказанной позиции, и закупочная цена загруженная в систему.
В колонке "Кол./Итого" расположено кол-во и общая стоимость данной позиции, т.е. кол-во умноженной на цену одной позиции.
В колонке "Дата" расположена дата заказанной позиции
В колонке "Статус позиции" расположен текущий статус позиции и ссылка на историю изменения статусов по данной позиции
В последней колонке расположена ссылка на форму изменения статусов и дополнительной информации по позиции.

Форма изменения статуса позиции

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

Административная часть - цмс ЕмПанель

ЕмПанель - собственная разработка компании MstarProject, предназначенная для самостоятельного управления своим сайтом заказчиком и минимизировать обращения, а соответственно и потерю времени на общение "заказчик-программист".

ЕмПанель находится по адресу: http://auto.mstarproject.com/mpanel/login.php

login: demo_admin

password: demo

1) Основные настройки сайта хранятся в модуле "Константы"

ЕмПанель>>Настройки>Константы

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

2) Пользователи ЕмПанели - Администраторы хранятся отдельно от пользователей сайта. Подробнее об их управлении:

ЕмПанель>>Настройки>Администраторы

Администраторы, как и другие пользователи сайта имеют закрытые md5+salt пароли. История посещения и действий администраторов, также как и других типов пользователей, сохраняется в базе для последующего анализа, кто что и когда делал. Это модуля:

ЕмПанель>>Логи>Лог посещений
ЕмПанель>>Логи>Админ посещения

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

3) Для работы со страницами сайта предназначены 2 модуля:

ЕмПанель>>Содержание>Менеджер страниц

Менеджер страниц - нужен для управления страницами сайта: создание, изменение, удаление

Связь страницы в ЕмПанели со страницей на сайте осуществляется по полю "Код". То есть для того, чтобы написать текст на странице http://auto.mstarproject.com/?action=provider нужно создать страницу с таким же кодом ("provider") в Менеджере страниц.

Все страницы сайта представлены в виде дерева 3-х уровней. Первые два уровня показываются на первой странице модуля. Остальные страницы сайта 3-го уровня спрятаны по ссылке "Посмотреть айтемы".

Создана специальная группа страниц "Дополнительные страницы other_pages", в которую нужно добавлять различные служебные страницы, которые не отображены в меню, к примеру "Пользовательское соглашение".
Меню заказчика и меню менеджера можно расширять, добавляя страницы в группы "Меню заказчика customer_account" и "Меню менеджера manager_account" соответственно.

ЕмПанель>>Содержание>Редактор страниц

Редактор страниц - предназначен для редактирования текста созданной в Менеджере страницы. Также в Редакторе страниц есть файловый менеджер для загрузки картинок, ексель, пдф и других типов файлов на сервер.

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

Рекомендуем пользоваться только базовыми параметрами разметки и не использовать дополнительные, такие как "Размер текста" или "цвет текста/фона". Стили для сайта, созданные дизайнером могут некорректно работать вместе и могут конфликтовать со стилями самого редактора. В результате тексты становятся непредставительными.

"Источник" - очень полезная кнопка для продвинутых пользователей, которая позволяет проверить и исправить ошибки разметки в ручном режиме. Онлайн редакторы не идеальные и генерируют часто не валидный html код при частых изменениях одних и тех же блоков. В этом режиме также работает сохранение.
В модуле "загрузки картинок" на сервер лучше сразу создайте корректную структуру файлов, чтобы можно было потом понять, что и куда ложить.
Для копирования текстов из MS Word и других html редакторов используйте кнопку "Вставить из ворд", которая очищает вставляемый код от дополнительных тегов, которые могу сломать вашу страницу.

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

4) Управление т.н переводами - это три модуля "Сообщения, Тексты, Шаблоны". Они по сути однотипные, но разные по назначению.

Чтобы заказчик не просил "Поменяйте текст кнопки" или же "СРОЧНО!!! Смените заголовок таблицы, формы, поля ..." - программист ставит английский код, которые правится в модуле "Перевод сообщений". Нужный текст можно найти по "Содержанию" в фильтре в нижнем левом углу.

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

5) На сайте сохраняются все важные последовательности действий, время и авторы этих действий. Смс и письма отправляются через очередь:

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

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

Менеджер шаблонов

Работу модуля "Шаблоны" рассмотрим на примере первого документа, который получает каждый новый заказчик - это письмо "Подтверждения учетной записи" при регистрации. Код данного шаблона "confirmation_letter": по данному уникальному полю нужно находить и править документы на своем сайте. Данные по-умолчанию сохранены в базе для примера оформления каждого документа, а не для их использования на рабочем сайте.

ЕмПанель>>Содержание>Шаблоны

Логика работы шаблонов такая: в шаблоне указываются объект и поле объекта при редактировании или создании шаблона. Соответствующие объекты берутся из базы данных и подставляются данными в нужный шаблон. К примеру, если в шаблоне нужно вставить логин пользователя - то нужно написать вот такую конструкцию {$info.login}, где $info - объект, а login - поле этого объекта. Чаще всего объекты и поля уже доступны в шаблонах. Если каких-то объектов или полей не хватает - нужно написать комментарий с задание джиры - и программист обязан выписать все передаваемые в шаблон объекты и их поля.

В каждое письмо, отправляемое сервером сайта подставляется "Автоподпись" - Перевод текста с кодом "added_no_reply". Его также нужно отредактировать под свой сайт.

ЕмПанель>>Содержание>Перевод текстов

В итоге компиляции шаблона и данных получается письмо:

Кроме отправляемых автоматически писем - шаблоны также используются при генерации печатных форм документов и формировании страниц или блоков страниц. Но принцип везде одинаковый, также как и используемый синтаксис. На сайте уже есть базовый набор шаблонов уведомлений и документов, которые вы можете изменять (не ломая структуру, так как шаблон поломается). Расширять набор используемых шаблонов нужно через создание новых заданий в джире.

Управление группами поставщиков

ЕмПанель>>Пользователи>Группы поставщиков

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

Управление регионами поставщиков

ЕмПанель>>Пользователи>Группы поставщиков

Управление поставщиками

ЕмПанель>>Пользователи>Поставщики

Логин:
Название:
Описание: 1
Кодовое название:
Код:
Группа поставщиков: Задается группа поставщиков со своей наценкой
Регион поставщика:
Срок доставки: Задается срок доставки по умолчанию, будет выведен если не указан срок доставки специальный для запчасти
Валюта цен: Валюта в которой загружаются цены данного поставщика.
Страна:
Штат (область):
Город:
Индекс:
Компания:
Адрес:
е-Мейл:
Телефон:
Телефон 2:
Мобильный телефон:
Примечания:
Видимый: Поле которое отключается предложения данного поставщика из поиска запчастей
Тестовый?:
Участвует в аукционе:
Наш склад: Пометка поставщика которые является внутренним поставщиком
Подтвержденный:

Управление валютами

Скрытые (невизуальные) и системные модули

Скидки пользователей

Скидки пользователей работает по формуле: в момент определения цены берется максимальная из трех доступных скидок для пользователя. По-умолчанию доступны такие скидки, как: статическая, динамическая и групповая.
Итоговая скидка не может больше, чем константа "price:discount_max", значение которой по-умолчанию 10%. То есть если заказчику выставлена скидка больше чем 10%, то в модуле "прайс онлайн" будет использоваться скидка в 10%. Чтобы отменить работу скидок - можно выставить значение этой константы в 0.

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

ЕмПанель>>Пользователи>Группа заказчиков

Группа с ИД=1 назначается зарегистрированным пользователям по-умолчанию и если у этой группы есть скидка, то все зарегистрированные пользователи, в отличие от гостевого заказа, будут покупать продукт дешевле на размер этой скидки.

Статическая скидка назначается лично заказчику и не меняется со временем, она редактируется в модуле

ЕмПанель>>Пользователи>Заказчики

Динамическая скидка рассчитывается исходя из оборота денег за месяц (30 дней - константа в емпанели "discount:dynamic_discount_period_day"). Сами же динамические скидки для оборотов устанавливаются в модуле

ЕмПанель>>Пользователи>Динамические скидки

Исходя из этой таблицы, если у пользователя за 30 дней было пополнено денег более чем на 25 тысяч условных единиц базовой валюты - ему будет назначена динамическая скидка в 4%, если более 50 тысяч - 5%. Динамические скидки пересчитываются раз в день ночью для всех покупателей.