Skip to main content

Configuring Products

This guide covers the Update Product editor: product name, free text metadata, and product-level input parameters. For allowed accounts, asset types, and transaction controls, see Account Configuration.


Opening the Product Editor

  1. Navigate to Configurations → Products.
  2. Click a product row or click + New Product.
  3. The editor opens at /products/add (new) or /products/add?id=<product_id> (existing).

The breadcrumb shows Products < Update Product. Use the X button to return to the list.


Editor Layout

The product editor has two areas:

AreaContents
Main panel (left)Product Name, Allowed Accounts, Free Texts
Sidebar (right)Product Parameters

Product Name

The Product Name field is the primary identifier for the product.

FieldDescription
Product NameUnique product slug used across the platform (for example, user_holdings, customer, loan).

Important Notes

  • The product name typically becomes both the Product Id in the list and the reference used in process Product ID and Product Slug fields.
  • Use lowercase identifiers with underscores for consistency (for example, bank_las_account).
  • Changing a product name on an existing product may affect downstream references; coordinate with your team before renaming production products.

Free Texts

Free Texts map predefined metadata slots to business field names. These fields are available when creating product accounts and during process execution.

Adding a Free Text Entry

  1. Scroll to the Free Texts section below Allowed Accounts.
  2. Click + New.
  3. Select a Key from the dropdown (for example, freetext1, freetext2, … up to freetext25).
  4. Enter a Value — typically the business label or field name (for example, name, branch, risk_rating).
  5. Click the Save icon on the row.
  6. A success notification confirms creation (for example, Freetext created).

Free Text Fields

FieldDescription
KeyPredefined slot identifier (freetext1 through freetext25). Each key can be used once per product.
ValueBusiness meaning or label for the slot (for example, phone_number, dob, account_number).

Example: Customer Product Metadata

The customer product maps free text slots to customer attributes:

KeyValue
freetext1risk_rating
freetext2branch
freetext3actual_balance
freetext4dob
freetext5id_type
freetext6id_num
freetext7grand_father_name
freetext8father_name
freetext9name
freetext10gender
freetext11email
freetext12account_number
freetext13is_freeze
freetext14phone_number
freetext15boid

These mappings allow the Account Stage and account-creation forms to store customer data in consistent free-text fields across the platform.

Row Actions

ActionDescription
SavePersists the key-value mapping.
DeleteRemoves the free text entry.
DuplicateCopies the row for quick configuration.

Product Parameters

The Product Parameters sidebar defines input parameters available for the product. These parameters can be referenced during account creation and in process workflows.

Adding an Input Parameter

  1. In the Product Parameters sidebar, locate Input Parameters.
  2. Click + New.
  3. Enter the parameter details (name, type, and order as prompted).
  4. Save the parameter.

Parameters defined here appear in the Configuration summary on allowed account rows (for example, 1 Assets, 2 Params).

Important Notes

  • Product parameters are distinct from process parameters but may be mapped together in Account Stage configuration.
  • Define parameters before creating accounts if account creation requires specific inputs (for example, limits, rates, or flags).

Saving Changes

Product configuration is saved at the row level for free texts and through individual section actions for accounts and parameters.

  1. Save each free text row using the row-level Save icon.
  2. Save account rows and asset selections through the account configuration flow (see Account Configuration).
  3. After all changes are saved, return to the products list.
  4. If required by your runbook, click Load Configuration In Memory on the products list page.

Configuration Checklist

Before marking a product as ready for use:

  • Product name is unique and follows naming conventions.
  • At least one Allowed Account is configured with asset types.
  • Default Reporting Head values are set for each account slug.
  • Account Class is correct for each account (for example, LIABILITIES for customer deposits, EQUITY for holdings).
  • Free Texts are mapped for required metadata fields.
  • Product Parameters are defined if account creation requires inputs.
  • Transaction controls are configured where business rules require limits (see Account Configuration).
  • Configuration has been loaded into memory and verified in a test environment.