Ramom - Documentation

# Ramom School Subscription(Saas).

Ramom Saas addon adds School Subscription(Saas) module in "Ramom Multi Branch School Management System". Using this addon the superadmin can create subscription plan of own choice and manage any number of school, also offer Free Trial. User can purchase the school subscription plan of his/her choice by making payment through the website, Also user can renew the subscription plan anytime through online payment.

- Created : 24-April-2023
- Last Update : 02-November-2025
- Version : 3.1.6
- Author : https://codecanyon.net/user/ramomcoder
- Email : ramomcoder@yahoo.com
- Support : https://support.ramomcoder.com

### System Requirements

Using Ramom School Subscription(Saas), you must have running Ramom Multi Branch School Management System version 6.9 or its newer version on your server. Below are a list of items you should ensure before using Ramom School Subscription(Saas).

- Ramom Multi Branch School Management System version 6.9.0 or its newer version pre installed on your server

### Installation

##### Please follow the below steps to complete the installation process of the Ramom School Subscription(Saas) Addon.

* Always backup your all files and database before Installing Ramom School Subscription(Saas)

01. If you are running the latest version 6.9 or greater than 6.9 of Ramom Multi Branch School Management System, You are now ready to install the addon.

02. First Download "Ramom Saas Addon" from CodeCanyon. Now extract and open main_script.zip.

03. Login as Superadmin and Goto Addon Manager and click Install Addon Tabs.
Enter your Addon purchase code here. Do not use here to Ramom School Purchase code.

04. You will get two folders inside the downloaded file. One is for documentation and the other is for the addon file. No need to change anything like renaming, removing, etc

06. You just need to upload the ramom_saas_addon.zip file. After that hit the Install Now button. You will get a success message notification and window will reload automatically in 5 seconds and you can also see the newly installed addon on the Addon List there.

07. Now Clear the cache of your browser and login to SuperAdmin Panel and check if everything is Done...

### 01. Getting Started

First login as super admin. Then go to School Subscription > Settings and you can see the General settings page and you can configure as you like.

After this you are ready to configure the Website Settings. From here you can change all the information on the school subscription website. Like: Theme colors, social links, images, text content etc.

You are now ready to configure Payment Setting. Note that the payment setting is important, Because users will purchase subscriptions plan and renew subscriptions through the front-end website, they will be able to make payments based on this configuration.

Then finally you configure the Email Settings. Now fill in all box then finally click on Save.

Set E-mail triggers for user e-mail notifications. Turn on the email notifications you want to send to users and set the email templates and of course using the tags.

### 02. How to add Subscription Plan?

Subscription > Plan and you can see the Subscription Plan page and and click Add Package tab. Now fill in the Plan Name, Price, Discount, Student Limit, Parents Limit, Staff Limit, Teacher Limit, Subscription Period, Select Module then finally click on Save.

If you want to appear on the website as Recommended Plan, you can checked Recommended.
If you want to create a free trial plan, you can keep the free trial checkbox checked. In that case the price fill and discount fill will be disabled automatically.

You can set student, parents, staff, teacher limit as per your wish and school cannot add user above this limit.

Subscription time periods are divided into 4 categories (Days, Monthly, Yearly, Lifetime) And you can select the models you want to offer the user in this plan then finally click on Save.

### 03. How to Add A School Subscription

There are two ways you can add a school.

One way is you can add schools manually from the super-admin panel. Login as super admin. Then go to School Subscription > Subscription and you can see the Subscription List page and and click Add School tab and Fill-up in all box then finally click on Save.

The second way is the user can subscribe and pay directly from the website by selecting the plan as her choice.

Online school subscription register form and fill-up all mandatory box then click "Register & Payment" Button. The app will automatically take you to a checkout page.

After successful checkout you will get a success message and can download the invoice And after super-admin approves your request you can login as admin.

### 04. How To Approves Subscription Request?

Login as super-admin. Then go to School Subscription > Pending Request and you can see the Pending Request list page. If you want to approve, you can click on the Approve button. Also you can reject the request if you want.

### 05. How to Renew Subscription?

To Subscription renew you need to login as admin first. Then go to School Subscription and you can see the Subscription page and click Renew Subscription button.

### 06. How to Set Custom Domains?

Custom domains will allow your users to use their own domain name instead of the default domain URL. You can also add subdomains for each user.

* Before start the custom domains feature make sure this script is installed on your primary domain. Subdomains or subfolders it will not work properly.

You can offer two types of custom domains to users. 1. Domain 2.Subdomains

* Subdomains are auto-configurable. That means you don't have to go to the server for configuration every time.

Step 1 : First login as Super admin. Then go to School Subscription > Custom Domain and you can see the Custom Domain page and you can click Custom Domain Instruction button.

You can provide instructions for custom domains to your users. Also you can provide your server's DNS record setting here. If you don't want to give any kind of instruction you can disable the status.

Step 2 : Login as Admin. Then go to Custom Domain and you can see the Custom Domain page and you can click Sent Request tab. User can send request for domain or subdomain. A school can send requests for one custom domain at a time. But user can edit custom domain after approval. But in that case he has to wait for approval.

Step 3 : Login as Super admin. Then go to School Subscription > Custom Domain and here you will see all your users requested domain, once your approved your domain then this will be go for live.

### Set Up Server.

After approved "custom domain" request you need to add this user domain in your server Domain Aliases. Please login to your server go to Domains > Aliases section.

* These settings should be do only if the user sends the request of the Main Domain to the "Custom Domain". Not applicable to subdomains.

Paste here the Domain name requested by your user in the custom domain and click Add Domain button.

* Note : Must be The Domain Root path is same with your Ramom School hosted directory.

### - Configure Auto Subdomains

This configuration is only for subdomains, once done on your server you don't need to do it again. Then the Custom Domain request is approved then this will be go for live.

Please login to your server go to Domains > Subdomains section.

Use * in the subdomain field. Be sure Domain Root path is same with your Ramom School hosted directory.

### How to configure PWA (Progressive Web Application)?

For changing pwa app icon, color theme, name follow below instruction:

- SSL certificate is required for PWA.
- To change the app icons, go to the "uploads/appIcons/" folder in the main directory. There, you'll find icons of different sizes. Just upload your preferred icons using the sizes, name & extension.

02. Open manifest.json file in the root of your installation folder. Change the variables shown in the image.

03. Then Goto School Subscription > Settings and click Website Settings button and enable Progressive Web Apps (PWA).

N.B.

- Chrome uses a huge cache for these icons. If you change these icons it won’t reflect on the customer installed app. So before customers browsing your site replace those icons.
- Progressive web app only works properly on subdomain or domain.
  Example:
  https://saas.ramomcoder.com (Works Properly).
  https://ramomcoder.com/saas (Properly not work).

### Changelog

Version 3.1.6 – 02, November, 2025

    - Fixed - 404 Page Not Found After Plan Subscription Payment.

Version 3.1.5 – 26, March, 2025

    - Addad Compatible Ramom Multi Branch School V6.9
    - Fixed Footer Background Color Issue.

Version 3.1 – 26, May, 2024

    - Addad Compatible Ramom Multi Branch School V6.6.
    - Addad Send Test Email.
    - Fixed Subscription Related Page Showing Global Currency Issues.
    - Fixed Subdomain dot(.) Related Issues.
    - Fixed Front-End Contact Page Mobile Number Blank Issues.

Version 3.0 – 02, March, 2024

    - Added Added Progressive Web Apps (PWA).
    - Added Automatic Subscription Approval.
    - Added Offline Payments.
    - Added Google Recaptcha (School Register).
    - Added Terms & Conditions.
    - Added Feature Show/Hide Package On Website.
    - Added Slider Overlay Image Enable/Disable Feature.
    - Added Slider Overlay Image Upload Feature.
    - Added Paytm Payment Gateway (Indian).
    - Added Toyyibpay Payment Gateway (Malaysian).
    - Added Payhere Payment Gateway(Sri Lankan).
    - Fixed Disabled Packages Cannot Be Purchased.
    - Fixed Unwanted Trial Request.
    - Fixed All Known Bugs And Security Issue.

Version 2.2 – 22, August, 2023

    - Addad Addon is now installable.
    - Addad Compatible Ramom Multi Branch School V6.2.
    - Addad Saas Email Test.
    - Fixed Subscription Renew Payment Issue.
    - Fixed Subscription Payment Dropdown Issue.
    - Fixed Some Case Custom Domain Issue.
    - Fixed All Known Bugs.

Version 2.1 – 13, June, 2023

    - Added Subscription Transactions History.
    - Fixed All Known Bugs.

Version 2.0 – 01, June, 2023

    - Added Custom Domain Module.
    - Added SEO Title, Meta Keyword, Meta Description.
    - Added Google Analytics.
    - Fixed Parent Wrong Count in Front-end.

Version 1.0 – 24, April, 2023

    - Initialize release

### Customer Support

I hope you will enjoy using this software! We provide customer support through the Support Ticket System. If you encounter any technical issues, open a support ticket and our technical team will be happy to assist you and solve it.

* Please note that support does not cover script customizations or third-party plugins. For advanced modifications, we recommend hiring a third-party developer or using our customization service.

Go to Support Portal

Once again, thanks for purchasing Ramom School Subscription(Saas).