WooCommerce Board MLM Plan - Documentation

Server Requirements

As you konw this system is in Wordpress CMS. The Wordpress CMS has a few system requirements.
You will need to make sure your server meets the following requirements:

• PHP 7.4 or greater
• MySQL 5.6 or greater OR MariaDB 10.1 or greater
• Nginx or Apache with mod_rewrite module
• HTTPS support

Plan Setup

Plan settings steps :

• Login to website's admin panel
• Go to Settings > admin settings, and fill your websites settings (like title, subtitle logo)
• Go to Plugins > Activate WooCommerce before activateing Board Mlm Plan.
• Go to Plugins > Activate Board Mlm Woocommerce Plan .

Plan Setup

Plan settings steps :

Go to Settings if first user is register then you will directly jump on general settings otherwise you have to create first user.

Fill all given fields.

1. Username --> Enter your username.
2. Password --> Enter the password.
3. Confirm password --> Enter the password that is same as filled in password.
4. Email --> enter your valid email.
5. First name --> enter your First name.
6. Last name --> enter your Last name.

That's Done!!

General Settings

General settings steps :

Fill all given fields

1. Redirect after Registration --> It means that Select the Redirect Page after registered the User Successfully.
2. Redirect after Login --> It means that Select the Redirect Page after Login the User Successfully.
3. Affiliate user Redirect Page --> Select the page where affiliate user will redirect by referral link.
4. Board Plan Type --> Select the Board Plan Type Single-Board or Multi-Board Plan;
5. Board Matrix --> You can Select how many height and width of matrix;
6. Matrix-Width --> how many width of matrix it means that how many childs under the users
7. Matrix-Height --> how many levels of matrix.
8. Withdrawal limit --> Enter the withdrawal limit , how much money your can withdrawal, and update settings.
9. Shortcode Error Message--> Display this message or content when shortcode have error or not display after add on the page.
10. Plan Based On --> Select your plan base, means you want to run your plan on price value or want to run on point value.

That's Done!!

Eligibility Settings

Eligibility settings steps :

1. No of personal Referrals --> That eligibility is eligible the user for payout ,when user’s referrals are equal to total personal referrals then the user eligible for payout.
2. Distribute ineligible Commissions --> Enable the option if you want to distibute commission for ineligible Users.
3. update settings.

That's Done!!

Mapping Settings

Mapping settings steps :

1. Order completetion status --> when order is placed and order status changed to selected status them user become paid and sponsor and parent’s commission will be generated.
2. update settings.

That's Done!!

Payout Settings

Payout settings steps :

Fill all given fields

1. Join Commission --> This amount will be credit in each user’s account and that commission only one time credit in new join or registered user’s account.
2. Referral Commission --> This commission Amount is credit in user’s account when they add the users in network and who is sponsor of new registered user and this commission only one time credit of any new user and this amount would be in fixed or Percentage(if this amount in percent then the percent amount will be calculated from the order total).
3. Board Completion Commission --> This commission Amount is credit in user’s account when that users complete our board matrix users it means that when the user add the number of users under him and matrix will complate like 2x2(2 levels and 2 childs) then this commission will be credit in user account.
4. Matching Commission --> This commission Amount is credit in user’s account when current user sponsored the new user and then new user is also sponsored any new another user and and this amount would be in fixed or Percentage(if this amount in percent then the percent amount will be calculated from the order total). eg:- (Suppose User A sponsor to the User B and then User B is sponsored User C then User C will purchase any item then User B get the referral commission from User C 20rps and then (spillover) User A will get matching commission like 5% from User B of 20rps not from User C. it means that User A mathing commission is 1 rps but User B will not get the matching commission from User C))
5. Service Charge --> This Amount is debite from user’s total created amount when payout run and this amount would be in fixed or Percentage.
6. Tax Deduction --> This Amount is debite from user’s total created amount when payout run and this amount would be in fixed or Percentage.
7. Cap Limit Amount --> Cap limit is prevent the payout amount limit , that prevent the payout amount never be greater to cap limit amount.
8. Update settings.

Matching Commission Image of Users and try to understand from this below image.

Level Commission Settings

Level Commission Settings Steps :

Fill all given fields

1. Level Name --> You need to give the name to each level.
2. Commission Amount --> Set commission amount to each level.
3. Commission Type --> Evevry user on that level user get the amount(if commission type is percent then each product have the setting for level commission amount the amount will be calculate from that) or (if select commission type fixed then each user get commsion amount on the basis of level commission amount).
4. Update settings.

That's Done!!

Left menu pages Settings

Left menu pages :This setting is display in under the general setting in the congiguration tab.This setting is by default disabled.It is enabled or disabled by the admin.It is Enabled or Disabled the left menu pages in frontend or User end dashboard. ex-display downlines, payout and withdrawal etc.

1. Dashboard Page--> Dashboard Page is enabled means user can access and display the dashborad tab in the left menu of user dashboard
2. Genealogy Page--> Genealogy Page is enabled means user can access and display the genealogy tab in the left menu of user dashboard
3. My Downlines Page--> My Downlines Page is enabled means that user can access and display the My Downliners tab in the left menu of user dashboard
4. Payout Details Page--> Payout Details Page is enabled means user can access and display the Payout Details tab in the left menu of user dashboard
5. Payout Details Page--> Payout Details Page is enabled means that user can access and display the Payout Details tab in the left menu of user dashboard
6. Payout List--> Payout List Page is enabled means that user can access and display the Payout List tab under the payouts details in the left menu of user dashboard
7. Join Commission List--> Join Commission List Page is enabled means that user can access and display the Join Commission tab under the payout details in the left menu of user dashboard
8. Level Commission List--> Level Commission List Page is enabled means that user can access and display the Level Commission tab under the payout details in the left menu of user dashboard
9. Personal Information Page--> Personal Information Page is enabled means user can access and display the Personal Information tab in the left menu of user dashboard
10. Bank Details Page--> Bank Details Page is enabled means user can access and display the Bank Details tab in the left menu of user dashboard
11. Withdrawal Amount Page--> Withdrawal Amount Page is enabled means user can access and display the Withdrawal Amount tab in the left menu of user dashboard
12. Registration Page--> Registration Page is enabled means user can access and display the Registration tab in the left menu of user dashboard
13. Update settings or Click Save Page Settings.

That's Done!!

All pages are enabled.

All pages are displaying in user left menu sider bar or user dashboard because all pages are enabled.

Now Disabled the genealogy page then it will not display on user Dashboard.

Genealogy Page is not displaying on User dashboard because It has been disabled from lef menu pages Setting By admin.

Lisence settings

Lisence settings steps :

Fill all given fields

1. Licence --> Enter your licence key to use the plugin and this key is provide by us, If you don’t have key then click on purchase licence and perchase the licence.
2. Update settings.

That's Done!!

Dashboard Design Setting

Dashboard Design Setting :This setting is used for design the dashboard of front end or user end. Admin can design the user dashbord with the help of these settings. Admin can enabled or disabled these settings.

Disable Custom Style--> Admin can enabled and disabled the style on user dashboard.If You will click on checkbox it means that disabled the defaults dashboard designing and your custom designing will be set. if You will unchecked the checkbox and then save it means that default designing will set and your custom designing is unset.

1. Bg Gradient--> This Bg Gradient setting or color is applied on lef menu background color with gradient.
2. Link Hover Bg and Right border--> This Link Hover Bg and Right border setting or color is applied on lef menu background color and right small border display when hover on left menu.
3. Link Active Bg and Right border--> This Link Active Bg and Right border setting or color is applied on lef menu background color and right small border display when active or visited the left menu.
4. Heading Bg and Font color--> This Heading Bg and Font color setting is display the background color and font color on the heading and table header on user Dashborad.
5. Loader Color--> this is applied on the loader color when any ajax request is execute on user end.
6. Overlay Bg Color--> this is applied on the Overlay background color when any ajax request is execute on user end.
7. Click Save Dashboard Design Settings.




User Dashboard design will display the before apply the custom css or we can say the default user dashboard Design Settings.





Default Design User Dashboard





User Dashboard design will display the after apply the custom css or we can say the custom user dashboard Design Settings.





Custom User Dashboard

How to Distribute Commission ?

Go to Distribute Commission :- Display all commission whatever user will get the commission.

• Level Commission List--> Level Commission List Page is enabled means that user can access and display the Level Commission tab under the payout details in the left menu of user dashboard
• Referral Commission --> This commission Amount is credit in user’s account when they add the users in network and who is sponsor of new registered user and this commission only one time credit of any new user and this amount would be in fixed or Percentage(if this amount in percent then the percent amount will be calculated from the order total).
• Join Commission --> This amount will be credit in each user’s account and that commission only one time credit in new join or registered user’s account.
• Matching Commission --> This commission Amount is credit in user’s account when current user sponsored the new user and then new user is also sponsored any new another user and and this amount would be in fixed or Percentage(if this amount in percent then the percent amount will be calculated from the order total). eg:- (Suppose User A sponsor to the User B and then User B is sponsored User C then User C will purchase any item then User B get the referral commission from User C 20rps and then (spillover) User A will get matching commission like 5% from User B of 20rps not from User C. it means that User A mathing commission is 1 rps but User B will not get the matching commission from User C))
• Board Completion Commission --> This commission Amount is credit in user’s account when that users complete our board matrix users it means that when the user add the number of users under him and matrix will complate like 2x2(2 levels and 2 childs) then this commission will be credit in user account.

That's Done!!

How to run payout ?

Go to Run Payout. Here is all type of commission that user will get and there are 3 steps to run payout.

• Payout Run : Here you will find the run payout button. Click on this button to run payout.
• Charges :There two Charges in board plan that will be deducted from total commission amount (First One Service Charge) and (Second One Tax) that are exist in payout Setting.
• Service Charge :Service Charge will be debit from Total Commission Amount
• Tax Charge :Tax Charge will be debit from Total Commission Amount

How can i check payout reports?

Go to Board Plan > Payout report. here you will see all payouts List.

• To view details of payout click on action button, here you will see the user's payouts with their total commissions, deductions.
• To view user's payout details click on action button, here you will see complete details of that users payout.

How can i check user reports ?

Go to board plan > User Report. Here you will see user reports listing with total comissions, and deductions.

• Action : Here you will find the button. click on this buuton to cheack particular user report.
• Personal detail : Here you will find the all personol detail of user.
• Complete commission : Here you can see Completion commision (Board Complete commision) of user.
• matching commission : Here you can see matching commision of user .
• Level commission : Here you can see level commision of user.
• Join commission : Here you can see join commision of user.
• Referrel commission : Here you can see referrel commision of user.

Genealogy

In our system we have developed genealogy with d3.v4 onganization chart .

• Single Board :- In single board we have display only Two Board in genealogy second board will display when any user will be jump on second board after complate the first board eligibility.
• Multi-Board In multi board we have display multi Board in genealogy next board will display when any user will be jump on next board after complate the current board eligibility.

Fisrt Board :-

Second Board :-

How To Manage Withdrawals Requests?

Go to umw > Withdrawals. Here you will see user withdrawal requests.
Click on action pay button to change status of withdrawal request. you can change withdrawal status only once.

• To view details of witdrawal click on action pay button, here you will see the user's witdrawal requset and you can accept requst and you can see history of witdrawal .
• Here you will get the all detail of witdwaral request. and history of witdrawal request. here we have three sections.
• withdrawal requestHere you will get the all detail of withdrawal request.
• Bank detailhere we have account detail of user for the payment.
• payment formpayment form for change the status of payment .
• withdrawal historyhere we have history of withdrawal, paid request, process request,initiate request.

SMS Settings

Click on Gateway button to see gateway settings,In our system we have developed three SMS gateway.

• To use TEXT LOCAL SMS gateway fill all the credential of TEXL LOCAL SMS gateway
• To use Twilio SMS gateway fill all the credential of Twilio SMS gateway
• To use Plivo SMS gateway fill all the credential of Plivo SMS gateway

Click on SMS settings button to see SMS settings,.

• Write the message in message box that you want to send to user .
• Select the mail type for what you re typing mail.
• Click and use in message you can use these keywords in your message.
• Click on Submit button to save the message.

Mail Center

Go to Mail Center If admin want to send mail to any user he can send mail useing mail center.

• Select the user him you want to send mail
• Enter the subject of mail
• Type the message that you want to send to user

Mail Settings

Go to Mail Settings To see mail settings.

• Write the mail in message box that you want send to user.
• Select the mail type for what you re typing mail.
• Click and use in message you can use these keywords in your mail.
• Click on Submit button to save the mail.

Registration

Registration steps :

1. username--> Your username should be unique otherwise it will return an error.
2. First Name--> Enter your first name.
3. Lat name--> Enter your last name .
4. Password--> Enter your password.
5. Confirm password--> Enter your confirm password , password and confirm password should be match otherwise it will return an error.
6. parent name --> Enetr your parent name, parent is the person that is just uplines you.
7. Address--> Enter your Address.
8. Email--> Your Email also should be unique otherwise it will return an error.
9. Sponsor name--> Enter your sponsor name, sponsor is a person who refer you in this plan.
10. Mobile no.--> Select your country phone code and enter your mobile no. and click on get otp to verify your number.

That's Done!!

Join

Join steps :

1. Phone--> Enter your Phone .
2. Sponsor--> Enter your Sponsor name.

That's Done!!

User dashboard

User dashboard :

1. User earning--> User earning details how much user earn, how much withdrawal by user and the no. of referrals.
2. This section is display the user’s all details like that.

That's Done!!

Genealogy

In our system we have developed genealogy with d3.v4 onganization chart .

That's Done!!

User Payout details

User Payout details :

1. payout list--> Here we have total payout list details you can check how much commission you get from which commission.
2. particular commission--> If you want to know abount particular commission then Check on tab that you want to know about.

That's Done!!

User account details

User account details :

1. Plese fill your all details otherwise you can not withdrawal amount from your account Update your account details.

That's Done!!

User Withdrawal details

User Withdrawal details :

1. Account details--> Here we have total amount deatils your current amount,requested amount and panding amount.
2. Withdraw Amount--> Withdrawal form enter your amount how much you want to withdrawal and click on request now to withdrawal tha amount.
3. Withdrawal List--> You have withdrawal amount deatils .

That's Done!!

Shortcode Details

Registration Shortcode - [umw_user_registeration] : Registration Shortcode is used for add the Registration Form or functionality on the any page by use the registration shortcode direct or with the help elementor plugin. ex-[umw_user_registeration]

Loing Shortcode

Loing Shortcode - [umw_login_form] : Loing Shortcode is used for add the Loing Form or functionality on the any page by use the Loing shortcode direct or with the help elementor plugin. ex-[umw_user_registeration]

Genealogy Shortcode

Genealogy Shortcode - [umw_genealogy] : Genealogy Shortcode is used for display the genealogy on the any page by use the Genealogy shortcode direct or with the help elementor plugin. ex-[umw_genealogy]

My Downliners Shortcode

My Downliners Shortcode - [umw_my_downlines] : Downliners Shortcode is used for dispaly the our downliners on the any page by use the Loing shortcode direct or with the help elementor plugin. ex-[umw_my_downlines]

Payout List Shortcode

Payout List Shortcode - [umw_payout_list] : Loing Shortcode is used for add the Loing Form or functionality on the any page by use the Loing shortcode direct or with the help elementor plugin. ex-[umw_payout_list]

Join Commission List Shortcode

Join Commission List Shortcode - [umw_join_commission_list] : Join Commission List Shortcode is used for display the join commission list on the any page by use the Join Commission shortcode direct or with the help elementor plugin. ex-[umw_join_commission_list]

Level Commission List Shortcode

Level Commission List Shortcode - [umw_level_commission_list] : Level Commission List Shortcode is used for display the Level commission list on the any page by use the Level Commission shortcode direct or with the help elementor plugin. ex-[umw_level_commission_list]

Referral Commission List Shortcode

Referral Commission List Shortcode - [umw_referral_commission_list] : Referral Commission List Shortcode is used for display the Referral commission list on the any page by use the Referral Commission shortcode direct or with the help elementor plugin. ex-[umw_referral_commission_list]

Regular Bonus List Shortcode

Regular Bonus List Shortcode - [umw_regular_bonus_list] : Regular Bonus List Shortcode is used for display the Regular Bonus list on the any page by use the Regular Bonus shortcode direct or with the help elementor plugin. ex-[umw_regular_bonus_list]

Personal Information Shortcode

Personal Information Shortcode - [umw_personal_detail] : Personal Information Shortcode is used for display the user personal information on the any page by use the Personal Information shortcode direct or with the help elementor plugin. ex-[umw_personal_detail]

Bank Details Shortcode

Bank Details Shortcode - [umw_bank_detail] : Bank Details Shortcode is used for display the user Bank Details on the any page by use the Bank Details shortcode direct or with the help elementor plugin. ex-[umw_bank_detail]

Withdrawal Earning Summary Shortcode

Withdrawal Earning Summary Shortcode - [umw_withdrawal_earning_summary] : Withdrawal Earning Summary Shortcode is used for display the user Withdrawal Earning Summary on the any page by use the Withdrawal Earning Summary shortcode direct or with the help elementor plugin. ex-[umw_withdrawal_earning_summary]

Withdrawal Amount Shortcode

Withdrawal Amount Shortcode - [umw_withdrawal_amount] : Withdrawal Amount Shortcode is used for display the user Withdrawal Amount Form for withdrawal process on the any page by use the Withdrawal Amount shortcode direct or with the help elementor plugin. ex-[umw_withdrawal_amount]

Withdrawal History Shortcode

Withdrawal History Shortcode - [umw_withdrawal_history] : Withdrawal History Shortcode is used for display the user Withdrawal History of the User on the any page by use the Withdrawal History shortcode direct or with the help elementor plugin. ex-[umw_withdrawal_history]

Join Network Shortcode

Join Network Shortcode - [umw_join_network] : Join Network Shortcode is used for display the Join Network form on the any page by use the Join Network shortcode direct or with the help elementor plugin. ex-[umw_join_network]

User Affiliatem Link Shortcode

User Affiliatem Link Shortcode - [umw_affiliate_link] : User Affiliatem Link Shortcode is used for display the User Affiliatem Link on the any page by use the Affiliatem Link shortcode direct or with the help elementor plugin. ex-[umw_affiliate_link]

Total Earning, Withdrawal, Bonus, Downlines Shortcode

Total Earning, Withdrawal, Bonus, Downlines Shortcode - [umw_earn_with_bonus_down] : This shortcode is used for display the Total Earning, Withdrawal, Bonus, Downlines on the any page. ex-[umw_earn_with_bonus_down]

Total Earning Graph Shortcode

Total Earning Graph Shortcode - [umw_earning_graph] : This shortcode is used for display the Total Earning by the graph or chart on the any page. ex-[umw_earning_graph]

Total Earning, Charges, Net Income Shortcode

Total Earning, Charges, Net Income Shortcode - [umw_overall_earning] : This shortcode is used for display the Total Earning, Charges, Net Income on the any page. ex-[umw_overall_earning]

Board MLM Compensation Plan Example

Frontend : Login with first user. Now this user will sponsor new users in network.

-->Registration of new user

-->Order the product

-->Approve the order by changing the order status as done in mapping setting

-->Add more users in network

The first user ‘admindemo’ has sponsored two new users ‘A’ and ‘B’ in network,

Total Order done by user A=>₹20,000.00 (200 points is set of the product)
Total Order done by user A=>₹35,000.00 (350 points is set of the product)

Commission calculation

From our configuration settings, the commission/points values are as follows:

• Join commission = 200 (fixed)
• Referral Commission or Affiliate Commission = 100 (fixed)
• Board Completion Commission = 500 (fixed)
• Matching Commission = 10% (Sponsor get matching commission when its child get referral commission or completion commission)
• Level commission = 10% (for users at level 1), 5% (for users at level 2)

Referral Commission

For user A=>100 points (fixed)
For user B=>100 points (fixed)

Level Commission

For user A=>10%*200=20 points
For user B=>10%*350=35 points

Join Commission

Join commission is set as 200 points(fixed).

Total points =>Join comm+Referral comm+Level comm=200+(100+100)+(20+35)=455 points (as shown in figure below)

-->User ‘A’ sponsored/ refer two new users, user 'C' & user 'D' and User 'B' sponsored 'E' & 'F' in network
Total order done by user ‘C’= ₹15,000.00
Total order done by user ‘D’ = ₹20,000.00
Total order done by user ‘E’= ₹35,000.00
Total order done by user ‘F’ = ₹20,000.00

As the plan is based on points, so the points related to that products will be considered;
Total points by user ‘C’ = 150 points
Total points by user ‘D’ = 200 points
Total points by user ‘E’ = 350 points
Total points by user ‘F’ = 200 points

Distribute Commission

Join Commission

For user A = 200 points
For user B = 200 points

Referral Commission

user A = 100 points(user C) + 100 points(user D)= 200 points
user B = 100 points(user E) + 100 points(user F)= 200 points

Level Commission

User A = 10% * product points purchased by user C + 10% * product points purchased by user D
= 10% * 150 + 10% * 200
=15 points + 20 points
=35 points

User B = 10% * product points purchased by user E + 10% * product points purchased by user F
= 10% * 350 + 10% * 200
=35 points + 20 points
=55 points

users C, D, E & F all are second level for user admindemo , so it will get commission 5% * points purchased by users

User admindemo = = (5% * 150) +(5% * 200) +(5% * 350) + (5% * 200)
= 7.50 + 10 + 17.50 + 10
= 45 points

As we have defined the board matrix= 2*2, hence on adding user ‘F’ the board 1 will be completed and the root user ‘admindemo’ will upgrade to new board 2 in the system.

Board Completion Commission

user admindemo= 500 points

Matching Commission

user A = 10%* A’s referral commission (for user C) + 10%* A’s referral commission (for user D)
= 10% *100 + 10% *100
=20 points

user B = 10%* A’s referral commission (for user E) + 10%* A’s referral commission (for user F)
= 10% *100 + 10% *100
=20 points

Total commission/points = Level commission + Referral commission + join commission + matching commission + completion commission

• user ‘admindemo’=> Total commission/ points = (55+45) + (100+100) + 200 + 40 + 500 = 1040 points
• For user ‘A’ => Total commission/ points = (20+15) + (100+100) + 200 = 435 points
• For user ‘B’ => Total commission/ points = (35+20) + (100+100) + 200 = 455 points

Total distributed commission points = (1040 + 435 + 455) points = 1930 points

Payout Run

Total commission = Total points / Conversion rate
Net amount = Total Commission amount - (service charges + TDS)

• For first user ‘admindemo’=> Net amount = ₹520.00 - ( ₹26.00 + ₹26.00) = ₹468.00
• For user ‘A’=> Net amount = ₹217.50 - ( ₹10.88 + ₹10.88) = ₹195.75
• For user ‘B’=> Net amount = ₹227.50 - ( ₹11.38 + ₹11.38) = ₹204.75

Total amount distributed in network after first payout run = =₹468.00 + ₹195.75 + ₹204.75 =₹868.50

That's Done!!

Buy Now