Requirements and install¶
Profitability Copilot installs like every other extension sold here. Follow the shared procedure rather than a Profitability Copilot-specific one:
- Requirements: check these first.
- Installing an extension: upload, enable, grant permission. All three steps are required.
- Troubleshooting an install: if it did not work.
What is specific to Profitability Copilot¶
The releases it has been through. A full install-to-uninstall pass has been
run on OpenCart 4.0.2.0, 4.0.2.1, 4.0.2.2, 4.0.2.3, 4.1.0.0, 4.1.0.1, 4.1.0.2,
4.1.0.3 and 4.1.0.4. It refuses to install below 4.0.2.0, and on PHP older than
8.1. OpenCart still reports Success when it refuses; the reason is a line
containing install refused under System → Maintenance → Error Logs, in the
store's error log for PHP and on the kyvero.log tab for OpenCart.
The permission entry to tick at step 3 of the shared procedure is:
extension/profitability_copilot/module/profitability_copilot
That is the settings screen. Each of the other screens carries a permission of its own, so that you can hand out the reports without handing out what you pay people. Enabling the extension gives all of them to your own user group. For any other group, tick the ones it should have under System → Users → User Groups:
| Entry | Opens | Tick |
|---|---|---|
extension/profitability_copilot/report/dashboard |
Dashboard | Access |
extension/profitability_copilot/report/product |
Product profit | Access |
extension/profitability_copilot/catalog/cost |
Cost book, and the cost field on the product form with the margin and markup under it | Access to see a cost, Modify to change one |
extension/profitability_copilot/report/expense |
Expenses | Access to read, Modify to change |
extension/profitability_copilot/report/recompute |
Back-fill, Recalculate, Recalculate this order and Recheck orders | Access and Modify |
extension/profitability_copilot/customer/purge |
The remove-everything personal-data screen | Access and Modify |
A menu entry a group may not open is left out of the Profitability menu rather than shown greyed out. Read who can see what you pay before you tick the two reports for a group: both show cost of goods.
It arrives switched off. Enabling it from Extensions → Extensions → Modules creates its tables and settings, but records nothing until you tick Status on the General tab of its settings screen and save. Orders that change status before then have no figures. See figures start the day you switch it on.
It stores its own data, in four tables: the cost per product, one row per recorded order line, your operating expenses, and a copy of its settings. Uninstalling leaves all four and everything in them in place, so an update loses nothing. See uninstalling and updating.
Updating keeps your costs, expenses, recorded figures and settings, apart from detailed logging, which comes back off. The full list is under what an update keeps. Follow updating to a newer version in the order it gives.
Nothing else to set up¶
There is no cron entry, no scheduled task, no writable directory and no external service. The API ships switched off, and nothing needs it.