Non-virtual admin.
[stg.git] / doc / help / ch5.xml
1 <chapter xml:id="ch5">
2   <title>Описание работы с конфигуратором</title>
3   <para>Как и говорилось выше, конфигуратор предназначен для выполнения различных административных действий над клиентами и над некоторыми параметрами сервера.</para>
4   <para>
5         Общий вид окна конфигуратора при работе показан ниже:
6         <mediaobject>
7             <imageobject>
8                 <imagedata fileref="images/sgconfig-main.png" format="PNG"/>
9             </imageobject>
10         </mediaobject>
11     </para>
12   <para>В окне расположены: меню, кнопки быстрого доступа к элементам меню, таблица с информацией о клиентах, панель с дополнительной информацией о клиенте, панель состояния. Следует помнить что почти все команды, вызываемые из конфигуратора будут работоспособны в случае успешного входа на сервер. При этом в панели состояния изменится статус, и появиться имя пользователя, который вошел в систему:
13   <mediaobject>
14             <imageobject>
15                 <imagedata fileref="images/username.png" format="PNG"/>
16             </imageobject>
17         </mediaobject>
18   </para>
19   <para>Обзор меню:</para>
20   <itemizedlist mark="opencircle">
21     <listitem><para>Файл — Сохранить — команда сохраняет таблицу с клиентами в указанный текстовый файл по указанному пути.</para></listitem>
22     <listitem><para>Файл — Login… — команда, предназначенная для доступа на сервер. При этом выведется следующее окно, в котором необходимо ввести учетные данные администратора, как они заданы при вводе администратора:
23     <mediaobject>
24             <imageobject>
25                 <imagedata fileref="images/login.png" format="PNG"/>
26             </imageobject>
27         </mediaobject>
28     </para>
29     <para>В случае успешного входа конфигуратор отобразит список клиентов, и даст, в зависимости от ограничений администратора доступ к функциям. После первой установки и старта системы, по-умолчанию логин и пароль на вход равны admin и 123456 соответственно.</para>
30     </listitem>
31     <listitem><para>Файл — Logout… — команда, выполняющая выход из системы, при этом таблица клиентов очищается.</para></listitem>
32     <listitem><para>Файл — Печатать всех… — команда выводит предварительный просмотр списка клиентов с указанием трафика по направлениям.</para></listitem>
33     <listitem><para>Файл — Выход — выполняет выход из системы и закрытие окна конфигуратора.</para></listitem>
34     <listitem><para>Правка — Редактировать пользователя... — команда предназначена редактирования данных клиента (дублируется кнопкой
35     <mediaobject>
36             <imageobject>
37                 <imagedata fileref="images/user-key.png" format="PNG"/>
38             </imageobject>
39         </mediaobject>
40     ), при её вызове будет вызвано следующее окно:
41     <mediaobject>
42             <imageobject>
43                 <imagedata fileref="images/data-editor.png" format="PNG"/>
44             </imageobject>
45         </mediaobject>
46     </para>
47     <para>В данном окне отображаются все настройки клиента, так как они будут записаны в конфигурационный файл. Опции и настройки данного окна описаны выше. Все числовые величины должны разделяться только знаком «.» (точка), IP адреса разделяются символом «,» (запятая), если клиенту необходимо иметь доступ с любого IP адреса, то в это поле необходимо занести символ * (звёздочка). В нижней части окна расположена индивидуальная статистика клиента, её можно изменять, для этого необходимо два раза щелкнуть на подлежащему изменению числе, после редактирование подтвердить изменение кнопкой «Enter». Кнопка «?» предназначена для автоматического поиска свободного IP адреса из указанного в настройках диапазона:
48     <mediaobject>
49             <imageobject>
50                 <imagedata fileref="images/ip-search.png" format="PNG"/>
51             </imageobject>
52         </mediaobject>
53     </para>
54     <para>Признак «Заморожен» предназначен для того, чтобы на определенное время прекратить любые денежные действия со счетом клиента, при установке этого признака со счета клиента снимается сумма, указанная в тарифе. Для того чтобы увидеть пароль клиента, сгенерированный кнопкой «Сгенерировать пароль», необходимо нажать на кнопку «Показать пароль», при этом в первом окне пароля отобразится текущий пароль (через 10 секунд он сам исчезнет снова). Следует помнить что при записи пароли и в первом поле ввода и во втором должны совпадать, иначе система выведет предупреждение и не даст записать данные на клиента. Если данные после изменения успешно записаны, то будет выведено сообщение:
55     <mediaobject>
56             <imageobject>
57                 <imagedata fileref="images/information.png" format="PNG"/>
58             </imageobject>
59         </mediaobject>
60     </para>
61     <para>В случае изменения тарифа будет выведен вопрос о времени перевода клиента на новый вид тарифа:
62     <mediaobject>
63             <imageobject>
64                 <imagedata fileref="images/change-in-tariff-user.png" format="PNG"/>
65             </imageobject>
66         </mediaobject>
67     </para>
68     <para>Если был выбран вариант «Немедленно», то тариф применится к клиентскому аккаунту немедленно, иначе в случае выбора варианта «В следующем месяце» тариф применится с 1 числа следующего месяца автоматически, при этом строка с клиентом, у которого изменится тариф примет вид:
69     <mediaobject>
70             <imageobject>
71                 <imagedata fileref="images/tariff.png" format="PNG"/>
72             </imageobject>
73         </mediaobject>
74     </para>
75     <para>Т. е. в колонке «Тариф» появится запись двойного тарифа, где перед знаком «/» находится текущий, а после – тот тариф, который будет применен со следующего месяца. Следует учитывать что при переходе на другой тариф в течении месяца (выбрана опция «Немедленно») система пересчитает средства на счёте следующим образом: если в тарифе есть абонплата, то с переходом на новый тариф с клиента будет снята часть абонплаты от того тарифа с которого переходят и в конце месяца с него будет снята часть абонплаты от того тарифа на который перевели. Аналогично клиент получит только часть бесплатных Мб от того тарифа на который его перевели.</para>
76     </listitem>
77     <listitem><para>Правка - Добавить пользователя... – команда, позволяющая добавить нового клиента в систему (дублируется кнопкой
78     <mediaobject>
79             <imageobject>
80               <imagedata fileref="images/new-customer.png" format="PNG"/>
81             </imageobject>
82         </mediaobject>
83     ). При вызове этой команды будет выведено окно для заполнения свойств клиента:
84     <mediaobject>
85             <imageobject>
86               <imagedata fileref="images/create-new-user.png" format="PNG"/>
87             </imageobject>
88         </mediaobject>
89     </para>
90     <para>Обязательными к заполнению являются поля: логин, пароль и его подтверждение, IP-адрес(а), тарифный план. Остальные поля и опции  являются необязательными. В случае если какой то обязательный параметр не заполнен, система сообщит об ошибке и предложит ввести недостающие данные, если же все данные указаны верно, то система запишет нового клиента в систему. Также при добавлении нового клиента система выставит количество бесплатных Мб которое стоит в тарифе, установленном клиенту, пропорционально времени оставшемуся до обнуления статистики. Также с клиента будет снята абонаплата выставленная в тарифе пропорционально времени до конца месяца.</para>
91     </listitem>
92     <listitem><para>Правка - Удалить пользователя... – команда позволяющая удалить клиента из системы, при этом все клиентские настройки не удаляются физически на сервере, а переносятся в специальную папку /deleted_users.Команда дублируется кнопкой
93     <mediaobject>
94             <imageobject>
95               <imagedata fileref="images/delete-user.png" format="PNG"/>
96             </imageobject>
97         </mediaobject>.
98     При вызове этой команды будет вызвано подтверждение на удаление:
99     <mediaobject>
100             <imageobject>
101               <imagedata fileref="images/confirm-delete-user.png" format="PNG"/>
102             </imageobject>
103         </mediaobject>.
104     </para>
105     </listitem>
106     <listitem><para>Правка – Тарифные планы... – команда вызывающая редактор тарифных планов (дублируется кнопкой 
107     <mediaobject>
108             <imageobject>
109               <imagedata fileref="images/tariff-plans.png" format="PNG"/>
110             </imageobject>
111         </mediaobject>
112     ):
113     <mediaobject>
114             <imageobject>
115               <imagedata fileref="images/editor-rate-plans.png" format="PNG"/>
116             </imageobject>
117         </mediaobject>
118     </para>
119     <para>Цены вводятся через знак «/» - это разделение цены до/после перехода порога по направлению, если цена будет введена без знака «/», то она будет применена как к трафику до, так и после превышения одинаково. Порог устанавливается в поле «Порог (Мб)», если установлен признак «Без порога», то цена вводиться одна. В стоимость заморозки устанавливается сумма, которая будет снята с клиента при установке признака «Заморожен».</para>
120     <para>После изменения тарифного плана необходимо нажать кнопку «Сохранить» для записи данных. Измененный тарифный план начинает применяться сразу после записи.</para>
121     </listitem>
122     <listitem><para>Правка – Администраторы – команда, позволяющая изменять права администраторов и добавлять/удалять их. Дублируется кнопкой
123     <mediaobject>
124             <imageobject>
125               <imagedata fileref="images/key-admin.png" format="PNG"/>
126             </imageobject>
127         </mediaobject>
128     , при вызове команды будет выдано окно со списком текущих администраторов:
129     <mediaobject>
130             <imageobject>
131               <imagedata fileref="images/administrators.png" format="PNG"/>
132             </imageobject>
133         </mediaobject>
134     </para>
135     <para>Пароль и подтверждение пароля в целях безопасности не отображаются, при записи если оставить незаполненными поля пароля, то он изменен не будет. Для сохранения сделанных изменений необходимо нажать кнопку «Сохранить». В случае успешного сохранения данных администратора будет выведено сообщение:
136     <mediaobject>
137             <imageobject>
138               <imagedata fileref="images/inform-admin.png" format="PNG"/>
139             </imageobject>
140         </mediaobject>
141     </para>
142     <para>Если имела место какая-либо ошибка, сервер сообщит об ней.</para>
143     </listitem>
144     <listitem><para>Инструменты - Статистика – команда отображает общую статистику по направлениям, с визуальным обзором на диаграмме:
145     <mediaobject>
146             <imageobject>
147               <imagedata fileref="images/statistics.png" format="PNG"/>
148             </imageobject>
149         </mediaobject>
150     </para>
151     <para>При выборе вариантов внизу соответственно будет перерисована диаграмма. Также можно указать по каким клиентам показывать суммарную статистику: по всем или только по отфильтрованным, и какую собственно на диаграмме прорисовывать статистику.</para>
152     </listitem>
153     <listitem><para>Инструменты – Фильтр – команда позволяет отфильтровать текущую таблицу с данными о клиентах по заданному фильтру:
154     <mediaobject>
155             <imageobject>
156               <imagedata fileref="images/filter.png" format="PNG"/>
157             </imageobject>
158         </mediaobject>
159     </para>
160     </listitem>
161     <listitem><para>Инструменты - Разослать письма... – команда позволяет разослать письма указанным клиентам с сервера:
162     <mediaobject>
163             <imageobject>
164               <imagedata fileref="images/notification-letters.png" format="PNG"/>
165             </imageobject>
166         </mediaobject>
167     </para>
168     <para>В поля From, Subject заносятся электронный адрес отправителя и тема писем соответственно.</para>
169     <para>Кнопка «Все» позволяет выделить всех клиентов из списка, «Никто» - убирает выделение со всех в списке, «Должники» - выделяет клиентов, у которых баланс меньше нуля и превысил «Кредит», «Инверсия» - позволяет инвертировать выделение, т. е. все кто был помеченными станут непомеченными и наоборот. Кнопки «Загрузить шаблон» и «Сохранить шаблон» позволяют загружать исходный и сохранять текущий шаблоны соответственно. В «Подстановках» можно выбрать спец. Макросы, которые потом при отправке каждому клиенту заменяться на реальные для него цифры или информацию. Пример сохраненного шаблона:</para>
170 <programlisting numbering="unnumbered">
171     admin@my.net
172 Состояние счета
173 Уважаемый пользователь %name!
174
175 По состоянию на %date %time на вашем счету осталось %cash у.е.
176
177 Перекачано по миру %udload0
178 Перекачано по городу %udload1
179
180 С уважением, администрация сети my.net
181 </programlisting>
182     <para>Кнопка «Просмотр» позволяет просмотреть итоговое сообщение для выбранного клиента:
183     <mediaobject>
184             <imageobject>
185               <imagedata fileref="images/view-letter.png" format="PNG"/>
186             </imageobject>
187         </mediaobject>
188     </para>
189     <para>Следует помнить что для корректной рассылки писем в настройках необходимо указать SMTP сервер. Рассылка писем предусматривает сохранение и восстановление шаблонов.</para>
190     </listitem>
191     <listitem><para>Инструменты – Отправить сообщение – команда предназначена для отправки сообщений клиентам, в данный момент находящимся в OnLine или в OffLine (следует учитывать, что сообщение дойдет моментально только лишь в том случае, если клиент пользуется в данный момент авторизатором, если же клиент в данный момент находится в состоянии OffLine, то сообщение дойдет сразу же после первого подключения):
192     <mediaobject>
193             <imageobject>
194               <imagedata fileref="images/send-message.png" format="PNG"/>
195             </imageobject>
196         </mediaobject>
197     </para>
198     <para>При отправке сообщения можно задать пользователей, которым уйдет сообщение, интервал повторения сообщения в минутах, количество повторений, а также время в секундах, в течении которого окно с сообщением будет держаться на экране у пользователя.</para>
199     </listitem>
200     <listitem><para>Инструменты – Очистить таблицу пользователей – команда позволяет очистить таблицу клиентов и их статистики, однако следует понимать что таблица очищается только в окне конфигуратора, никакие данные на сервере изменены не будут.</para></listitem>
201     <listitem><para>Настройки – Настройки... – команда вызывает окно с настройками конфигуратора (дублируется кнопкой
202     <mediaobject>
203             <imageobject>
204               <imagedata fileref="images/key-settingsconfig.png" format="PNG"/>
205             </imageobject>
206         </mediaobject>
207     ):</para>
208     <para>
209     <mediaobject>
210             <imageobject>
211               <imagedata fileref="images/network-settings.png" format="PNG"/>
212             </imageobject>
213         </mediaobject>
214     </para>
215     <para>В данном окне задаются настройки конфигуратора: адрес сервера, порт, адрес почтового сервера и его порт, интервал авто обновления, длина генерируемого пароля и прочие параметры конфигуратора. На закладке «Интерфейс»
216     <mediaobject>
217             <imageobject>
218               <imagedata fileref="images/interface.png" format="PNG"/>
219             </imageobject>
220         </mediaobject>
221     задаются: видимость колонок в окне клиентов, а так же ширина. Признак «Загружать последний шаблон» определяет загружать ли конфигуратору последний шаблон, который был использован при последней отправке писем клиентам.</para>
222     <para>На закладке «Раскраска» можно задать цвета, шрифт и другие параметры отображения в основной таблице и в панели информации.
223     <mediaobject>
224             <imageobject>
225               <imagedata fileref="images/coloring.png" format="PNG"/>
226             </imageobject>
227         </mediaobject>
228     </para>
229     <para>На закладке «Прочее» можно указать, сохранять ли логин и (или) пароль администратора. Пароль шифруется и привязывается к HDD компьютера, однако, НЕ РЕКОМЕНДУЕТСЯ сохранять пароль администратора !!! Также здесь можно задать имена полей типа UserDataN для отображения в конфигураторе и параметры, которые будут показываться в нижней панели информации. В разделе «Подсети и IP–адреса» можно задать имя и начальный адрес для автоматического поиска свободного IP адреса.
230     <mediaobject>
231             <imageobject>
232               <imagedata fileref="images/other-settings.png" format="PNG"/>
233             </imageobject>
234         </mediaobject>
235     </para>
236     </listitem>
237     <listitem><para>Настройки – Информация о сервере – команда позволяет узнать некоторую информацию о сервере, о его версии и некоторые другие данные:
238     <mediaobject>
239             <imageobject>
240               <imagedata fileref="images/informserver.png" format="PNG"/>
241             </imageobject>
242         </mediaobject>
243     </para>
244     <para>Кнопка
245     <mediaobject>
246             <imageobject>
247               <imagedata fileref="images/update.png" format="PNG"/>
248             </imageobject>
249         </mediaobject>
250     позволяет обновить данные о клиентах в таблице.</para>
251     <para>Кнопка
252     <mediaobject>
253             <imageobject>
254               <imagedata fileref="images/autoupdate.png" format="PNG"/>
255             </imageobject>
256         </mediaobject>
257     позволяет включать или отключать авто обновление данных. В настройках конфигуратора можно задать интервал авто обновления.</para>
258     </listitem>
259   </itemizedlist>
260 </chapter>