From Proxscripts Documentation
Revision as of 11:36, 20 March 2015 by Maksa (talk | contribs)
Jump to: navigation, search
Introduction

Investment Plans
Investment Plan is a distinctive type of module. We have two different plans in the Investment Plans module: Regular Investment Plans and Dynamic Investment Plans. You can check out the 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 1 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/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: Earning Plan, Earning System, Investment Plan 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 :* - module1 (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 : - Regular-Dynamic (Don't change this. You need to enter it exactly the way it is written)
    • Plan Model : - Dailyearningplan-Dynamicearningplan (Don't change this. You need to enter it exactly the way it is written)
    • Position Model : - Position-Dynamicposition (Don't change this. You need to enter it exactly the way it is written)
    • Purchase Position : - (Front Side Purchase Position) - index-dynamic (Don't change this. You need to enter it exactly the way it is written)
    • Earning History : - (Front Side Earning History) - dailyposition-dynamicposition (Don't change this. You need to enter it exactly the way it is written)
    • Cronjob : - daily1;daily2;daily3.days1;days2;days3.hours1;hours2;hours3daily1;daily2;daily3.days1;days2;days3.hours1;hours2;hours3 (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
  • Regular Earning Days Plans (Recommended)**

Provides earnings to members of regular earning plans that are providing earnings every 'n' days. Not needed if you do not intend to use these type of plans.

Timing : Once a Day (0 0 * * *)

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

  • Regular Earning Hourly Plans (Recommended)**

Provides earnings to members of regular earning plans that are providing earnings every 'n' hours. Not needed if you do not intend to use these type of plans.

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

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

  • Regular Earning Daily Plans (Recommended)**

Provides earnings to members of regular earning plans that are providing earnings daily. Not needed if you do not intend to use these type of plans.

Timing : Once a Day (0 0 * * *)

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

  • Dynamic Earning Days Plans (Recommended)**

Provides earnings to members of dynamic earning plans that are providing earnings every 'n' days. Not needed if you do not intend to use these type of plans.

Timing : Once a Day (0 0 * * *)

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

  • Dynamic Earning Hourly Plans (Recommended)**

Provides earnings to members of dynamic earning plans that are providing the earnings every 'n' hours. Not needed if you do not intend to use these type of plans.

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

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

  • Dynamic Earning Daily Plans (Recommended)**

Provides earnings to members of dynamic earning plans that are providing earnings daily. Not needed if you do not intend to use these type of plans.

Timing : Once a Day (0 0 * * *)

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

These cronjobs are used to provide earnings to regular earning and dynamic earning plan position holders. To maintain the performance of the cronjobs, we have distributed them when data is huge. 3 stages are there for each of these 6 cronjobs. Initially, stage1 will run for each of them. When there will be more than 1 lac (one hundred thousand) positions for regular earning plans, you need to add 3 new cronjobs of stage2. Same way, when there will be more than 1 lac (one hundred thousand) positions for dynamic earning plans, you need to add 3 new cronjobs of stage2. They are shown below :

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

  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dailyearndays stage2 -app /home/[USERNAME]/public_html/app
  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dailyearnhours stage2 -app /home/[USERNAME]/public_html/app
  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dailyearn stage2 -app /home/[USERNAME]/public_html/app
  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dynamicearndays stage2 -app /home/[USERNAME]/public_html/app
  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dynamicearnhours stage2 -app /home/[USERNAME]/public_html/app
  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dynamicearn stage2 -app /home/[USERNAME]/public_html/app

And when the respective positions are more than 2 lacs, stage3 should be launched. So, add more of them.

  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dailyearndays stage3 -app /home/[USERNAME]/public_html/app
  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dailyearnhours stage3 -app /home/[USERNAME]/public_html/app
  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dailyearn stage3 -app /home/[USERNAME]/public_html/app
  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dynamicearndays stage3 -app /home/[USERNAME]/public_html/app
  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dynamicearnhours stage3 -app /home/[USERNAME]/public_html/app
  • php -q /home/[USERNAME]/public_html/app/Console/cake.php dynamicearn stage3 -app /home/[USERNAME]/public_html/app

Note : Please note that if you are using subdomain, you must put the corresponding folder name after public_html/ in the above lines.

Groups

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

  • To Create Group
    • Click on Add New
    • Specify the Group Name in the box and click on Submit.
Investment Plans
  • You can add two types of Investment Plans :
    • Regular Investment Plans
    • Dynamic Investment Plans
  • Adding A New Plan
    • Click on your Investment Plans module. You will find it on the top of your website.
    • Click on the Regular Investment Plans or Dynamic Investment Plans tab (or whatever you have specified in the module label while installing your module).
    • Regular Investment Plans - You can provide fixed price for positions and fixed earnings with this plan.
    • Dynamic Investment Plans - You can set a range of earning amount with this plan. It is especially useful if you run a HYIP program or an advertisement website for earnings.
    • 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.
    • Plan Type : Choose whether your want to create a Regular Investment Plan or Dynamic Investment Plan.
      If you have selected Regular Investment Plan in plan type then complete the following steps:
  • Regular Investment Plan
    • 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.

    • Step 2 for Regular Investment Plan
      • Price Per Position ($) :* Specify the Amount per Share which the members will have to pay while purchasing position(s) in this plan.
      • Earnings :* You need to specify two things here:
        • Choose whether you want to provide earnings for a position in Percentage (%) or Dollar ($)
        • Choose whether you want to provide Regular earnings or provide earnings based on the Membership Plan
          • Regular - If you select Regular, then specify the earnings in Percentage (%) or Dollar ($) in the text box provided below.
          • Membership Plan - If you select Membership Plan, then specify the earnings in Percentage (%) or Dollar ($) in the corresponding membership plans
      • Important Note:
        • Do not change the Earnings option once members have purchased positions in the plan as it may cause problems in calculations. Earnings of all the members is rounded to 4 decimal points. So, make calculations accordingly before finalizing the plan.
        • If you set earnings based on Membership Plan, then members' membership must be active in order to continue receiving earnings on every cycle.
      • Earning Interval : Choose whether you want to provide earnings on "Daily", "Days" (Every 'n' Days) or "Hours" (Every 'n' Hours) basis.
        If you select "Days" or "Hours", then one more text box will be displayed below where you need to specify the Number of Days or Hours.
      • Note : It is a must to specify Round Figure. You cannot provide earnings at every one and a half hours or two and a half days.
      • Earning Interval Cronjob Note: The cronjobs for Daily, Days and Hours are all different.
      • 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. 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.
        • On Position Completion : Earnings amount will be credit upon position completion
        • Important Note:
          • Both Earning Internal and Earning Credit Strategy are based on cronjob and work on the same cronjob only. So, make sure that your cronjob settings are proper
          • If you have selected the "Instantly" option above, then we highly recommend to set cronjob as per the hour mentioned in the Earning Interval. For example, if you have specified 2 hours, then the cronjob will run every 2 hours. Even if you run the cronjob every hour, then there will be no issue of double earnings. The speed (performance) of the cronjob depends on your server configuration.
          • If Membership becomes inactive, then earnings will stop.
      • 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.
      • ROI Days :* Select the days on which you want to provide earnings of this plan. This field is valid only if you set the "Earning Interval" to Daily.
      • 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.

      • Pay Commission For The First Position Only : Select whether you want to give One-Time or Recurring Referral Commission to sponsor.
        Select 'Yes' if you want to provide referral commission to sponsor one-time only. The commission will be given to sponsor for referral's purchase of first position only. Select 'No' if you want to offer Recurring referral commission to sponsor.
      • Referral Commission (%) :*R Specify the commission (in %) to be provided to the referral. You can specify the commission up to 10 levels.
      • Note: Commission is calculated on position price. If you're maintaining individual balances, commission amount will be credited in the Processor Balance of the sponsor using which the referral has made a new purchase i.e. if referral purchases new position using his Payza balance, sponsor will receive commission amount in his Payza balance only. Set the value to 0 (zero) when you do not want provide referral commission.
      • Step 2 for Dynamic Investment Plan
        • The earning of the members will depend on the range specified below: You can set a range here
        • Interest Rate Type
          • Simple Earning - Members will get earnings based on Simple Interest calculation. Earnings will be as per the calculations in the "Earnings" field.
          • Compound Earning: Select compound earning if you want to provide additional earnings to the members on their already accrued earnings. For example, a member invests $10 and earning rate is 10%. Then, the member's earnings will be $1, $1.1, $1.21, etc. Note that in case of compound earning, earning that you specify below will be based on percentage only. It is highly recommended to set earning credit strategy to be on position completion below when you set compound earning for this option.
        • Earnings :* You need to specify two things here:
          • Choose whether you want to provide earnings for a position in Percentage (%) or Dollar ($) if you have selected "Simple Earning"<b/> in the Interest Rate Type field above. If <b>"Compound Earning" is selected, then Earnings will based on percentage only and you will not see the first drop-down box.
          • Choose whether you want to provide Regular earnings or provide earnings based on the Membership Plan
            • Regular - If you select Regular, then specify the earnings in Percentage (%) or Dollar ($) in the text box provided below.
            • Membership Plan - If you select Membership Plan, then specify the earnings in Percentage (%) or Dollar ($) in the corresponding membership plans
              Next, you will need to specify the Name, Range (Minimum Amount and Maximum Amount) and what amount or percentage of Earnings (depending what you have selected above - either $ or %) you want to provide members.
              If you select Membership plan, then you will see the Membership plan names and specify earnings to be given for each membership plan.
        • Important Note:
          • Do not change the Earnings option once members have purchased positions in the plan as it may cause problems in calculations. Earnings of all the members is rounded to 4 decimal points. So, make calculations accordingly before finalizing the plan.
          • If you set earnings based on Membership Plan, then members' membership must be active in order to continue receiving earnings on every cycle.
        • Earning Interval: Choose whether you want to provide earnings on "Daily", "Days" (Every 'n' Days) or "Hours" (Every 'n' Hours) basis.
          If you select "Days" or "Hours", then one more text box will be displayed below where you need to specify the Number of Days or Hours.
        • Note: It is a must to specify Round Figure. You cannot provide earnings at every one and a half hours or two and a half days.
        • Earning Interval Cronjob Note:
          The cronjobs for Daily, Days and Hours are all different.
        • 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. 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.
          • On Position Completion: Earnings amount will be credit upon position completion.
        • Important Note:
          • Both Earning Internal and Earning Credit Strategy are based on cronjob and work on the same cronjob only. So, make sure that your cronjob settings are proper
          • If you have selected the "Instantly" option above, then we highly recommend to set cronjob as per the hour mentioned in the Earning Interval. For example, if you have specified 2 hours, then the cronjob will run every 2 hours. Even if you run the cronjob every hour, then there will be no issue of double earnings. The speed (performance) of the cronjob depends on your server configuration.
          • If Membership becomes inactive, then earnings will stop.
        • 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.
        • ROI Days :* Select the days on which you want to provide earnings of this plan. This field is valid only if you set the "Earning Interval" to Daily.
        • 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.
        • Pay Commission For The First Position Only : Select whether you want to give One-Time or Recurring Referral Commission to sponsor.
          Select 'Yes' if you want to provide referral commission to sponsor one-time only. The commission will be given to sponsor for referral's purchase of first position only. Select 'No' if you want to offer Recurring referral commission to sponsor.
        • Referral Commission (%) :* Specify the commission (in %) to be provided to the referral. You can specify the commission up to 10 levels
    • Step 3
      • Plan End Date : The Plan End Date is optional. If you set the date, then the plan will be closed after the end date and will not be shown in the member side when purchasing positions. Earnings will continue even after the plan end date.
      • Total Cycles :* This option decides how much the members will earn from this plan. Specify the number of cycles for which members would be getting earnings on their investments in the plan.
    • Step 4
      • 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.
      • Maximum Positions a Member Can Own :* This is to set a limit to the maximum number of positions a member can own. Note that it is mandatory to specify a number here. Set this field to 0 (Zero) if you want members to purchase unlimited number of positions. Members will not be able to take benefit of quickening top position's earnings if you set this to a less number.
      • Maximum Joinings :* This is to specify the maximum number of members who can purchase positions in this plan. It is mandatory to specify a number here. Set this field to 0 (Zero) if you do not want to specify a limit to the number of members who can join/purchase positions this plan.
      • 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. If he has more, he will be given the option to select the membership using which he wants to purchase position(s). Select "No" if you want all members including those who do not have membership(s) to purchase positions in this plan. If you set 'no' here, make sure you are providing regular earnings and not membership plan-wise earnings in Step 2.
      • Note: To set Membership, go to Settings => Membership Settings => Click on "Add New"
    • Step 5
      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.
    • Step 6
      • Payment Method :* Select the payment method/balance type that you want to allow members to purchase positions in this plan.
      • 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, EgoPay, Perfect Money and many more.
    • Step 7
      • Enable Quickener :
      • 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 then, select the plan type and plan name that you wish to offer as a parallel plan.
      • 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 8
      • Admin Note : You can add an admin note here which will be displayed in the purchase page.
      • 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 the 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 Investment Plan added in the system

Plan Name : This displays the name of the Investment Plan added in the system

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

Cycles : Number of times when the member will get earnings

Returns: This displays the Return on Investment (ROI)

Maturity : This displays the Return on Investment (ROI)

Earning Interval:The time when members will get earnings

Credit Time: Time when earnings will be credited

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