The ARS Download ID app integrates J2Commerce with Akeeba Release System (com_ars). It creates a unique download ID for each customer when they complete an order and shows it on the customer's profile page.
This app is a separate add-on available from the Akeeba (ARS) Integration. It is not included with the core J2Commerce 6 component.
Prerequisites
- J2Commerce 6.6.2 or later, installed and enabled
- Akeeba Release System (
com_ars) installed and enabled on the same Joomla site - Joomla 6
- PHP 8.2 or higher
Warning
Install com_ars and update J2Commerce first. The plugin does not install without them.
Installation
- Download the
plg_j2commerce_app_arsdlid.zippackage from the J2Commerce website. - Go to System -> Install -> Extensions.
- Upload the ZIP file and click Upload & Install.
Enable the App
Option A: Click the J2Commerce icon at the top right corner, then Apps.
Option B: Go to Components -> J2Commerce -> Apps.
Find Akeeba Release System Download ID in the list, click the toggle to enable it, and click Save.
Configuration
Tip
Click the Toggle Inline Help button in the toolbar to show a description below each field.
Open the global settings by clicking Akeeba Release System Download ID on the J2Commerce Apps screen.
Basic Settings
| Setting | What It Does | Default | Options |
|---|---|---|---|
| Display Locations | Where the translations block appears on the product page. | Before Product Description | Before or After Product Title, Before or After Product Images, Before Product Description, Before or After Product Detail, Before or After Product Options, Before or After Product Cart, Before Product Stock, Before or After Product Upsells, Before or After Product Cross-sells |
| Languages Display | Shows the available languages as a vertical list or inline on one wrapping row. | List | List, Inline |
| Languages | The pool of languages that the product-level "All" option expands to. | None selected | Languages installed in Joomla plus Manual Languages |
| Manual Languages | Languages not installed in Joomla that you still want to select as product translations. Each row needs a Language Tag and a Language Name. Flag Image is optional. | Empty | Repeatable rows |
| Template | The CSS framework used for the storefront and profile output. | Auto | Bootstrap 5, UIkit |
| Debug Mode | Writes log entries to administrator/logs/app_arsdlid.php. Disable in production. | No | Yes, No |
Release Notes Settings
These settings are on the Release Notes tab. They pull the latest version and release history from Akeeba Release System onto the product page. The product needs an ARS Package ID to be linked to a category.
| Setting | What It Does | Default | Options |
|---|---|---|---|
| Show Latest Version | Replaces the product's Version custom field with the latest published ARS release version wherever the product page shows a version number. | Yes | Yes, No |
| Changelog | Shows the product's release history as a tab or an accordion section on the product page. | Hidden | Hidden, Tab, Accordion |
| Changelog Releases | Maximum number of releases in the changelog, newest first. Shown only when Changelog is Tab or Accordion. | 5 | 1 to 50 |
| Respect Release Access | Yes: only visitors whose access level can view a release in ARS see its version and notes. No: everyone sees them, and downloads stay protected by the release access level. | No | Yes, No |
License Code Settings
These settings are on the License Codes tab. They apply to per-purchase license codes on subscription products. Turn license codes on in the product's subscription settings, which need the Subscription Product app.
| Setting | What It Does | Default | Options |
|---|---|---|---|
| Primary Download ID | Controls the primary Download ID of customers who own a license subscription. Follow License Codes: it works only while at least one license code is active. Leave Unchanged: the plugin never switches it on or off. Disabled: it is switched off, so only per-purchase codes work. | Follow License Codes | Follow License Codes, Leave Unchanged, Disabled |
| Refunded Orders | Follow Subscription: license codes follow the subscription status and ignore the order status. Revoke Codes: codes are switched off while the order is in one of the selected statuses, and back on when it moves to another status. | Follow Subscription | Follow Subscription, Revoke Codes |
| Revoke on Order Statuses | Order statuses that switch off the codes bought with that order. Shown only when Refunded Orders is Revoke Codes. Select at least one, or no codes are revoked. | None selected | Your order statuses |
Per-Product Settings
These settings appear on the Akeeba Release System section of the product edit screen.
| Field | What It Does |
|---|---|
| ARS Package ID | The numeric ID of the ARS package that this product unlocks. Leave blank if the product has no ARS package. |
| Language Translations | The languages this product is translated into. The list includes all languages installed in Joomla plus the Manual Languages. Selected languages show on the product page. |
| Additional Languages | Languages for this product only, such as a payment method available in one region. Each row has a Language Tag, a Language Name and an optional Flag Image. Without a Flag Image, a matching Joomla language flag is used when available. These always show alongside the selected translations. Empty rows do not block saving the product. |
How It Works
Automatic Download ID Generation
When an order is saved, the plugin checks whether the customer has a primary download ID in ARS. If not, it creates a random download ID through ARS and sets it as the customer's primary ID. A customer who already has a primary ID keeps it.
Translation List on Product Pages
Products with selected translations show a list headed "Translated In The Following Languages". It appears at the Display Locations you chose. Products with no translations show nothing.
Latest Version and Changelog
With Changelog set to Tab or Accordion, the product page shows the newest ARS releases for the product's package, up to the Changelog Releases limit. Both the Bootstrap 5 and UIkit templates support this.
Customer Profile Tab
Logged-in customers see a License ID tab on their My Profile page. It shows the download ID in a read-only field with a Copy button. Customers paste the ID into their site's update settings to receive updates.
Finding the ARS Package ID
- Log in to the Joomla backend.
- Go to Components -> Akeeba Release System -> Categories.
- Note the ID of the category that matches your product.
- Enter that number in the ARS Package ID field of the product.
Troubleshooting
No Download ID Appears on the Customer Profile
The customer ordered before the plugin was enabled. There is no bulk back-fill, so create the ID in ARS: go to Components -> Akeeba Release System -> Download IDs, click New, and enter the Joomla user ID and an ID string.
Plugin Fails to Install
The installer refuses when J2Commerce is missing or older than 6.6.2, or when com_ars is not installed and enabled. A message such as "This plugin requires J2Commerce 6.6.2 or later" names the cause. Update J2Commerce or install and enable com_ars, then install the plugin again.
"License ID" Tab Is Not Visible on My Profile
- Go to J2Commerce -> Apps and confirm the app is enabled.
- Go to System -> Manage -> Extensions and confirm
com_arsis installed and enabled.
Changelog or Latest Version Is Missing
Check that the product has an ARS Package ID and that Changelog is not Hidden. If Respect Release Access is Yes, visitors only see releases their access level can view in ARS.
Debug Logging
Enable Debug Mode and read the log at:
administrator/logs/app_arsdlid.php
See Also
- Akeeba Release System
- Apps Overview
