AUP plugin for NorrCompetition
This add-on provides an integration between NorrCompetition and AUP.
1. Getting Started
AUP Plugin provides integration between NorrCompetition and AltaUserPoins and let to assign AUP points for actions performed in NorrCompetition (NC). The AUP for NorrCompetition distributive pack includes an integration plugin and rules kit for AltaUserPoints (by nordmograph):
plg_competition_aup.zip - version for AltaUserPoints
Note: the original AlphaUserPoints component (by Bernard Gilly) delisted at the JED and is no longer available to download. Due to this fact, NorrCompetition rules for original AlphaUserPoints were removed from the distibution package. Please use AltaUserPoints!
2. Installation
The installation package of AUP Plugin for NorrCompetition includes a plugin and rules kit in one file. You don't need to extract rules from the archive and then to import in AltaUserPoints manually.
2.1. Download and install the plugin
Get latest version of the distribution pack from NorrNext site and proceed to install it as typical Joomla extension. Go to Administrator panel > Extensions > Install extensions and install plg_competition_aupp.zip package.
An integration plugin will be automatically enabled after installation. All rules will be imported to AUP automatically after the installation of the package. There is no need to import each rule manually as it is typical for AUP rules.
2.2. Download Key tab
This feature allow to get an update of the plugin via back-end in few clicks. Set your download key to enable the update using Joomla! Update System. You can find the key in your NorrCompetition subscription on the NorrNext website. If you set the key for the first time or have changed it, please click on the Update Key button to save it for Joomla! Update System.
Read official tutorial: How to enable one-click update for NorrNext commercial extensions
Note: If you are already logged in to your site front-end and installed new AUP rules in the administrator panel, please bear in mind the rules will take action during the new user's session. So, you should sign out and sign-in on the front-end again.
3. List of Rules
3.1. View actions rules
Name: View Active Contest
XML name: view_competition_active.xml
Function name: plgaup_nc_view_competition_active
Description: Assign points to the user for viewing the active contest
Name: View Completed Contest
XML name: view_competition_completed.xml
Function name: plgaup_nc_view_competition_completed
Description: Assign points to the user for viewing the completed contest
Name: View Entry in Completed Contest
XML name: view_participant_completed.xml
Function name: plgaup_nc_view_participant_completed
Description: Assign points to the user for viewing an entry in the completed contest
Name: View Entry in Active Contest
XML name: view_participant_active.xml
Function name: plgaup_nc_view_participant_active
Description: Assign points to the user for viewing an entry in the active contest
3.2. Entry actions rules
Name: Entry Approved
XML name: participant_approved.xml
Function name: plgaup_nc_participant_approved
Description: Assign points to the user when their entry has been approved
Name: Entry Unapproved
XML name: participant_unapproved.xml
Function name: plgaup_nc_participant_unapproved
Description: Assign points to the user when their entry has been unapproved
Name: Entry Published
XML name: participant_published.xml
Function name: plgaup_nc_participant_published
Description: Assign points to the user when their entry has been published
Name: Entry Unpublished
XML name: participant_unpublished.xml
Function name: plgaup_nc_participant_unpublished
Description: Assign points to the user when their entry has been unpublished
Name: Entry Trashed
XML name: participant_trashed.xml
Function name: plgaup_nc_participant_trashed
Description: Assign points to the user when his entry has been moved to trash
Name: Unvote for Entry
XML name: plgaup_nc_unvote_user.xml
Function name: plgaup_nc_unvote_user
Description: Assign points to user for unvote
Name: Unvote to Contestant
XML name: plgaup_nc_unvote_submitter.xml
Function name: plgaup_nc_unvote_submitter
Description:Assign points to contestant for unvote for their entry
3.3. User actions rules
Name: Vote for Entry
XML name: vote_user.xml
Function name: plgaup_nc_vote_user
Description: Assign points to the user for a vote
Name: Voter to Entry
XML name: vote_submitter.xml
Function name: plgaup_nc_vote_submitter
Description: Assign points to the submitter for voting for their entry
Name: Viewer to Entry in Active Contest
XML name: view_participant_active_submitter
Function name: plgaup_nc_view_participant_active_submitter
Description: Assign points to the submitter for viewing his entry in the active contest
Name: Viewer to Entry in Completed Contest
XML name: view_participant_completed_submitter
Function name: plgaup_nc_view_participant_completed_submitter
Description: Assign points to the submitter for viewing his entry in the completed contest
3.4. Application actions rules
Name: Submit Entry Form
XML name: appform_submit.xml
Function name: plgaup_nc_appform_submit
Description: Assign points to the user for submitting an entry to the contest.
4. Configuring the rule
Go to AUP back-end panel. When you open any rule to edit, you’ll see settings divided on 3 tabs.
4.1. Details tab
ID: (non-edit)
Category: you can select category from the list to which your rule will be assigned to.
Rule name: name of your rule
Description: Description of your rule
Plugin type: By default it is NorrCompetition
Unique function name: Function name given by default. You can change it (not recommended)
User level: Set up which user group this rule is for. By default it is Public.
Points: Attrib x points to this rule. Add symbol “minus” if you need to subtract. (i.e. -1.00)
Fixed points (No / Yes): Choose if points are fixed or unknown
Percentage (No / Yes): Use percentage
Expires: Enter a specified date to limit the use of points earned by this rule for all users or choose a period to limit the use of points earned by this rule for each activity generated by this rule. e.g. If a date is specified, the set of points earned by each user by this rule will no longer be valid after that date (useful for contest). If a period is selected, then each user can take advantage of its points earned by this rule until the end of the period (example: to be used with the rule Buy Points With Paypal as a subscription)
Display activity (No / Yes): Display this activity on frontend listing (profile and activities lists)
Published (No / Yes): Status of the rule.
Auto approved (No / Yes): Auto approved
Method: Choose the method to assigns points
Only once per user
Once a day per user
Once a day for a single user on all users
Once per week per user
Once per month per user
Once per year per user
Whenever (default)
Link up: Link up another rule
4.2. Message Tab
Display message (No / Yes): Select should the message be displayed.
Message: Enter a custom message to be displayed on the frontend after assigning or removing points. Leave blank if you want the default message. You can using the tag {username} and the tag {points} if you want showing the username and the number of points in the message.
4.3. E-mail notification
Email notification (No / Yes): Sending a message to the user as soon as it wins or spent points
Subject: You can using the following tags {username} {points} and {newtotal} if you want showing the username, the number of points added or removed and the new total of points of this user in the subject.
Message body: You can using the following tags {username} {points} {newtotal} and {datareference} if you want showing the username, the number of points added or removed and the new total of points of this user in the body message. {Datareference} is used to show the reason (e.g. Rule custom points)
Format: E-mail format. If you choose HTML, you can insert in body text some HTML tags available for e-mail.
Send copy to Admin(s): Allows Admin(s) to receive a BCC e-mail
5. Enabling rules in NorrCompetition
We just been installed and configured rules at AUP side and now it’s time to enable AUP mode in NorrCompetition. There are global settings, but it’s possible to enable AUP plugin for custom competitions. Go to Administrator Panel > Components > NorrCompetition > Options and click on “Competition” tab. Then find Integration options in the bottom of screen:
AUP Integration - Enable the processing of specific AUP rules for this competition. Please install NorrCompetition AUP Plugin to handle the rules.
Set to “Yes” if you want AUP rules to be processed everywhere. If you need manual selection and enable AUP rules for specified competitions, you can override these settings in custom competition. Go to edit mode of the competition and click on “Basic options” tab. You will find Integration Options in the bottom which have 3 options: Use Global, Yes and No. So, you can enable, disable AUP rules for the competition or use global settings.
It might be useful in case if you want to exclude some competitions of being processed by AUP rules. All is done. Now you can assign AUP points to users for actions they performing in NorrCompetition.
6. Rules for JComments and Komento
Comments provided by social networks (Facebook or VK.com) loads as external scripts and the actions performed there are out of control. But it is easy to assign scores for actions with comments if you are using a 3rd party Joomla extension as Komento or JComments. Both components have rules for AlphaUserPoints and AltaUserPoints (AUP).
6.1. JComments
6.1.1. AlphaUserPoints rules
AlphaUserPoints rules. Open this link and Download JComments AlphaUserPoints 3.0 for Joomla 2.5+ file from the official site. This file is an installation package that contains all rules to be installed via Joomla Extensions manager.
6.1.2. AltaUserPoints rules
Go to JComments site and download plg_jcomments_altauserpoints.zip file. Alternatively, you can download the rules from Nordmograph site. The installation package contains all rules to be installed via Joomla Extensions manager.
6.1.3. List of rules
Both packages for AlphaUserPoints and AltaUserPoints includes the following rules:
Add comment - Assign points when a user adds a comment.
Comment has voted as bad - Assign points to the author when the comment has got negative vote.
Comment has been deleted - Assign points to the author when his comment has been deleted.
Comment has been published - Assign points to the author when his comment has been published.
Comment has been reported - Assign points to the author when his comment has been reported by other user.
Comment has been unpublished - Assign points to the author when his comment has been unpublished.
Comment has voted as good - Assign points to the author when the comment has got positive vote.
Report comment - Assign points when a user reports a comment.
Vote comment - Assign points when a user votes a comment.
6.2. Komento
6.2.1. AlphaUserPoints
Please go to Stackideas repository and download Komento AUP's rules. The archive is not an installation package and contains rules in XML format. You need to unzip the archive and install / import rules manually. After copying the files to the required folder, go to Administrator Panel > Extensions > AltauserPoints and click on Auto-detect new rules button in dashboard.
6.2.2. AltaUserPoints
There are no official rules for AltaUserPoints at the moment. You can take rules for AlphaUserPoints and rename classes or contact extension provider.
6.2.3. List of rules
The package includes the following rules:
Comment added to article - Add points for article author when a user posts a new comment on that article.
Comment liked - Add points to comment author when a user likes the comment.
Comment removed - Deduct points to comment author when a comment is removed.
Comment reported - Deduct points to comment author when a user reports the comment.
Comment sticked - Add points to comment author when comment is sticked.
Comment unliked - Deduct points to comment author when a user unlike the comment.
Comment unreported - Deduct points to comment author when a user unreports the comment.
Comment unsticked - Deduct points to comment author when comment is unsticked.
Like a comment - Add points to user when a user likes a comment.
Post new comment - Add points to user when a user post a comment.
Comment removed from article - Deduct points for article author when a comment is removed from that article.
Reply comment - Add points to user when a user reply to a comment.
Report Comment - Add points to user when a user reports a comment.
Unlike a comment - Deduct points to user when a user unlike a comment.
Unreport Comment - Add points to user when a user unreports a comment.
Last updated
