This documentation page does not apply to our software versions for Joomla! 4.0 and later versions. If you are not using Joomla 3 please consult the documentation index to find and read the correct version of the documentation.
Note | |
---|---|
This feature is NOT available on Akeeba Ticket System Core. Even though you can add Credits to users they are not taken into account when creating / replying to tickets. |
Credits are the "currency" of Akeeba Ticket System. If you want, you can set up the necessary options so that each category requires the user to spend a specific amount of credits to submit or reply a new ticket. You can even set them up to require a different amount of credits depending on whether the ticket is public or private. But you somehow need to assign users the credits they will be spending.
Typically you will be using an integration with a third party system which will allow users to buy credits, or award credits to the users based on some kind of activity. Akeeba Subscriptions does come with such an integration which allows you to award credits to subscribers when they subscribe to specific subscription levels and expire those credits when their subscription expires. The other way you can assign credits is manually, through Akeeba Ticket System's back-end. Both types of credits can be managed in this page.
Before explaining how credits are managed, we need to explain a little about how credits work. What you see in the back-end Credits page are actually credit records. Each credit record provides the user with an allotment of credits. As long as the credits record is published, the user can use these credits to post tickets and replies to Akeeba Ticket System. Each ticket's and post's credit consumption is charged against one of those credits records. If there is no published credit record with enough credits left Akeeba Ticket System will now allow the user to post anything. For example, if you have one credit record with 2 credits left and another one with 3 credits left the user will not be able to post a ticket that costs 5 credits. This is because his 5 credits are "fragmented" between different credit records. This is a known limitation of the system and cannot be worked around.
Credits
Each credit record displayed on the page shows the following fields:
The internal numeric ID of the credits record
The user information of the owner of those credits
When the credits were assigned to this user. The date and time are always shown in the UTC timezone.
The source of these credits. For example,
akeebasubs
means that these credits were
assigned by Akeeba Subscriptions, when a user bought a
subscription. When you want to manually assign credits to a user
please use the value manual
in this
field.
This is a unique identifier, used by integration plugins.
In the case of the akeebasubs
type, this is the
subscription ID. When you manually assign credits to a user
please use the current date and time as your unique ID, e.g.
2013-02-10-17-52-00.
The amount of credits given to the user.
When a credits record is published, the credits are available for consumption. When the credits record is disabled, the credits are not available for consumption.
Editing Credits
Even though you can edit any existing credits record we strongly
recommend that you do not do so. Only edit credits records where the
type is set to manual
. Modifying a credits record
created by an integration plugin may have unforeseen
consequences.
The fields in the credits editor are the same as the fields in the list page. No further explanation should be required.