From Proxscripts Documentation
Revision as of 04:58, 11 March 2019 by Maksa (talk | contribs)
Jump to: navigation, search
Contents
Introduction

Straight Line Cycler
Straight Line Cycler is a unique module for straight line cycler matrix where you can add a single matrix or continuous cycles. You can further check the features and demo of this module at http://demo.proxcore.com/.

Downloading Module
  • Login to your "proxscripts.com" account
  • Go to the "Downloads" page
  • Click on the "More..." Button of the script you wish to download
  • You will find the "License Key" for module 4 in the Modules box
  • Click on "Download Now" to download your script
Module Installation Steps
  • "Unzip" downloaded script and upload all files present in the folder named =>"module4=>upload" :
  • Next, connect your “FTP” to your “webhost account”. Upload all the files in the folder named “upload” mentioned in first step to “public_html/app" directory.
  • Next, go to the admin area of your script.
  • Go to Manage Modules => Modules

  • Click on the "Import Module" tab and fill in the relevant fields, which are as follows :



    • License Key :* - Specify the license key here. This is a mandatory field and you will find it from the steps given above.
    • Module Label :* - Specify the module label here for your reference. You can set whatever you want in this field. For example: Straight Line Cycler Plan, Straight Line Cycler System etc. The Module Label will be the name of your module which will be displayed in the Menu when it will be added to your script.
    • Module Name :* - module4 (Don't change this. You need to enter it exactly the way it is written)
    • Advance Settings : - Enable (Enable the advance settings. Don't disable them)
    • Sub Plan Name : - Straight Line (Don't change this. You need to enter it exactly the way it is written.Make sure that “S” and "L" are in capital)
    • Plan Model : - Straightlineplan (Don't change this. You need to enter it exactly the way it is written.Make sure that “S” is in capital)
    • Position Model : - Straightlineposition (Don't change this. You need to enter it exactly the way it is written.Make sure that “S” is in capital)
    • Purchase Position : - (Front Side Purchase Position) - index (Don't change this. You need to enter it exactly the way it is written)
    • Earning History : - (Front Side Earning History) - position (Don't change this. You need to enter it exactly the way it is written)
    • Cronjob : - position (Don't change this. You need to enter it exactly the way it is written)
    • Title of The Site : - Select the areas where you wish to display the options/statistics of this module. You can check all the places or the ones you want.
    • Setting Options : - Select the checkbox for Withdraw Restriction. It is mandatory to check this box.
    • Select SQL Patch File :* - Click on browse and add the SQL file (patch.xml) provided with the module here.
    • Site Email Template Category #ID :* - You have to setup a new Email Template first of all and after it is setup, you need to enter the ID of the Site Email Template here. Please follow the steps mentioned below on how to setup a new Email Template and get the #ID:
      • Go to Design & CMS => Email Templates => Site Email Template Categories tab
      • Click on “Add New”
      • Name: Enter the Name of Site Email Template Category
      • Click on “Submit”
      • Click on “Back” to go back to Site Email Template Categories
      • In the Site Email Template Categories page you will find the email category you have created and on the left hand site you will find the Id.
      • Copy the #ID and enter it in the Site Email Template Category #ID :* field

      The use of Site Email Template Category is to add particular module’s email templates.

    • Website Page Category #ID :* - You have to setup a new Website Page Category first of all and after it is setup, you need to enter the ID of the Website Page Category here. Please follow the steps mentioned below on how to setup a new Website Page Category and get the #ID:
      • Go to Design & CMS => Website Pages => Website Page Categories tab
      • Click on “Add New”
      • Name: Enter the Name of Website Page Category
      • Click on “Submit”
      • Click on “Back” to go back to Site Website Page Categories
      • In the Site Website Page Categories page you will find the Website Page category you have created and on the left hand site you will find the Id.
      • Copy the #ID and enter it in the Website Page Category #ID :* field

      The use of Website Page Template Category is to add particular module’s website page templates.

    • Click on the "Submit" button to apply the changes.
Note:
Please make sure that you enter all the mandatory fields mentioned in ‘*’ and after that only click on “Submit” otherwise you will have to repeat the entire process again.

Kindly find the Next In Line Link as follows :
Next In Line Link : http://YOURDOMAIN.COM/module4/nextinline

Note : After module installation, you will need to clean the cache from your server. You can delete the cache from the following three directories:

  • app/tmp/cache
  • app/tmp/cache/models
  • app/tmp/cache/persistent

Once the cache will be deleted from the server, then refresh the page.

Cronjob Settings

Timing : Twice Per Hour (0,30 * * * *)

Path : php -q /home/[USERNAME]/public_html/app/Console/cake.php straightline -app /home/[USERNAME]/public_html/app

Groups

Groups are useful when you have multiple plans. You can create various straight line cycler plans and categorize them into groups. Groups can be created and managed from the "Groups" tab in the Straight Line Cycler module.

  • To Create Group
    • Click on Add New
    • Specify the Group Name in the box and click on Submit.
Straight Line Cycler Plan

Please note that you will be able to see this module only if you have purchased it.

Note :

This is the name of your Straight Line Cycler Module. The name of this module is what you have specified in the “Module Label” field while importing your module from Manage Module => Modules => Import Module

The label is also editable and you can edit it from the following page:

Go to Manage Module => Modules => Modules => Click on “Edit Module” => Edit the “Module Label” field

  • What is Straight Line Cycler Matrix ?

This is a type of Matrix, where everyone joins under one leg. That is every position will be a part of width of Matrix.

Please check below example of 3x1 Straight Line Matrix. You can set similar plan in current script.

Please check below all required fileds. Which you can set as per your requirement.



Like we set Payout & Matching Bonus Time: 200 % at Matrix Completion means member will receive earning ($2) once his matrix will complete.

Here you can set earning as per Every Member also.

As per above plan setup, position will mature and get earing of $2. Once he/member get another three positions under his position.

You can set similar plans as we set in screenshot. Example is of 3x1 SL Matrix. Here left 3 is width of Matrix. You will earn when A, B and C will Join. Then A will earn as soon as another member D will join. And so on it ends. This is not mandatory that every member has only one position in Matrix. If any one will buy 5 position at a time then position A,B,C,D,E will be filled by same member.

Position will earn Payout as per settings defined in plan setup.

  • Adding A New Plan
    • Click on your Straight Line Cycler module. You will find it on the top of your website.
    • Click on the Straight Line Plans tab (or whatever you have specified in the module label while installing your module).
    • Note : The name of the plan can be changed as per "module label" that you have specified while installing the module.
    • Click on "Add New" button located on the right side. There will be 6 Steps as follows, which you need to specify:
      • Step 1
        • Group : Select the group in which you wish to place your plan. Select a group you have created or select "Default".
        • Plan Status : There are two options for plan status:
          • Active : Select Active if you want members to purchase positions of the plan.
          • Inactive : If you select Inactive, then the plan will be inactive and members including old members would not be able to view it or purchase positions. In short, the plan would be closed completely.
        • Purchase Status: There are two options for purchase status:
          • Active : Select Active if you want new members to purchase positions.
          • Inactive : Select Inactive if you do not want new members to purchase positions. But, members who have already purchased positions (old members) will continue to get earnings.
        • Hide Plan? :
          • No : Select No if you do not want to hide the plan and want members to view the plan on position purchase page.
          • Yes : If you select Yes, then plan will not be displayed in the purchase page, but, it will be active. This is useful if you want to keep the plan as Supplementary/Parallel or it is useful if you want to test a plan without displaying it in the member's area. The direct link can be found at the end of the plan edit page once it is created.
        • Allow Coupons on Purchase? :
          • Yes : If Yes is selected, then members will be able to view the coupon code field (will be visible in the plan purchase page) so that they can use their coupons if they have any (active coupons).
          • No : If No is selected, then the coupon code field will not be visible in the purchase page. Even if members will have coupons, then they will not be able to use them.
        • Plan Name :* Specify your Plan Name here. The Plan Name will be displayed on the Member Side while purchasing positions.
        • Price Per Position ($) :* Specify the Amount per position which the members will have to pay while purchasing position(s) in this plan.
        • Maximum Positions a Member Can Purchase At a Time :* This is to set a limit to the maximum number of positions a member can purchase at once. Note that it is mandatory to specify a number here. Set this to 0 (Zero) if you want to allow this to be unlimited.
        • Payout Re-purchase/Compound Strategy (%) :* Specify the percentage of earnings that must be used for re-purchase purpose. Set 0, if you want members to withdraw the full amount earned.

          For instance, if you set this to 40, then 40% of the earnings can be used only for re-purchase purpose while the remaining 60% of the earnings can be withdrawn. If set to 0 (zero), then members can withdraw full amount earned. The values are rounded to 2 precisions while calculating the amount as per the ratio


      • Step 2
        • Width :* Specify the width of the matrix here.
        • Payout & Matching Bonus Time : This is to set when the Payout and Matching Bonus should be distributed. There are two options for this:
          • Matrix Completion : Members will get earnings and Matching Bonus will be distributed when the matrix is completed if this option is selected.
          • Every Member : Members will get earnings and Matching Bonus will be distributed as soon as a new member joins the matrix when this option is selected. Whenever the spots will get filled, members will get earnings.
        • Payout Type : Payout (Earnings) can be distributed in two ways:
          • Percentage (%) : If you want to provide earnings to members based on percentage, then select the percentage option.
          • Dollar ($) : If you want to provide earnings to members based on fixed amount, then select the Dollar option.
        • Payout:* Specify the percentage or dollar, as per your selection above, that member would get when he/she completes the matrix. For Example, if you select percentage above and if you specify 10% here, then

          Member Earnings = 10% of Price. If you select Dollar above, then specify the fixed amount to be given as payout.

        • Earnings Processor Preference: Select the preferred earnings processor here. There are two options for this:
          • Purchase Processor : If Purchase Processor is selected, then members would get earnings in the processor they have purchased the position with.
          • Priority Processor : If Priority Processor is selected, then members would get earnings in the processor that they have selected as their preferred processor in the Member's area. Priority Processor can be set from Member's profile and members can changed the priority processor from member's area.
        • Matching Bonus Type : Matching Bonus can be distributed in two ways:
          • Percentage (%) : If you want to provide Matching Bonus to Referral based on percentage, then select the percentage option.
          • Dollar ($) : If you want to provide Matching Bonus to Referral based on amount, then select the Dollar option.
        • Matching Bonus Re-purchase/Compound Strategy (%) :* Specify the percentage of earnings that must be used for re-purchase purpose. Set 0, if you want members to withdraw the full amount earned. For instance, if you set this to 40, then 40% of the earnings can be used only for re-purchase purpose while the remaining 60% of the earnings can be withdrawn. If set to 0 (zero), then members can withdraw full amount earned. The values are rounded to 2 precisions while calculating the amount as per the ratio.
        • Matching Bonus : * Specify the Percentage or Dollar as per your selection in Matching Bonus Type above that the respective level sponsor of the member would get as matching bonus. Note that you can provide matching bonus up to 10 levels only.
        • Referral Commission (%) :* Specify the commission (in %) to be provided to the referral. You can specify the commission up to 10 levels.
        • Dependent Plan(s) : This plan is to limit the purchase to some of the paid members only. It is mandatory that members have purchased position(s) of the dependent plan before they can purchase position(s) of the plan you are adding.
          • No : Select "No" if you don't want to make it mandatory for members to purchase dependent plan in order to purchase the plan you are adding.
          • Yes : Select "Yes" if you want to allow members to purchase this plan only if they have purchased a specific dependent plan. When you select "Yes", then you need to select the plan type and plan name of the dependent plan that members must purchase if they want to purchase positions in the plan you are adding
          • For Example : You have two plans, A and B. If A is the dependent plan for plan B, then members will need to purchase position(s) in plan A in order to purchase position(s) in plan B.
        • Parallel Plan(s)  : If admin wants to offer another plan (free or complementary plan) along with the plan being added, then choose Parallel Plan. Select yes if you want to offer a parallel plan and select the plan type and plan name that you wish to offer as a parallel plan.
        • Note :

          If you are creating a revenue plan, let’s say “Plan 1” and if you keep “Plan 2” as a Parallel plan, then make sure that you do not make Plan 1 parallel plan of Plan 2, otherwise the loop will keep on running and will not complete.

        • Supplementary Plan(s) : This plan can be offered to members when they complete positions of the plan you are adding. Whenever a member completes the cycle any of the position(s) of the plan being added, then he will be given the Supplementary Plan for free. Select "Yes" to offer Supplementary Plan to members and select the plan type and plan name that you wish to offer as a supplementary plan.
        • NOTE : You can offer any plans from different modules for all Dependent, Parallel and Supplementary Plans


      • Step 3
        • Membership Required  : Select "Yes" if you want only members with membership(s) to purchase positions in this plan. Please note that members would need only one of the required memberships to purchase position in this plan. Select "No" if you want all members including those who do not have membership(s) to purchase positions in this plan.
        • NOTE: To set Membership, go to Settings => Membership Settings => Click on "Add New"
        • Membership Required To Earn: Select "Yes" if want provide to earnings to members who have membership(s). Select "No" if it is not mandatory for members to have membership(s) in order to get earnings.


      • Step 4
        This is to offer advertisement plans such as Banner Ad Plans, Text Ad Plans, Solo Ad Plans, PPC Plans, PTC Plans, Login Ad Plans and Biz Directory Plans to members as complementary to members who purchase positions in this plan.
        • Banner Ad Plan : Select the Banner Ad Plan that you would like to award to the members as a complement who purchase position(s) in this plan.
        • Text Ad Plan : Select the Text Ad Plan that you would like to award to the members as a complement who purchase position(s) in this plan.
        • Solo Ad Plan : Select the Solo Ad Plan that you would like to award to the members as a complement who purchase position(s) in this plan.
        • PPC Plan : Select the PPC Ad Plan that you would like to award to the members as a complement who purchase position(s) in this plan.
        • PTC Plan : Select the PTC Ad Plan that you would like to award to the members as a complement who purchase position(s) in this plan.
        • Login Ad Plan : Select the Login Ad Plan that you would like to award to the members as a complement who purchase position(s) in this plan.
        • Biz Directory Plan : Select the Biz Directory Plan that you would like to award to the members as a complement who purchase position(s) in this plan.
        • Website Credit Plan : Select the Website Directory Plan that you would like to award to the members as a complement who purchase position(s) in this plan.


      • Step 5
        • Payment Method: Admin can make settings to allow members to make payment from different wallets while purchasing a plan or advertisement pack. Admins can choose which wallet to be allowed for making payment while adding a plan from the following fields: The following payment methods/wallets are available:
          Admins can choose which wallet to be allowed for making payment while adding a plan from the following field:
        • Payment Method :* Select the payment method/balance type that you want to allow members to purchase positions in this plan. At the moment, the following payment methods/wallets are available:

          Cash, Re-purchase, Earning, Commission, Processor, Cash + Re-purchase, Cash + Earning, Cash + Commission, Re-purchase + Earning, Re-purchase + Earning, Re-purchase + Commission, Earning + Commission, Cash + Re-purchase + Earning, + Re-purchase + Earning + Commission, Earning + Commission + Cash, Commission + Cash + Re-purchase, Cash + Re-purchase + Earning + Commission

        • NOTE : The payments methods/wallets displayed here will depend on what installation type you have chosen during script installation.

          Also, the wallets will be checked and funds will be deducted sequence wise from the system. For instance, Re-purchase + Earning: System will check re-purchase wallet first and then earning wallet. Likewise for Cash + Re-purchase + Earning + Commission, funds will be deducted from Cash first, then Re-purchase, then Earning and lastly from Commission.
        • Allowed Payment Processors :* You can decide which processors can be used to purchase position(s) in this plan. Select the payment processor you want to allow members to purchase positions in this plan. There are many options for this :
          Bank Wire, Payza, SolidTrustPay, OkPay, Perfect Money and many more.

          • There will be all the wallets available in the above, and admin can choose whichever he wants to allow.

          When members purchase a plan, then the payment from the wallets will be deducted in the following sequence: cash, repurchase, commission, earning

          For instance, let's say Member "A" has the following funds in his various wallets:

          Cash - $10

          Repurchase - $5

          Commission - $7

          Earning - $3

          Now, let' say he purchases a plan worth $20. Then, first the amount of $10 would be deducted from Cash wallet, then $5 from Repurchase wallet and $5 from Commission wallet.

          This is how it will work.

          Balance Transfer - Internal transfer possible from balance to balance or processer to processor

          Now members can transfer funds from various balances from one balance type to another and even from one processor to another.


      • Step 6
        • Admin Note: You can add an admin note here which will be displayed in the purchase page.
        • Default Position Member Id :* Specify the Member Id of the user who should be put at the top of the matrix. All the members who purchase position(s) in this matrix plan will be placed under him/her. By default it is always set as Admin.
        • Default Position's Payment Processor : * Select the payment processor which will be used (recorded) for top position. The respective earnings are provided in the selected processor.
        • Link : This is the link of your plan. You will get to see this link after you have added your plan and you can view it when you go to edit your plan. You can edit your plan by going to the plan over view page, click on the "Action" button of the relevant plan. Click on edit and you will be able to view the link in the bottom of the page.

          Finally, click on Submit to add your plan.
Plan Overview Page

If you want to view the plan you have added then go to the Plan Overview page and click on the relevant group tab in which you have added the plan.

ID : This displays the ID of the revenue sharing plan added in the system

Plan Name : This displays the name of the revenue sharing plan added in the system

Price : This displays the price of each position in of the plan

Matrix : This displays the matrix dimension of the matrix.

Action : You can edit, copy, inactivate/activate plan, view plan members, view pending plan members, delete plan positions, deny purchase positions and delete plan by clicking on this button.

Retrieved from "http://proxscripts.com/docs/index.php?title=Straight_Line_Cycler&oldid=1304"