Pdg Applet

Holds head office’s recommended display quantity for each product category at each kind of outlet, and the outlet guides each outlet derives from it: an in-store display plan, not a web catalogue. It writes no stock movement and no journal. Saving a guide hands the work to a background job, and a guide whose outlet sizes and types match no active location fails and disappears from the listing; nothing enforces its effective and end dates either.

Overview

The PDG applet holds a retail group’s Product Distribution Guides (PDG) — head office’s recommended display quantity for each product category at each kind of outlet — and the Outlet Product Distribution Guides (OPDG) that each outlet derives from them. Head-office planners create a PDG by choosing which outlet sizes, outlet types and product-category groups it applies to; BigLedger then generates one guide cell per (outlet size × outlet type) × (category combination) and the planner types the recommended quantity into each cell. An outlet manager opens the OPDG side, picks their outlet and a PDG, gets a copy of the applicable cells, and adjusts the quantity per cell — optionally splitting it by brand (“brand corner”). The OPDG Report lists every outlet’s PDG quantity, OPDG quantity and brand split side by side.

This is a master-data / planning applet: it writes no generic document, no stock movement and no journal. Everything it stores lives in its own PDG and OPDG records. Registry code pdgApplet, applet type TNT-USER.

Where it fits

The CP Commerce Admin page lists PDG under “catalogue”; PDG does not feed the storefront — it is an in-store display-planning tool (see Related applets).

Screens and menus

Sidebar: PDG, OPDG, OPDG Report, File Import, Audit Trail, then Settings and Personalization. The applet opens on the PDG listing.

• PDG › PDG Listing — columns Doc No, Pdg Name, Pdg Code, Created Date, Modified Date, Status. The listing shows only ACTIVE and PROCESSING PDGs, so a PDG whose background job failed (status DELETED) simply disappears. The + button opens Create PDG (Details tab only); clicking a row opens Edit PDG with three tabs:
  • Details — the PDG header (see Fields).
  • Guide — a grid with one row per category combination and one column per outlet size – outlet type pair; the cells are the recommended quantities. Each cell saves on edit.
  • Outlet Guide — Opdg Outlet Listing: the OPDGs already created for this PDG (Name, Code, Description, Outlet Size, Outlet Type). + opens Set OPDG Elements › Set Outlet; once saved a second tab OPDG Chart appears, and each row’s action opens Edit Opdg with Opdg Chart Details and Opdg By Brands.
• OPDG › Opdg Outlet Listing — one row per location that already has at least one ACTIVE OPDG element and that the user is permitted to see (Outlet Name, Outlet Code, Description, Outlet Size, Outlet Type, Created/Modified Date). + opens Opdg Add; clicking a row opens Opdg Pdg Listing (the PDGs applied at that outlet), then Set OPDG Elements › Set Outlet / OPDG Chart.
• OPDG Report › OPDG Report Listing — flat grid: Outlet Name, Outlet Code, Description, Outlet Size, Outlet Type, Product Department (category level 1), Product Type (category level 2), PDG QTY, OPDG QTY, Brand Corner, Brand, Brand QTY, Created Date, Modified Date. Column filters are text filters; CSV export is enabled.
• File Import › File Import Listing — File Name, File Size, Format, Status, Process Status, Error Message, Created Date. + opens Upload The Pdg Import File (drag-and-drop, .xls/.xlsx only). Clicking a row opens File Details with Details and Checking (sub-tabs Error and All, one row per spreadsheet line with Validation Error, Category Group 1/2 and their validation errors, Outlet Size / Outlet Type and their validation errors).
• Audit Trail — the shared applet audit-trail listing (Table Name, Status, Action Name, Action By, Date Created, Date Updated). Create, update and delete of PDG headers, OPDG headers, OPDG elements and brand rows write audit-trail rows.
• Settings — Application Settings, Default Selection, Printable Format Settings, Email Template, Webhook, Feature Visibility, Permission Wizard, Permission Set, User Permission, Role Permission. Personalization — Default Selection, Sidebar.

Configuration

Before you can use it

1. Outlet Type and Outlet Size lists exist — Organisation Applet › Settings › Outlet Settings (code and name required).
2. Every outlet location carries an Outlet Size and an Outlet Type — Organisation Applet › Location › Edit › Details. BigLedger builds a PDG’s outlet columns only from ACTIVE locations whose Outlet Size and Outlet Type match the PDG’s filters. A PDG whose filters match no such location fails its background job with “In bl_inv_mst_location outlet_type_guids and outlet_size_guids pair doesn’t exist” and ends up DELETED (invisible in the listing). Nothing on the PDG create screen warns about this.
3. Category groups mapped in Doc Item Maintenance › Settings › Item Category. The PDG Category Group Filter offers only category groups that appear in that mapping, and the PDG remembers both the group and the item column it maps to.
4. Items that carry those categories. The category combinations of a PDG are generated from the items themselves — only combinations used by at least one ACTIVE item become rows in the Guide.
5. Outlet users need a location-scoped permission — see Feature visibility / permissions. Without a target list they see every outlet (the applet filters only when the list is non-empty).
6. Backend permissions for the TNT_DM_INV_PDG_*, TNT_DM_INV_OPDG_*, TNT_DM_INV_OUTLET_* API families via Permission Wizard / Permission Set.

Applet settings

Settings › Application Settings opens the shared settings screen that every document applet carries; the applet’s own settings screen is not reachable and its four “Lines Settings” / four “Department Settings” toggles do nothing. Settings saved here are the applet’s tenant-wide master settings. Anyone who can open the applet’s Settings can change them.

The shared screen is not tailored to this applet, so it renders the whole generic sales-document settings catalogue (Main Details, Line Items, Listing, Miscellaneous … tabs). Only the keys below are actually declared, rendered, persisted and consumed by a PDG/OPDG screen:

Read at runtime without a control for this applet code: ENABLE_FILTER_BY_TODAYS_TXN (the PDG listings honour it, but the shared screen does not offer it for this applet). All other keys the shared screen offers (HIDE_ARAP_*, HIDE_COSTING_DETAILS, tab-hide keys, etc.) belong to sales-invoice screens this applet does not have and have no effect on any PDG/OPDG screen.

Default Selection renders Default Branch and Default Location and saves DEFAULT_BRANCH, DEFAULT_LOCATION, DEFAULT_COMPANY (plus rounding/group-discount item keys with no control) into the same master settings. No PDG, OPDG, report or import screen reads them; the branch filter it applies to its own drop-down looks for a sales-invoice permission this applet never loads. Personalization › Default Selection is a stub: it neither loads nor saves.

Document behaviour settings

Not a document applet. No status-flow, posting, printable, approval or e-Invoice options exist.

Settings in other applets that control this applet

Feature visibility / permissions

• Backend (server-side) permission — the one that matters. On opening, the applet loads the user’s target list for TNT_API_DOC_PDG_READ_LOCATION_TGT_GUID (“The assignee is allowed to access the target GUID of a location (OPDG) within the PDG Applet”) together with TNT_TENANT_ADMIN and TNT_TENANT_OWNER. The OPDG outlet listing and the Opdg Add outlet drop-down keep only locations in that target list. If the target list is empty the filter is skipped and every outlet is visible — the permission narrows, it does not gate. Grant it per role or user through Settings › Permission Wizard with the outlet’s location as target.
• Client-side permission definitions: none exist for this applet, and the applet checks none on any of its own screens. HIDE_* settings therefore have no SHOW_* per-role override here.
• Backend API permissions checked on every call: API_TNT_DM_INV_PDG_UNIQUE_COMBINATION_CREATE/UPDATE (PDG create/update), API_TNT_DM_INV_PDG_HDR_DELETE, API_TNT_DM_INV_OPDG_HDR_INV_OPDG_HDR_CREATE/UPDATE/DELETE, API_TNT_DM_INV_OPDG_ELEMENT_CREATE/UPDATE/DELETE/READ (READ also guards the OPDG Report), API_TNT_DM_INV_OPDG_ELEMENT_BY_BRAND_*, API_TNT_DM_INV_PDG_GUIDE_ELEMENT_*, API_TNT_DM_INV_OUTLET_TYPE_HDR_*, API_TNT_DM_INV_OUTLET_SIZE_HDR_*. A missing one surfaces in the applet as “The user is not authorized to perform this action.”
• Settings › Permission Wizard was blank for this applet in builds before 2026-05.

Fields

PDG › Details

PDG › Guide

One row per category combination, one column per location combination (labelled size–type). The cell is the recommended quantity, read as a whole number on cell change and saved immediately. The table also has room for an AI-suggested quantity and a previous quantity, but no screen writes them. The combination of row and column is unique per guide.

OPDG › Set Outlet / Opdg Add

OPDG Chart

One row per category combination of the guide; the category columns that name it are read-only.

Each OPDG element remembers its PDG, its OPDG header, the two combinations and the location; every cell save is written immediately.

Opdg By Brands

File Import

The upload form has no fields other than the file (.xls/.xlsx; the delimiter control belongs to the CSV template leftover and is not sent). The importer reads fixed cells:

One workbook = one PDG for one size–type pair. Rows that fail validation are listed under Checking › Error with the message text above; any error sets Process Status FAILED and deletes the half-created PDG header.

Lifecycle and effects

Not a generic document. There is no journal posting, no stock movement and no open queue for PDG or OPDG; saving checks only that the referenced records exist and that a status is set. Statuses are the generic values (ACTIVE, PROCESSING, INACTIVE, DELETED).

PDG create / update is asynchronous. Saving a PDG stores the header with status PROCESSING and hands the rest to a background job that runs at once. The job:

1. writes the outlet-type and outlet-size filter links (update: diffs them);
2. generates the category combinations from items (update: delete-and-regenerate);
3. generates the location combinations = distinct (outlet size, outlet type) of ACTIVE locations matching both filters — fails if none;
4. generates one guide element per location × category combination that does not exist yet — and, for every ACTIVE OPDG of this PDG, a matching OPDG element, so existing outlets pick up new rows;
5. on success sets the header ACTIVE; on any failure sets it DELETED. Quantities already typed into removed combinations are not carried over.

OPDG create is asynchronous too. Saving an OPDG stores the header as PROCESSING and a background job copies every ACTIVE guide element of the PDG into the outlet’s OPDG, then sets the header ACTIVE. Elements are created without quantities — the outlet starts from empty OPDG cells, not from the PDG numbers.

Edits — guide cells, OPDG cells and brand rows are saved immediately and each write an audit-trail row.

Delete PDG (listing action) is a permanent delete. Its guide elements and OPDG elements go with it, but an OPDG header still points at the PDG, so a PDG that already has an OPDG header cannot be deleted — the database rejects it and the applet shows its generic error toast. Delete the OPDG headers first (through the API; OPDG elements referencing the header are not removed with it).

What the applet reads elsewhere: locations (and writes their Outlet Size / Outlet Type from Opdg Add), the Outlet Type and Outlet Size lists, the Item Category level mapping, label lists and labels, and item headers. It writes nothing to inventory balances, documents or the general ledger.

Related applets

• Organisation Applet — owns the Outlet Type / Outlet Size lists and the per-location assignment that every PDG column and every OPDG depends on; Opdg Add writes back to the location.
• Doc Item Maintenance Applet — owns category groups, categories, the Item Category level mapping and the brand labels; PDG rows exist only for category pairs that real items carry.
• CP Commerce Admin Applet — links here as catalogue data; there is no data flow between the two applets (PDG is an in-store display plan, not a web catalogue).

Troubleshooting

Related documentation

• Inventory module
• Organisation Applet — Outlet Type / Outlet Size and Location Edit
• Doc Item Maintenance Applet — Category Groups, Item Category mapping