From Proxscripts Documentation
Jump to: navigation, search
Line 3: Line 3:
 
   <div class="docslink">
 
   <div class="docslink">
 
   <ul>
 
   <ul>
 +
            <li>[[Revenue Sharing#Introduction|Introduction]]</li>
 
    <li>[[Revenue Sharing#Downloading_Module|Downloading Module]]</li>
 
    <li>[[Revenue Sharing#Downloading_Module|Downloading Module]]</li>
 
             <li>[[Revenue Sharing#Module_Installation_Steps|Module Installation Steps]]</li>
 
             <li>[[Revenue Sharing#Module_Installation_Steps|Module Installation Steps]]</li>
Line 8: Line 9:
 
             <li>[[Revenue Sharing#Groups|Groups]]</li>
 
             <li>[[Revenue Sharing#Groups|Groups]]</li>
 
             <li>[[Revenue Sharing#Revenue_Sharing_Plan|Revenue Sharing Plan]]</li>
 
             <li>[[Revenue Sharing#Revenue_Sharing_Plan|Revenue Sharing Plan]]</li>
 +
            <li>[[Revenue Sharing#Plan_Overview_Page|Plan Overview Page]]</li>
 +
            <li>[[Revenue Sharing#Revenue_Share_Logs|Revenue Share Logs]]</li>
 
   </ul>
 
   </ul>
 
   </div>
 
   </div>

Revision as of 12:49, 14 March 2015

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 3 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 "upload" :
  • "FTP" to your "webhost account". Upload all the files to "public_html" 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: Revenue Sharing Plan, Revenue Sharing 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 :* - module3 (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 : - Revenue (Don't change this. You need to enter it exactly the way it is written)
    • Plan Model : - Revenueplan (Don't change this. You need to enter it exactly the way it is written)
    • Position Model : - Position - Revenueposition (Don't change this. You need to enter it exactly the way it is written)
    • 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 : - regular;advanced;revenuemail (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.
    • Click on the "Submit" button to apply the changes.
Cronjob Settings

Cronjob c) is mandatory to set.

You need to set cronjob a) or b) depending on the plan.

Note : IF Earning Credit Strategy : Instantly, Maturity Amount : Regular, Supplementary Plan : No THEN Set cronjob a) otherwise b)

Timing : Once an Hour (0 * * * *)

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

Timing : Once an Hour (0 * * * *)

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

Timing : Twice a Day (0 0,12 * * *)

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

Groups

Groups are useful when you have multiple plans. You can create various revenue sharing plans and categorize them into groups. Groups can be created and managed from the "Groups" tab in the Revenue Sharing module.

  • To Create Group
    • Click on Add New
    • Specify the Group Name in the box and click on Submit.
Revenue Sharing Plan
  • Adding A New Plan
    • Click on your Revenue Sharing module. You will find it on the top of your website.
    • Click on the Revenue Plans tab.
    • 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 : Select Inactive if you do not want members to purchase any positions. 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 and also earnings will be stopped. 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 or Parallel where you want only selected members to purchase positions of this plan. You just need to provide a direct link to the selected members who can then purchase positions from this plan. 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 see the coupon code and will be able to use their active coupons.
          • No : If No is selected, then members would not be able to view the coupon code.
        • Surfing Requirement :
          • Required : If Required is selected, then members must surf the site daily in order to remain active in the plan and to get earnings. For surfing settings,
          • Not Required :
        • Plan Name :* Specify your Plan Name here. The Plan Name will be displayed on the Member Side while purchasing positions.
        • Price Per Share($) :* Specify the Amount per Share which the members will have to pay while purchasing position(s) in this plan.
        • Admin Profit(%) :* This is the amount the admin will get as a profit. It will be the percentage of investment amount that will be deducted from the Price Per Share. For example, if you specify 10% here and when a member invests $100, then $10 will be the Admin's Profit, which will not be shared with the members. Moreover, referral commission will be counted as admin profit.
          So' $100 (member investment) - $10 (admin profit) - referral commission = Amount shared among members
        • 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 :
        • Maturity Amount (%) :*
          • Regular : Specify the percentage of amount for maturity here. For instance, let's say you specify 200% here. When a member purchases a share with $100, then his share will mature after earning $200.
          • Membership Plan : Specify different return on investment (ROI in %) for different membership plans. Members will get ROI depending on the membership plan they have chosen.
        • Earning Credit Strategy : Specify the interval when you want to credit the earning amount in the member's account. There are 3 options for Earning Credit Strategy :
          • Instantly : If you select Instantly, then the Earnings Amount credited will depend on the cronjob. If you have set the cronjob to 1 hr, then every hour the amount would be credited.
          • Every 'n' Days : Specify after how many number of days you want the earnings amount to be credited.
          • On Position Completion : Earnings amount will be credited to member's account when the position is completed.

          If You Set This to Every 'n' Days, Earning of Last Cycle Will Be Credited Upon Position Completion Even if The nth Day Has Not Arrived.

        • 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.
        • Maximum Earning Limit (%) :*
        • Minimum Earning :* Specify the minimum amount or percentage of earnings members will get. There are two options for this :
          • Percentage % : Specify the minimum earnings in percentage.
          • Dollar $ : Specify the minimum earnings in amount.
        • Fixed Earning Time Span : This is when the minimum earnings will be distributed. This depends on whether the minimum earning is set or not. If you have not set minimum earning then there is no need to set this field. If the minimum earning is set, then you need to specify this. There are two options for this :
          • As Per Cronjob : Minimum earnings will be distributed when the cronjob runs.
          • Once A Day : Minimum earnings will be distributed one time in a day.
        • Pay Commission For The First Position Only : Select whether you want to give Referral Commission to sponsor or not. Select 'Yes' if you want to provide referral commission to sponsor. The commission will be given to sponsor for referral's purchase of first position only. Select 'No' if you don't want to offer commission to sponsor.
        • Referral Commission (%) :* Specify the commission (in %) to be provided to the referral. You can specify the commission up to 10 levels.
        • Dependent Plan(s) :
        • Parallel Plan(s) :
        • Supplementary Plan(s) :