Difference between revisions of "User Manager/User page"

From MikroTik Wiki
Jump to: navigation, search
(Settings)
m (Removed subs part from links and changed from "?subs=test" to "/test")
 
(40 intermediate revisions by 16 users not shown)
Line 1: Line 1:
== Setup ==
 
If there is only one [[User Manager subscribers, customers and users #Subscribers | subscriber]] registered, user pages don't require any setup.
 
 
If there are many subscribers registered in the User Manager, it must be specified explicitly, to which subscriber the user belongs, because there can be many users with the same login belonging to different subscribers.
 
 
 
== How to find? ==
 
== How to find? ==
User page can be found at address: http://Router_IP_address/user?subs=publicID , where
+
User page can be found at address: http://Router_IP_address/user/publicID , where
  
 
* "Router_IP_address" must be replaced with IP address of your router '''where the User Manager is running''' (don't mix it with the HotSpot router, if User Manager and HotSpot are running on different routers);
 
* "Router_IP_address" must be replaced with IP address of your router '''where the User Manager is running''' (don't mix it with the HotSpot router, if User Manager and HotSpot are running on different routers);
* publicID must be replaced with public-id of the subscriber who is the owner of this user;
+
* publicID must be replaced with [[User Manager/Public ID | public ID]] of the [[User Manager/Subscribers | subscriber]] who is the owner of this [[User Manager/Users | user]];
* If there is only one subscriber on this router the part "?subs=..." can be skipped, i.e., then the address http://Router_IP_address/user can be used.
+
* If there is only one subscriber on this router the part "/publicID" can be skipped, i.e., then the address http://Router_IP_address/user can be used.
  
 
== What is ''Public ID'' and how to change it? ==
 
== What is ''Public ID'' and how to change it? ==
See [[User Manager subscriber's public ID | this page]].
+
See: [[User Manager/Public ID | Subscriber public ID]].
  
== Link to user pages ==
+
== Link to user page ==
Links and buttons to user pages can be used in other web pages. There are several things configurable:
+
Links and buttons to user page can be used in other web pages. There are several things configurable:
 
* router IP address;
 
* router IP address;
 
* subscriber's public ID;
 
* subscriber's public ID;
Line 21: Line 16:
  
 
=== Textual link ===
 
=== Textual link ===
To get a textual link to user pages, replace this template with your own values:
+
To get a textual link to user page, replace this template with your own values:
 
<pre>
 
<pre>
<nowiki><a href="http://%hostname%/user?subs=%subid%">%caption%</a></nowiki>
+
<nowiki><a href="http://%hostname%/user/%subid%">%caption%</a></nowiki>
 
</pre>
 
</pre>
 
* %hostname% - router's hostname or IP address;  
 
* %hostname% - router's hostname or IP address;  
Line 29: Line 24:
 
* %caption% - caption of the link that will be show to user.
 
* %caption% - caption of the link that will be show to user.
  
Example: To get a link to ''userman.mt.lv'' router's demo subscriber user pages, use the following link:
+
Example: To get a link to ''userman.mt.lv'' router's demo subscriber user page, use the following link:
 
<pre>
 
<pre>
<nowiki><a href="http://userman.mt.lv/user?subs=demo">This is an example link to Mikrotik User Manager demo User pages</a></nowiki>
+
<nowiki><a href="http://userman.mt.lv/user/demo">This is an example link to Mikrotik User Manager demo User page</a></nowiki>
 
</pre>
 
</pre>
And it looks like this: [http://userman.mt.lv/user?subs=demo This is an example link to Mikrotik User Manager demo User pages]
+
And it looks like this: [http://userman.mt.lv/user/demo This is an example link to Mikrotik User Manager demo User page]
  
 
=== Link button ===
 
=== Link button ===
To get a button, which leads to user pages, replace this template with your own values:
+
To get a button, which leads to user page, replace this template with your own values:
 
<pre>
 
<pre>
<nowiki><button onclick="document.location='http://%hostname%/user?subs=%subid%'">%caption%</button></nowiki>
+
<nowiki><button onclick="document.location='http://%hostname%/user/%subid%'">%caption%</button></nowiki>
 
</pre>
 
</pre>
  
Example: To get a button-link to ''userman.mt.lv'' router's demo subscriber user pages, use the following link:
+
Example: To get a button-link to ''userman.mt.lv'' router's demo subscriber user page, use the following link:
 
<pre>
 
<pre>
<nowiki><button onclick="document.location='http://userman.mt.lv/user?subs=demo'">Check</button></nowiki>
+
<nowiki><button onclick="document.location='http://userman.mt.lv/user/demo'">Check</button></nowiki>
 
</pre>
 
</pre>
 
The visual representation cannot be shown here because of the wiki security so you have to pretend how it looks like.
 
The visual representation cannot be shown here because of the wiki security so you have to pretend how it looks like.
Line 51: Line 46:
 
<nowiki>
 
<nowiki>
 
<!-- user manager link -->
 
<!-- user manager link -->
<button onclick="document.location='http://$(hostname)/user?subs='">status</button>
+
<button onclick="document.location='http://$(hostname)/user/'">status</button>
 
</nowiki>
 
</nowiki>
 
</pre>
 
</pre>
$(hostname) here is replaced with the hostname of the HotSpot router (so the default link works only if HotSpot and User Manager are running on the same router). And "subs=" means that first subscriber will be used (works fine when there's only one subscriber on the router). Hostname and subsciber id can be replaced with desired values.
+
$(hostname) here is replaced with the hostname of the HotSpot router (so the default link works only if HotSpot and User Manager are running on the same router). Hostname and subscriber id can be replaced with desired values.
  
 
== Sections ==
 
== Sections ==
This par of a document describes sections available in user pages. For navigation use the menu on the left side:
+
This par of a document describes sections available in user page. For navigation use the menu on the left side:
  
 
[[Image:UserManUserMenu.png|User page menu]]
 
[[Image:UserManUserMenu.png|User page menu]]
Line 71: Line 66:
 
[[Image:UserManUserStatus.png|User status section]]
 
[[Image:UserManUserStatus.png|User status section]]
  
This information is also formatted for printing. See print preview in the browser (Usually under File > Print preview in the browser's toolbar). Credits and sessions are formed in boxes. These boxes can be "minimized" - the button on the upper right corner of the box. A minimized box will not be printed (see print preview).
+
This information is also formatted for [[User Manager/Printing | printing]]. See print preview in the browser (Usually under File > Print preview in the browser's toolbar). [[User Manager/Credits #User credits | Credits]] and [[User Manager/Sessions | sessions]] are formed in [[User Manager/Tables | tables]]. These tables can be [[User Manager/Tables #Minimization | "minimized"]] - the button on the upper right corner of the table. A minimized table will not be printed (see print preview).
  
 
==== Summary ====
 
==== Summary ====
 
Here the user can see:
 
Here the user can see:
* Prepaid time - duration of all the credits bought (See: [[User Manager character constants #Time constants | time constants]]). Or the word ''unlimited'' (See [[User Manager prepaid and unlimited users | prepaid and unlimited users]]);
+
* Prepaid time - duration of all the credits bought (See: [[User Manager/Character constants #Time constants | time constants]]). Or the word ''unlimited'' (See [[User Manager/Prepaid and unlimited users | prepaid and unlimited users]]);
 
* Total price - how much all the credits cost;
 
* Total price - how much all the credits cost;
 
* Uptime limit - the maximum allowed duration of user's sessions;
 
* Uptime limit - the maximum allowed duration of user's sessions;
Line 83: Line 78:
  
 
==== Credits ====
 
==== Credits ====
Table with all [[User Manager credits | credits]] this user has bought. No data for unlimited users.
+
Table with all [[User Manager/Credits | credits]] this user has bought. No data for unlimited users.
  
 
Sample screenshot:
 
Sample screenshot:
  
[[Image:UserManUserCredits.png|User credits]]
+
[[Image:UserManUserCredits.png| User credits]]
  
If there are credits that are not started yet (see: [[User Manager credits | credits]]), start-time and end-time fields contain values "awaiting login".
+
If there are credits that are not started yet (see: [[User Manager/Credits | credits]]), start-time and end-time fields contain values "awaiting login".
  
 
==== Sessions ====
 
==== Sessions ====
Table with all user's sessions.
+
Table with all user's [[User Manager/Sessions | sessions]].
  
 
Sample screenshot:
 
Sample screenshot:
  
 
[[Image:UserManUserSessions.png|User sessions]]
 
[[Image:UserManUserSessions.png|User sessions]]
 +
 +
=== Payments ===
 +
Here the user can view payment history and buy a new credit .
 +
This section is only available if the [[User Manager/Subscribers | subscriber]] has allowed any payments.
 +
 +
==== View payments ====
 +
Table with all user [[User Manager/Payments | payments]].
 +
 +
Sample screenshot:
 +
 +
[[Image:UserManUserPayments.png|Payments]]
 +
 +
To see all details of specific [[User Manager/Payments | payment]], open [[#Payment detail form | payment detail form]] by  clicking on ID in the table.
 +
 +
==== Payment detail form ====
 +
[[User Manager/Detail forms | Detail form]] with [[User Manager/Payments | payment]] data:
 +
 +
[[Image:UserManPaymentDetail.png|Payment details]]
 +
 +
Contains all [[User Manager/Payments | payment]] fields.
 +
 +
==== Buy credit ====
 +
A new credit can be bought here using payment methods which are allowed by the [[User Manager/Subscribers | subscriber]].
 +
 +
There are a number of restrictions for this sub-section to be accessible:
 +
* Secure connection ([http://en.wikipedia.org/wiki/Https https]) must be used to access the site. Otherwise a notification with a link to secure page will be shown;
 +
* At least one payment method must be allowed by the [[User Manager/Subscribers | subscriber]];
 +
* [[User Manager/Subscribers | Subscriber]] must have configured all required payment attributes;
 +
 +
Sample screenshot:
 +
 +
[[Image:UserManBuyCredit.png|Buy credit]]
 +
 +
Here user can see his/her current balance and choose a credit to buy. After click on the "Buy" button user will be redirected to payment gateway where he/she will have to enter required data to process payment.
 +
 +
Important - payment data (such as credit card number and expiry date) is sent directly from user's computer to payment gateway and is not captured by User Manager. User Manager processes only response about the payment result from the payment gateway. This response does not contain any sensitive user's data.
 +
 +
When the payment is successful, the selected [[User Manager/Credits | credit]] is added to user's account.
  
 
=== Settings ===
 
=== Settings ===

Latest revision as of 11:32, 7 January 2015

How to find?

User page can be found at address: http://Router_IP_address/user/publicID , where

  • "Router_IP_address" must be replaced with IP address of your router where the User Manager is running (don't mix it with the HotSpot router, if User Manager and HotSpot are running on different routers);
  • publicID must be replaced with public ID of the subscriber who is the owner of this user;
  • If there is only one subscriber on this router the part "/publicID" can be skipped, i.e., then the address http://Router_IP_address/user can be used.

What is Public ID and how to change it?

See: Subscriber public ID.

Link to user page

Links and buttons to user page can be used in other web pages. There are several things configurable:

  • router IP address;
  • subscriber's public ID;
  • caption on the link/button.

Textual link

To get a textual link to user page, replace this template with your own values:

<a href="http://%hostname%/user/%subid%">%caption%</a>
  •  %hostname% - router's hostname or IP address;
  •  %subid% - subscriber's public ID;
  •  %caption% - caption of the link that will be show to user.

Example: To get a link to userman.mt.lv router's demo subscriber user page, use the following link:

<a href="http://userman.mt.lv/user/demo">This is an example link to Mikrotik User Manager demo User page</a>

And it looks like this: This is an example link to Mikrotik User Manager demo User page

Link button

To get a button, which leads to user page, replace this template with your own values:

<button onclick="document.location='http://%hostname%/user/%subid%'">%caption%</button>

Example: To get a button-link to userman.mt.lv router's demo subscriber user page, use the following link:

<button onclick="document.location='http://userman.mt.lv/user/demo'">Check</button>

The visual representation cannot be shown here because of the wiki security so you have to pretend how it looks like.

The same button-link is used in HotSpot page templates. By default it looks like this:


<!-- user manager link -->
<button onclick="document.location='http://$(hostname)/user/'">status</button>

$(hostname) here is replaced with the hostname of the HotSpot router (so the default link works only if HotSpot and User Manager are running on the same router). Hostname and subscriber id can be replaced with desired values.

Sections

This par of a document describes sections available in user page. For navigation use the menu on the left side:

User page menu

Status

Here the user can see account's status:

  • Summary;
  • Credits;
  • Sessions.

Sample screenshot:

User status section

This information is also formatted for printing. See print preview in the browser (Usually under File > Print preview in the browser's toolbar). Credits and sessions are formed in tables. These tables can be "minimized" - the button on the upper right corner of the table. A minimized table will not be printed (see print preview).

Summary

Here the user can see:

  • Prepaid time - duration of all the credits bought (See: time constants). Or the word unlimited (See prepaid and unlimited users);
  • Total price - how much all the credits cost;
  • Uptime limit - the maximum allowed duration of user's sessions;
  • Uptime used - current duration of user's sessions;
  • Download used
  • Upload used

Credits

Table with all credits this user has bought. No data for unlimited users.

Sample screenshot:

User credits

If there are credits that are not started yet (see: credits), start-time and end-time fields contain values "awaiting login".

Sessions

Table with all user's sessions.

Sample screenshot:

User sessions

Payments

Here the user can view payment history and buy a new credit . This section is only available if the subscriber has allowed any payments.

View payments

Table with all user payments.

Sample screenshot:

Payments

To see all details of specific payment, open payment detail form by clicking on ID in the table.

Payment detail form

Detail form with payment data:

Payment details

Contains all payment fields.

Buy credit

A new credit can be bought here using payment methods which are allowed by the subscriber.

There are a number of restrictions for this sub-section to be accessible:

  • Secure connection (https) must be used to access the site. Otherwise a notification with a link to secure page will be shown;
  • At least one payment method must be allowed by the subscriber;
  • Subscriber must have configured all required payment attributes;

Sample screenshot:

Buy credit

Here user can see his/her current balance and choose a credit to buy. After click on the "Buy" button user will be redirected to payment gateway where he/she will have to enter required data to process payment.

Important - payment data (such as credit card number and expiry date) is sent directly from user's computer to payment gateway and is not captured by User Manager. User Manager processes only response about the payment result from the payment gateway. This response does not contain any sensitive user's data.

When the payment is successful, the selected credit is added to user's account.

Settings

In this section user can configure his/her parameters:

  • Private information (informational, not used by User Manager):
    • First name;
    • Last name;
    • Phone;
    • Location.
  • Email - used to send emails to user. Must be unique.

If values provided in "New password" and "Retype new password" fields, the password will be changed.

Sample screenshot:

User settings