Go to user documentation
Go to user
documentation
Home

Introduction Last updated: 2021-08-06

This document explains the features available for an admin users. Admin user should set up payment gateways, Then customers can place orders. Order management, invoice management, plan management etc can be done by the admin user.

2. Admin Login

  • An admin have to login to Monitoring Zone to use the system.
  • Admin will be provided with default login credentials.
  • For logging in to the system, admin have to use the address https://saas.monitoring.zone/admin/login manually.
    Note: https://saas.monitoring.zone should be replaced with your domain address.

    Default login credentials:
    E-mail address: admin@servermonitor.com
    Password   : admin1234

    • Admin Login:
    Fig.2.1 Admin Login
  • After login, the page will be automatically redirected to the admin dashboard of Monitoring Zone.
  • Admin can reset their password from profile section after logged in.

2.1 Reset Password

  • Admin can reset their password from profile section after logged in.
  • The admin can view or update their profile from the profile section. They can update their user details and login password from here.

    • Admin profile:
    Fig.2.2 Admin profile

3. Dashboard

Dashboard view:
Fig.3.1 Dashboard

The admin is provided with a dashboard which gives the order statistics, Income statistics and monitor statistics very quickly.

3.1 Order Statistics

  • The admin can get the order statistics fom the dashboard.
  • It includes total orders, total paid orders, total trial orders and active,pending and inactive orders in each cases.

3.2 Income Statistics

  • The admin also gets his income statistics from the dashboard.
  • It includes total income, current day income, last week's income, last month's income and last year's income.
  • It also gives the percentage of the total income from each cases mentioned above.

3.3 Monitor Type Details

  • The admin can get total count of servers, webpages, and APIs that registered with the system from the dashboard

4. Orders

List of orders:
Fig.4.1 List of orders
  • The admin can get the order details from the "Orders" link provided in the panel.
  • All the orders are listed here in the order of latest first.
  • The admin can get the order ID, ordered user details, gateway details of the order and the amount details from this page.
  • Orders are created before the payment is completed. So, the admin have to accept each orders after verification. Otherwise users can't use the features properly.
  • An order confirm Email will be sent to user's email id after accepting an order.

5. Invoices

List of invoices:
Fig.5.1 List of invoices
  • The admin can get the list of invoices by clicking the "Invoices" link provided in the panel.
  • From the invoices page, admin can get the order ID and user details associated with the invoice, amount and payment status etc.
  • The admin can filter the invoices by searching with order ID or user name.

5.1 Invoice Details


Invoice details page:
Fig.5.2 Invoice details page
  • The detailed information of an invoice can obtained by clicking on the order IDs provided in each invoices.
  • The admin can get all data associated with the invoice including transaction details and plan details.
  • The admin can refund the full amount of the transaction to users by clicking on the refund button given in this page. The amount will be refunded in the same transaction method of the payment. please confirm all details including bank statement twice before doing this!

6. Subscriptions

List of subscriptions:
Fig.6.1 List of subscriptions
  • The admin can get the list of subscriptions of users from the "Subscriptions" link provided in the panel.
  • They can obtain the data like order Id associated with the service, user details, plan details and status etc from this page.
  • The admin can activate or inactivate the subscription by clicking on the status link in each subscriptions.
  • There is search option is provided in this page also. Admin can filter the subscription list by service ID, Order Id and username.

7. User Management

List of users:
Fig.7.1 List of users
  • The admin can get the details of all users registered with the system using "Users" link provided in the panel.
  • They can Add, Edit or Delete the users from this sections. Also they can get the current status of the user.
  • From the listing page admin can search users with their name or Email address.

7.1 Add a User


Add user page:
Fig.7.2 Add user page
  • The admin can add a user by clicking "Add User" link provided in the users page.
  • They should provide first and last name of the user, Email address, password and address details of the user.
  • User have to verify their email address when they login at first time.
  • After adding a user, the default status of user will be "Active". Admin can change this status from update user page accordingly.

7.2 Update a User


Update user page:
Fig.7.3 Update user page
  • The admin can update a user by clicking on edit link provided in users page.
  • They have to provide their updated details as done in the add section.
  • One extra option will be status. They can update the status of a user from this page.

8. Plans Management

List of plans:
Fig.8.1 List of plans
  • The admin can manage the available plans by the "Plans" link provided in the panel.
  • They can Add, Edit or Delete a plan from this page.
  • The green tick and red cross indicates the active and inactive states of the plan respectively.
  • Also a link is provided to view the properties of a plan
    • .

8.1 Add a Plan


Add plan page:
Fig.8.2 Add plan page
  • The admin can add a plan using "Add Plan" link provided in the plans page.
  • They should provide the name and price of the plan in the corresponding area. Price can be decimal numbers and it will be taken in USD
  • Plan should be enabled to make it visible to the users.

8.2 Update a Plan


Update plan page:
Fig.8.3 Update plan page
  • The admin can update a plan using edit link provided in plans page.
  • They should provide the updated details of the plan as done in add section.
  • In addition to that, they should provide the properties of the plan also from the update section.
  • Note that all fields are mandatory here.

8.3 View Plan Details


Plan details:
Fig.8.4 Plan details
  • The admin can view the plan details using the view link provided in each plans.
  • It includes the properties and it's values.
  • Refer section 8 to know more about properties.

9. Plan Properties

List of plan properties:
Fig.9.1 List of plan properties
  • The properties are the features that could be given to a plan
  • The available properties of plans are listed in the properties section in admin panel.
  • The admin can View, Add, Edit or Delete a property from this sections.
  • The green tick and red cross indicates the active and inactive states of the plan properties respectively.

9.1 Add a Property


Add plan property page:
Fig.9.2 Add plan property page
  • The admin can add a property by using the "Add property" link provided in the properties section.
  • They should provide a name and display name for the property. The display name will be visible for users in their add plans section.
  • They can provide a description fo the property. But it's optional.
  • The status of the property also can be changed.

9.2 Update a Property


Update plan property page:
Fig.9.3 Update plan property page
  • The admin can update a property by using the edit link provided in each properties.
  • They can provide the updated details of the property as done in the add section.

10. Gateways

List of gateways:
Fig.10.1 List of gateways
  • The available gateways and it status are listed in the gateways section in admin panel
  • The admin should provide the gateway details for each gateways.
  • There are currently 3 gateways are provided in this version. Paypal, Stripe and Mollie gateways
  • The admin can't add a new gateway to the system. If it required, they have to contact the developer team directly.
  • In-order to activate a gateway, admin should update his billing address in the system. Note that while adding the billing address, you have to provide country that accepts USD currency (Must not be India). Refer section 10.2
  • The green tick and red cross indicates the active and inactive states of the gateways respectively.

10.1 PayPal


Add PayPal API details:
Fig.10.2 Add PayPal API details
  • PayPal is a secure simple gateway for payments.
  • To activate this gateway in this system, Admin should crate a PayPal account and should provide it's API details in the system.
  • For PayPal you have to provide PayPal Email address, and PayPal API credentials such as API username, API password, and API signature of the account. Note that your details are secure with this system.
  • You can test the payments by enabling the test mode from the system. After the testing, don't forget to turn off the test mode from this section.
  • Also, the admin can enable or disable this gateway from this section. The gateway will not be available for users if it's not activated.

10.2 Stripe


Add stripe API details:
Fig.10.3 Add stripe API details
  • Stripe is also a secure payment gateway provided in this system.
  • To activate this gateway in this system, Admin should crate a Stripe account and should provide it's API details in the system.
  • For Stripe you have to provide stripe key and stripe secret key of your account. Note that your details are secure with this system.
  • You can test the payments by enabling the test mode from the system. After the testing, don't forget to turn off the test mode from this section.
  • Also, an admin can enable or disable this gateway from this section. The gateway will not be available for users if it's not activated.

10.3 Mollie


Add mollie API details:
Fig.10.4 Add mollie API details
  • Mollie gateway is also a secure payment gateway provided in this system.
  • To activate this gateway in this system, Admin should crate a Mollie account and should provide it's API details in the system.
  • For Mollie gateway you have to provide mollie key of your account. Note that your details are secure with this system.
  • You can test the payments by enabling the test mode from the system. After the testing, don't forget to turn off the test mode from this section.
  • Also, the admin can enable or disable this gateway from this section. The gateway will not be available for users if it's not activated.

11. Settings

11.1 Add a Language


    Languages:
    Fig.11.1 Languages
  • It is a multilingual system.Admin can add a language to the system by the help of developers.
  • For that, first of all you have to add the language name and language code from Add language option in settings section.
  • Not that the name of the language must be entered in the same language. Example: English, Deutsche..
  • Also, the language code must be a two letter keyword based on ISO 2 letter (Alpha-2 code, ISO 639-1) standerd.
    Eg: en for English. Reference: Language codes.
  • After that, you have to contact the developer team to set up the translation file.

11.2 Billing Address


    Billing address page:
    Fig.11.2 Billing address page
  • The admin should update their billing address in settings before sett-upping the gateways.
  • They have to provide the name nd contact details from this page.
  • Note that while adding the billing address, you have to provide country that accepts USD currency (Must not be India).

    • Update billing address:
    Fig.11.3 Update billing address

11.3 Ping Interval


    Ping interval management:
    Fig.11.4 Ping interval management
  • Ping interval is the status checking intervals for monitoring a system.
  • The admin should add some ping intervals to the system from settings.
  • That ping intervals will be listed to users when they add a server,webpage or API. So they can't add a ping interval as they want.