Omnibus Price Compliance: setup and help

Requirements

Requires PrestaShop 1.6.1 or later and PHP 7.1 or later.

You need a regular scheduler and a theme with the supported product, listing, quick-view and cart hooks. No external pricing-service account is required. The module records public product prices; it does not create a complete history for dates before installation.

Installation sequence

1. Upload and install the ZIP through Modules > Module Manager > Upload a module.
2. Click Configure, or open Omnibus Compliance > Configuration.
3. Select the shop whose settings you are changing. Review History, Display, Legal text and Disclosures, then click Save.
4. Configure regular execution of Process Omnibus price-history work.
5. Open Omnibus Compliance > Dashboard and Price History to confirm that initial work and later observations are recorded.
6. Test the enabled storefront locations with a qualifying reduction after enough history exists.

Installation creates module tables, registers hooks and the scheduled task, seeds default public market contexts, starts processing existing specific prices and queues initial snapshot work. A fresh installation can correctly show no prior-price statement.

History tab

Open Omnibus Compliance > Configuration > History. These values start with the defaults below. Settings are saved for the selected shop.

Enter country policy JSON

The supplied initial policy is:

{
  "PL": {
    "window_days": 30,
    "progressive": false,
    "introductory_days": 30
  }
}

Use uppercase two-letter country keys. Each entry needs window_days, progressive and introductory_days. The form requires a window of at least 30 days, a JSON boolean for progressive, and 1 to 30 introductory days. Runtime resolution caps the window at 365 days.

With progressive enabled, a supported continuing sequence of reductions can retain the reference period before the first reduction. Leave it off unless that is the policy you intend to apply. Keep your translated wording consistent with the configured period.

These are shop-maintained policy settings. The module does not provide an automatically updated legal policy database for every country. Choose the policy and wording for the shop's actual practices before relying on the output.

Schedule the worker

The included task Process Omnibus price-history work is due every 300 seconds. It handles pending changes, snapshots, installation backfill and eligible retention cleanup. The 02:00 daily default determines when a new snapshot cycle becomes due. Several worker runs may be needed to complete it.

Use your installed compatible task manager or the host's scheduler. Cron Manager is optional. This task does not opt in to the bundled scheduler's visitor fallback. Page visits do not run this task; configure external scheduled execution.

The module has a token-protected cron front controller. A server administrator can obtain its actual URL by running this against the installed shop, replacing the path:

php -r 'require "/absolute/path/to/shop/config/config.inc.php"; echo Module::getInstanceByName("mpromnibus")->getCronURL(), PHP_EOL;'

Use the returned URL in your host scheduler, for example every minute. The runner processes tasks that are due. Keep the token private and update scheduled URLs if the shared cron token changes. Prefer the actual generated URL over constructing one from an assumed friendly-URL format.

Check progress

Open Dashboard in a single-shop context. Read Queued changes, Last job, Processed targets, Errors and Last activity. Reopen it after scheduled runs to see the progress. If Last job does not change, the scheduled worker is not running.

Snapshots cover active products available for order in tracked public markets. Each market includes the shop, country and currency. They cover recently active contexts plus the shop's default country/currency, not every possible country and currency pair. Priority contexts (JSON) does not add markets in this version.

Display tab

Check each enabled location in your theme. Product combination updates clear the old reference and unit text before requesting the new selection's result. A failed refresh leaves the comparison hidden. The price-history chart belongs to the back office and is not a storefront chart.

Legal text tab

Edit all shop languages, then Save. Nonempty values are required for the supplied wording fields.

The formatter accepts {lowest_price}, {current_price}, {discount_percent}, {window_days}, {window_start} and {window_end}. Preserve the tokens you need. If you configure a period other than 30 days, change any fixed 30-day wording in every language.

Create a product or combination policy

Open Omnibus Compliance > Product Policies with one shop selected. The panel is Product-specific legal and unit basis.

1. Select one Product.
2. Set Combination ID to 0 for the product-wide default, or enter a valid combination belonging to the product.
3. Choose History mode: Standard 30-day / introductory rule or Perishable: price before first reduction.
4. Leave Offered-since override empty to use the available offering information, or enter the actual offering date and time when catalogue creation does not describe it. The saved wall time is the shop-local value.
5. Set the unit-price fields as described below.
6. Click Save policy. This requires edit permission.

A combination-specific policy takes precedence over a product-wide policy. A saved explicit policy also takes precedence over category-derived perishable treatment. Saving the policy invalidates the shop's payload cache.

Select a unit-price mode

A new policy starts with standard history, an empty offering override, automatic unit pricing, basis quantity 1, and empty quantity/unit/reason fields. Invalid or incompatible quantity data produces no unit-price statement.

For a 500 g pack compared per 100 g, select Manual content and basis, enter content quantity 500, content code g, basis quantity 100, and basis code g. At a current pack price of 10, the calculated price per 100 g is 2 in the same currency. This is an illustrative calculation, not a catalogue record. Check the storefront result and rounding.

Disclosures tab

All four disclosure switches start off. Enable them only after supplying wording that describes your shop.

Search ranking parameters (one Label|Note per line) and Category ranking parameters (one Label|Note per line) start empty. Use a line such as:

Relevance|How closely the result matches the search terms

The other statement fields come with translated text. The initial review processing text says that the shop does not check whether reviews come from real buyers. Replace it only when your process differs. Most translated statement fields need a value in every installed language; the ranking parameter lists may stay empty.

These settings publish explanations. They do not inspect ranking algorithms, verify review authorship or establish whether a displayed price was chosen by automated decision-making.

Public price scope

The history records the effective public quantity-one price for the relevant product or combination, shop, country and currency. It retains prices with and without tax. The storefront comparison concerns the matching public tax-inclusive price. Customer-specific prices, wholesale/group prices, quantity tiers and cart discounts are outside that public history.

Supported native product, combination, specific-price and catalogue price-rule changes create recording work. Compatible pricing tools can report committed mutations through the module's integration hook. Confirm support for your particular importer or pricing tool. Direct database changes that bypass hooks need special attention.

Installation examines existing specific prices. It records current eligible observations and can keep older projections for inspection. Historical projections are marked ineligible for reference resolution because their historic winning priority, tax and displayed price are not proven. They do not supply a missing earlier 30-day record.

Reference selection

For the standard policy, the module selects the lowest eligible public price in the applicable period before a supported reduction start. The default period is 30 days. An earlier sale within that period can therefore become the reference.

Introductory treatment uses the evidenced offering period under the configured policy. Perishable treatment uses evidenced price information before the first reduction. Progressive treatment needs a supported continuing reduction episode. The resolver checks the boundary and history coverage before it shows a comparison.

For example, if a fully evidenced 30-day period contains both the regular price and an earlier lower sale price, the earlier sale price is the standard reference. Do not replace that result with a higher regular price simply because the earlier price was promotional.

When output is suppressed

A reference stays hidden when the history period, reduction boundary or accepted coverage is insufficient. It is also suppressed when the displayed offer differs from the public price or is otherwise outside the public comparison. Tax-exclusive storefront displays do not receive that public reference.

Cart rules, gifts, unknown cart-line prices and line prices that differ from the expected public price suppress the cart reference. Unit-price output additionally needs its own enabled switch and a valid quantity basis.

Inspect a product and market

Open Omnibus Compliance > Price History. Select the product, combination and recorded market context. Review the Effective price timeline and the reduction start marker. The table includes Applied price, Currency, Announced, Resolver eligible, Confidence, Time precision, Source, Applied from and Applied until.

Read these columns together. A row counts toward the reference price only when Resolver eligible says so. The reduction start display shows whether a start date was supplied, inferred or cannot be determined. Check the exact combination and market before comparing it with the storefront.

No reference after installation

Check whether enough earlier price records exist. The module records prices from installation onwards and cannot create past records. Backfilled historical estimates are not used for the reference price. When the required period is not covered, the reference price stays hidden, as expected.

Old or incomplete observations

Check Enable module, Enable daily snapshots, Enable dirty-price worker, scheduler execution, Last activity and Errors. Confirm that the market is tracked and active. Increasing the accepted gap cannot reconstruct the missing period. Resume regular recording and investigate the pricing tool's mutation integration.

Reference missing only in one location

Check its switch in Display, theme hooks and product-update behavior. In a cart, check rules, gifts and line-price matching. Compare a public tax-inclusive customer context with the corresponding recorded market. Custom themes and checkout modules need a functional test.

Settings do not save

Keep JSON valid. Include the selected Jurisdiction profile in the policy object. Use positive category IDs, valid numeric ranges, a valid ranking URL and required wording in all installed languages. In Product Policies, select one shop, a valid product/combination, positive manual quantities and an exemption reason when required.

Keep price records

The scheduled worker deletes expired price records according to History retention days, with internal safety limits. Cleanup works in small batches and can take several runs. Keep separate backups or exports of records you must keep longer.

The catalogue price record excludes personalized observations. The resolve endpoint nevertheless stores a salted fingerprint derived from the visitor's connecting address for rate limiting. Do not describe the whole module as handling no visitor-related information.

Disable or uninstall

To stop this shop's processing temporarily, turn Enable module off and save. Existing observations remain until cleanup or removal.

Before uninstalling, back up or export the price records and policy data you need. Uninstall removes the module's recorded history, module tables, settings, menu and task registration, so the stored compliance history is deleted. Reinstalling does not bring it back without a separate backup.