Board MLM Module Documentation for Magento 2

Introduction

He Board MLM Module for Magento 2 is a comprehensive multi-level marketing solution that incorporates a structured board system for seamless user progression, automatic board completion, hierarchical upgrades, and commission distribution based on predefined rules.

Features

Board-Based MLM Structure: Users are placed in a board, progressing through levels.
Automatic Board Completion: When a board is filled, it splits, promoting users.
Commission Distribution: Earnings are calculated based on board levels.
User Upgrades: Users upgrade upon meeting board completion criteria.
Genealogy Tree View: Displays user hierarchy and board positions.
Integration with Magento 2: Fully compatible with Magento customer module.

Key Features:

Referral and commission tracking based on customizable Board Mlm structures.
Bonus and level commission management, with options for both fixed and percentage-based commissions.
Eligibility settings to determine which users qualify for commissions and bonuses.
Payout management, including service charges, taxes, and the ability to run payouts for commissions and bonuses.
Genealogy tree view to visualize your network and customer hierarchy.
Advanced reporting Generate reports for commissions, payouts, withdrawals, and customer activity. Reports can be customized to suit your business needs and exportable for further analysis.
QR Code for Referral Link Generate a QR code for referral links, making it easier for users to share their referral link both online and offline. The QR code can be downloaded in JPG or PNG format for easy sharing.

Installation

Magento 2 module installation. Here's a detailed guide on how to proceed:

Magento 2 module Installation

Step 1:Extract the Zip File:

Extract the contents of the zip file to a temporary directory on your computer.

Step 2: Copy Files to Magento Root Directory:

Copy all files and folders from the extracted zip file.
Paste the copied files into the app/code directory inside your < Magento root directory>. If app/code does not exist, create it.

Step 3: Open Terminal or CMD:

Change your working directory to the Magento root directory using the following command:

you need to run the following commands to install and activate the module:

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy -f

php bin/magento cache:clean

Verify Installation:

```
php bin/magento module:status
```

Troubleshooting:

Permissions Issue: Ensure the app/code directory and its contents have the correct permissions set for your web server user.
Magento Cache: If you encounter issues, try clearing Magento caches and reindexing:
```
php bin/magento indexer:reindex
```
```
php bin/magento cache:clean
```

Configuration

Navigate to the Module Configuration:

Go to LETSCMS Board_mlm Plan > Board Mlm Plan Configuration.

General Settings

Go to Letscms Board mlm Plan > Board_mlm Configuration > General and update general settings for defaults.

Fill all given fields

Enable Board_mlm plan : set "YES" to enable plan for website.

Order 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.

Board Plan Type: Select the type of board plan for your MLM structure.

Maximum Number of Boards:Specify the maximum number of boards allowed. Only applicable if "Multi Board" is selected.

Network WidthPlease specify width of network

Network HeightPlease specify height of network

Max referrals : is maximum number of referrals can be join directly under a single person.

Min Withdrawal : amount you can withdrawal for each request.

Max Withdrawal : amount you can withdrawal for each request.

Withdrawal Fee Amount : withdrawal processing fee amount for each request.

Withdrawal Fee Type : withdrawal processing deduction type (percentage/fixed)

Eligibility Settings

Go to Letscms Board Mlm Plan > Bmm Configuration > Eligibility and update eligibility settings for defaults.

Fill given fields

Min Direct Referral : That eligibility is eligible the user for payout, when user’s referrals are equal to total personal referrals then the user eligible for payout.

Bonus Settings

Go to Letscms Board Mlm Plan > Bmm Configuration > Bonus and update bonus settings for defaults.

Fill all given fields

Direct Referrals : Enter the minimum number of direct referrals required. This ensures that only users with a significant network can earn bonuses.

Amount : Enter the amount of the bonus in this field. This amount can be a fixed sum or a percentage, depending on the Comm. Type.

Commission Type : Determines how the commission amount is calculated. There are two types:

Percentage: The bonus is calculated as a percentage of the total earned commission.
Fixed: The bonus is a fixed amount regardless of the total earned commission

Example

Fixed Bonus Example:
- Direct Referrals: 5
- Amount: $100
- Comm. Type: Fixed
  - Explanation: A user with at least 5 direct referrals will receive a $100 bonus. This bonus is a fixed amount, regardless of the total earned commission.
Percentage Bonus Example:
- Direct Referrals: 10
- Amount: 5%
- Comm. Type: Percentage
  - Explanation: A user with at least 10 direct referrals will receive a bonus equal to 5% of their total earned commission. For example, if the total earned commission is $1,000, the bonus would be $50 (5% of $1,000).

Note : user can get multiple time bonus based on sale of downliners.

Level Commission

Go to Letscms Board Mlm Plan > Bmm Configuration > Level Commission and update level commission settings for defaults.

Fill given fields

Level Name : Enter the name or label for each level. This helps in identifying and distinguishing between different levels of commission.

Amount : Enter the commission amount that should be rewarded for the respective level. This can be a fixed amount or a percentage based on the total order amount.

Commission Type : Determines how the commission amount is calculated. There are two types:

Percentage: commission is calculated as a percentage of the total order amount. For example, if the commission type is set to percentage and the percentage is 5%, and the total order amount is $200, then the commission amount would be $10 (5% of $200).
Fixed: The commission is a fixed amount regardless of the order amount. For example, if the commission type is fixed and the amount is $20, then $20 will be awarded for that level regardless of the total order amount.

Example

Level 1:
- Level Name:: Level 1
- Amount: 5% (Commission Type: Percentage)
  - Explanation: For each order placed by a member on Level 1, the commission awarded will be 5% of the total order amount. If the order amount is $100, the commission will be $5.
Level 2:
- Level Name:: Level 2
- Amount: $20 (Commission Type: Fixed)
  - Explanation: For each order placed by a member on Level 2, the commission awarded will be a fixed amount of $20, regardless of the total order amount.

Payout Settings

Go to Letscms Board Mlm Plan > Bmm Configuration > Payout Settings and update bonus settings for defaults.

Fill all given fields

Company Commission Amount : Enter the commission amount the company will earn per order.

Company Commission Type: Determines how the commission amount is calculated. There are two types:

Percentage: The company earns a percentage of the total order amount.
Fixed: The company earns a fixed amount per order.

Commission : commision is the commision that root memeber of the network will get commission based on configuartion by each order

Company Commission:This is the commission amount that the root member of the network (e.g., the top-level user or network owner) will receive
from each order, based on the configuration.

Join Commission Amount:The amount of commission given to a new user for their first order.

Join Commission Type: Defines how the join commission amount is calculated

Percentage: The commission is a percentage of the first order amount.
Fixed: The commission is a fixed amount.

Join Commission : commission is the commision that get to the new registered user one time only when joined the network. it is discount to new memeber but in the form of commision

Affiliate/Referral Commission Amount:The commission amount awarded to the affiliate or referrer when their direct downline places their first order.

Affiliate/Referral Commission Type Specifies how the affiliate or referral commission is calculated

Percentage: The commission is a percentage of the first order amount.
Fixed: The commission is a fixed amount.

Affiliate/Referral Commission : is commision to the sponsor based on configuration but only one time when the first order is placed by the direct downliner

Board Commission AmountThe commission awarded to an affiliate or referrer once their board is completed.

Board Commission Type Determines how the board commission is calculated:

Percentage: The commission is a percentage of the first order amount.
Fixed: The commission is a fixed amount.

Service Charge Amount:The amount deducted as a service charge for each payout.

Service Charge Amount Type: Defines how the service charge amount is calculated.

Percentage: The service charge is a percentage of the total commissions and bonuses.
Fixed: The service charge is a fixed amount per payout.

TDS (Tax Deducted at Source):The amount of tax to be deducted from the payout as per the applicable tax laws.

TDS Charge Amount Type: TDS Charge Amount Type:

Percentage: The TDS is a percentage of the total commissions and bonuses.
Fixed: The TDS is a fixed amount.

Email Settings

Go to Letscms Board Mlm Plan > Bmm Configuration > Eligibility and update eligibility settings for defaults.

Fill given fields

From Name:Enter the name you want to display as the sender of the emails. This helps recipients recognize who the email is from.

From Email:Enter the email address you want to use for sending out emails. Ensure this email address is valid and monitored, especially if you expect replies.

Example: @yourcompany.com or support@yourcompany.com.

Email Templates Settings : have created default templates with template variables, please create new templates using them and change the content of template as you wish and assign the new template instead of default template. to create a new template go to Marketing > Email Template.

Board Mlm Product

Creating a Board Mlm Product

To configure a product as a Board Mlm product, follow these steps:

Navigate to Product Management:

Go to Catalog > Products in the Magento Admin Panel.

Select or Create a Product:

In the product edit page, scroll down to the General section or similar, depending on your Magento version and customizations.

Find the field or checkbox labeled Is Board Mlm Product.

Set this field to True or check the checkbox to enable it.

Save the Product::

After enabling the Is Board Mlm Product option and making any other necessary adjustments, click Save to apply the changes.

Search for Board Mlm Product

Ensure the search functionality works for Board Mlm products.

Search for “your Board Mlm product name ” and “ etc Board Mlm product ”.

Create First/Root Customer

Creating a Board Mlm Product

Navigate to LETSCMS Board Mlm Plan:

Go to Letscms Board Mlm in the Admin Panel menu.

Click on Create Root Customer.

Run Payout

Payout Commissions

Ensure that the commissions calculated for payout are accurate before executing the payout process.

Payout Bonuses

Confirm that the bonuses due for payout are correct and aligned with the company's bonus structure.

Run Payout

Ensure that the total amounts of commissions and bonuses are correct before proceeding with the actual payout.

Note : Don't Forgot to select website each time whenever checking payout details or running payout. !!

Genealogy

To enable the admin to view and manage the hierarchical structure of Board Mlm customers, providing insights into their network and structure.

Navigate to Genealogy

go to Letscms Board Mlm Plan > Genealogy to access the genealogy management section.

Board A

Board B

Viewing the Genealogy Tree

Navigating the Tree:
- Zoom and Pan: zoom and pan features to get a closer look at specific areas of the tree or to view larger sections.
- Expand/Collapse Nodes: Click on nodes to expand or collapse branches of the tree. This helps in focusing on specific parts of the network or simplifying the view.
Tree View Overview:
- Tree Structure: Genealogy section displays a visual tree view of the Board Mlm customers, showing their hierarchical relationships within the system.
- Nodes and Links: Each node on the tree represents a customer or affiliate, and lines or links between nodes illustrate the relationships or downlines.

Reports

Customer Reports

view, filter, and manage customer information, including details on referrals, transactions, withdrawals, and payouts.

Navigate to Customer Reports:

go to Letscms Board Mlm Plan > Customer Reports to access the list of customers.

View the List of Customers:

Click the View button to access detailed information about a customer’s referrals, transactions, withdrawals, and payouts.

Payout Report

view detailed customer payout information, and analyze payout data effectively.

Navigate to Payout Reports:

go to Letscms Board Mlm Plan > Payout Reports to access the list of master payouts

View the List of Customers:

The Payout Report page To check customers payouts click on view List button from payout row, here you can check list of customers payout.

Viewing Customer Payouts

customer payout details click on view details button from payout row, here you can check customers payout full details.

Withdrawals Report

view, manage, and update withdrawal requests, including ensuring that withdrawal details are correctly reflected in the bank details system.

Navigate to Withdrawals List:

go to Letscms Board Mlm Plan > Withdrawals List to access the list of withdrawal requests.

Show in Bank Details:

Check that the withdrawal amount and related information appear correctly in the bank details or reconciliation system.

Updating Withdrawal Status

Click on Update Status Button: For the withdrawal entry you want to manage, click the Update Status button associated with that row.

Front-End Functionality Guide for Letscms Board Mlm Plan

Customer Registration

Screenshot: the registration form showing fields like Name, Email, Password , Username: ,Parent , Sponsor,etc.

Customer Join

Ensure that the process for creating referrals and adding new customers under an existing user is functioning correctly.

Screenshot: Capture a screenshot of the referral creation process and the list of new referrals.

Board Mlm user Dashboard

Customer Board Mlm Dashboard

Ensure that the dashboard displays accurate information for user u1 including any sales, referrals, and commissions.

Screenshot: Capture a screenshot of Board Mlm Dashboard

Customer Bank Info

Verify that the form allows updates and that the new information is saved correctly.

Screenshot: Capture a screenshot of Update Bank Info

Customer Genealogy

Confirm that the user u1's referrals (u2, u3, u4, u5, u6, u7) are correctly placed according to the referral settings and are visible in the genealogy tree.

Screenshot: Capture a screenshot of Genealogy Dashboard

Board_mlm mlm Board_mlm_Genealogy_Dashboard

User Referrals

Ensure that all referrals are listed and properly associated with user u1.

Screenshot: Capture a screenshot of Referrals Dashboard

User Payouts

Confirm that the payouts are correctly calculated based on the orders and the referral structure.

Screenshot: Capture a screenshot of Payouts Dashboard

User Transactions

Verify that all transactions are recorded accurately and reflect the correct order details.

Screenshot: Capture a screenshot of Transactions Dashboard

User Withdrawal

User Withdrawal Requests list

Confirm that the withdrawal requests are listed and match the submitted requests for user

Screenshot: Capture a screenshot of Withdrawal Dashboard

Create Withdrawal Request

Ensure that the request is processed correctly and the user is notified.

Screenshot: Capture a screenshot of Create Withdrawal Request Dashboard

Commissions

Verify that commissions are calculated and displayed correctly for user u1 and their referrals.

Screenshot: Capture a screenshot of Commissions Dashboard

Example

The user has been registered successfully. Let me know if you'd like to proceed with any further actions, such as placing an order or creating referrals

Ensure that the order status is updated to the status that triggers commission generation (e.g., "Completed" or "panding"). This is necessary for the commission calculations to take effect.

Introduction

Features

Key Features:

Magento 2 module Installation

Step 1:Extract the Zip File:

Step 2: Copy Files to Magento Root Directory:

Step 3: Open Terminal or CMD:

Verify Installation:

Troubleshooting:

Navigate to the Module Configuration:

General Settings

Eligibility Settings

Bonus Settings

Example

Level Commission

Example

Payout Settings

Email Settings

Creating a Board Mlm Product

Navigate to Product Management:

Select or Create a Product:

Save the Product::

Search for Board Mlm Product

Creating a Board Mlm Product

Navigate to LETSCMS Board Mlm Plan:

Payout Commissions

Payout Bonuses

Run Payout

Navigate to Genealogy

Board A

Board B

Viewing the Genealogy Tree

Customer Reports

Navigate to Customer Reports:

View the List of Customers:

Payout Report

Navigate to Payout Reports:

View the List of Customers:

Viewing Customer Payouts

Withdrawals Report

Navigate to Withdrawals List:

Show in Bank Details:

Updating Withdrawal Status

Customer Registration

Customer Join

Customer Board Mlm Dashboard

Customer Bank Info

Customer Genealogy

User Referrals

User Payouts

User Transactions

User Withdrawal

User Withdrawal Requests list

Create Withdrawal Request

Commissions

Our MLM Plans

Opencart Plans

Wordpress Plans

Laravel Plans