As the name suggests, this service allows you to setup recurring payouts for your users. As of version 1.7, you can setup multiple recurring payouts for each point type and no longer just one per type.
The service must be enabled for your schedules to run! Disabling the service will not delete your schedules but they will stop working. When you re-enable the service, your scheduled payouts will be re-scheduled. If the service has been disabled long enough that one or more scheduled payouts have missed their date, they will be disabled and you will be required to delete them and create new ones.
As of version 1.7, you can add a new recurring payout using the “Add New” button.
Each recurring payout can be setup hourly, daily, weekly, monthly, quarterly, biannually and annually with technically an unlimited number of repeats (but one must be set). You an exclude or include users by ID and/or roles and set a minimum and/or maximum balance requirement to get points.
At a bear minimum, you are required to give your payout a title, set the amount you want to give, how often, what to show in the users log for each payout, the start date and the number of times to repeat. Once the payout reaches the repeat limit you set, it will disable itself after the last run.
As of version 1.7, you can also set a limit to which of your users will receive these points. You can set the following limitations:
- Require a minimum and/or maximum balance.
- Require users to have a certain role (Include) or exclude users based on their rank (Exclude).
- Limit payout to a list of user IDs (Include) or exclude a list of IDs (Exclude). This list must be a comma separated list of the numeric IDs of the users without any empty space.
If you are using the Central Banking Service, you can also select if you want to pay users even if the central bank runs out of funds. This settings will not be visible if the service is not used.
As of version 1.7, you can select to “View” each scheduled payout you have setup. This popup will display the current status of your setup. Besides the setup, you can also see:
- The total amount of points that the setup has paid out till this day.
- The total number of completed payouts. ( runs x eligible users at each run ).
- The total number of misses.
- The number of runs that remain.
A “miss” is an instance where someone we requested to pay did not receive their points. This can be due to the user being excluded, custom code on your site is declining the payout or if you use the central banking service, the central bank has run out of funds (and you selected to honour this).
By default, both the Compound Interest and Recurring Payout services will only run a maximum 1500 users in each scheduled instance. If more then 1500 balances need to be compounded or paid, the add-on will schedule a new instance 2 min after the original starting point. It will continue to do this until everyone has been processed.
It is especially important to keep in mind when setting up an hourly recurring payout. With a limit of 1500, you can maximum pay 45000 users before the scripts starts over.