AlphaUserPoints - Help

Presentation: AlphaUserPoints is a Referral User Points System. It's is a component that can distribute or assign points to registered users according to some of its actions and activity on your website. AlphaUserPoints acts as an incentive promoting participation of users. Users often strive for more recognition, as well as competition. It's also usefull for contest, challenge, participation, game, online store. This component has its own component of invite/recommendation for refer which can also be used by non-registered users (based on AlphaRecommend).

License: AlphaUserPoints is made under license GNU/GPL License.

Installation: Installing the component via the administration interface Joomla. During installation, plugins systems and module administrator are installed and are automatically published. If, however Plugins directory does not have permission in writing, an error and warned the user. The component will be reinstalled after amendment rights in the directory Plugins.

Upgrade: all custom rules are preserved instead points to users. No needs to uninstall the previous version. Just install the latest version, then go to in admin panel, check and save the general configuration if new settings.
If you want uninstall the previous version before, just uninstall and install the latest version, then go to in admin panel, check and save the general configuration. Go to in menu manager and edit each menu linked to AlphaUserPoints and save again.

General Control panel of Joomla:

During the installation of AlphaUserPoints, an icon is added to the general control panel of joomla (mod_aupadmin). This icon allows you to quickly launch AlphaUserPoints and display also a warning if there are pending approvals.

AlphaUserPoints Control panel:

Button / menu Configuration
This menu lets you configure the basic parameters for the use of component.

Button / menu Rules
This menu provides access to the list of rules to award points according to some actions of the registered user. The descriptions of the rules will give you information on their roles and conditions for awarding points. To install new rules inter-acting with third components, see To go further.

Button / menu Users
This menu displays all registered members of the site with their respective IDs AlphaUserPoint, total points for each current members and a link to the details of every action having reported points.

Button / menu Activity
This menu displays all activities of members of the site with possibility to export in CSV format.

Button / menu Plugins
This menu allows you to add new rules inter-acting with third components. For more information on this menu, see To go further.

Button / menu Sync. users
This menu allows, after the first installation, synchronize Together members already registered on the site to their assigned an AlphaUSerPoints identifier (referral id). Before synchronize users, please read the Getting Started section.

Button / menu Recalculate
This menu allows you to launch a recalculation of the total number of points for each member after removal or modification of action points by an administrator.

Button / menu Reset all points
This menu reset all the counters to zero points for all registered members. You can set this counter manualy for each member (menu Users Statistics)

Button / menu Set max points
This menu sets a maximum limit of points can be assigned to all registered members of the site. 0 or blank if you do not set limits. You can set max points manualy for each member (menu Users Statistics).

Button / menu Purge expires points
This menu allows purging all user points with a deadline of validity. Important: This action results in an immediate recalculation (auto) of all points and for all users.

Button / menu Coupon Codes
This menu allows to create Coupon Codes for extra points for your users. Code generator and coupons generator.

Button / menu Raffle
This menu allows to create raffle, lottery or promotions for your users. 1 to 3 winners for each raffle.

Button / menu Ranks/Medals
This menu allows to create ranks and medals for your users. Both can be combined.

Button / menu Statistics
This menu display Top 10 winning points and Top 10 Points spent by users. Filter by date.

Button / menu Export active users (CSV)
This menu launches export in CSV file first fifty of the most active members (with the most points).

Button / Menu Export e-mails (CSV)
This menu launches export in CSV file of all email addresses stored in the table details of the component following an action-type invitation/recommendation, recommend an article ...

Button / Menu Combine Activities
This menu allows to combine the set of all actions in one activity from a specified date (perform database if you have huge activity).

Button / menu About
Information on the component.

Button / menu How to create a plugin
This menu displays a help file explaining how to integrate the API AlphaUserPoints in a third component and how to generate an XML file installation of the new rule concerning this third component.

Button / menu Help
Displays this file.

Getting Started:


Setting pre-existing rules
Via the administration interface Joomla! Click on the menu components then on the menu AlphaUserPoints. Then click on the submenu rules or click the rules if you are already in the control panel of AlphaUserPoints component .

When you launch the device for the first time, an informational message appears in the control panel component. This message informs you that you must first synchronize users / members registered with AlphaUserPoints. However, if you want to award points to each registering a new user, and not to penalize the former members, you must set the rule for new members before making synchronization. Edit this rule and assign a number of points for each new member. Save this rule. You are now able to synchronize all members. These will be credited with points. As soon as a new member will, it will be credited with the number of points specified in the rule.
Set and activate other rules according to your needs. The descriptions of the rules will give you information on their roles and conditions for awarding points.
Note: The rule for new users can not be disabled. You can only save to zero the number of points awarded for this rule if you do not wish to assign point on this action.

  1. Rule New user: Assigned or not points for each new user registered on the site.
  2. Rule Daily Login: Assigns points for each daily login.
  3. Rule Invite: Assigned or not points when a user to ask someone else to register on the site (send email).
  4. Rule Invite with success: Assigned or not points to the refferal user when a user registers on the site following an invitation.
  5. Rule Submit article: Assigned points or not to the user when it submits an article.
  6. Rule Submit web link: Assigned points or not to the user when it submits a web link.
  7. Rule Invite a friend to read: Assigned points when a member invites a friend to read an article (won on points when the article was read). Using the native function send to a friend included in Joomla.
  8. Rule Reader to author: Assigns points to the author when one of its articles were read by a user.
  9. Rule Read article: Assigns points when a registered user read an article. To change in "Paid to read", just enter a negative amount (example: -150). Points are awarded or removed only on first reading.
  10. Rule Vote article: Assigns points when a registered user vote an article with Joomla internal system vote.
  11. Rule Click banner: Assigns points when a registered user click on banner (with com_banners, the first click on each banner assigns points).
  12. Rule Answering a poll : Assigns points to the user after he responded to a poll.
  13. Rule User to user points: Allows users to transfer all or part of their points to other users. Requires create a menu linked to component for the frontend.
  14. Rule Referral points: Referral users earn bonus points as a percentage on all points earned by their referrees.
  15. Rule Bonus points: Assigns bonus points to specific users (Backend -> AlphaUserPoints -> menu Users statistics).
  16. Rule Become author: Specifies a number of points sufficient to authorize a registered user to change level and become author.
  17. Rule Become editor: Specifies a number of points sufficient to authorize an author user to change level and become editor.
  18. Rule Become publisher: Specifies a number of points sufficient to authorize an editor user to change level and become publisher
  19. Rule Exclude specific users: Excluded some referring to the allocation of points (useful for administrators).
  20. Rule Email notification: Sending a message to the user as soon as it earns points.
  21. Rule Winner notification: Sending a message to the user and administrator, when it reached the maximum number of points required (requires setting max points).
  22. Rule Buy points with Paypal: Authorize your users to purchase points with Paypal. Setting all parameters in menu.
  23. Rule Coupon points codes: Allows users to enter a code in the module appropriate to get extra points. You must install the module mod_alphauserpoints_couponcode.
  24. Rule Raffle: This rule allows to enable a raffle system.
  25. Rule Custom: Assigns or remove custom points to a specific user and set a reason (Backend -> menu Users -> Details -> Toolbar -> Button Custom points)
  26. Rule Happy Birthday: Assigns points once in year when the birth date of user is reached. Note: User must be login this day to earn points.
  27. Rule Content : Assigns or remove points on any view content (com_content or any component using the content plugin "onPrepareContent" of Joomla!). Just add the tag {AUP::CONTENT=XXX} in your content and where XXX is the number of points, you can use positive or negative values.
  28. Rule Upload avatar : Assigns points when a user upload a picture or avatar in his profile with the internal avatar system of AlphaUserPoints.
  29. Rule Profile complete : Assigns points when a user has 100% completed his / her profile. Must be used with the internal system avatar of AlphaUserPoints. Assigns 10% complete on registration, assigns 50% with image or avatar, reach 100% with small description, birthday, gender and hometown (city). If the profile down and becomes incomplete, points will be removed automatically.
  30. Rule Inactive user : Remove points for inactive users after a preset period.
  31. Rule Combined activities: Allows administrator to combine the set of all actions in one activity from a specified date (perform database if you have huge activity). This rule is necessary to show the combined activity on the activities of users.
  32. Rule Donate points to the author: The reader gives points to the author to read his article with ability to customize the amount of points. Just add the tag {AUP::CONTENTAUTHOR=XXX} in your content and where XXX is the number of points. This number must be positive. The amount of points will be awarded to the author of the article and removed for reader.

There are also 2 auto-detect rules if Kunena forum is installed on the website. This 2 rules allows to assigns points on post a new topic and reply on topic.


Creating menus
AlphaUserPoints includes 8 options for creating menu on frontend.

To use ReCaptcha (anti-spam), you must first obtain keys for use on the site http://recaptcha.net/api/getkey.

To create a menu selected AlphaUserPoints component in the interface for creating menus Joomla! then choose the type of menu to create. Enter a name for this menu, then set it if necessary. For more information on creating menu under Joomla! See you using Joomla!.

Disabled user congratulation messages on frontend
Use the menu Configuration and enabled or disabled the messages on frontend.

Allows guest user to see profile members
Use the menu Configuration and enabled or disabled to allows guest user to see profile members.

Change the prefix identifier
You can change the prefix identifier AlphaUserPoints in Configuration menu. You can enter a particular prefix for users to register themselves on your site and another for users by referrer. 7 characters maximum.

Modify Referral ID type:
You can change the type of identifier AlphaUserPoints in Configuration menu. Choose between randomize or Username as the referral Identifier.

Limit daily points:
If you want to limit user points earned by day, you can enter a number in Configuration menu, otherwise leave empty.

Raffle system:
First step: If you want offer a raffle to you users, you must enabled the rule "Raffle". Then, add a raffle and settings it. You can choose to offer points, coupon code to your registered users or an e-mail with a link to download something.
Second step (optional): If you have choose a registration for a raffle, you can put in a content article this following tag to activate the Joomla content plugin: {AUP::RAFFLE=ID} where ID is the ID of your raffle. This tag display a button to raffle registration to your registered users. If multiple entries is allowed, then a user can subscribe more than once to a raffle (as a system tickets lottery).
NOTE: button show in frontend only to registered user if registration is Yes, and then registered user can join to raffle. If registration is No, then all users are automatically in raffle (only once).

Now, in backend, you have the number of enrolled users in this raffle. If you click on this number, You can show and export the entire list of participating in this raffle in csv format.

Level/Rank and Medals :
Both can be used together or individually. Ranks or medals can be awarded automatically when a user reaches a certain number of points (enter a number of points in the rank/medal) or can be assigned manually to a user (Set to zero point). In all cases, the rank or medal can be modified manually by administrator directly in the detail user. If you assign a rank that is normally intended to be assigned automatically to a certain level of points, it will not be taken into account. It is recommended not to mix the two types of rank (automatic or manual).

When you assign a medal to a user, you can add a description or a reason for award. If you leave blank, the default description of the medal is assigned. The default ranks and medals created during installation of the component can be removed without problem if you do not use them. If there is no rank/medal, the columns to display the icons or the number of medals will not be displayed in users management.

Show current points to the current user in article content :
Just add the tag {AUP::SHOWPOINTS} in your content article to show the total points of the current user connected.

Check version :
You can show/hide the checking version in Configuration menu.

To go further:

Installing third plugins
To add new rules or from inter-acting with components third, click on the menu or Plugins button control panel component, and then select the file. Zip or. Xml containing the new rule. Upload the file. If the file is uploaded correctly, a new rule will add to the existing list. Set this new rule and enable there to suit your needs. The fact that click New in the list of rules can also add a plugin via the same function.

If you want more information on how to create a plugin, go on using "How to create a plugin."