Skip to main content

Product Overview

What is Product Configuration?

Product Configuration is Sumo Ledger’s master-data module for defining financial and operational products. Each product describes the account structure, asset types, metadata fields, and input parameters that the ledger engine uses when creating accounts, posting journals, and executing process workflows.

Products are the foundation of the ledger:

  • Account creation — The Account Stage in a process references a Product ID to determine how new accounts are provisioned.
  • Journal postingJournal Stages can associate entries with a Product Slug for product-specific GL routing.
  • Runtime accounts — End users create product accounts from the Accounts menu using the structure defined here.
  • Process scoping — Stages can be restricted to specific products through Product Configuration settings on the process stage.

Administrators manage products from Configurations → Products (/settings/products/list). This is the default landing page when you open the Configurations section.


Product Configuration Capabilities

CapabilityDescription
Product registryMaintain a central list of product identifiers and display names (for example, loan, customer, user_holdings).
Allowed accountsDefine account slugs, asset groups, reporting heads, and account classes for each product.
Asset type mappingSelect applicable asset types (for example, defaultNpr, rewardPoint) per account through the Select Asset Type dialog.
Free text metadataMap custom key-value fields (freetext1freetext25) to business attributes such as name, branch, or risk rating.
Product parametersDefine input parameters that flow into account creation and process execution.
Transaction controlsConfigure debit/credit limits, balance bounds, and time-based counters per account ledger.
Import and exportMove product definitions between environments using JSON import/export.
Load configuration in memoryPublish product changes to the running ledger service without a full restart.

Product Configuration lives inside the Configurations module. The layout uses two levels of navigation:

Primary Sidebar

Click Configurations in the main sidebar to open the configuration area.

Secondary Menu

Inside Configurations, settings are grouped into three categories:

CategoryItems
General SettingsProducts, Coa Mapping, Tariff, Process, Table, Feed, Contract Type, Txn Controls, Policy, Policy Mapping, Webhooks
Accounting SettingsReporting Groups, Channel Types, Asset Groups, User Types
System SettingsUsers, Roles

Products is the first item under General Settings and is selected by default when you open Configurations.


Product Components

ComponentDescription
ProductTop-level container identified by a unique product ID and display name.
Allowed AccountAn account slug within the product (for example, main, primary, processing_fee) with asset group, reporting head, and account class.
Asset TypeA currency or instrument type linked to an allowed account (for example, defaultNpr under the Currency asset group).
Free TextA key-value mapping from predefined free-text slots to business field names or labels.
Product ParameterAn input parameter available when creating or operating accounts under this product.
Transaction ControlRules that limit debit/credit amounts, balances, and transaction counts over configurable time intervals.

Typical Workflow

┌──────────────────────────────────────────┐
│ Administrator opens Configurations │
│ → Products │
└──────────────────────────────────────────┘


┌──────────────────────────────────────────┐
│ Create or import a product definition │
└──────────────────────────────────────────┘


┌──────────────────────────────────────────┐
│ Configure allowed accounts, assets, │
│ free texts, and parameters │
└──────────────────────────────────────────┘


┌──────────────────────────────────────────┐
│ Save product and load configuration │
│ in memory (if required) │
└──────────────────────────────────────────┘


┌──────────────────────────────────────────┐
│ Product available for account creation, │
│ journal posting, and process workflows │
└──────────────────────────────────────────┘
  1. An administrator creates or imports a product in Configurations → Products.
  2. The product editor is opened to define Allowed Accounts, Free Texts, and Product Parameters.
  3. Asset types and transaction controls are configured per account as needed.
  4. After saving, Load Configuration In Memory publishes changes to the runtime (per your deployment runbook).
  5. The product appears in account-creation flows, process Account Stages, and journal Product Slug selectors.

ModuleRelationship
Process ConfigurationAccount Stage uses Product ID; Journal Stage uses Product Slug.
Tariff ConfigurationTariff rules can reference product-specific business logic.
Accounts (operations)End users create product accounts based on the structure defined here.
Form BuilderForm submissions can trigger processes that create accounts under configured products.
Report BuilderReports can query product accounts and holdings defined by these products.