// Introduction to User Points - Rules

Below are the Events, Conditions and Actions available with User Points - Rules Integration.

Events

Userpoints: User was awarded points
- When userpoints are added to/deducted from a user on the site this event is triggered. You will be able to select Conditions to check for and Actions to implement once this event is triggered.

Conditions

Check the transaction category
- This condition is used to check the userpoints category of the userpoints that was added to/deducted from the user. The Negate checkbox can be checked to make the condition into an 'is not x userpoints category' condition.

Compare Userpoints before the transaction
- This condition is used to compare the amount of userpoints the user had before the userpoints was added to/deducted from the user against a specified value.
- The 'Amount to compare' value is checked as >= (greater than or equal to) and the Negate checkbox will change the condition to < (less than) as it will be any value other than >=. If you would like to get an exact value, say 1, you can add two of the condition to use >= and < to specify one number. Simple math stuff here =)

Compare current Userpoints
- This condition is used to compare the amount of userpoints the user has after the userpoints are added to/deducted from the user against a specified value.
- The 'Amount to compare' value is checked as >= (greater than or equal to) and the Negate checkbox will change the condition to < (less than) as it will be any value below >=. Again, two of the same condition can be used if you would like to check for an exact value that the user has currently.

Compare the transaction amount
- This condition is used to compare the amount of userpoints added to/deducted from the user against a specified value.
- The 'Amount to compare' value is checked as >= (greater than or equal to) and the Negate checkbox will change the condition to < (less than) as it will be any value below >=. Again, two of the same condition can be used if you would like to check for an exact value that is added to/deducted from the user.

Actions

Grant points to a user
- This action is used to add/deduct userpoints from a user.
Parameters:

• User* - The user that will receive the points.
• Points* - Amount of points to give or take. This can be a negative number in order to deduct the userpoints from the user.
• Points Category* - The category the points should be awarded to as defined under your userpoints taxonomy.
• Entity - The entity to which this transaction refers. (NEED MORE INFO)
• Description - Can contain the reason why the points have been granted.
• Operation* - Describes the operation (Insert/Remove/...). (Need to describe other potential operations and why they might be used)
• Reference - Can contain a reference for this transaction. (A reference for what? Why?)
• Display - Whether or not to show a message to the user when this points transaction is added.
• Moderate* - Whether or not this points transaction should be moderated.
• Expiration Date - The date when the points should expire. Points will not expire if left empty.