Administrator: Created page with "== Setup == There are no special setup actions for web interface. The only requirement - at least one subscriber must be defined. See User Man..."

2016-05-10T17:53:40Z

Created page with "== Setup == There are no special setup actions for web interface. The only requirement - at least one subscriber must be defined. See User Man..."

New page

== Setup ==
There are no special setup actions for web interface. The only requirement - at least one [[User Manager/Subscribers | subscriber]] must be defined. See [[User Manager/Getting started #Create first subscriber | first subscriber setup]] guide.
== How to find? ==
Type the following address in your web browser: http://Router_IP_address/userman

where "Router_IP_address" must be replaced with IP address of your router.

== Sections ==
Here are described customer page sections. Use menu on the left side to navigate:

[[Image:UserManCustMenu.png | Customer page menu]]

=== Status ===
This page has several components:
* User search;
* Active user listing;
* Active session listing;
* User batch-add form.

==== User search ====
Type in the [[User Manager/Search patterns | search pattern]] and press the button "Search". Results will be displayed in a new [[User Manager/Tables | table]].

[[Image:UserManSearchUsers.png | User search form]]

==== Active users ====
Active user count displayed here. To see a full list of active users, click on "Show":

[[Image: UserManActiveUsers.png | active user form]]

==== Active sessions ====
Active sessions count displayed here. To see a full list of active sessions, click on "Show":

[[Image: UserManActiveSessions.png | active session form]]

==== User batch-add form ====
Batch of [[User Manager/Users | users]] can be added here:

[[Image: UserManBatchAdd.png | batch add form]]

Fields:
* Number of users. How many users to add;
* Login starts with. Displays [[User Manager/User prefix | user prefix]];
* Rate limits. hidden by default. Check the box on the right to show [[User Manager/Limiting #Rate limits | rate limit]] field group;
* [[User Manager/Limiting #Uptime limit | Uptime limit]];
* Prepaid. [[User Manager/Credits | Credit]] that will be assigned to users. [[User Manager/Prepaid and unlimited users | Unlimited users]] can also be created by selecting ''unlimited'' as a value.
* Generate [http://en.wikipedia.org/wiki/Comma-separated_values CSV] file. When checked a [http://en.wikipedia.org/wiki/Comma-separated_values CSV-file] will be generated containing just created user data;
* Generate vouchers. When checked [[User Manager/Printing | printable]] [[User Manager/Reports #User credit vouchers | vouchers]] for just created users will be generated.

=== Routers ===
==== View routers ====
[[User Manager/Tables | Table]] displaying [[User Manager/Routers | routers]]:

[[Image: UserManRouters.png | routers]]

All [[User Manager/Routers | router's attributes]] are shown here.

Click on ''name'' opens router [[User Manager/Detail forms | detail/edit form]].

==== Add router ====
Opens [[User Manager/Routers | router]] add [[User Manager/Detail forms | form]]. The same form is used to edit routers:

[[Image: UserManRouterAdd.png | router add]]

Fields:
* Name. Router's name. Must be unique per [[User Manager/Subscribers | subscriber]];
* IP Address. Address of the router;
* Shared secret. Password used for authentication;
* Log events. Specifies which events must be written to [[User Manager/Logs | log]].

=== Credits ===
==== View credits ====
[[User Manager/Tables | Table]] displaying [[User Manager/Credits | credits]]:

[[Image: UserManCredits.png | credits]]

All [[User Manager/Credits | credit's attributes]] are shown here.

Click on ''name'' opens credit [[User Manager/Detail forms | detail/edit form]].

==== Add credit ====
Opens [[User Manager/Credits | credit]] add [[User Manager/Detail forms | form]]. The same form is used to edit credits:

[[Image: UserManCreditAdd.png | credit add]]

Fields:
* Name. Credit's name. Must be unique per [[User Manager/Subscribers | subscriber]];
* Time. How long this [[User Manager/Credits | credit]] is valid when started;
* Full price. The price of this as the first [[User Manager/Credits #User credits | credit]] for a [[User Manager/Users | user]]. When the checkbox at the right is empty, full price is unavailable - this credit can not be used as a base credit;
* Extended price. The price of this as extended [[User Manager/Credits #User credits | credit]] for a [[User Manager/Users | user]] (user already has credits before this on). When the checkbox at the right is empty, extended price is unavailable - this credit can not be used as an extended credit;

=== Users ===
==== View users ====
[[User Manager/Tables | Table]] displaying [[User Manager/Users | users]]:

[[Image: UserManUsers.png | users]]

Only part of [[User Manager/Users | user's attributes]] are shown here. To see all details of specific user, open user [[#User detail form | detail form]] by clicking on username in the [[User Manager/Tables | table]].

==== User detail form ====
[[User Manager/Detail forms | Detail form]] with user data:

[[Image: UserManEditUser.png | edit user]]

Contains all [[User Manager/Users | user fields ]].

There are groups of fields (for example, private information, rate limits). These fields are hidden by default and are accessible by checking the box on the right:

[[Image: UserManUserPrivInfo.png | private field group]]

If the user has [[User Manager/Credits | credits]] assigned the total prepaid time is shown at the bottom. To see credit details click on the plus sign ("+") under ''Prepaid time'':

[[Image: UserManUserCredDet.png | user credit detail]]

New credits can also be assigned (if [[User Manager/Permissions | permitted]]) to user. At the bottom is a select-box called "Extend" (called "Add time" when user has no credits yet). The price depends on what kind of credit this is for a user - first or extended. Price is shown in braces:

[[Image: UserManUserExtend.png | user extend]].

To assign credit to the user, choose the desired credit and click ''Save''.

Options (buttons at the bottom):
* Save - saves edited information, assigns [[User Manager/Credits | credit]], if one selected;
* View report - opens [[User Manager/Reports #Single user report | single user report]].
* Remove last [[User Manager/Credits | credit]] - removes last credit that's not started yet;
* Show sessions - opens window with all [[User Manager/Sessions | sessions]] this user has;

==== Add user ====
Detail form for filling in information about the new user. Very similar to [[#User detail form | user detail form]]. This form does not have read-only counters and other user statistics:

[[Image: UserManUserAdd.png | user add]]

==== Add batch of users ====
The [[#User batch-add form | User batch-add form]] will be opened.

=== Sessions ===
==== View sessions ====
[[User Manager/Tables | Table]] displaying [[User Manager/Sessions | sessions]]:

[[Image: UserManSessions.png | users]]

Only part of [[User Manager/Sessions | session's attributes]] are shown here. To see all details of specific session, open session [[#Session detail form | detail form]] by clicking on ID in the [[User Manager/Tables | table]].

To see details of session [[User Manager/Users | user]] click on the username in the [[User Manager/Tables | table]].

==== Session detail form ====
[[User Manager/Detail forms | Detail form]] with [[User Manager/Sessions | session]] data:

[[Image: UserManEditSession.png | edit session]]

Contains all [[User Manager/Sessions | session fields ]].

=== Customers ===
==== View customers ====
[[User Manager/Tables | Table]] displaying [[User Manager/Customers | customers]]:

[[Image: UserManCustomers.png | customers]]

Only part of [[User Manager/Customers | customer's attributes]] are shown here. To see all details of specific [[User Manager/Customers | customer]], open [[#Customer detail form | customer detail form]] by clicking on login in the [[User Manager/Tables | table]].

==== Customer detail form ====
[[User Manager/Detail forms | Detail form]] with [[User Manager/Customers | customer]] data:

[[Image: UserManEditCustomer.png | edit customer]]

Contains all [[User Manager/Customers | customer fields ]].

There are groups of fields (for example, private information, user options). These fields are hidden by default and are accessible by checking the box on the right:

[[Image: UserManCustPrivInfo.png | private field group]]

There are fields which are accessible only for [[User Manager/Subscribers | subscribers]]: Public Host and Authorize.Net fields. These fields are not shown for [[User Manager/Customers | customers]] who are not [[User Manager/Subscribers | subscribers]]:

[[Image: UserManCustSubsFields.png | subscriber fields]]

There are sensitive-data fields (Authorize.Net) which are visible only when using secure connection (https):

[[Image: UserManCustUseHttps.png | https fields]]

There are sensitive-data fields (Authorize.Net) whose values are not shown. Whether the field has value specified or not is visible by the title standing before it: if the title says "Set ...", this field has no value set; the title saying "Change ..." means that this field has some value:

[[Image: UserManCustSensitiveFieldTitles.png | sensitive field titles]]

In the example above Login ID and Transaction Key fields have values (titles are "Change ...") while MD5 Value field has no value specified (title is "Set ...").

==== Add customer ====
Detail form for filling in information about the new [[User Manager/Customers | customer]]. Very similar to [[#Customer detail form | customer detail form]]. This form does not have [[User Manager/Subscribers | subscriber]] fields since [[User Manager/Subscribers | subscribers]] cannot be added here:

[[Image: UserManCustomerAdd.png | customer add]]

=== Reports ===
This section refers to [[User Manager/Reports #User time and traffic report | user time and traffic reports]].

Reports generated here can be [[User Manager/Printing | printed]] directly.

Configurable options:
* Users - which users to show: [[User Manager/Prepaid and unlimited users | prepaid, unlimited]] or all;
* Type - time (contains [[User Manager/Credits | prepaid time, extend time and price]]) or amount (contains upload and download amount) report;
* Period - total (whole history) or with specific time boundaries;
See [[User Manager/Reports #User time and traffic report | user time and traffic reports]] for further detail.

Sample report:

[[Image: UserManReport.png | report]]

=== Logs ===
==== View logs ====
[[User Manager/Tables | Table]] displaying [[User Manager/Logs | logs]]:

[[Image: UserManLogs.png | logs]]

Only part of [[User Manager/Logs | log's attributes]] are shown here. To see all details of specific log, open [[#Log detail form | log detail form]] by clicking on ID in the [[User Manager/Tables | table]].

==== Log detail form ====
[[User Manager/Detail forms | Detail form]] with [[User Manager/Logs | log]] data:

[[Image: UserManLogDetails.png | log details]]

Contains all [[User Manager/Logs | log fields ]].

User Manager/Customer page - Revision history

Administrator: Created page with "== Setup == There are no special setup actions for web interface. The only requirement - at least one subscriber must be defined. See User Man..."